GuiFrameSetCtrl Class Reference

#include <guiFrameSetCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions
void	anchorFrame (int frameID)
String	createHorizontalSplit (int frameID)
String	createVerticalSplit (int frameID)
String	getFrameLayout ()
void	setFrameLayout (layout)
void	setFrameSize (int frameID, int size)
Public Member Functions inherited from GuiControl
void	addGuiControl (int controlId)
void	applySizing ()
Boolean	canBeChildOf (GuiControl parent)
void	childrenReordered ()
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	isGeometryEditable ()
Boolean	isVisible ()
void	makeFirstResponder (isFirst)
void	performClick ()
Boolean	pointInControl (int x, int y)
Boolean	pullIntoView ()
Boolean	rendersChildren ()
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

anchorFrame()

void anchorFrame

(

int

frameID

)

This anchors a frame and unachors it's twin. An anchored frame tries to stay the same size when its parent resizes. It can still be resized by the user.

Parameters

frameID

The frameID that should be anchored.

Returns

No return value.

createHorizontalSplit()

String createHorizontalSplit

(

int

frameID

)

Splits the frame with the frameID given into two frames with one on the left and one on the right. The existing control will move to the first frame.

Parameters

frameID

The frameID that should be split.

Returns

(int frameID1/int frameID2) The resulting two frameIDs seperated by a space.

createVerticalSplit()

String createVerticalSplit

(

int

frameID

)

Splits the frame with the frameID given into two frames with one on top and one on bottom. The existing control will move to the first frame.

Parameters

frameID

The frameID that should be split.

Returns

(int frameID1/int frameID2) The resulting two frameIDs seperated by a space.

getFrameLayout()

String getFrameLayout

(

)

Gets the frame tree as text: the splits, their sizes, and which control sits in each frame. Opaque - hand it back to setFrameLayout unchanged.

A frame set destroys a frame when the control in it is removed, so anything that needs to put a removed control back where it was - the Gui Editor's undo - has to keep the layout first.

Returns

The frame tree, as a string.

setFrameLayout()

void setFrameLayout

(

layout

)

Rebuilds the frame tree from text taken earlier by getFrameLayout, and lays the children out again.

A frame naming a control that is no longer a child of this frame set comes back empty, so a layout recorded before a delete can be restored before the control is.

Parameters

layout

A string from getFrameLayout.

Returns

No return value.

setFrameSize()

void setFrameSize	(	int	frameID,
		int	size )

Sets the width or height of a frame depending on if its parent is split horizontally or vertically.

Parameters

frameID	The frameID that should be set.
size	The size in pixels to set the width or height to.

Returns

No return value.