XInterface.GUITreeList

Extends: GUIVertList
Modifiers: Native

Core.Object
|   
+-- XInterface.GUI
   |   
   +-- XInterface.GUIComponent
      |   
      +-- XInterface.GUIListBase
         |   
         +-- XInterface.GUIVertList
            |   
            +-- XInterface.GUITreeList

Variables Summary
GUITreeList
bool	bAllowDuplicateCaption
bool	bAllowParentSelection
bool	bGroupItems
array<GUITreeNode>	Elements
float	PrefixWidth
array<GUITreeNode>	SelectedElements
float	SelectedPrefixWidth
eTextAlign	TextAlign
int	VisibleCount

Inherited Variables from XInterface.GUIListBase
bAllowEmptyItems, bDrawSelectionBorder, bHotTrack, bHotTrackSound, bInitializeList, bMultiSelect, bNotify, bSorted, bVisibleWhenEmpty, DropIndex, Index, ItemCount, ItemHeight, ItemsPerPage, ItemWidth, LastPressX, LastPressY, LastSelected, LinkedObjects, MightRemove, MyScrollBar, OutlineStyle, OutlineStyleName, SectionJustification, SectionStyle, SectionStyleName, SelectedBKColor, SelectedImage, SelectedItems, SelectedStyle, SelectedStyleName, Top

Inherited Variables from XInterface.GUIListBase

bAllowEmptyItems, bDrawSelectionBorder, bHotTrack, bHotTrackSound, bInitializeList, bMultiSelect, bNotify, bSorted, bVisibleWhenEmpty, DropIndex, Index, ItemCount, ItemHeight, ItemsPerPage, ItemWidth, LastPressX, LastPressY, LastSelected, LinkedObjects, MightRemove, MyScrollBar, OutlineStyle, OutlineStyleName, SectionJustification, SectionStyle, SectionStyleName, SelectedBKColor, SelectedImage, SelectedItems, SelectedStyle, SelectedStyleName, Top

Delegates Summary
	int	CompareItem (GUITreeNode ElemA, GUITreeNode ElemB)

Inherited Delegates from XInterface.GUIVertList
GetItemHeight

Inherited Delegates from XInterface.GUIListBase
CheckLinkedObjects, OnAdjustTop, OnDrawItem, OnScrollBy, OnTrack

Functions Summary
	int	AddElement (GUITreeNode Node)
	int	AddItem (string Caption, string Value, optional string ParentCaption, optional bool bEnabled, optional string ExtraInfo)
	int	CalculateIndex (optional bool bRequireValidIndex)
		Clear ()
		ClearPendingElements ()
	bool	Collapse (int idx)
	bool	Down ()
		End ()
	bool	Expand (int idx, optional bool bRecursive)
	int	FindAvailableChildIndex (int ParentIndex)
	int	FindElement (string Caption, string Value, int Level, optional bool bCaseSensitive)
	int	FindFullIndex (string Caption, string Value, string ParentCaption)
	int	FindIndex (string Caption, optional bool bExact)
	int	FindIndexByValue (string Value, optional bool bExact)
	int	FindNextAvailableRootIndex (int Target)
	int	FindParentIndex (int ChildIndex)
	int	FindVisibleIndex (int Idx, int Distance)
	bool	GetAtIndex (int i, out string Caption, out string Value, out string ParentCaption, out int Level, out byte bEnabled, out string ExtraInfo)
	string	GetCaption ()
	string	GetCaptionAtIndex (int i)
	array<int>	GetChildIndexList (int idx, optional bool bNoRecurse)
	bool	GetElementAtIndex (int i, out GUITreeNode Node)
	string	GetExtra ()
	string	GetExtraAtIndex (int idx)
	array<int>	GetIndexList ()
	int	GetLevel ()
	int	GetLevelAtIndex (int i)
	string	GetParentCaption ()
	string	GetParentCaptionAtIndex (int idx)
	array<GUITreeNode>	GetPendingElements (optional bool bGuarantee)
	string	GetValue ()
	string	GetValueAtIndex (int i)
	int	HardInsert (int idx, string Caption, string Value, string ParentCaption, int Level, bool bEnabled, optional string ExtraInfo)
		HardSwap (int IndexA, int IndexB)
	bool	HasChildren (int ParentIndex)
	int	InsertItem (int idx, string Caption, string Value, string ParentCaption, int Level, bool bEnabled, optional string ExtraInfo)
	bool	InternalDblClick (GUIComponent Sender)
	bool	InternalOnClick (GUIComponent Sender)
	bool	InternalOnDragDrop (GUIComponent Sender)
		InternalOnEndDrag (GUIComponent Accepting, bool bAccepted)
	bool	IsExpanded (int ParentIndex)
	bool	IsToggleClick (int idx)
		LoadFrom (GUITreeList Source, optional bool bClearFirst)
		PgDn ()
		PgUp ()
	int	RemoveElement (GUITreeNode Node, optional int Count, optional bool bNoSort)
	int	RemoveItem (string Caption)
	int	RemoveItemAt (int idx, optional bool bNoSort, optional bool bSkipCleanup)
	int	RemoveSilent (string Caption)
		Replace (int i, string NewItem, string NewValue, optional string ParentCaption, optional bool bNoSort, optional string ExtraInfo)
		SetCaptionAtIndex (int i, string NewCaption)
	int	SetIndex (int NewIndex)
		SetLevelAtIndex (int i, int NewLevel)
		SetTopItem (int Item)
		SetValueAtIndex (int i, string NewValue)
		Sort ()
		SortList ()
	bool	Swap (int IndexA, int IndexB)
		ToggleExpand (int idx, optional bool bRecursive)
	bool	Up ()
		UpdateVisibleCount ()
	bool	ValidSelection ()
	bool	ValidSelectionAt (int idx)

