Diffpack Documentation

---

              Search  

---

BtGuiMenuHelpCB Class Reference

special callback for GUI help system. More...

#include <BtGuiMenuSystem.h>

Inheritance diagram for BtGuiMenuHelpCB::

List of all members.

Public Methods
	BtGuiMenuHelpCB (const BtGuiTkInterpreter &interf, const String &name="")
void	addInfo (String tcl_path, MenuItemBase &item)
void	setDescriptionWidget (BtGuiWidget *widget)
void	setDescriptionVariable (BtGuiVariable *variable)
virtual bool	performeAction (int argc, char **argv)

---

Detailed Description

special callback for GUI help system.

NAME: BtGuiMenuHelpCB - special callback for GUI help system

DESCRIPTION:

This is a special version of "BtGuiCallback" that implements a callback functionality that starts the help system of the application.

---

Constructor & Destructor Documentation

BtGuiMenuHelpCB::BtGuiMenuHelpCB ( const BtGuiTkInterpreter & interf, const String & name = "" )

See class "BtGuiCallback".

---

Member Function Documentation

void BtGuiMenuHelpCB::addInfo ( String tcl_path, MenuItemBase & item )

adds information on a menu item to be displsyed by the help system. Such information is stored as a list of "BtGuiLabelInfo" objects.

bool BtGuiMenuHelpCB::performeAction ( int argc, char ** argv ) [virtual]

this is a specialized version of the callback entry point that starts the help system. Reimplemented from BtGuiCallback.

void BtGuiMenuHelpCB::setDescriptionVariable ( BtGuiVariable * variable )

sets the "BtGuiVariable" telling whether the user wants help messages to be shown.

void BtGuiMenuHelpCB::setDescriptionWidget ( BtGuiWidget * widget )

sets the "BtGuiWidget" that is supposed to receive the help system output.

---

The documentation for this class was generated from the following file:

• BtGuiMenuSystem.h

---