Inherits SimGroup, and SimGroup.

Inherited by GuiArrayCtrl, GuiArrayCtrl, GuiBackgroundCtrl, GuiBackgroundCtrl, GuiBitmapBorderCtrl, GuiBitmapBorderCtrl, GuiBitmapCtrl, GuiBitmapCtrl, GuiButtonBaseCtrl, GuiButtonBaseCtrl, GuiCanvas, GuiCanvas, GuiColorPickerCtrl, GuiColorPickerCtrl, GuiConsoleTextCtrl, GuiConsoleTextCtrl, GuiControlArrayControl, GuiControlArrayControl, GuiDragAndDropControl, GuiDragAndDropControl, GuiDynamicCtrlArrayControl, GuiDynamicCtrlArrayControl, GuiEditCtrl, GuiEditCtrl, GuiEditorRuler, GuiEditorRuler, GuiFilterCtrl, GuiFilterCtrl, GuiFormCtrl, GuiFormCtrl, GuiFrameSetCtrl, GuiFrameSetCtrl, GuiGraphCtrl, GuiGraphCtrl, GuiInputCtrl, GuiInputCtrl, GuiInspectorField, GuiInspectorField, GuiListBoxCtrl, GuiListBoxCtrl, GuiMessageVectorCtrl, GuiMessageVectorCtrl, GuiMLTextCtrl, GuiMLTextCtrl, GuiMouseEventCtrl, GuiMouseEventCtrl, GuiPaneControl, GuiPaneControl, GuiRolloutCtrl, GuiRolloutCtrl, GuiScriptNotifyCtrl, GuiScriptNotifyCtrl, GuiScrollCtrl, GuiScrollCtrl, GuiSeparatorCtrl, GuiSeparatorCtrl, GuiSliderCtrl, GuiSliderCtrl, GuiSpriteCtrl, GuiSpriteCtrl, GuiStackControl, GuiStackControl, GuiTabBookCtrl, GuiTabBookCtrl, GuiTextCtrl, GuiTextCtrl, GuiTickCtrl, GuiTickCtrl, SceneWindow, and SceneWindow.

Methods
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

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 GuiControl::addGuiControl ( int controlId )

Adds the gui control

Parameters

controlId integer ID of the control to add

Returns: No Return value

void GuiControl::addGuiControl ( int controlId )

Adds the gui control

Parameters

controlId integer ID of the control to add

Returns: No Return value

int GuiControl::findHitControl	(	int	x,
		int	y
	)

Searches for the control at the given point

Returns: Returns the Id of the control at the point

int GuiControl::findHitControl	(	int	x,
		int	y
	)

Searches for the control at the given point

Returns: Returns the Id of the control at the point

string GuiControl::getCenter ( )

Returns: Returns center of control, as space seperated ints

string GuiControl::getCenter ( )

Returns: Returns center of control, as space seperated ints

string GuiControl::getExtent ( )

Get the width and height of the control.

Returns: The height and width as a string with space-separated integers

string GuiControl::getExtent ( )

Get the width and height of the control.

Returns: The height and width as a string with space-separated integers

string GuiControl::getGlobalCenter ( )

Returns: Returns center of control, as space seperated ints

string GuiControl::getGlobalCenter ( )

Returns: Returns center of control, as space seperated ints

string GuiControl::getGlobalPosition ( )

Returns: Returns the control's position converted to global coordinates (position as space-separted integers)

string GuiControl::getGlobalPosition ( )

Returns: Returns the control's position converted to global coordinates (position as space-separted integers)

string GuiControl::getMinExtent ( )

Get the minimum allowed size of the control.

Returns: Returns the minimum extent as a string with space separated point values <width> <height>

string GuiControl::getMinExtent ( )

Get the minimum allowed size of the control.

Returns: Returns the minimum extent as a string with space separated point values <width> <height>

int GuiControl::getParent ( )

Returns: Returns the Id of the parent control

int GuiControl::getParent ( )

Returns: Returns the Id of the parent control

string GuiControl::getPosition ( )

Returns: A string set up as "<pos.x> <pos.y>"

string GuiControl::getPosition ( )

Returns: A string set up as "<pos.x> <pos.y>"

string GuiControl::getValue ( )

Use the getValue method to get the control-specific 'value' for this control.

Returns: Returns a control-specific specific value. Varies by control

string GuiControl::getValue ( )

Use the getValue method to get the control-specific 'value' for this control.

Returns: Returns a control-specific specific value. Varies by control

bool GuiControl::isActive ( )

Use the isActive method to determine if this control is active. An inactive control may visible, but will not accept inputs. It will also normally re-shade or re-skin itself to reflect its inactive state

Returns: Returns true if this control is active.

bool GuiControl::isActive ( )

Use the isActive method to determine if this control is active. An inactive control may visible, but will not accept inputs. It will also normally re-shade or re-skin itself to reflect its inactive state

Returns: Returns true if this control is active.

bool GuiControl::isAwake ( )

Use the isAwake method to determine if this control is awake.

Returns: Returns true if this control is awake and ready to display

bool GuiControl::isAwake ( )

Use the isAwake method to determine if this control is awake.

Returns: Returns true if this control is awake and ready to display

bool GuiControl::isVisible ( )

Use the isVisible method to determine if this control is visible. This can return true, even if the entire control covered by another. This merely means that the control will render if not covered

Returns: Returns true if the control is visible.

bool GuiControl::isVisible ( )

Use the isVisible method to determine if this control is visible. This can return true, even if the entire control covered by another. This merely means that the control will render if not covered

Returns: Returns true if the control is visible.

