Inherits GuiArrayCtrl, and GuiArrayCtrl.

Methods
void	addChildSelectionByValue (TreeItemId parent, value)

void	addChildSelectionByValue (TreeItemId parent, value)

void	addSelection (string ID)

void	addSelection (string ID)

bool	buildIconTable (string icons)

bool	buildIconTable (string icons)

void	buildVisibleTree ()

void	buildVisibleTree ()

void	clear ()

void	clear ()

void	clearSelection ()

void	clearSelection ()

void	deleteSelection ()

void	deleteSelection ()

bool	editItem (TreeItemId item, string newText, string newValue)

bool	editItem (TreeItemId item, string newText, string newValue)

bool	expandItem (TreeItemId item,[bool expand=true])

bool	expandItem (TreeItemId item,[bool expand=true])

int	findItemByName (name)

int	findItemByName (name)

int	findItemByObjectId (find item by object id and returns the mId)

int	findItemByObjectId (find item by object id and returns the mId)

int	getChild (TreeItemId item)

int	getChild (TreeItemId item)

int	getFirstRootItem ()

int	getFirstRootItem ()

int	getItemCount ()

int	getItemCount ()

string	getItemText (TreeItemId item)

string	getItemText (TreeItemId item)

string	getItemValue (TreeItemId item)

string	getItemValue (TreeItemId item)

int	getNextSibling (TreeItemId item)

int	getNextSibling (TreeItemId item)

int	getParent (TreeItemId item)

int	getParent (TreeItemId item)

int	getPrevSibling (TreeItemId item)

int	getPrevSibling (TreeItemId item)

int	getSelectedItem ()

int	getSelectedItem ()

string	getSelectedItemList ()

string	getSelectedItemList ()

int	getSelectedItemsCount ()

int	getSelectedItemsCount ()

int	getSelectedObject ()

int	getSelectedObject ()

string	getTextToRoot (TreeItemId item, Delimiter=none)

string	getTextToRoot (TreeItemId item, Delimiter=none)

int	insertItem (TreeItemId parent, name, value, icon, normalImage=0, expandedImage=0)

int	insertItem (TreeItemId parent, name, value, icon, normalImage=0, expandedImage=0)

void	lockSelection ([bool lock])

void	lockSelection ([bool lock])

void	moveItemDown (TreeItemId item)

void	moveItemDown (TreeItemId item)

void	moveItemUp (TreeItemId item)

void	moveItemUp (TreeItemId item)

void	open (SimSet obj, bool okToEdit=true)

void	open (SimSet obj, bool okToEdit=true)

void	removeAllChildren (TreeItemId parent)

void	removeAllChildren (TreeItemId parent)

void	removeChildSelectionByValue (TreeItemId parent, value)

void	removeChildSelectionByValue (TreeItemId parent, value)

bool	removeItem (TreeItemId item)

bool	removeItem (TreeItemId item)

void	removeSelection (string ID)

void	removeSelection (string ID)

void	scrollVisible (TreeItemId item)

void	scrollVisible (TreeItemId item)

int	scrollVisibleByObjectId (show item by object id.returns true if sucessful.)

int	scrollVisibleByObjectId (show item by object id.returns true if sucessful.)

bool	selectItem (TreeItemId item,[bool select=true])

bool	selectItem (TreeItemId item,[bool select=true])

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

TreeView
int	tabSize

int	textOffset

bool	fullRowSelect

int	itemHeight

bool	destroyTreeOnSleep

bool	MouseDragging

bool	MultipleSelections

bool	DeleteObjectAllowed

bool	DragToItemAllowed

Fields inherited from GuiArrayCtrl
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 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 GuiTreeViewCtrl::addChildSelectionByValue	(	TreeItemId	parent,
		value
	)

void GuiTreeViewCtrl::addChildSelectionByValue	(	TreeItemId	parent,
		value
	)

void GuiTreeViewCtrl::addSelection ( string ID )

Select an item

Parameters

ID	The ID of the item to select.

Returns: No return value.

void GuiTreeViewCtrl::addSelection ( string ID )

Select an item

Parameters

ID	The ID of the item to select.

Returns: No return value.

bool GuiTreeViewCtrl::buildIconTable ( string icons )

Icons should be designated by the bitmap/png file names (minus the file extensions) and separated by colons (:). This list should be synchronized with the Icons enum.

Parameters

icons The list of icons to add sepated by colons.

