DigitalSpaces::DI3DVisualsGUIElement1 Struct Reference
[Generic GUI Interfaces]

#include <Interfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Detailed Description

Basic base class for all GUI elements.

This contains all the common functionality to all the GUI components.


Public Member Functions

void setText (const char *sText)
 Set the text that will be displayed on this GUI element.
const char * getText () const
 Get the text being displayed on this GUI element.
bool isClicked ()
 Returns if the GUI element has been clicked.
void show ()
 Makes the GUI element visible.
void hide ()
 Makes the GUI element no longer visible.
bool isClosed ()
 Returns if a window has been closed.
void setAlpha (const float fAlpha)
 Sets the visible transperency of the GUI element.
bool isMouseButtonDown ()
 Returns if the mouse button is currently down.
bool isMouseButtonUp ()
 Returns if the mouse button is currently up.
void setEnabled (bool bEnabled)
 Sets if the GUI element can be interacted with.
bool gainedFocus ()
 Returns if the GUI element has gained focus.
bool lostFocus ()
 Returns if the GUI element has lost focus.
Positioning
Functions for getting and setting the GUI Element's position

float getXPosition ()
 Return the X (horizontal) position of the GUI element.
float getYPosition ()
 Return the Y (vertical) position of the GUI element.
void setXPosition (const float fX)
 Set the X (horizontal) position of the GUI element.
void setYPosition (const float fY)
 Set the Y (vertical) position of the GUI element.

Member Function Documentation

void DigitalSpaces::DI3DVisualsGUIElement1::setText ( const char *  sText  ) 

Set the text that will be displayed on this GUI element.

How this will be displayed depends on the type of GUI element this actually is.


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