XInterface.GUIListBase

Extends: GUIComponent
Modifiers: Native Abstract

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

Direct Known Subclasses:

GUICircularList, GUIHorzList, GUIVertList

Constants Summary

Inherited Contants from XInterface.GUI
Counter, QBTN_Abort, QBTN_AbortRetry, QBTN_Cancel, QBTN_Continue, QBTN_Ignore, QBTN_No, QBTN_Ok, QBTN_OkCancel, QBTN_Retry, QBTN_Yes, QBTN_YesNo, QBTN_YesNoCancel

Variables Summary
GUIListBase
bool	bAllowEmptyItems
bool	bDrawSelectionBorder
bool	bHotTrack
bool	bHotTrackSound
bool	bInitializeList
bool	bMultiSelect
bool	bNotify
bool	bSorted
bool	bVisibleWhenEmpty
int	DropIndex
int	Index
int	ItemCount
float	ItemHeight
int	ItemsPerPage
float	ItemWidth
int	LastPressX
int	LastPressY
int	LastSelected
array<GUIComponent>	LinkedObjects
int	MightRemove
GUIScrollBarBase	MyScrollBar
ETextAlign	SectionJustification
color	SelectedBKColor
Material	SelectedImage
array<int>	SelectedItems
int	Top
Style
GUIStyles	OutlineStyle
string	OutlineStyleName
GUIStyles	SectionStyle
string	SectionStyleName
GUIStyles	SelectedStyle
string	SelectedStyleName

Inherited Variables from XInterface.GUIComponent
bAcceptsInput, bAnimating, bBoundToParent, bCaptureMouse, bCaptureTabs, bDebugging, bDropSource, bDropTarget, bFocusOnWatch, bHasFocus, bInit, bMouseOverSound, bNeverFocus, bNeverScale, BoundingType, Bounds[4], bPendingFocus, bPositioned, bRepeatClick, bRequireReleaseClick, bRequiresStyle, bScaleToParent, bSizing, bStandardized, bTabStop, bTimerRepeat, bTravelling, bVisible, ClientBounds[4], ContextMenu, DrawCount, DropState, FocusInstead, FontScale, FriendlyLabel, Hint, IniDefault, IniOption, LastMenuState, MenuOwner, MenuState, MotionFrame, MouseCursorIndex, MouseOffset[4], OnClickSound, OnDrawCount, OnPreDrawCount, OnRenderCount, OnRenderedCount, PageOwner, PreDrawCount, RenderWeight, ScalingType, SizeFrame, StandardHeight, Style, StyleName, TabOrder, Tag, TimerCountdown, TimerIndex, TimerInterval, ToolTip, WhiteColor, WinHeight, WinLeft, WinTop, WinWidth

Inherited Variables from XInterface.GUIComponent

bAcceptsInput, bAnimating, bBoundToParent, bCaptureMouse, bCaptureTabs, bDebugging, bDropSource, bDropTarget, bFocusOnWatch, bHasFocus, bInit, bMouseOverSound, bNeverFocus, bNeverScale, BoundingType, Bounds[4], bPendingFocus, bPositioned, bRepeatClick, bRequireReleaseClick, bRequiresStyle, bScaleToParent, bSizing, bStandardized, bTabStop, bTimerRepeat, bTravelling, bVisible, ClientBounds[4], ContextMenu, DrawCount, DropState, FocusInstead, FontScale, FriendlyLabel, Hint, IniDefault, IniOption, LastMenuState, MenuOwner, MenuState, MotionFrame, MouseCursorIndex, MouseOffset[4], OnClickSound, OnDrawCount, OnPreDrawCount, OnRenderCount, OnRenderedCount, PageOwner, PreDrawCount, RenderWeight, ScalingType, SizeFrame, StandardHeight, Style, StyleName, TabOrder, Tag, TimerCountdown, TimerIndex, TimerInterval, ToolTip, WhiteColor, WinHeight, WinLeft, WinTop, WinWidth

Inherited Variables from XInterface.GUI
Controller, SaveColor, SaveFont, SaveModulation, SaveStyle, SaveX, SaveY

Enumerations Summary

Inherited Enumerations from XInterface.GUIComponent
EClickSound, EParentScaleType

Inherited Enumerations from XInterface.GUI
EAnimationType, eCellStyle, eDrawDirection, eDropState, eEditMask, eFontScale, eIconPosition, eImgAlign, eImgStyle, EMenuRenderStyle, eMenuState, EOrientation, ePageAlign, eTextAlign, eTextCase

Structures Summary

Inherited Structures from XInterface.GUI
APackInfo, AutoLoginInfo, GUIListElem, GUITabItem, GUITreeNode, ImageListElem, MultiSelectListElem