Returns: Returns true on success, false otherwise.

bool GuiTreeViewCtrl::buildIconTable ( string icons )

Icons should be designated by the bitmap/png file names (minus the file extensions) and separated by colons (:). This list should be synchronized with the Icons enum.

Parameters

icons The list of icons to add sepated by colons.

Returns: Returns true on success, false otherwise.

void GuiTreeViewCtrl::buildVisibleTree ( )

Build the visible tree

void GuiTreeViewCtrl::buildVisibleTree ( )

Build the visible tree

void GuiTreeViewCtrl::clear ( )

empty tree

void GuiTreeViewCtrl::clear ( )

empty tree

void GuiTreeViewCtrl::clearSelection ( )

Clear selection

Returns: No return value.

void GuiTreeViewCtrl::clearSelection ( )

Clear selection

Returns: No return value.

void GuiTreeViewCtrl::deleteSelection ( )

Delete all selected items.

Returns: No return value.

void GuiTreeViewCtrl::deleteSelection ( )

Delete all selected items.

Returns: No return value.

bool GuiTreeViewCtrl::editItem	(	TreeItemId	item,
		string	newText,
		string	newValue
	)

bool GuiTreeViewCtrl::editItem	(	TreeItemId	item,
		string	newText,
		string	newValue
	)

bool GuiTreeViewCtrl::expandItem ( TreeItemId item )

Deselects item

bool GuiTreeViewCtrl::expandItem ( TreeItemId item )

Deselects item

int GuiTreeViewCtrl::findItemByName ( name )

Find item by name

Parameters

name	The name of the desired object.

Returns: Returns the ID of the object, or -1 on failure (not found).

int GuiTreeViewCtrl::findItemByName ( name )

Find item by name

Parameters

name	The name of the desired object.

Returns: Returns the ID of the object, or -1 on failure (not found).

int GuiTreeViewCtrl::findItemByObjectId ( find item by object id and returns the mId )

int GuiTreeViewCtrl::getChild ( TreeItemId item )

int GuiTreeViewCtrl::getFirstRootItem ( )

Get id for root item.

int GuiTreeViewCtrl::getFirstRootItem ( )

Get id for root item.

int GuiTreeViewCtrl::getItemCount ( )

Returns: Returns the number of items in control

int GuiTreeViewCtrl::getItemCount ( )

Returns: Returns the number of items in control

string GuiTreeViewCtrl::getItemText ( TreeItemId item )

string GuiTreeViewCtrl::getItemValue ( TreeItemId item )

int GuiTreeViewCtrl::getNextSibling ( TreeItemId item )

int GuiTreeViewCtrl::getParent ( TreeItemId item )

int GuiTreeViewCtrl::getPrevSibling ( TreeItemId item )

int GuiTreeViewCtrl::getSelectedItem ( )

Returns: Returns the ID of the selected item.

int GuiTreeViewCtrl::getSelectedItem ( )

Returns: Returns the ID of the selected item.

string GuiTreeViewCtrl::getSelectedItemList ( )

returns a space seperated list of mulitple item ids

string GuiTreeViewCtrl::getSelectedItemList ( )

returns a space seperated list of mulitple item ids

int GuiTreeViewCtrl::getSelectedItemsCount ( )

int GuiTreeViewCtrl::getSelectedObject ( )

Returns: Returns the currently selected simObject in inspector mode or -1

int GuiTreeViewCtrl::getSelectedObject ( )

Returns: Returns the currently selected simObject in inspector mode or -1

string GuiTreeViewCtrl::getTextToRoot	(	TreeItemId	item,
		Delimiter	= `none`
	)

gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally

string GuiTreeViewCtrl::getTextToRoot	(	TreeItemId	item,
		Delimiter	= `none`
	)

gets the text from the current node to the root, concatenating at each branch upward, with a specified delimiter optionally

int GuiTreeViewCtrl::insertItem	(	TreeItemId	parent,
		name	,
		value	,
		icon	,
		normalImage	= `0`,
		expandedImage	= `0`
	)

Adds item to tree control.

Parameters

parent	The new item's parent.
name	The name of the new item.
value	The new item's value.
icon	The new item's icon

Returns: Returns the new item's ID.

int GuiTreeViewCtrl::insertItem	(	TreeItemId	parent,
		name	,
		value	,
		icon	,
		normalImage	= `0`,
		expandedImage	= `0`
	)

