UE2:GUIListBase (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search
UT2004 Object >> GUI >> GUIComponent >> GUIListBase
Package: 
XInterface

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

Property group 'GUIListBase'

bAllowEmptyItems

Type: bool


bDrawSelectionBorder

Type: bool

Should we draw a selection border around the selected item

Default value: True

bHotTrack

Type: bool

Use the Mouse X/Y to always hightlight something

bHotTrackSound

Type: bool

Whether to make the mouse over sound when hottracking

Default value: True

bInitializeList

Type: bool

If true, set index to 0 when adding first item

Default value: True

bMultiSelect

Type: bool

allow multiple selections (where implemented)

Default value: True

bNotify

Type: bool

Used to abort OnChange notification in list

Default value: True

bSorted

Type: bool

Should we sort this list

bVisibleWhenEmpty

Type: bool

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

DropIndex

Type: int

Modifiers: noexport, editconst

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

Default value: -1

Index

Type: int

Modifiers: noexport, editconst

Pointers in to the list

Default value: -1

ItemCount

Type: int

Modifiers: noexport, editconst


ItemHeight

Type: float

Modifiers: noexport, editconst, const

Size of each row. Subclass should set in PreDraw.

ItemsPerPage

Type: int

Modifiers: noexport, editconst, const

  1. of items per Page. Is set natively

ItemWidth

Type: float

Modifiers: noexport, editconst, const

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

LastPressX

Type: int

Modifiers: noexport, editconst


LastPressY

Type: int

Modifiers: noexport, editconst

Last position of mouse press

LastSelected

Type: int

Modifiers: noexport, editconst

Last selected item

Default value: -1

LinkedObjects

Type: array<GUIComponent>

Modifiers: noexport, editconstarray


MightRemove

Type: int

Modifiers: noexport, editconst

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

Default value: -1

MyScrollBar

Type: GUIScrollBarBase

Modifiers: noexport


SectionJustification

Type: GUI.eTextAlign


SelectedBKColor

Type: Object.Color

Color for a selection background

Default value:

Member Value
A 255
B 200
G 255
R 255

SelectedImage

Type: Material

Image to use when displaying

SelectedItems

Type: array<int>

Modifiers: noexport, editconst


Top

Type: int

Modifiers: noexport, editconst


Property group 'Style'

OutlineStyle

Type: GUIStyles

Modifiers: noexport

Used for outlining a pending drag-n-drop

OutlineStyleName

Type: string


Default value: "ItemOutline"

SectionStyle

Type: GUIStyles

Modifiers: noexport


SectionStyleName

Type: string

Name of the style to use for header items

Default value: "ListSection"

SelectedStyle

Type: GUIStyles

Modifiers: noexport


SelectedStyleName

Type: string

Name of the style to use for the selected item

Default value: "ListSelection"

Default values

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

CheckLinkedObjects

delegate CheckLinkedObjects (GUIListBase List)


OnAdjustTop

delegate OnAdjustTop (GUIComponent Sender)


OnDrawItem

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


OnScrollBy

delegate OnScrollBy (GUIComponent Sender)


OnTrack

delegate OnTrack (GUIComponent Sender, int LastIndex)


Functions

Events

AdditionalDebugString

event string AdditionalDebugString ()

Overrides: GUIComponent.AdditionalDebugString


CalculateIndex

event int CalculateIndex (optional bool bRequireValidIndex)


InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIComponent.InitComponent


IsMultiSelect

event bool IsMultiSelect ()

Overrides: GUIComponent.IsMultiSelect


Other instance functions

See GUIListBase instance functions.