GuiFrameSetCtrl Class Reference

Inherits GuiControl, and GuiControl.

Methods
void	addColumn ()
void	addColumn ()
void	addRow ()
void	addRow ()
void	frameBorder (index[, enable=true])
void	frameBorder (index[, enable=true])
void	frameMinExtent (index, w, h)
void	frameMinExtent (index, w, h)
void	frameMovable (index[, enable=true])
void	frameMovable (index[, enable=true])
int	getColumnCount ()
int	getColumnCount ()
int	getColumnOffset (column)
int	getColumnOffset (column)
int	getRowCount ()
int	getRowCount ()
int	getRowOffset (row)
int	getRowOffset (row)
void	removeColumn ()
void	removeColumn ()
void	removeRow ()
void	removeRow ()
void	setColumnOffset (column, offset)
void	setColumnOffset (column, offset)
void	setRowOffset (row, offset)
void	setRowOffset (row, offset)
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	autoBalance
ColorI	borderColor
enumval	borderEnable
enumval	borderMovable
int	borderWidth
intList	columns
int	fudgeFactor
intList	rows
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 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 GuiFrameSetCtrl::addColumn

(

)

Use the addColumn method to add another column to the control. The current contents of the GUIFrameCtrl may shift to fill the new column. New columns are added on the right of the control.

Returns

No return value.

See Also

addRow, removeColumn, removeRow

void GuiFrameSetCtrl::addColumn

(

)

Use the addColumn method to add another column to the control. The current contents of the GUIFrameCtrl may shift to fill the new column. New columns are added on the right of the control.

Returns

No return value.

See Also

addRow, removeColumn, removeRow

void GuiFrameSetCtrl::addRow

(

)

Use the addRow method to add another row to the control. The current contents of the GUIFrameCtrl may shift to fill the new row. New rows are added on the bottom of the control.

Returns

No return value.

See Also

addColumn, removeColumn, removeRow

void GuiFrameSetCtrl::addRow

(

)

Use the addRow method to add another row to the control. The current contents of the GUIFrameCtrl may shift to fill the new row. New rows are added on the bottom of the control.

Returns

No return value.

See Also

addColumn, removeColumn, removeRow

void GuiFrameSetCtrl::frameBorder

(

index

[, enable=true]

)

Use the frameBorder method to change the frame's enable state. This function is not working as of this writing

Parameters

index

Frame index to enable/disable/enable - Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.

Returns

No return value.

void GuiFrameSetCtrl::frameBorder

(

index

[, enable=true]

)

Use the frameBorder method to change the frame's enable state. This function is not working as of this writing

Parameters

index

Frame index to enable/disable/enable - Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.

Returns

No return value.

void GuiFrameSetCtrl::frameMinExtent	(	index	,
		w	,
		h
	)

Use the frameMinExtent method to set the minimum extent allowed for a frame. These minimum extents do not prevent a parent control from collapsing the frame control and its frames. These limits apply to dragging and resizing as is done with the frames' draggable borders

Parameters

index	The frame number.
w	Minimum width in pixels.
h	Minimum height in pixels.

Returns

No return value.

void GuiFrameSetCtrl::frameMinExtent	(	index	,
		w	,
		h
	)

Use the frameMinExtent method to set the minimum extent allowed for a frame. These minimum extents do not prevent a parent control from collapsing the frame control and its frames. These limits apply to dragging and resizing as is done with the frames' draggable borders

Parameters

index	The frame number.
w	Minimum width in pixels.
h	Minimum height in pixels.

Returns

No return value.

void GuiFrameSetCtrl::frameMovable

(

index

[, enable=true]

)

Use the frameMovable method to change the frame's draggable state. This function is not working as of this writing

Parameters

index

Frame index to enable/disable/enable - Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.

Returns

No return value.

void GuiFrameSetCtrl::frameMovable

(

index

[, enable=true]

)

Use the frameMovable method to change the frame's draggable state. This function is not working as of this writing

Parameters

index

Frame index to enable/disable/enable - Currently a boolean, but should actually be a string: alwaysOn, alwaysOff, dynamic.

Returns

No return value.

int GuiFrameSetCtrl::getColumnCount

(

)

Use the getColumnCount method to determine the number of columns in this control.

Returns

Returns an integer value equal to the number of columns in this frame.

See Also

getRowCount

int GuiFrameSetCtrl::getColumnCount

(

)

Use the getColumnCount method to determine the number of columns in this control.

Returns

Returns an integer value equal to the number of columns in this frame.

See Also

getRowCount

int GuiFrameSetCtrl::getColumnOffset

(

column

)

Use the getColumnOffset method to determine the current pixel location of the specified column. Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc.

Parameters

column

An integer value specifying the column to examine.

Returns

Returns the pixel offset for the specified column.

See Also

getRowOffset, setColumnOffset, setRowOffset

int GuiFrameSetCtrl::getColumnOffset

(

column

)

Use the getColumnOffset method to determine the current pixel location of the specified column. Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc.

Parameters

column

An integer value specifying the column to examine.

Returns

Returns the pixel offset for the specified column.

See Also

getRowOffset, setColumnOffset, setRowOffset

int GuiFrameSetCtrl::getRowCount

(

)

Use the getRowCount method to determine the number of rows in this control.

Returns

Returns an integer value equal to the number of rows in this frame.

See Also

getColumnCount

