Diffpack Documentation

---

              Search  

---

BtGuiMenuSystem Class Reference

Tk-based representation of a "MenuSystem" object. More...

#include <BtGuiMenuSystem.h>

Inheritance diagram for BtGuiMenuSystem::

List of all members.

Public Methods
	BtGuiMenuSystem (const BtGuiTkInterpreter &interf, const String &name="")
	BtGuiMenuSystem (const BtGuiTkInterpreter &interf, const BtGuiWidget &parent, const String &name="")
	~BtGuiMenuSystem ()
void	setMenuSystem (MenuSystem &menu)
void	setMenuSystem (MenuSystem *menu)
void	setParent (const BtGuiWidget &parent)
void	setCreateTopLevel (bool b)
void	setCreateDismissButton (bool b)
void	setDescriptionWidget (BtGuiWidget *widget)
void	setDescriptionVariable (BtGuiVariable *variable)
void	buildPage (BtGuiMenuPage &page)
virtual bool	create ()

---

Detailed Description

Tk-based representation of a "MenuSystem" object.

NAME: BtGuiMenuSystem - Tk-based representation of a "MenuSystem" object

DESCRIPTION:

This is a widget representing the GUI associated with a "MenuSystem" object. It is derived from the "BtGuiWidget" base class.

---

Constructor & Destructor Documentation

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

See class "BtGuiWidget". There is also a special constructor that accepts a reference to the parent widget, if the current widget is not at top level.

BtGuiMenuSystem::BtGuiMenuSystem ( const BtGuiTkInterpreter & interf, const BtGuiWidget & parent, const String & name = "" )

See documentation of one of the overloaded constructor.

BtGuiMenuSystem::~BtGuiMenuSystem ( )

---

Member Function Documentation

void BtGuiMenuSystem::buildPage ( BtGuiMenuPage & page )

construct the GUI page (called by "create").

bool BtGuiMenuSystem::create ( ) [virtual]

create the widget and feed it to the Tk interpreter. Returns true if the creation was successful, otherwise it returns false. Reimplemented from BtGuiWidget.

void BtGuiMenuSystem::setCreateDismissButton ( bool b )

set a flag (true/false) indicating whether this widget should have a dismiss button or not.

void BtGuiMenuSystem::setCreateTopLevel ( bool b )

set a flag (true/false) indicating whether this widget should be created at top level or not.

void BtGuiMenuSystem::setDescriptionVariable ( BtGuiVariable * variable )

set a variable determining whether description will be shown or not. Cconnect it to the help callback system if that is available.

void BtGuiMenuSystem::setDescriptionWidget ( BtGuiWidget * widget )

set a description widget and connect it to the help callback system if that is available.

void BtGuiMenuSystem::setMenuSystem ( MenuSystem * menu )

See documentation of one of the overloaded functions.

void BtGuiMenuSystem::setMenuSystem ( MenuSystem & menu )

set the internal handle to the "MenuSystem" object that is to be presented in a GUI fashion.

void BtGuiMenuSystem::setParent ( const BtGuiWidget & parent )

set the parent widget, thus indicating that this is not a top-level widget.

---

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

• BtGuiMenuSystem.h

---