Inherits GuiButtonBaseCtrl, and GuiButtonBaseCtrl.

Inherited by GuiRadioCtrl, and GuiRadioCtrl.

Methods
void	setStateOn (state)

void	setStateOn (state)

Methods inherited from GuiButtonBaseCtrl
bool	getStateOn (bool getStateOn)

bool	getStateOn (bool getStateOn)

string	getText ()

string	getText ()

void	performClick ()

void	performClick ()

void	setStateOn (bool isStateOn)

void	setStateOn (bool isStateOn)

void	setText (string text)

void	setText (string text)

void	setTextID (string id)

void	setTextID (string id)

Methods inherited from GuiControl
void	addGuiControl (int controlId)

void	addGuiControl (int controlId)

int	findHitControl (int x, int y)

int	findHitControl (int x, int y)

string	getCenter ()

string	getCenter ()

string	getExtent ()

string	getExtent ()

string	getGlobalCenter ()

string	getGlobalCenter ()

string	getGlobalPosition ()

string	getGlobalPosition ()

string	getMinExtent ()

string	getMinExtent ()

int	getParent ()

int	getParent ()

string	getPosition ()

string	getPosition ()

string	getValue ()

string	getValue ()

bool	isActive ()

bool	isActive ()

bool	isAwake ()

bool	isAwake ()

bool	isVisible ()

bool	isVisible ()

void	makeFirstResponder (isFirst)

void	makeFirstResponder (isFirst)

bool	pointInControl (int x, int y)

bool	pointInControl (int x, int y)

void	reorderChild (child1, child2)

void	reorderChild (child1, child2)

void	resize (int x, int y, int w, int h)

void	resize (int x, int y, int w, int h)

void	setActive (isActive)

void	setActive (isActive)

void	setCanSave (bool canSave)

void	setCanSave (bool canSave)

void	setCenter (int x, int y)

void	setCenter (int x, int y)

void	setExtent (int width, int height)

void	setExtent (int width, int height)

void	setFirstResponder ()

void	setFirstResponder ()

void	setPosition (int x, int y)

void	setPosition (int x, int y)

void	setPositionGlobal (int x, int y)

void	setPositionGlobal (int x, int y)

void	setProfile (GuiControlProfile p)

void	setProfile (GuiControlProfile p)

void	setValue (value)

void	setValue (value)

void	setVisible (isVisible)

void	setVisible (isVisible)

Fields
bool	useInactiveState

SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Gui Editing
bool	isContainer

GuiControl
GuiProfile	Profile

enumval	HorizSizing

enumval	VertSizing

Point2I	Position

Point2I	Extent

Point2I	MinExtent

bool	canSave

bool	Visible

deprecated	Modal

deprecated	setFirstResponder

string	Variable

string	Command

string	AltCommand

string	Accelerator

bool	Active

ToolTip
GuiProfile	tooltipprofile

string	ToolTip

int	tooltipWidth

int	hovertime

Localization
string	langTableMod

GuiButtonBaseCtrl
caseString	text

string	textID

int	groupNum

enumval	buttonType

bool	useMouseEvents

Fields inherited from GuiButtonBaseCtrl
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

bool	isContainer

GuiProfile	Profile

enumval	HorizSizing

enumval	VertSizing

Point2I	Position

Point2I	Extent

Point2I	MinExtent

bool	canSave

bool	Visible

deprecated	Modal

deprecated	setFirstResponder

string	Variable

string	Command

string	AltCommand

string	Accelerator

bool	Active

GuiProfile	tooltipprofile

string	ToolTip

int	tooltipWidth

int	hovertime

string	langTableMod

caseString	text

string	textID

int	groupNum

enumval	buttonType

bool	useMouseEvents

Fields inherited from GuiControl
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

bool	isContainer

GuiProfile	Profile

enumval	HorizSizing

enumval	VertSizing

Point2I	Position

Point2I	Extent

Point2I	MinExtent

bool	canSave

bool	Visible

deprecated	Modal

deprecated	setFirstResponder

string	Variable

string	Command

string	AltCommand

string	Accelerator

bool	Active

GuiProfile	tooltipprofile

string	ToolTip

int	tooltipWidth

int	hovertime

string	langTableMod

Fields inherited from SimGroup
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Fields inherited from SimSet
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

void GuiCheckBoxCtrl::setStateOn ( state )

Sets the control as active and updates siblings of the same group.

Parameters

state This argument may be a boolean value or an integer.state < 0: Parent::setStateOn(false), obj::setActive(false) state == 0 (or false): Parent::setStateOn(false), obj::setActive(true) state > 0 (or true): Parent::setStateOn(true), obj::setActive(true)

void GuiCheckBoxCtrl::setStateOn ( state )

Sets the control as active and updates siblings of the same group.

Parameters

state This argument may be a boolean value or an integer.state < 0: Parent::setStateOn(false), obj::setActive(false) state == 0 (or false): Parent::setStateOn(false), obj::setActive(true) state > 0 (or true): Parent::setStateOn(true), obj::setActive(true)

Member Data Documentation

string GuiCheckBoxCtrl::Accelerator

bool GuiCheckBoxCtrl::Active

string GuiCheckBoxCtrl::AltCommand

enumval GuiCheckBoxCtrl::buttonType

bool GuiCheckBoxCtrl::canSave

bool GuiCheckBoxCtrl::canSaveDynamicFields

string GuiCheckBoxCtrl::class

Script SuperClass of object.

string GuiCheckBoxCtrl::Command

Point2I GuiCheckBoxCtrl::Extent

int GuiCheckBoxCtrl::groupNum

enumval GuiCheckBoxCtrl::HorizSizing

int GuiCheckBoxCtrl::hovertime

string GuiCheckBoxCtrl::internalName

bool GuiCheckBoxCtrl::isContainer

string GuiCheckBoxCtrl::langTableMod

Point2I GuiCheckBoxCtrl::MinExtent

deprecated GuiCheckBoxCtrl::Modal

SimObjectPtr GuiCheckBoxCtrl::parentGroup

Group hierarchy parent of the object.

Point2I GuiCheckBoxCtrl::Position

GuiProfile GuiCheckBoxCtrl::Profile

deprecated GuiCheckBoxCtrl::setFirstResponder

string GuiCheckBoxCtrl::superclass

Script Class of object.

caseString GuiCheckBoxCtrl::text

string GuiCheckBoxCtrl::textID

string GuiCheckBoxCtrl::ToolTip

GuiProfile GuiCheckBoxCtrl::tooltipprofile

int GuiCheckBoxCtrl::tooltipWidth

bool GuiCheckBoxCtrl::useInactiveState

bool GuiCheckBoxCtrl::useMouseEvents

string GuiCheckBoxCtrl::Variable

enumval GuiCheckBoxCtrl::VertSizing

bool GuiCheckBoxCtrl::Visible