int GuiFrameSetCtrl::getRowCount

(

)

Use the getRowCount method to determine the number of rows in this control.

Returns

Returns an integer value equal to the number of rows in this frame.

See Also

getColumnCount

int GuiFrameSetCtrl::getRowOffset

(

row

)

Use the getRowOffset method to determine the current pixel location of the specified row. Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc.

Parameters

row	An integer value specifying the row to examine.

Returns

Returns the pixel offset for the specified row.

See Also

getColumnOffset, setColumnOffset, setRowOffset

int GuiFrameSetCtrl::getRowOffset

(

row

)

Use the getRowOffset method to determine the current pixel location of the specified row. Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc.

Parameters

row	An integer value specifying the row to examine.

Returns

Returns the pixel offset for the specified row.

See Also

getColumnOffset, setColumnOffset, setRowOffset

void GuiFrameSetCtrl::removeColumn

(

)

Use the removeColumn method to remove a column from the right side of the control. Columns are removed right to left.

Returns

No return value.

See Also

addColumn, addRow, removeRow

void GuiFrameSetCtrl::removeColumn

(

)

Use the removeColumn method to remove a column from the right side of the control. Columns are removed right to left.

Returns

No return value.

See Also

addColumn, addRow, removeRow

void GuiFrameSetCtrl::removeRow

(

)

Use the removeRow method to remove the bottom row from the control. Rows are removed bottom to top.

Returns

No return value.

See Also

addColumn, addRow, removeColumn

void GuiFrameSetCtrl::removeRow

(

)

Use the removeRow method to remove the bottom row from the control. Rows are removed bottom to top.

Returns

No return value.

See Also

addColumn, addRow, removeColumn

void GuiFrameSetCtrl::setColumnOffset	(	column	,
		offset
	)

Use the setColumnOffset method to determine the current pixel location of the specified column. Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc. The left-most and right-most columns cannot be moved.

Parameters

column	An integer value specifying the column to examine.
offset	An integer value specifying the new column offset in pixels.

Returns

No return value.

See Also

getColumnOffset, getRowOffset, setRowOffset

void GuiFrameSetCtrl::setColumnOffset	(	column	,
		offset
	)

Use the setColumnOffset method to determine the current pixel location of the specified column. Column 0 is the first column on the left side of frame 0. Column 1 is on the right side of frame 0 and the left side of frame 1, etc. The left-most and right-most columns cannot be moved.

Parameters

column	An integer value specifying the column to examine.
offset	An integer value specifying the new column offset in pixels.

Returns

No return value.

See Also

getColumnOffset, getRowOffset, setRowOffset

void GuiFrameSetCtrl::setRowOffset	(	row	,
		offset
	)

Use the setRowOffset method to set the current pixel location of the specified row. Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc. The bottom-most and top-most rows cannot be moved.

Parameters

row	An integer value specifying the row to modify.
offset	An integer value specifying the new row offset in pixels.

Returns

No return value.

See Also

getColumnOffset, getRowOffset, setColumnOffset

void GuiFrameSetCtrl::setRowOffset	(	row	,
		offset
	)

Use the setRowOffset method to set the current pixel location of the specified row. Row 0 is the first row on the top of the first row of frames. Row 1 is below the first row of frames and above the second row of frames, etc. 1, etc. The bottom-most and top-most rows cannot be moved.

Parameters

row	An integer value specifying the row to modify.
offset	An integer value specifying the new row offset in pixels.

Returns

No return value.

See Also

getColumnOffset, getRowOffset, setColumnOffset

Member Data Documentation

string GuiFrameSetCtrl::Accelerator

bool GuiFrameSetCtrl::Active

string GuiFrameSetCtrl::AltCommand

bool GuiFrameSetCtrl::autoBalance

ColorI GuiFrameSetCtrl::borderColor

enumval GuiFrameSetCtrl::borderEnable

enumval GuiFrameSetCtrl::borderMovable

int GuiFrameSetCtrl::borderWidth

bool GuiFrameSetCtrl::canSave

bool GuiFrameSetCtrl::canSaveDynamicFields

string GuiFrameSetCtrl::class

Script SuperClass of object.

intList GuiFrameSetCtrl::columns

string GuiFrameSetCtrl::Command

Point2I GuiFrameSetCtrl::Extent

int GuiFrameSetCtrl::fudgeFactor

enumval GuiFrameSetCtrl::HorizSizing

int GuiFrameSetCtrl::hovertime

string GuiFrameSetCtrl::internalName

bool GuiFrameSetCtrl::isContainer

string GuiFrameSetCtrl::langTableMod

Point2I GuiFrameSetCtrl::MinExtent

deprecated GuiFrameSetCtrl::Modal

SimObjectPtr GuiFrameSetCtrl::parentGroup

Group hierarchy parent of the object.

Point2I GuiFrameSetCtrl::Position

GuiProfile GuiFrameSetCtrl::Profile

intList GuiFrameSetCtrl::rows

deprecated GuiFrameSetCtrl::setFirstResponder

string GuiFrameSetCtrl::superclass

Script Class of object.

string GuiFrameSetCtrl::ToolTip

GuiProfile GuiFrameSetCtrl::tooltipprofile

int GuiFrameSetCtrl::tooltipWidth

string GuiFrameSetCtrl::Variable

enumval GuiFrameSetCtrl::VertSizing

bool GuiFrameSetCtrl::Visible