VkHelpPane(3x)							VkHelpPane(3x)

NAME    [Toc]    [Back]

     VkHelpPane	- A menu pane that interfaces to the ViewKit help system

INHERITS FROM    [Toc]    [Back]

     VkSubMenu : VkMenu	: VkMenuItem : VkComponent : VkCallbackObject

HEADER FILE    [Toc]    [Back]

     #include <Vk/VkHelpPane.h>

PUBLIC PROTOCOL	SUMMARY
   Constructor/Destructor
	   VkHelpPane(const char *name,
		      VkMenuDesc *desc = NULL,
		      XtPointer	defaultClientData = NULL);
	   VkHelpPane(Widget parent,
		      const char *name,
		      VkMenuDesc *desc = NULL,
		      XtPointer	defaultClientData = NULL);
	   virtual void	~VkHelpPane(void);

CLASS DESCRIPTION    [Toc]    [Back]

	  This class is	a ready-made menu pane that provides an	interface to
	  the standard help protocol supported by all ViewKit applications.
	  This menu pane can be	added to other menus or	menu panes as needed.
	  All interactions with	the help system	are handled automatically.

	  For example, the following code segment creates a popup menu and
	  adds a cascading help	pane to	the popup:


	   // ...

	   VkPopupMenu *actionsPopup = new VkPopupMenu();

	   actionsPopup->addSubmenu(new	VkHelpPane("helpMenu"));
	   actionsPopup->attach(parent);

FUNCTION DESCRIPTIONS    [Toc]    [Back]

   VkHelpPane()
	   VkHelpPane(const char *name,
		      VkMenuDesc *desc = NULL,
		      XtPointer	defaultClientData = NULL);
	   VkHelpPane(Widget parent,
		      const char *name,
		      VkMenuDesc *desc = NULL,
		      XtPointer	defaultClientData = NULL);







									Page 1






VkHelpPane(3x)							VkHelpPane(3x)



	  Initialize a VkHelpPane object. If a menu description	is provided,
	  the specified	items will be added to the top of the help menu	before
	  the standard items are added.

   ~VkHelpPane()
	   virtual void	~VkHelpPane(void);


	  Free all memory associated with a VkHelpPane object.

INHERITED MEMBER FUNCTIONS    [Toc]    [Back]

   Inherited from VkSubMenu
	  widgetDestroyed(), build(), menuType(), menuParent(),	VkSubMenu(),
	  VkSubMenu(), ~VkSubMenu(), pulldown(), _pulldown


   Inherited from VkMenu    [Toc]    [Back]
	  isContainer(), findParent(), addAction(), addActionWidget(),
	  addConfirmFirstAction(), addSeparator(), addLabel(), addToggle(),
	  addToggle(), add(), addSubmenu(), addRadioSubmenu(),
	  registerSubmenu(), findNamedItem(), removeItem(), activateItem(),
	  deactivateItem(), replace(), getItemPosition(), getItemPosition(),
	  getItemPosition(), operator[](), numItems(), _contents, _nItems,
	  _maxItems,


   Inherited from VkMenuItem    [Toc]    [Back]
	  show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
	  deactivate(),	remove(), show(), _position, _isBuilt, _sensitive,
	  _parentMenu, _label, _isHidden, _unmanagedWidgets,
	  _numUnmanagedWidgets,


   Inherited from VkComponent    [Toc]    [Back]
	  installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
	  setDefaultResources(), getResources(), manage(), unmanage(),
	  baseWidget(),	okToQuit(), _name, _baseWidget,	_w, deleteCallback


   Inherited from VkCallbackObject    [Toc]    [Back]
	  callCallbacks(), addCallback(), removeCallback(),
	  removeAllCallbacks()


CLASSES	USED BY	THIS CLASS
     VkApp, VkDialogManager, VkMenu

KNOWN CLASSES THAT USE THIS CLASS    [Toc]    [Back]

     VkHelpPane






									Page 2






VkHelpPane(3x)							VkHelpPane(3x)

SEE ALSO    [Toc]    [Back]

     VkSubMenu,	VkMenu,	VkMenuItem, VkComponent, VkApp,	VkDialogManager
     ViewKit Programmer's Guide
     The X Window System, DEC Press, Bob Sheifler and Jim Gettys
     The X Window System Toolkit, DEC Press, Paul Asente and Ralph Swick
     The OSF/Motif Programmers Reference, Prentice Hall, OSF


									PPPPaaaaggggeeee 3333