Diffpack Documentation

---

              Search  

---

BtGuiWidget Class Reference

Base class for GUI widgets. More...

#include <BtGuiWidget.h>

Inheritance diagram for BtGuiWidget::

List of all members.

Public Methods
	BtGuiWidget (const BtGuiTkInterpreter &interf, const String &name="")
	BtGuiWidget (const BtGuiTkInterpreter &interf, const BtGuiWidget &parent, const String &name="")
	~BtGuiWidget ()
String	widgetName () const
virtual void	attachToTkWidget (const String &name)
virtual bool	create ()=0
virtual bool	widgetOption (const String &option, const String &value)
virtual bool	widgetOption (const String &option, int value)
virtual bool	widgetOption (const String &option, real value)
virtual String	getWidgetOption (const String &option)
virtual String	widgetCommand (const String &cmd)
virtual String	widgetCommand (const String &cmd, const String &args)
virtual String	widgetCommand (const String &cmd, const String &widgetName, const String &args)
virtual bool	pack ()
virtual bool	place ()
virtual bool	packOption (const String &option, const String &value)
virtual bool	packOption (const String &option, int value)
virtual bool	packOption (const String &option, real value)
virtual bool	placeOption (const String &option, const String &value)
virtual bool	placeOption (const String &option, int value)
virtual bool	placeOption (const String &option, real value)
virtual void	destroy ()
Protected Methods
bool	setOptions ()
String	subwidget (const String &name)
Protected Attributes
bool	is_created_

---

Detailed Description

Base class for GUI widgets.

NAME: BtGuiWidget - Base class for GUI widgets

DESCRIPTION:

This class implements a base class widget wrapper for a Tcl/Tk/Tix-based GUI. Specialized widget classes are derived from this base class.

---

Constructor & Destructor Documentation

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

In order to create an instance of this class one must provide an interpreter object to the constructor. In addition two optional arguments may be given, a parent widget and a name for the widget. It is important that the parent's "create" command is called before the "create" command of a child.

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

See documentation of one of the overloaded constructor.

BtGuiWidget::~BtGuiWidget ( )

---

Member Function Documentation

void BtGuiWidget::attachToTkWidget ( const String & name ) [virtual]

apply the stored options to the widget indicated by the input "name".

bool BtGuiWidget::create ( ) [pure virtual]

create the widget and display it. This is a pure virtual function that needs to be defined in derived classes. Reimplemented in BtGuiBalloon, BtGuiButton, BtGuiButtonBox, BtGuiCanvas, BtGuiCheckButton, BtGuiCheckList, BtGuiComboBox, BtGuiControl, BtGuiDirList, BtGuiDirSelectDialog, BtGuiDirTree, BtGuiEntry, BtGuiExFileSelectBox, BtGuiExFileSelectDialog, BtGuiFileEntry, BtGuiFileSelectBox, BtGuiFileSelectDialog, BtGuiFrame, BtGuiGrid, BtGuiHList, BtGuiInputOnly, BtGuiLabel, BtGuiLabelEntry, BtGuiLabelFrame, BtGuiListBox, BtGuiListNoteBook, BtGuiMenu, BtGuiMenuButton, BtGuiMenuSystem, BtGuiMessage, BtGuiMeter, BtGuiNoteBook, BtGuiOptionMenu, BtGuiPanedWindow, BtGuiPopupMenu, BtGuiRadioButton, BtGuiScale, BtGuiScrollbar, BtGuiScrolledGrid, BtGuiScrolledTList, BtGuiScrollHList, BtGuiScrollListBox, BtGuiScrollText, BtGuiScrollWindow, BtGuiSelect, BtGuiStdButtonBox, BtGuiText, BtGuiTList, BtGuiTopLevel, BtGuiTree, and BtGuiWidgetGen.

void BtGuiWidget::destroy ( ) [virtual]

destroy the widget and remove it from the display..

String BtGuiWidget::getWidgetOption ( const String & option ) [virtual]

get the value of a specific option for the current widget.

bool BtGuiWidget::pack ( ) [virtual]

let Tcl/Tk pack the widget using the pack options set by "packOption". Reimplemented in BtGuiLabelEntry.

bool BtGuiWidget::packOption ( const String & option, real value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::packOption ( const String & option, int value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::packOption ( const String & option, const String & value ) [virtual]

set pack options and call "pack".

bool BtGuiWidget::place ( ) [virtual]

let Tcl/Tk place the widget using the place options set by "placeOption". Reimplemented in BtGuiLabelEntry.

bool BtGuiWidget::placeOption ( const String & option, real value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::placeOption ( const String & option, int value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::placeOption ( const String & option, const String & value ) [virtual]

set place options and call "place".

bool BtGuiWidget::setOptions ( ) [protected]

set options collected so far (normally used by "create").

String BtGuiWidget::subwidget ( const String & name ) [protected]

returns the Tk-path of a subwidget (relevant for TiX meta widgets). Reimplemented in BtGuiLabelEntry, BtGuiOptionMenu, and BtGuiScrollWindow.

String BtGuiWidget::widgetCommand ( const String & cmd, const String & widgetName, const String & args ) [virtual]

See documentation of one of the overloaded functions.

String BtGuiWidget::widgetCommand ( const String & cmd, const String & args ) [virtual]

See documentation of one of the overloaded functions.

String BtGuiWidget::widgetCommand ( const String & cmd ) [virtual]

execute a Tcl/Tk command affecting this widget.

String BtGuiWidget::widgetName ( ) const

return the name of the widget as set in the constructor.

bool BtGuiWidget::widgetOption ( const String & option, real value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::widgetOption ( const String & option, int value ) [virtual]

See documentation of one of the overloaded functions.

bool BtGuiWidget::widgetOption ( const String & option, const String & value ) [virtual]

set and apply a widget option.

---

Member Data Documentation

bool BtGuiWidget::is_created_ [protected]

---

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

• BtGuiWidget.h

---