Delegates Summary
		CheckLinkedObjects (GUIListBase List)
		OnAdjustTop (GUIComponent Sender)
		OnDrawItem (Canvas Canvas, int Item, float X, float Y, float W, float HT, bool bSelected, bool bPending)
		OnScrollBy (GUIComponent Sender)
		OnTrack (GUIComponent Sender, int LastIndex)

Inherited Delegates from XInterface.GUIComponent
OnActivate, OnArrival, OnBeginDrag, OnBeginTooltip, OnCapturedMouseMove, OnChange, OnClick, OnDblClick, OnDeActivate, OnDesignModeKeyEvent, OnDragDrop, OnDragEnter, OnDragLeave, OnDragOver, OnDraw, OnEndAnimation, OnEndDrag, OnEndTooltip, OnHide, OnHitTest, OnHover, OnInvalidate, OnKeyEvent, OnKeyType, OnLoadINI, OnMessage, OnMousePressed, OnMouseRelease, OnMultiSelect, OnPreDraw, OnRender, OnRendered, OnRightClick, OnSaveINI, OnShow, OnTimer, OnWatch

Inherited Delegates from XInterface.GUIComponent

OnActivate, OnArrival, OnBeginDrag, OnBeginTooltip, OnCapturedMouseMove, OnChange, OnClick, OnDblClick, OnDeActivate, OnDesignModeKeyEvent, OnDragDrop, OnDragEnter, OnDragLeave, OnDragOver, OnDraw, OnEndAnimation, OnEndDrag, OnEndTooltip, OnHide, OnHitTest, OnHover, OnInvalidate, OnKeyEvent, OnKeyType, OnLoadINI, OnMessage, OnMousePressed, OnMouseRelease, OnMultiSelect, OnPreDraw, OnRender, OnRendered, OnRightClick, OnSaveINI, OnShow, OnTimer, OnWatch

Functions Summary
	string	AdditionalDebugString ()
	int	AddLinkObject (GUIComponent NewObj, optional bool bNoCheck)
	int	CalculateIndex (optional bool bRequireValidIndex)
		CheckDragSelect ()
		Clear ()
		ClearPendingElements ()
		DisableLinkedObjects ()
	bool	Down ()
		EnableLinkedObjects ()
		End ()
	string	GetItemAtIndex (int idx)
	array<string>	GetPendingItems (optional bool bGuarantee)
		Home ()
		IndexChanged (GUIComponent Sender)
		InitComponent (GUIController MyController, GUIComponent MyOwner)
		InitLinkObjects (array<GUIComponent> NewObj, optional bool bNoCheck)
	bool	InternalOnBeginDrag (GUIComponent Sender)
	bool	InternalOnDragDrop (GUIComponent Sender)
		InternalOnDragEnter (GUIComponent Sender)
		InternalOnDragLeave (GUIComponent Sender)
		InternalOnDragOver (GUIComponent Sender)
		InternalOnEndDrag (GUIComponent Accepting, bool bAccepted)
	bool	InternalOnKeyEvent (out byte Key, out byte KeyState, float Delta)
		InternalOnMousePressed (GUIComponent Sender, bool IsRepeat)
		InternalOnMouseRelease (GUIComponent Sender)
	bool	InternalOnRightClick (GUIComponent Sender)
	bool	IsMultiSelect ()
	bool	IsValid ()
	bool	IsValidIndex (int i)
		MakeVisible (float Perc)
	bool	MoveLeft ()
	bool	MoveRight ()
		PgDn ()
		PgUp ()
	int	SetIndex (int NewIndex)
		SetOutlineAlpha (int NewAlpha)
		SetTopItem (int Item)
	int	SilentSetIndex (int NewIndex)
		Sort ()
	bool	Up ()
		WheelDown ()
		WheelUp ()

Inherited Functions from XInterface.GUIComponent
ActualHeight, ActualLeft, ActualTop, ActualWidth, AdditionalDebugString, Animate, AutoPosition, AutoPositionOn, BeginAnimation, CanAcceptFocus, CenterMouse, Closed, DAnimate, DebugFocus, DebugFocusPosition, DebugTabOrder, DisableComponent, DisableMe, DropStateChange, EnableComponent, EnableMe, EndAnimation, FillOwner, FocusFirst, FocusLast, Free, GetMenuPath, Hide, InitComponent, IsInBounds, IsInClientBounds, IsMultiSelect, KillAnimation, KillTimer, LevelChanged, LoadINI, LoseFocus, MakeColorCode, MenuStateChange, NextControl, NextPage, Opened, OwnerPage, PadLeft, PadRight, PlayerOwner, PrevControl, PrevPage, RelativeHeight, RelativeLeft, RelativeTop, RelativeWidth, Resize, ResolutionChanged, SaveINI, SetFocus, SetFocusInstead, SetFriendlyLabel, SetHint, SetPosition, SetTimer, SetTooltip, SetToolTipText, SetVisibility, Show, SpecialHit, StripColorCodes, Timer, UpdateOffset

