DigitalSpaces::DI3DVisualsGUIComboBox1 Struct Reference
[Generic GUI Interfaces]

#include <Interfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Detailed Description

Interface for a combo box (a drop down selection list that allows typing values into the element).

Using the function DI3DVisualsGUIElement1::setText allows you to change the text displayed, DI3DVisualsGUIElement1::getText returns the text currently displayed. When the user selects (clicks) an entry from the drop down box, this changes the text retreived by DI3DVisualsGUIElement1::getText.

Note:
When setting the visual size of this GUI element, the size specified is that of the entire GUI element, including the drop down list. The vertical size of the text portion of the GUI element is decided by the GUI elemenent implementation, based on the font being used.

To allow the combo box to appear below the bottom the parent window, make sure the ClippedByParent property is set to false.


Public Member Functions

bool hasSelectionChanged ()
 Returns if an item has been selected from the drop down list.
void addItem (const char *sItemText)
 Adds an item to the drop down list.
void removeItem (const char *sItemText)
 Removes an item from the drop down list.
void resetList ()
 Removes every item from the drop down list.

Member Function Documentation

bool DigitalSpaces::DI3DVisualsGUIComboBox1::hasSelectionChanged (  ) 

Returns if an item has been selected from the drop down list.

The current implementation returns if the user has selected from the list element since the last time this function was called, or since creation if the function has not been called before.


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

Generated on Sun Aug 31 17:46:28 2008 for Digital Spaces by  doxygen 1.5.6