Inherited Functions from XInterface.GUIVertList
CalculateIndex, CenterMouse, Down, End, Home, InternalOnClick, InternalOnKeyType, PgDn, PgUp, Up, WheelDown, WheelUp

Inherited Functions from XInterface.GUIListBase
AdditionalDebugString, AddLinkObject, CalculateIndex, CheckDragSelect, Clear, ClearPendingElements, DisableLinkedObjects, Down, EnableLinkedObjects, End, GetItemAtIndex, GetPendingItems, Home, IndexChanged, InitComponent, InitLinkObjects, InternalOnBeginDrag, InternalOnDragDrop, InternalOnDragEnter, InternalOnDragLeave, InternalOnDragOver, InternalOnEndDrag, InternalOnKeyEvent, InternalOnMousePressed, InternalOnMouseRelease, InternalOnRightClick, IsMultiSelect, IsValid, IsValidIndex, MakeVisible, MoveLeft, MoveRight, PgDn, PgUp, SetIndex, SetOutlineAlpha, SetTopItem, SilentSetIndex, Sort, Up, WheelDown, WheelUp

Inherited Functions from XInterface.GUIListBase

AdditionalDebugString, AddLinkObject, CalculateIndex, CheckDragSelect, Clear, ClearPendingElements, DisableLinkedObjects, Down, EnableLinkedObjects, End, GetItemAtIndex, GetPendingItems, Home, IndexChanged, InitComponent, InitLinkObjects, InternalOnBeginDrag, InternalOnDragDrop, InternalOnDragEnter, InternalOnDragLeave, InternalOnDragOver, InternalOnEndDrag, InternalOnKeyEvent, InternalOnMousePressed, InternalOnMouseRelease, InternalOnRightClick, IsMultiSelect, IsValid, IsValidIndex, MakeVisible, MoveLeft, MoveRight, PgDn, PgUp, SetIndex, SetOutlineAlpha, SetTopItem, SilentSetIndex, Sort, Up, WheelDown, WheelUp

Variables Detail

GUITreeList

bAllowDuplicateCaption Source code

var(GUITreeList) bool bAllowDuplicateCaption;

bAllowParentSelection Source code

var(GUITreeList) bool bAllowParentSelection;

bGroupItems Source code

var(GUITreeList) bool bGroupItems;

Elements Source code

var(GUITreeList) editconstarray editconst noexport array<GUITreeNode> Elements;

PrefixWidth Source code

var(GUITreeList) const editconst float PrefixWidth;

SelectedElements Source code

var(GUITreeList) editconstarray editconst noexport array<GUITreeNode> SelectedElements;

SelectedPrefixWidth Source code

var(GUITreeList) const editconst float SelectedPrefixWidth;

TextAlign Source code

var(GUITreeList) eTextAlign TextAlign;

VisibleCount Source code

var(GUITreeList) editconst const noexport int VisibleCount;

Delegates Detail

CompareItem Source code

delegate int CompareItem ( GUITreeNode ElemA, GUITreeNode ElemB )

Functions Detail

AddElement Source code

function int AddElement ( GUITreeNode Node )

AddItem Source code

function int AddItem ( string Caption, string Value, optional string ParentCaption, optional bool bEnabled, optional string ExtraInfo )

CalculateIndex Source code

event int CalculateIndex ( optional bool bRequireValidIndex )

Clear Source code

function Clear ( )

ClearPendingElements Source code

function ClearPendingElements ( )

Collapse Source code

function bool Collapse ( int idx )

Down Source code

function bool Down ( )

End Source code

function End ( )

Expand Source code

function bool Expand ( int idx, optional bool bRecursive )

FindAvailableChildIndex Source code

function int FindAvailableChildIndex ( int ParentIndex )