Adds item to tree control.

Parameters

parent	The new item's parent.
name	The name of the new item.
value	The new item's value.
icon	The new item's icon

Returns: Returns the new item's ID.

void GuiTreeViewCtrl::lockSelection ( )

Set whether the selection is to be locked.

Parameters

lock	Boolean flag for whether or not the current selected object should be locked

Returns: No return value.

void GuiTreeViewCtrl::lockSelection ( )

Set whether the selection is to be locked.

Parameters

lock	Boolean flag for whether or not the current selected object should be locked

Returns: No return value.

void GuiTreeViewCtrl::moveItemDown ( TreeItemId item )

void GuiTreeViewCtrl::moveItemUp ( TreeItemId item )

void GuiTreeViewCtrl::open	(	SimSet	obj,
		bool	okToEdit = `true`
	)

Set the root of the tree view to the specified object, or to the root set.

void GuiTreeViewCtrl::open	(	SimSet	obj,
		bool	okToEdit = `true`
	)

Set the root of the tree view to the specified object, or to the root set.

void GuiTreeViewCtrl::removeAllChildren ( TreeItemId parent )

void GuiTreeViewCtrl::removeChildSelectionByValue	(	TreeItemId	parent,
		value
	)

void GuiTreeViewCtrl::removeChildSelectionByValue	(	TreeItemId	parent,
		value
	)

bool GuiTreeViewCtrl::removeItem ( TreeItemId item )

void GuiTreeViewCtrl::removeSelection ( string ID )

Deselects given item.

Parameters

ID	The ID of the item to deselect.

Returns: No return value.

void GuiTreeViewCtrl::removeSelection ( string ID )

Deselects given item.

Parameters

ID	The ID of the item to deselect.

Returns: No return value.

void GuiTreeViewCtrl::scrollVisible ( TreeItemId item )

Make the given item visible.

Parameters

ID	of the desired item.

Returns: No return value.

void GuiTreeViewCtrl::scrollVisible ( TreeItemId item )

Make the given item visible.

Parameters

ID	of the desired item.

Returns: No return value.

int GuiTreeViewCtrl::scrollVisibleByObjectId ( show item by object id.returns true if sucessful. )

bool GuiTreeViewCtrl::selectItem ( TreeItemId item )

Selects item.

bool GuiTreeViewCtrl::selectItem ( TreeItemId item )

Selects item.

Member Data Documentation

string GuiTreeViewCtrl::Accelerator

bool GuiTreeViewCtrl::Active

string GuiTreeViewCtrl::AltCommand

bool GuiTreeViewCtrl::canSave

bool GuiTreeViewCtrl::canSaveDynamicFields

string GuiTreeViewCtrl::class

Script SuperClass of object.

string GuiTreeViewCtrl::Command

bool GuiTreeViewCtrl::DeleteObjectAllowed

bool GuiTreeViewCtrl::destroyTreeOnSleep

bool GuiTreeViewCtrl::DragToItemAllowed

Point2I GuiTreeViewCtrl::Extent

bool GuiTreeViewCtrl::fullRowSelect

enumval GuiTreeViewCtrl::HorizSizing

int GuiTreeViewCtrl::hovertime

string GuiTreeViewCtrl::internalName

bool GuiTreeViewCtrl::isContainer

int GuiTreeViewCtrl::itemHeight

string GuiTreeViewCtrl::langTableMod

Point2I GuiTreeViewCtrl::MinExtent

deprecated GuiTreeViewCtrl::Modal

bool GuiTreeViewCtrl::MouseDragging

bool GuiTreeViewCtrl::MultipleSelections

SimObjectPtr GuiTreeViewCtrl::parentGroup

Group hierarchy parent of the object.

Point2I GuiTreeViewCtrl::Position

GuiProfile GuiTreeViewCtrl::Profile

deprecated GuiTreeViewCtrl::setFirstResponder

string GuiTreeViewCtrl::superclass

Script Class of object.

int GuiTreeViewCtrl::tabSize

int GuiTreeViewCtrl::textOffset

string GuiTreeViewCtrl::ToolTip

GuiProfile GuiTreeViewCtrl::tooltipprofile

int GuiTreeViewCtrl::tooltipWidth

string GuiTreeViewCtrl::Variable

enumval GuiTreeViewCtrl::VertSizing

bool GuiTreeViewCtrl::Visible