Contents User Forum Source Index APIs by Task APIs by Level Data


G3D::GuiLabel Class Reference

A text label. More...

#include <GuiLabel.h>

Inherits G3D::GuiControl.

List of all members.

Public Member Functions

const GuiCaptioncaption () const
bool enabled () const
bool focused () const
bool mouseOver () const
void moveBy (float dx, float dy)
void moveBy (const Vector2 &delta)
void moveRightOf (const GuiControl *control)
const Rect2Drect () const
void setCaption (const GuiCaption &text)
void setEnabled (bool e)
void setFocused (bool b)
void setHeight (float h)
void setPosition (float x, float y)
void setPosition (const Vector2 &v)
virtual void setRect (const Rect2D &rect)
void setSize (float x, float y)
void setSize (const Vector2 &v)
void setVisible (bool b)
void setWidth (float w)
GuiSkinRef skin () const
bool visible () const

Protected Member Functions

void fireActionEvent ()
virtual bool onEvent (const GEvent &event)

Protected Attributes

GuiCaption m_caption
Rect2D m_clickRect
bool m_enabled
GuiWindowm_gui
GuiPanem_parent
Rect2D m_rect
bool m_visible

Friends

class GuiPane
class GuiWindow


Detailed Description

A text label.

Will never be the focused control and will never have the mouse over it.


Member Function Documentation

const GuiCaption& G3D::GuiControl::caption (  )  const [inherited]

bool G3D::GuiControl::enabled (  )  const [inherited]

void G3D::GuiControl::fireActionEvent (  )  [protected, inherited]

Fires an action event.

bool G3D::GuiControl::focused (  )  const [inherited]

bool G3D::GuiControl::mouseOver (  )  const [inherited]

void G3D::GuiControl::moveBy ( float  dx,
float  dy 
) [inherited]

void G3D::GuiControl::moveBy ( const Vector2 delta  )  [inherited]

void G3D::GuiControl::moveRightOf ( const GuiControl control  )  [inherited]

If these two controls have the same parent, move this one immediately to the right of the argument.

virtual bool G3D::GuiControl::onEvent ( const GEvent event  )  [inline, protected, virtual, inherited]

Events are only delivered to a control when the control that control has the key focus (which is transferred during a mouse down).

Reimplemented in G3D::GuiButton, G3D::GuiCheckBox, G3D::GuiDropDownList, G3D::GuiPane, G3D::GuiRadioButton, G3D::_GuiSliderBase, and G3D::GuiTextBox.

const Rect2D& G3D::GuiControl::rect (  )  const [inherited]

void G3D::GuiControl::setCaption ( const GuiCaption text  )  [inherited]

void G3D::GuiControl::setEnabled ( bool  e  )  [inherited]

void G3D::GuiControl::setFocused ( bool  b  )  [inherited]

Grab or release keyboard focus.

void G3D::GuiControl::setHeight ( float  h  )  [inherited]

void G3D::GuiControl::setPosition ( float  x,
float  y 
) [inherited]

void G3D::GuiControl::setPosition ( const Vector2 v  )  [inherited]

virtual void G3D::GuiControl::setRect ( const Rect2D rect  )  [virtual, inherited]

If you explicitly change the rectangle of a control, the containing pane may clip its borders.

Call pack() on the containing pane (or window) to resize that container appropriately.

Reimplemented in G3D::GuiCheckBox, G3D::GuiDropDownList, G3D::GuiPane, G3D::GuiRadioButton, and G3D::GuiTextBox.

void G3D::GuiControl::setSize ( float  x,
float  y 
) [inherited]

void G3D::GuiControl::setSize ( const Vector2 v  )  [inherited]

void G3D::GuiControl::setVisible ( bool  b  )  [inherited]

void G3D::GuiControl::setWidth ( float  w  )  [inherited]

GuiSkinRef G3D::GuiControl::skin (  )  const [inherited]

bool G3D::GuiControl::visible (  )  const [inherited]


Friends And Related Function Documentation

friend class GuiPane [friend]

Reimplemented from G3D::GuiControl.

friend class GuiWindow [friend]

Reimplemented from G3D::GuiControl.


Member Data Documentation

GuiCaption G3D::GuiControl::m_caption [protected, inherited]

Rect2D G3D::GuiControl::m_clickRect [protected, inherited]

Rect bounds used for mouse actions.

Updated by setRect.

bool G3D::GuiControl::m_enabled [protected, inherited]

GuiWindow* G3D::GuiControl::m_gui [protected, inherited]

The window that ultimately contains this control.

GuiPane* G3D::GuiControl::m_parent [protected, inherited]

Parent pane.

Rect2D G3D::GuiControl::m_rect [protected, inherited]

Rect bounds used for rendering and layout.

Relative to the enclosing pane's clientRect.

bool G3D::GuiControl::m_visible [protected, inherited]


The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:46 2007 for G3D by doxygen 1.5.2
Hosted by SourceForge.net Logo