FindElement Source code

function int FindElement ( string Caption, string Value, int Level, optional bool bCaseSensitive )

FindFullIndex Source code

function int FindFullIndex ( string Caption, string Value, string ParentCaption )

FindIndex Source code

function int FindIndex ( string Caption, optional bool bExact )

FindIndexByValue Source code

function int FindIndexByValue ( string Value, optional bool bExact )

FindNextAvailableRootIndex Source code

function int FindNextAvailableRootIndex ( int Target )

FindParentIndex Source code

function int FindParentIndex ( int ChildIndex )

FindVisibleIndex Source code

function int FindVisibleIndex ( int Idx, int Distance )

GetAtIndex Source code

function bool GetAtIndex ( int i, out string Caption, out string Value, out string ParentCaption, out int Level, out byte bEnabled, out string ExtraInfo )

GetCaption Source code

function string GetCaption ( )

GetCaptionAtIndex Source code

function string GetCaptionAtIndex ( int i )

GetChildIndexList Source code

function array<int> GetChildIndexList ( int idx, optional bool bNoRecurse )

GetElementAtIndex Source code

function bool GetElementAtIndex ( int i, out GUITreeNode Node )

GetExtra Source code

function string GetExtra ( )

GetExtraAtIndex Source code

function string GetExtraAtIndex ( int idx )

GetIndexList Source code

function array<int> GetIndexList ( )

GetLevel Source code

function int GetLevel ( )

GetLevelAtIndex Source code

function int GetLevelAtIndex ( int i )

GetParentCaption Source code

function string GetParentCaption ( )

GetParentCaptionAtIndex Source code

function string GetParentCaptionAtIndex ( int idx )

GetPendingElements Source code

function array<GUITreeNode> GetPendingElements ( optional bool bGuarantee )

GetValue Source code

function string GetValue ( )

GetValueAtIndex Source code

function string GetValueAtIndex ( int i )

HardInsert Source code

protected function int HardInsert ( int idx, string Caption, string Value, string ParentCaption, int Level, bool bEnabled, optional string ExtraInfo )

HardSwap Source code

protected function HardSwap ( int IndexA, int IndexB )

HasChildren Source code

event bool HasChildren ( int ParentIndex )

InsertItem Source code

function int InsertItem ( int idx, string Caption, string Value, string ParentCaption, int Level, bool bEnabled, optional string ExtraInfo )

InternalDblClick Source code

function bool InternalDblClick ( GUIComponent Sender )

InternalOnClick Source code

function bool InternalOnClick ( GUIComponent Sender )

InternalOnDragDrop Source code

function bool InternalOnDragDrop ( GUIComponent Sender )

InternalOnEndDrag Source code

function InternalOnEndDrag ( GUIComponent Accepting, bool bAccepted )

IsExpanded Source code

event bool IsExpanded ( int ParentIndex )

IsToggleClick Source code

function bool IsToggleClick ( int idx )

LoadFrom Source code

function LoadFrom ( GUITreeList Source, optional bool bClearFirst )

PgDn Source code

function PgDn ( )

PgUp Source code

function PgUp ( )

RemoveElement Source code

function int RemoveElement ( GUITreeNode Node, optional int Count, optional bool bNoSort )

RemoveItem Source code

function int RemoveItem ( string Caption )

RemoveItemAt Source code

function int RemoveItemAt ( int idx, optional bool bNoSort, optional bool bSkipCleanup )

RemoveSilent Source code

function int RemoveSilent ( string Caption )

Replace Source code

function Replace ( int i, string NewItem, string NewValue, optional string ParentCaption, optional bool bNoSort, optional string ExtraInfo )

SetCaptionAtIndex Source code

function SetCaptionAtIndex ( int i, string NewCaption )

SetIndex Source code

function int SetIndex ( int NewIndex )

SetLevelAtIndex Source code

function SetLevelAtIndex ( int i, int NewLevel )

SetTopItem Source code

function SetTopItem ( int Item )

SetValueAtIndex Source code

function SetValueAtIndex ( int i, string NewValue )

Sort Source code

function Sort ( )

SortList Source code

native final function SortList ( )

Swap Source code

event bool Swap ( int IndexA, int IndexB )

ToggleExpand Source code

function ToggleExpand ( int idx, optional bool bRecursive )

Up Source code

function bool Up ( )

UpdateVisibleCount Source code

native final function UpdateVisibleCount ( )

ValidSelection Source code

event bool ValidSelection ( )

ValidSelectionAt Source code

event bool ValidSelectionAt ( int idx )

Defaultproperties

defaultproperties
{
     bAllowDuplicateCaption=True
     bGroupItems=True
}

Creation time: Wed 7/2/2007 19:16:01.671 - Created with UnCodeX