Inherits GuiControl, and GuiControl.

Inherited by GuiBorderButtonCtrl, GuiBorderButtonCtrl, GuiButtonCtrl, GuiButtonCtrl, GuiCheckBoxCtrl, and GuiCheckBoxCtrl.

Methods
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
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 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

bool GuiButtonBaseCtrl::getStateOn ( bool getStateOn )

gets whether the state of the button is currently 'on'

bool GuiButtonBaseCtrl::getStateOn ( bool getStateOn )

gets whether the state of the button is currently 'on'

string GuiButtonBaseCtrl::getText ( )

returns the text of the button.
Returns
The text member of the button as a char string

string GuiButtonBaseCtrl::getText ( )

returns the text of the button.
Returns
The text member of the button as a char string

void GuiButtonBaseCtrl::performClick ( )

simulates a button click from script.

void GuiButtonBaseCtrl::performClick ( )

simulates a button click from script.

void GuiButtonBaseCtrl::setStateOn ( bool isStateOn )

sets the state on member and updates siblings of the same group.

void GuiButtonBaseCtrl::setStateOn ( bool isStateOn )

sets the state on member and updates siblings of the same group.

void GuiButtonBaseCtrl::setText ( string text )

Sets the text of the button to the string.

void GuiButtonBaseCtrl::setText ( string text )

Sets the text of the button to the string.

void GuiButtonBaseCtrl::setTextID ( string id )

Sets the text of the button to the localized string.

void GuiButtonBaseCtrl::setTextID ( string id )

Sets the text of the button to the localized string.

Member Data Documentation

string GuiButtonBaseCtrl::Accelerator

bool GuiButtonBaseCtrl::Active

string GuiButtonBaseCtrl::AltCommand

enumval GuiButtonBaseCtrl::buttonType

bool GuiButtonBaseCtrl::canSave

bool GuiButtonBaseCtrl::canSaveDynamicFields

string GuiButtonBaseCtrl::class

Script SuperClass of object.

string GuiButtonBaseCtrl::Command

Point2I GuiButtonBaseCtrl::Extent

int GuiButtonBaseCtrl::groupNum

enumval GuiButtonBaseCtrl::HorizSizing

int GuiButtonBaseCtrl::hovertime

string GuiButtonBaseCtrl::internalName

bool GuiButtonBaseCtrl::isContainer

string GuiButtonBaseCtrl::langTableMod

Point2I GuiButtonBaseCtrl::MinExtent

deprecated GuiButtonBaseCtrl::Modal

SimObjectPtr GuiButtonBaseCtrl::parentGroup

Group hierarchy parent of the object.

Point2I GuiButtonBaseCtrl::Position

GuiProfile GuiButtonBaseCtrl::Profile

deprecated GuiButtonBaseCtrl::setFirstResponder

string GuiButtonBaseCtrl::superclass

Script Class of object.

caseString GuiButtonBaseCtrl::text

string GuiButtonBaseCtrl::textID

string GuiButtonBaseCtrl::ToolTip

GuiProfile GuiButtonBaseCtrl::tooltipprofile

int GuiButtonBaseCtrl::tooltipWidth

bool GuiButtonBaseCtrl::useMouseEvents

string GuiButtonBaseCtrl::Variable

enumval GuiButtonBaseCtrl::VertSizing

bool GuiButtonBaseCtrl::Visible