Torque Game Engine Documentation
TGE Version 1.5.2

GuiCheckBoxCtrl Class Reference

#include <guiCheckBoxCtrl.h>

Inheritance diagram for GuiCheckBoxCtrl:


Public Member Functions
	DECLARE_CONOBJECT (GuiCheckBoxCtrl)
	GuiCheckBoxCtrl ()
void	setStateOn (S32 state)
virtual const char *	getScriptValue ()
	Returns the value of the variable bound to this object.
virtual void	onMouseDown (const GuiEvent &event)
virtual void	onMouseUp (const GuiEvent &event)
virtual void	onAction ()
	Occurs when this control performs its "action".
void	onRender (Point2I offset, const RectI &updateRect)
	Called when this control is to render itself.
bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
S32	mIndent
Private Types
typedef GuiButtonBaseCtrl	Parent
Private Attributes
bool	mUseInactiveState

Member Typedef Documentation

Reimplemented from GuiButtonBaseCtrl.

Reimplemented in GuiRadioCtrl.

GuiCheckBoxCtrl::GuiCheckBoxCtrl ( )

GuiCheckBoxCtrl::DECLARE_CONOBJECT ( GuiCheckBoxCtrl )

void GuiCheckBoxCtrl::setStateOn ( S32 state )

virtual const char* GuiCheckBoxCtrl::getScriptValue ( ) [virtual]

Returns the value of the variable bound to this object.

Reimplemented from GuiButtonBaseCtrl.

virtual void GuiCheckBoxCtrl::onMouseDown ( const GuiEvent & event ) [virtual]

Reimplemented from GuiButtonBaseCtrl.

virtual void GuiCheckBoxCtrl::onMouseUp ( const GuiEvent & event ) [virtual]

Reimplemented from GuiButtonBaseCtrl.

virtual void GuiCheckBoxCtrl::onAction ( ) [virtual]

Occurs when this control performs its "action".

Reimplemented from GuiButtonBaseCtrl.

void GuiCheckBoxCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

bool GuiCheckBoxCtrl::onWake ( ) [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiButtonBaseCtrl.

static void GuiCheckBoxCtrl::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiButtonBaseCtrl.