Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

GUI.GUIList

Extends
GUIVertList
Modifiers
HideCategories ( Menu , Object ) Native

Core.Object
|   
+-- GUI.GUI
   |   
   +-- GUI.GUIComponent
      |   
      +-- GUI.GUIListBase
         |   
         +-- GUI.GUIVertList
            |   
            +-- GUI.GUIList

Direct Known Subclasses:

GUIScrollText

Variables Summary
GUIList
boolbListIsDirty
boolbNativeSort
boolbNeverSort
boolbSortForward
eListElemDisplayDisplayItem
array<GUIListElem>Elements
eTextAlignTextAlign
eSortTypeTypeOfSort
Inherited Variables from GUI.GUIListBase
bHotTrack, bReadOnly, bVisibleWhenEmpty, Index, ItemCount, ItemHeight, ItemsPerPage, ItemWidth, MyScrollBar, SelectedBKColor, SelectedImage, Top

Enumerations Summary
eSortType
SORT_AlphaItem, SORT_AlphaExtra, SORT_Numeric, SORT_Bool, SORT_IP,

Delegates Summary
delegatebool CompareItem (GUIListElem ElemA, GUIListElem ElemB))
delegatebool ElementsEqual (GUIListElem ElemA, GUIListElem ElemB))
delegate ReorderByIndices (int indices))
delegate SwapIndices (int indexA, int indexB ))
Inherited Delegates from GUI.GUIListBase
OnAdjustTop, OnDrawItem

Functions Summary
function Add (string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData, optional bool bDontReplace, optional bool bDontReAlign ))
functionint AddElement (GUIListElem theElem, optional bool bDontReplace, optional bool bDontReAlign ))
functionbool AlphabeticalCompare (string ElemA, string ElemB ))
functionbool AlphabeticalCompareExtra (GUIListElem ElemA, GUIListElem ElemB ))
functionbool AlphabeticalCompareItem (GUIListElem ElemA, GUIListElem ElemB ))
functionbool BooleanCompare (GUIListElem ElemA, GUIListElem ElemB ))
function Clear ()))
functionbool EqualsBool (GUIListElem ElemA, GUIListElem ElemB))
functionbool EqualsExtra (GUIListElem ElemA, GUIListElem ElemB))
functionbool EqualsInt (GUIListElem ElemA, GUIListElem ElemB))
functionbool EqualsItem (GUIListElem ElemA, GUIListElem ElemB))
functionbool EqualsObject (GUIListElem ElemA, GUIListElem ElemB))
functionstring find (string Text, optional bool bExact, optional bool bDontSetIndex))
functionint FindElement (GUIListElem theElem))
functionstring FindExtra (string ExtraText, optional bool bExact, optional bool bDontSetIndex ))
functionint FindIndex (string Test, optional bool bExact, optional bool bExtra, optional Object TestObject))
functionstring Get ()))
functionGUIListElem GetAtIndex (int i))
functionGUIListElem GetElement ()))
functionstring GetExtra ()))
functionstring GetExtraAtIndex (int i))
functionbool GetExtraBoolData ()))
functionint GetExtraIntAtIndex (int i))
functionint GetExtraIntData ()))
functionstring GetItemAtIndex (int i))
functionobject GetObject ()))
functionobject GetObjectAtIndex (int i))
function InitComponent (GUIComponent MyOwner))
function Insert (int index, string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData ))
functionint InsertElement (int NewIndex, optional GUIListElem theElem, optional bool bInsertSorted, optional bool bDontReAlign ))
functionbool IPCompare (GUIListElem ElemA, GUIListElem ElemB ))
function LoadFrom (GUIList Source, optional bool bClearFirst))
functionbool NumericCompare (GUIListElem ElemA, GUIListElem ElemB ))
function qSort ()
function Remove (int i, optional int Count))
function RemoveItem (string Item))
function ReorderItems (int indices)
function Replace (int index, string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData))
function ReplaceElement (int index, GUIListElem theElem ))
function ReverseList ()))
eventstring SelectedText (int offsetIndex ))
function SetExtraAtIndex (int i, string NewExtra))
function SetExtraIntAtIndex (int i, int NewExtra))
function SetItemAtIndex (int i, string NewItem))
function Sort ()))
event Swap (int IndexA, int IndexB, optional bool bIsSorting))
Inherited Functions from GUI.GUIVertList
Click, Down, End, Home, InitComponent, InternalOnKeyEvent, InternalOnKeyType, InternalOnXControllerEvent, PgDn, PgUp, Up, WheelDown, WheelUp
Inherited Functions from GUI.GUIListBase
Clear, InitComponent, MakeVisible, SetIndex, SetTopItem, Sort


Variables Detail

GUIList

bListIsDirty Source code

var(GUIList) EditConst bool bListIsDirty;
If true, the list may be unsorted

bNativeSort Source code

var(GUIList) bool bNativeSort;
If true, a native qSort will be used (which breaks CompareItem delegates)

bNeverSort Source code

var(GUIList) config bool bNeverSort;
If true, the list should never be sorted

bSortForward Source code

var(GUIList) EditConst bool bSortForward;
If true, will sort forward, else will sort backwards

DisplayItem Source code

var(GUIList) config eListElemDisplay DisplayItem;
Determines which element member will be shown in this list

Elements Source code

var(GUIList) editinline editconst array<GUIListElem> Elements;