Inherited Functions from XInterface.GUIComponent

ActualHeight, ActualLeft, ActualTop, ActualWidth, AdditionalDebugString, Animate, AutoPosition, AutoPositionOn, BeginAnimation, CanAcceptFocus, CenterMouse, Closed, DAnimate, DebugFocus, DebugFocusPosition, DebugTabOrder, DisableComponent, DisableMe, DropStateChange, EnableComponent, EnableMe, EndAnimation, FillOwner, FocusFirst, FocusLast, Free, GetMenuPath, Hide, InitComponent, IsInBounds, IsInClientBounds, IsMultiSelect, KillAnimation, KillTimer, LevelChanged, LoadINI, LoseFocus, MakeColorCode, MenuStateChange, NextControl, NextPage, Opened, OwnerPage, PadLeft, PadRight, PlayerOwner, PrevControl, PrevPage, RelativeHeight, RelativeLeft, RelativeTop, RelativeWidth, Resize, ResolutionChanged, SaveINI, SetFocus, SetFocusInstead, SetFriendlyLabel, SetHint, SetPosition, SetTimer, SetTooltip, SetToolTipText, SetVisibility, Show, SpecialHit, StripColorCodes, Timer, UpdateOffset

Inherited Functions from XInterface.GUI
GetModList, GetModLogo, GetModValue, IsDigit, JoinArray, Profile

Variables Detail

GUIListBase

bAllowEmptyItems Source code

var(GUIListBase) bool bAllowEmptyItems;

bDrawSelectionBorder Source code

var(GUIListBase) bool bDrawSelectionBorder;

bHotTrack Source code

var(GUIListBase) bool bHotTrack;

bHotTrackSound Source code

var(GUIListBase) bool bHotTrackSound;

bInitializeList Source code

var(GUIListBase) bool bInitializeList;

bMultiSelect Source code

var(GUIListBase) bool bMultiSelect;

bNotify Source code

var(GUIListBase) bool bNotify;

bSorted Source code

var(GUIListBase) bool bSorted;

bVisibleWhenEmpty Source code

var(GUIListBase) bool bVisibleWhenEmpty;

DropIndex Source code

var(GUIListBase) noexport editconst int DropIndex;

Index Source code

var(GUIListBase) noexport editconst int Index;

ItemCount Source code

var(GUIListBase) noexport editconst int ItemCount;

ItemHeight Source code

var(GUIListBase) noexport editconst const float ItemHeight;

ItemsPerPage Source code

var(GUIListBase) noexport editconst const int ItemsPerPage;

ItemWidth Source code

var(GUIListBase) noexport editconst const float ItemWidth;

LastPressX Source code

var(GUIListBase) noexport editconst int LastPressX;

LastPressY Source code

var(GUIListBase) noexport editconst int LastPressY;

LastSelected Source code

var(GUIListBase) noexport editconst int LastSelected;

LinkedObjects Source code

var(GUIListBase) noexport editconstarray array<GUIComponent> LinkedObjects;

MightRemove Source code

var(GUIListBase) noexport editconst int MightRemove;

MyScrollBar Source code

var(GUIListBase) noexport GUIScrollBarBase MyScrollBar;

SectionJustification Source code

var(GUIListBase) ETextAlign SectionJustification;

SelectedBKColor Source code

var(GUIListBase) color SelectedBKColor;

SelectedImage Source code

var(GUIListBase) Material SelectedImage;

SelectedItems Source code

var(GUIListBase) noexport editconst array<int> SelectedItems;

Top Source code

var(GUIListBase) noexport editconst int Top;

Style

OutlineStyle Source code

var(Style) noexport GUIStyles OutlineStyle;

OutlineStyleName Source code

var(Style) string OutlineStyleName;

SectionStyle Source code

var(Style) noexport GUIStyles SectionStyle;

SectionStyleName Source code

var(Style) string SectionStyleName;

SelectedStyle Source code

var(Style) noexport GUIStyles SelectedStyle;

SelectedStyleName Source code

var(Style) string SelectedStyleName;

Delegates Detail

CheckLinkedObjects Source code

delegate CheckLinkedObjects ( GUIListBase List )

OnAdjustTop Source code

delegate OnAdjustTop ( GUIComponent Sender )

OnDrawItem Source code

