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


G3D::GuiRadioButton Class Reference

Radio button or exclusive set of toggle butons. More...

#include <GuiRadioButton.h>

Inherits G3D::GuiControl.

List of all members.

Public Types

enum  Style { RADIO_STYLE, BUTTON_STYLE, TOOL_STYLE }

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 ()
 GuiRadioButton (GuiWindow *gui, GuiPane *parent, const GuiCaption &text, int myID, const Pointer< int > &groupSelection, Style style=RADIO_STYLE)
virtual bool onEvent (const GEvent &event)
virtual void render (RenderDevice *rd, const GuiSkinRef &skin) const
bool selected () const
void setSelected ()

Protected Attributes

GuiCaption m_caption
Rect2D m_clickRect
bool m_enabled
GuiWindowm_gui
int m_myID
GuiPanem_parent
Rect2D m_rect
Style m_style
Pointer< int > m_value
bool m_visible

Friends

class GuiPane
class GuiWindow


Detailed Description

Radio button or exclusive set of toggle butons.


Member Enumeration Documentation

Enumerator:
RADIO_STYLE 
BUTTON_STYLE 
TOOL_STYLE 


Constructor & Destructor Documentation

G3D::GuiRadioButton::GuiRadioButton ( GuiWindow gui,
GuiPane parent,
const GuiCaption text,
int  myID,
const Pointer< int > &  groupSelection,
Style  style = RADIO_STYLE 
) [protected]

Parameters:
myID The ID of this button

Parameters:
groupSelection Pointer to the current selection. This button is selected when myID == *groupSelection


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::GuiRadioButton::onEvent ( const GEvent event  )  [protected, virtual]

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

Reimplemented from G3D::GuiControl.

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

virtual void G3D::GuiRadioButton::render ( RenderDevice rd,
const GuiSkinRef skin 
) const [protected, virtual]

Implements G3D::GuiControl.

bool G3D::GuiRadioButton::selected (  )  const [protected]

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::GuiRadioButton::setRect ( const Rect2D rect  )  [virtual]

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 from G3D::GuiControl.

void G3D::GuiRadioButton::setSelected (  )  [protected]

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.

int G3D::GuiRadioButton::m_myID [protected]

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