TextAlign Source code

var(GUIList) config eTextAlign TextAlign;
How is text Aligned in the control

TypeOfSort Source code

var(GUIList) config eSortType TypeOfSort;
Determines what type of sort to use for this list


Enumerations Detail

eSortType Source code

enum eSortType
{
SORT_AlphaItem, SORT_AlphaExtra, SORT_Numeric, SORT_Bool, SORT_IP,
};


Delegates Detail

CompareItem Source code

delegate bool CompareItem ( GUIListElem ElemA, GUIListElem ElemB) )

ElementsEqual Source code

delegate bool ElementsEqual ( GUIListElem ElemA, GUIListElem ElemB) )

ReorderByIndices Source code

delegate ReorderByIndices ( int indices) )

SwapIndices Source code

delegate SwapIndices ( int indexA, int indexB ) )


Functions Detail

Add Source code

function Add ( string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData, optional bool bDontReplace, optional bool bDontReAlign ) )

AddElement Source code

function int AddElement ( GUIListElem theElem, optional bool bDontReplace, optional bool bDontReAlign ) )

AlphabeticalCompare Source code

function bool AlphabeticalCompare ( string ElemA, string ElemB ) )

AlphabeticalCompareExtra Source code

function bool AlphabeticalCompareExtra ( GUIListElem ElemA, GUIListElem ElemB ) )

AlphabeticalCompareItem Source code

function bool AlphabeticalCompareItem ( GUIListElem ElemA, GUIListElem ElemB ) )

BooleanCompare Source code

function bool BooleanCompare ( GUIListElem ElemA, GUIListElem ElemB ) )

Clear Source code

function Clear ( ) )

EqualsBool Source code

function bool EqualsBool ( GUIListElem ElemA, GUIListElem ElemB) )

EqualsExtra Source code

function bool EqualsExtra ( GUIListElem ElemA, GUIListElem ElemB) )

EqualsInt Source code

function bool EqualsInt ( GUIListElem ElemA, GUIListElem ElemB) )

EqualsItem Source code

function bool EqualsItem ( GUIListElem ElemA, GUIListElem ElemB) )

EqualsObject Source code

function bool EqualsObject ( GUIListElem ElemA, GUIListElem ElemB) )

find Source code

function string find ( string Text, optional bool bExact, optional bool bDontSetIndex) )

FindElement Source code

function int FindElement ( GUIListElem theElem) )

FindExtra Source code

function string FindExtra ( string ExtraText, optional bool bExact, optional bool bDontSetIndex ) )

FindIndex Source code

function int FindIndex ( string Test, optional bool bExact, optional bool bExtra, optional Object TestObject) )

Get Source code

function string Get ( ) )

GetAtIndex Source code

function GUIListElem GetAtIndex ( int i) )

GetElement Source code

function GUIListElem GetElement ( ) )

GetExtra Source code

function string GetExtra ( ) )

GetExtraAtIndex Source code

function string GetExtraAtIndex ( int i) )

GetExtraBoolData Source code

function bool GetExtraBoolData ( ) )

GetExtraIntAtIndex Source code

function int GetExtraIntAtIndex ( int i) )

GetExtraIntData Source code

function int GetExtraIntData ( ) )

GetItemAtIndex Source code

function string GetItemAtIndex ( int i) )

GetObject Source code

function object GetObject ( ) )

GetObjectAtIndex Source code

function object GetObjectAtIndex ( int i) )

InitComponent Source code

function InitComponent ( GUIComponent MyOwner) )

Insert Source code

function Insert ( int index, string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData ) )

InsertElement Source code

function int InsertElement ( int NewIndex, optional GUIListElem theElem, optional bool bInsertSorted, optional bool bDontReAlign ) )

IPCompare Source code

function bool IPCompare ( GUIListElem ElemA, GUIListElem ElemB ) )

LoadFrom Source code

function LoadFrom ( GUIList Source, optional bool bClearFirst) )

NumericCompare Source code

function bool NumericCompare ( GUIListElem ElemA, GUIListElem ElemB ) )

qSort Source code

final native function qSort ( )

Remove Source code

function Remove ( int i, optional int Count) )

RemoveItem Source code

function RemoveItem ( string Item) )

ReorderItems Source code

final native function ReorderItems ( int indices )

Replace Source code

function Replace ( int index, string NewItem, optional Object obj, optional string Str, optional int intData, optional bool bData) )

ReplaceElement Source code

function ReplaceElement ( int index, GUIListElem theElem ) )

ReverseList Source code

function ReverseList ( ) )

SelectedText Source code

event string SelectedText ( int offsetIndex ) )

SetExtraAtIndex Source code

function SetExtraAtIndex ( int i, string NewExtra) )

SetExtraIntAtIndex Source code

function SetExtraIntAtIndex ( int i, int NewExtra) )

SetItemAtIndex Source code

function SetItemAtIndex ( int i, string NewItem) )

Sort Source code

function Sort ( ) )

Swap Source code

event Swap ( int IndexA, int IndexB, optional bool bIsSorting) )


Defaultproperties

defaultproperties
{
	bSortForward=True
	bListIsDirty=false
	bNeverSort=false
	TypeOfSort=SORT_AlphaItem
	bNativeSort=true
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: st 23.5.2018 00:10:30.291 - Created with UnCodeX