void GuiControl::makeFirstResponder ( isFirst )

Use the makeFirstResponder method to force this control to become the first responder.

Parameters

isFirst A boolean value. If true, then this control become first reponder and at captures inputs before all other controls, excluding dialogs above this control.

Returns: No return value

void GuiControl::makeFirstResponder ( isFirst )

Use the makeFirstResponder method to force this control to become the first responder.

Parameters

isFirst A boolean value. If true, then this control become first reponder and at captures inputs before all other controls, excluding dialogs above this control.

Returns: No return value

bool GuiControl::pointInControl	(	int	x,
		int	y
	)

Check if point id in the control

Parameters

x	Point x coordinate in parent coords
y	Point y coordinate in parent coords

Returns: Returns true if the point is in the control, false otherwise

bool GuiControl::pointInControl	(	int	x,
		int	y
	)

Check if point id in the control

Parameters

x	Point x coordinate in parent coords
y	Point y coordinate in parent coords

Returns: Returns true if the point is in the control, false otherwise

void GuiControl::reorderChild	(	child1	,
		child2
	)

uses simset reorder to push child 1 after child 2 - both must already be child controls of this control

void GuiControl::reorderChild	(	child1	,
		child2
	)

uses simset reorder to push child 1 after child 2 - both must already be child controls of this control

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

Resizes the control to the given dimensions

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

Resizes the control to the given dimensions

void GuiControl::setActive ( isActive )

Use the setActive method to (de)activate this control. Once active, a control can accept inputs. Controls automatically re-shade/skin themselves to reflect their active/inactive state.

Parameters

isActive A boolean value. f isActive is true, this control is activated, else it is set to inactive.

Returns: No return value

void GuiControl::setActive ( isActive )

Use the setActive method to (de)activate this control. Once active, a control can accept inputs. Controls automatically re-shade/skin themselves to reflect their active/inactive state.

Parameters

isActive A boolean value. f isActive is true, this control is activated, else it is set to inactive.

Returns: No return value

void GuiControl::setCanSave ( bool canSave )

Sets whether this control can serialize itself to the hard disk

Parameters

Flag setting

Returns: No Return Value

void GuiControl::setCanSave ( bool canSave )

Sets whether this control can serialize itself to the hard disk

Parameters

Flag setting

Returns: No Return Value

void GuiControl::setCenter	(	int	x,
		int	y
	)

Sets control position, by center - coords are local not global

Returns: No Return value.

void GuiControl::setCenter	(	int	x,
		int	y
	)

Sets control position, by center - coords are local not global

Returns: No Return value.

void GuiControl::setExtent	(	int	width,
		int	height
	)

Sets the width & height of the control.

Returns: No Return Value.

void GuiControl::setExtent	(	int	width,
		int	height
	)

Sets the width & height of the control.

Returns: No Return Value.

void GuiControl::setFirstResponder ( )

Sets this control as the first responder

void GuiControl::setFirstResponder ( )

Sets this control as the first responder

void GuiControl::setPosition	(	int	x,
		int	y
	)

Sets the current control position in local space

Returns: No Return Value.

void GuiControl::setPosition	(	int	x,
		int	y
	)

Sets the current control position in local space

Returns: No Return Value.

void GuiControl::setPositionGlobal	(	int	x,
		int	y
	)

Sets the control's position in global space

Returns: No return value

void GuiControl::setPositionGlobal	(	int	x,
		int	y
	)

Sets the control's position in global space

Returns: No return value

void GuiControl::setProfile ( GuiControlProfile p )

Sets the currently used from for the GuiControl

Parameters

p	The profile you wish to set the control to use

Returns: No return value

void GuiControl::setProfile ( GuiControlProfile p )

Sets the currently used from for the GuiControl

Parameters

p	The profile you wish to set the control to use

Returns: No return value

void GuiControl::setValue ( value )

Use the setValue method to set the control specific value to value. Purpose and type varies by control type.

Parameters

value Some control specific value.

Returns: No return value

void GuiControl::setValue ( value )

Use the setValue method to set the control specific value to value. Purpose and type varies by control type.

Parameters

value Some control specific value.

Returns: No return value

void GuiControl::setVisible ( isVisible )

Use the setVisible method to (un)hide this control.

Parameters

isVisible A boolean value. If true, the control will be made visible, otherwise the control will be hidden.

Returns: No return value

void GuiControl::setVisible ( isVisible )

Use the setVisible method to (un)hide this control.

Parameters

isVisible A boolean value. If true, the control will be made visible, otherwise the control will be hidden.

Returns: No return value

Member Data Documentation

string GuiControl::Accelerator

bool GuiControl::Active

string GuiControl::AltCommand

bool GuiControl::canSave

bool GuiControl::canSaveDynamicFields

string GuiControl::class

Script SuperClass of object.

string GuiControl::Command

Point2I GuiControl::Extent

enumval GuiControl::HorizSizing

int GuiControl::hovertime

string GuiControl::internalName

bool GuiControl::isContainer

string GuiControl::langTableMod

Point2I GuiControl::MinExtent

deprecated GuiControl::Modal

SimObjectPtr GuiControl::parentGroup

Group hierarchy parent of the object.

Point2I GuiControl::Position

GuiProfile GuiControl::Profile

deprecated GuiControl::setFirstResponder

string GuiControl::superclass

Script Class of object.

string GuiControl::ToolTip

GuiProfile GuiControl::tooltipprofile

int GuiControl::tooltipWidth

string GuiControl::Variable

enumval GuiControl::VertSizing

bool GuiControl::Visible