GuiGridCtrl Class Reference

#include <guiGridCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions
String	getCellModeX ()
String	getCellModeY ()
String	getCellSize ()
String	getCellSpacing ()
Boolean	getIsExtentDynamic ()
Integer	getMaxColCount ()
Integer	getMaxRowCount ()
String	getOrderMode ()
void	setCellModeX (cellMode mode)
void	setCellModeY (cellMode mode)
void	setCellSize (float width, float height)
void	setCellSpacing (float x, float y)
void	setMaxColCount (int max)
void	setMaxRowCount (int max)
Public Member Functions inherited from GuiControl
void	addGuiControl (int controlId)
Integer	findHitControl (int x, int y)
String	getCenter ()
String	getExtent (...)
String	getGlobalCenter ()
String	getGlobalPosition ()
String	getMinExtent ()
Integer	getParent ()
String	getPosition ()
String	getText ()
Boolean	getTextExtend ()
Boolean	getTextWrap ()
String	getValue ()
Boolean	isActive ()
Boolean	isAwake ()
Boolean	isVisible ()
void	makeFirstResponder (isFirst)
void	performClick ()
Boolean	pointInControl (int x, int y)
void	reorderChild (child1, child2)
void	resize (int x, int y, int w, int h)
void	setActive (isActive)
void	setCanSave (bool canSave)
void	setCenter (int x, int y)
void	setExtent (int width, int height)
void	setFirstResponder ()
void	setPosition (int x, int y)
void	setPositionGlobal (int x, int y)
void	setProfile (GuiControlProfile p)
void	setText (text)
void	setTextExtend (setting)
void	setTextID (id)
void	setTextWrap (setting)
void	setValue (value)
void	setVisible (isVisible)

Member Function Documentation

getCellModeX()

String getCellModeX

(

)

Gets the horizontal cell mode.

Returns

The horizontal cell mode.

getCellModeY()

String getCellModeY

(

)

Gets the vertical cell mode.

Returns

The vertical cell mode.

getCellSize()

String getCellSize

(

)

Gets the size assigned to child controls. Results should be interpreted based on CellMode.

Returns

(float width/float height) The width and height of the cells.

getCellSpacing()

String getCellSpacing

(

)

Gets the spacing that will be between each child control. Results should be interpreted based on CellMode.

Returns

(float x/float y) The horizontal and vertical spacing between the cells.

getIsExtentDynamic()

Boolean getIsExtentDynamic

(

)

Gets if the extent will change based on the size of the contents. Expansion will happen in the direction of the final letter of the order mode.

Returns

The dynamic extent.

getMaxColCount()

Integer getMaxColCount

(

)

Gets the max column count.

Returns

The max column count.

getMaxRowCount()

Integer getMaxRowCount

(

)

Gets the max row count.

Returns

The max row count.

getOrderMode()

String getOrderMode

(

)

Gets the order mode.

Returns

The order mode.

setCellModeX()

void setCellModeX

(

cellMode

mode

)

Sets the cell mode in the horizontal direction.

Returns

No return value.

setCellModeY()

void setCellModeY

(

cellMode

mode

)

Sets the cell mode in the vertical direction.

Returns

No return value.

setCellSize()

void setCellSize	(	float	width,
		float	height
	)

Sets the size assigned to each child control.

Parameters

width	The width of the child.
height	The height of the child.

Returns

No return value.

setCellSpacing()

void setCellSpacing	(	float	x,
		float	y
	)

Sets the spacing used between each child control. Note that if child controls use margin, there will appear to be additional spacing.

Parameters

x	The horizontal spacing.
y	The vertical spacing.

Returns

No return value.

setMaxColCount()

void setMaxColCount

(

int

max

)

Sets the max number of columns. This will be ignored by Order Modes that end in L or R.

Parameters

max	The max number of columns. Use zero for auto.

Returns

No return value.

setMaxRowCount()

void setMaxRowCount

(

int

max

)

Sets the max number of rows. This will be ignored by Order Modes that end in T or B.

Parameters

max	The max number of rows. Use zero for auto.

Returns

No return value.