delegate OnDrawItem ( Canvas Canvas, int Item, float X, float Y, float W, float HT, bool bSelected, bool bPending )

OnScrollBy Source code

delegate OnScrollBy ( GUIComponent Sender )

OnTrack Source code

delegate OnTrack ( GUIComponent Sender, int LastIndex )

Functions Detail

AdditionalDebugString Source code

event string AdditionalDebugString ( )

AddLinkObject Source code

function int AddLinkObject ( GUIComponent NewObj, optional bool bNoCheck )

CalculateIndex Source code

event int CalculateIndex ( optional bool bRequireValidIndex )

CheckDragSelect Source code

function CheckDragSelect ( )

Clear Source code

function Clear ( )

ClearPendingElements Source code

function ClearPendingElements ( )

DisableLinkedObjects Source code

function DisableLinkedObjects ( )

Down Source code

function bool Down ( )

EnableLinkedObjects Source code

function EnableLinkedObjects ( )

End Source code

function End ( )

GetItemAtIndex Source code

function string GetItemAtIndex ( int idx )

GetPendingItems Source code

function array<string> GetPendingItems ( optional bool bGuarantee )

Home Source code

function Home ( )

IndexChanged Source code

function IndexChanged ( GUIComponent Sender )

InitComponent Source code

function InitComponent ( GUIController MyController, GUIComponent MyOwner )

InitLinkObjects Source code

function InitLinkObjects ( array<GUIComponent> NewObj, optional bool bNoCheck )

InternalOnBeginDrag Source code

function bool InternalOnBeginDrag ( GUIComponent Sender )

InternalOnDragDrop Source code

function bool InternalOnDragDrop ( GUIComponent Sender )

InternalOnDragEnter Source code

function InternalOnDragEnter ( GUIComponent Sender )

InternalOnDragLeave Source code

function InternalOnDragLeave ( GUIComponent Sender )

InternalOnDragOver Source code

function InternalOnDragOver ( GUIComponent Sender )

InternalOnEndDrag Source code

function InternalOnEndDrag ( GUIComponent Accepting, bool bAccepted )

InternalOnKeyEvent Source code

function bool InternalOnKeyEvent ( out byte Key, out byte KeyState, float Delta )

InternalOnMousePressed Source code

function InternalOnMousePressed ( GUIComponent Sender, bool IsRepeat )

InternalOnMouseRelease Source code

function InternalOnMouseRelease ( GUIComponent Sender )

InternalOnRightClick Source code

function bool InternalOnRightClick ( GUIComponent Sender )

IsMultiSelect Source code

event bool IsMultiSelect ( )

IsValid Source code

function bool IsValid ( )

IsValidIndex Source code

function bool IsValidIndex ( int i )

MakeVisible Source code

function MakeVisible ( float Perc )

MoveLeft Source code

function bool MoveLeft ( )

MoveRight Source code

function bool MoveRight ( )

PgDn Source code

function PgDn ( )

PgUp Source code

function PgUp ( )

SetIndex Source code

function int SetIndex ( int NewIndex )

SetOutlineAlpha Source code

function SetOutlineAlpha ( int NewAlpha )

SetTopItem Source code

function SetTopItem ( int Item )

SilentSetIndex Source code

function int SilentSetIndex ( int NewIndex )

Sort Source code

function Sort ( )

Up Source code

function bool Up ( )

WheelDown Source code

function WheelDown ( )

WheelUp Source code

function WheelUp ( )

Defaultproperties

defaultproperties
{
     bHotTrackSound=True
     bDrawSelectionBorder=True
     bNotify=True
     bInitializeList=True
     bMultiSelect=True
     SelectedStyleName="ListSelection"
     SectionStyleName="ListSection"
     OutlineStyleName="ItemOutline"
     SelectedBKColor=(B=200,G=255,R=255,A=255)
     Index=-1
     LastSelected=-1
     DropIndex=-1
     MightRemove=-1
     FontScale=FNS_Small
     StyleName="NoBackground"
     bTabStop=True
     bAcceptsInput=True
     OnRightClick=GUIListBase.InternalOnRightClick
     OnMousePressed=GUIListBase.InternalOnMousePressed
     OnMouseRelease=GUIListBase.InternalOnMouseRelease
     OnKeyEvent=GUIListBase.InternalOnKeyEvent
     OnBeginDrag=GUIListBase.InternalOnBeginDrag
     OnEndDrag=GUIListBase.InternalOnEndDrag
     OnDragDrop=GUIListBase.InternalOnDragDrop
     OnDragEnter=GUIListBase.InternalOnDragEnter
     OnDragLeave=GUIListBase.InternalOnDragLeave
     OnDragOver=GUIListBase.InternalOnDragOver
}

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