GuiEditorExplorerTree Class Reference

#include <guiEditorExplorerTree_ScriptBinding.h>

Inherits GuiTreeViewCtrl.

Public Member Functions
Integer	getGutterColumnWidth ()
String	getGutterPoint (S32 index, string column)"
String	gutterColumnAt (S32 localX)"
Public Member Functions inherited from GuiTreeViewCtrl
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

getGutterColumnWidth()

Integer getGutterColumnWidth

(

)

The width of one gutter column, in pixels.

Returns

The column width, dividers included.

getGutterPoint()

String getGutterPoint	(	S32	index,
		string	column )

The center of one column's box on one row, in canvas coordinates. Exists so a test can find its own target rather than carry a hard-coded point: a coordinate that drifted off the box would report a missing item, which is exactly what a broken hit test reports, and the test would be lying either way.

Parameters

index	The zero-based raw item index.
column	"hidden" or "locked".

Returns

The point, as "x y".

gutterColumnAt()

String gutterColumnAt

(

S32

localX

)

Which gutter column a point in the tree's own coordinates falls in.

Parameters

localX

The x offset into the control.

Returns

"hidden", "locked", or "" for neither.