My program doesn't have bugs. It just develops random features.

UE2:GUIListBase (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIListBase

Contents

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

[edit] Properties

[edit] Property group 'GUIListBase'

[edit] bAllowEmptyItems

Type: bool


[edit] bDrawSelectionBorder

Type: bool

Should we draw a selection border around the selected item

Default value: True

[edit] bHotTrack

Type: bool

Use the Mouse X/Y to always hightlight something

[edit] bHotTrackSound

Type: bool

Whether to make the mouse over sound when hottracking

Default value: True

[edit] bInitializeList

Type: bool

If true, set index to 0 when adding first item

Default value: True

[edit] bMultiSelect

Type: bool

allow multiple selections (where implemented)

Default value: True

[edit] bNotify

Type: bool

Used to abort OnChange notification in list

Default value: True

[edit] bSorted

Type: bool

Should we sort this list

[edit] bVisibleWhenEmpty

Type: bool

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

[edit] DropIndex

Type: int

Modifiers: noexport, editconst

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

Default value: -1

[edit] Index

Type: int

Modifiers: noexport, editconst

Pointers in to the list

Default value: -1

[edit] ItemCount

Type: int

Modifiers: noexport, editconst


[edit] ItemHeight

Type: float

Modifiers: noexport, editconst, const

Size of each row. Subclass should set in PreDraw.

[edit] ItemsPerPage

Type: int

Modifiers: noexport, editconst, const

  1. of items per Page. Is set natively

[edit] ItemWidth

Type: float

Modifiers: noexport, editconst, const

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

[edit] LastPressX

Type: int

Modifiers: noexport, editconst


[edit] LastPressY

Type: int

Modifiers: noexport, editconst

Last position of mouse press

[edit] LastSelected

Type: int

Modifiers: noexport, editconst

Last selected item

Default value: -1

[edit] LinkedObjects

Type: array<GUIComponent>

Modifiers: noexport, editconstarray


[edit] MightRemove

Type: int

Modifiers: noexport, editconst

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

Default value: -1

[edit] MyScrollBar

Type: GUIScrollBarBase

Modifiers: noexport


[edit] SectionJustification

Type: GUI.eTextAlign


[edit] SelectedBKColor

Type: Object.Color

Color for a selection background

Default value:

Member Value
A 255
B 200
G 255
R 255

[edit] SelectedImage

Type: Material

Image to use when displaying

[edit] SelectedItems

Type: array<int>

Modifiers: noexport, editconst


[edit] Top

Type: int

Modifiers: noexport, editconst


[edit] Property group 'Style'

[edit] OutlineStyle

Type: GUIStyles

Modifiers: noexport

Used for outlining a pending drag-n-drop

[edit] OutlineStyleName

Type: string


Default value: "ItemOutline"

[edit] SectionStyle

Type: GUIStyles

Modifiers: noexport


[edit] SectionStyleName

Type: string

Name of the style to use for header items

Default value: "ListSection"

[edit] SelectedStyle

Type: GUIStyles

Modifiers: noexport


[edit] SelectedStyleName

Type: string

Name of the style to use for the selected item

Default value: "ListSelection"

[edit] 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"

[edit] Delegates

[edit] CheckLinkedObjects

delegate CheckLinkedObjects (GUIListBase List)


[edit] OnAdjustTop

delegate OnAdjustTop (GUIComponent Sender)


[edit] OnDrawItem

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


[edit] OnScrollBy

delegate OnScrollBy (GUIComponent Sender)


[edit] OnTrack

delegate OnTrack (GUIComponent Sender, int LastIndex)


[edit] Functions

[edit] Events

[edit] AdditionalDebugString

event string AdditionalDebugString ()

Overrides: GUIComponent.AdditionalDebugString


[edit] CalculateIndex

event int CalculateIndex (optional bool bRequireValidIndex)


[edit] InitComponent

event InitComponent (GUIController MyController, GUIComponent MyOwner)

Overrides: GUIComponent.InitComponent


[edit] IsMultiSelect

event bool IsMultiSelect ()

Overrides: GUIComponent.IsMultiSelect


[edit] Other instance functions

See GUIListBase instance functions.

Personal tools