I'm a doctor, not a mechanic

UE2:GUIListBase (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIListBase
Package: 
XInterface
Direct subclasses:
GUICircularList, GUIHorzList, GUIVertList
This class in other games:
UE2Runtime, UT2003

Class: UT2K4UI.GUIListBase

Abstract GUIList list box component.

Written by Joe Wilcox Made abstract by Jack Porter (c) 2002, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'GUIListBase'[edit]

bAllowEmptyItems[edit]

Type: bool


bDrawSelectionBorder[edit]

Type: bool

Should we draw a selection border around the selected item

Default value: True

bHotTrack[edit]

Type: bool

Use the Mouse X/Y to always hightlight something

bHotTrackSound[edit]

Type: bool

Whether to make the mouse over sound when hottracking

Default value: True

bInitializeList[edit]

Type: bool

If true, set index to 0 when adding first item

Default value: True

bMultiSelect[edit]

Type: bool

allow multiple selections (where implemented)

Default value: True

bNotify[edit]

Type: bool

Used to abort OnChange notification in list

Default value: True

bSorted[edit]

Type: bool

Should we sort this list

bVisibleWhenEmpty[edit]

Type: bool

List is still drawn when there are no items in it.

DropIndex[edit]

Type: int

Modifiers: noexport, editconst

Indicates the insertion position for the drag-n-drop operation

Default value: -1

Index[edit]

Type: int

Modifiers: noexport, editconst

Pointers in to the list

Default value: -1

ItemCount[edit]

Type: int

Modifiers: noexport, editconst


ItemHeight[edit]

Type: float

Modifiers: noexport, editconst, const

Size of each row. Subclass should set in PreDraw.

ItemsPerPage[edit]

Type: int

Modifiers: noexport, editconst, const

  1. of items per Page. Is set natively

ItemWidth[edit]

Type: float

Modifiers: noexport, editconst, const

Width of each row.. Subclass should set in PreDraw.

LastPressX[edit]

Type: int

Modifiers: noexport, editconst


LastPressY[edit]

Type: int

Modifiers: noexport, editconst

Last position of mouse press

LastSelected[edit]

Type: int

Modifiers: noexport, editconst

Last selected item

Default value: -1

LinkedObjects[edit]

Type: array<GUIComponent>

Modifiers: noexport, editconstarray


MightRemove[edit]

Type: int

Modifiers: noexport, editconst

Indicates an item that will be de-selected unless a drag operation begins

Default value: -1

MyScrollBar[edit]

Type: GUIScrollBarBase

Modifiers: noexport


SectionJustification[edit]

Type: GUI.eTextAlign


SelectedBKColor[edit]

Type: Object.Color

Color for a selection background

Default value:

Member Value
A 255
B 200
G 255
R 255

SelectedImage[edit]

Type: Material

Image to use when displaying

SelectedItems[edit]

Type: array<int>

Modifiers: noexport, editconst


Top[edit]

Type: int

Modifiers: noexport, editconst


Property group 'Style'[edit]

OutlineStyle[edit]

Type: GUIStyles

Modifiers: noexport

Used for outlining a pending drag-n-drop

OutlineStyleName[edit]

Type: string


Default value: "ItemOutline"

SectionStyle[edit]

Type: GUIStyles

Modifiers: noexport


SectionStyleName[edit]

Type: string

Name of the style to use for header items

Default value: "ListSection"

SelectedStyle[edit]

Type: GUIStyles

Modifiers: noexport


SelectedStyleName[edit]

Type: string

Name of the style to use for the selected item

Default value: "ListSelection"

Default values[edit]

Property Value
bAcceptsInput True
bTabStop True
FontScale FNS_Small
OnBeginDrag InternalOnBeginDrag
OnDragDrop InternalOnDragDrop
OnDragEnter InternalOnDragEnter
OnDragLeave InternalOnDragLeave
OnDragOver InternalOnDragOver
OnEndDrag InternalOnEndDrag
OnKeyEvent InternalOnKeyEvent
OnMousePressed InternalOnMousePressed
OnMouseRelease InternalOnMouseRelease
OnRightClick InternalOnRightClick
StyleName "NoBackground"

Delegates[edit]

CheckLinkedObjects[edit]

delegate CheckLinkedObjects (GUIListBase List)


OnAdjustTop[edit]

delegate OnAdjustTop (GUIComponent Sender)


OnDrawItem[edit]

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


OnScrollBy[edit]

delegate OnScrollBy (GUIComponent Sender)


OnTrack[edit]

delegate OnTrack (GUIComponent Sender, int LastIndex)


Functions[edit]

Events[edit]

AdditionalDebugString[edit]

event string AdditionalDebugString ()

Overrides: GUIComponent.AdditionalDebugString


CalculateIndex[edit]

event int CalculateIndex (optional bool bRequireValidIndex)


InitComponent[edit]

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIComponent.InitComponent


IsMultiSelect[edit]

event bool IsMultiSelect ()

Overrides: GUIComponent.IsMultiSelect


Other instance functions[edit]

See GUIListBase instance functions.