G3D::GuiCheckBox Class ReferenceCheck box or toggle button.
More...
#include <GuiCheckBox.h>
Inherits G3D::GuiControl.
List of all members.
|
Public Types |
| enum | Style { BOX_STYLE,
BUTTON_STYLE,
TOOL_STYLE
} |
Public Member Functions |
| const GuiCaption & | caption () 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 Rect2D & | rect () 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 () |
| | GuiCheckBox (GuiWindow *gui, GuiPane *parent, const GuiCaption &text, const Pointer< bool > &value, Style style=BOX_STYLE) |
| virtual bool | onEvent (const GEvent &event) |
| virtual void | render (RenderDevice *rd, const GuiSkinRef &skin) const |
Protected Attributes |
| GuiCaption | m_caption |
| Rect2D | m_clickRect |
| bool | m_enabled |
| GuiWindow * | m_gui |
| GuiPane * | m_parent |
| Rect2D | m_rect |
| Style | m_style |
| Pointer< bool > | m_value |
| bool | m_visible |
Friends |
| class | GuiPane |
| class | GuiWindow |
Detailed Description
Check box or toggle button.
Member Enumeration Documentation
Box is the normal checkbox appearance.
Button makes them appear as a normal button, Tool as a tool button. - Enumerator:
-
| BOX_STYLE |
|
| BUTTON_STYLE |
|
| TOOL_STYLE |
|
Constructor & Destructor Documentation
Member Function Documentation
| const GuiCaption& G3D::GuiControl::caption |
( |
|
) |
const [inherited] |
| bool G3D::GuiControl::enabled |
( |
|
) |
const [inherited] |
| void G3D::GuiControl::fireActionEvent |
( |
|
) |
[protected, inherited] |
| 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::GuiCheckBox::onEvent |
( |
const GEvent & |
event |
) |
[protected, virtual] |
Delivers events when this control is clicked on and when it has the key focus.
Reimplemented from G3D::GuiControl.
| const Rect2D& G3D::GuiControl::rect |
( |
|
) |
const [inherited] |
| virtual void G3D::GuiCheckBox::render |
( |
RenderDevice * |
rd, |
|
|
const GuiSkinRef & |
skin | |
|
) |
| | const [protected, virtual] |
| 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::GuiCheckBox::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::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
Member Data Documentation
Rect bounds used for mouse actions.
Updated by setRect.
The window that ultimately contains this control.
Rect bounds used for rendering and layout.
Relative to the enclosing pane's clientRect.
The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:46 2007 for G3D by
1.5.2
Hosted by
|