GuiTreeViewCtrl Class Reference

#include <guiTreeViewCtrl_ScriptBinding.h>

Inherits GuiListBoxCtrl.

Inherited by GuiEditorExplorerTree.

Public Member Functions
Integer	getItemIcon (S32 index)"
Boolean	getItemOpen (int index)"
Integer	getItemParent (int index)"
void	inspect (SimGroup obj)
void	refresh ()
void	refreshItem (S32 index)"
void	refreshItemText (S32 index)"
void	setItemOpen (int index, bool isOpen)"
void	uninspect ()
Public Member Functions inherited from GuiListBoxCtrl
void	addItem (string text, [color red/green/blue/[alpha]])"
void	clearItems ()"
void	clearSelection ()"
Integer	findItemID (int ID)"
Integer	findItemText (string itemText, bool caseSensitive)"
Boolean	getItemActive (int index)"
Integer	getItemCount ()"
Integer	getItemID (int index)"
void	getMultiSelection ()"
Integer	getSelCount ()"
Integer	getSelectedItem ()"
String	getSelectedItems ()"
void	setCurSel (S32 index)"
void	setCurSelRange (S32 start, [S32 stop])"
void	setItemActive (int index)"
void	setItemID (int index, int ID)"
void	setItemInactive (int index)"
void	setMultiSelection (bool allowMultiSelection)"
void	setSelected (int index, [bool isSelected])"
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

getItemIcon()

Integer getItemIcon

(

S32

index

)

Gets the icon frame the given item is wearing, or -1 if it has none.

Parameters

index

The zero-based index of the item.

Returns

The frame index into the tree's IconImage sheet.

getItemOpen()

Boolean getItemOpen

(

int

index

)

Returns if an item is open or not using an index.

Parameters

index

The zero-based index of the item.

Returns

True if the item is open and false otherwise.

getItemParent()

Integer getItemParent

(

int

index

)

Returns the index of the parent of the item.

Parameters

index

The zero-based index of the child item.

Returns

The index of the parent or -1 if the parent is the root.

inspect()

void inspect

(

SimGroup

obj

)

Sets the root object to view.

Parameters

obj	A SimGroup that will be viewed as a tree.

Returns

No return value.

refresh()

void refresh

(

)

Informs the tree that the contents of the tree have changed and should be refreshed but preserves selection if possible.

Returns

No return value.

refreshItem()

void refreshItem

(

S32

index

)

Refreshes both the text and the icon of the item based on the inspected object. A control's picture can change without the row moving - re-profiling a bare GuiControl from a panel to a label is still the same object in the same place - so prefer this over refreshItemText.

Parameters

index

The zero-based index of the item that will be updated.

Returns

No return value.

refreshItemText()

void refreshItemText

(

S32

index

)

Refreshes the text of the item based on the inspected object.

Parameters

index

The zero-based index of the item that will be updated.

Returns

No return value.

setItemOpen()

void setItemOpen	(	int	index,
		bool	isOpen )

Sets if an item is open by the index.

Parameters

index	The zero-based index of the item.
isOpen	True if the item should be open and false otherwise.

Returns

No return value.

uninspect()

void uninspect

(

)

Removes the root object.

Returns

No return value.