There is no spoon
UE3:UIOptionList (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIOptionListBase >> UIOptionList |
Contents
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Copyright 2006-2007 Epic Games, Inc. All Rights Reserved.
Option widget that works similar to a read only combobox.
Properties[edit]
CurrentIndex[edit]
Type: int
Modifiers: transient
Current index in the datastore
DataProvider[edit]
Type: UIListElementProvider
Modifiers: transient, const
the list element provider referenced by DataSource
Default values[edit]
| Property | Value |
|---|---|
| Children[0] | UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate' |
| Children[1] | UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate' |
| DecrementButton | UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate' |
| IncrementButton | UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate' |
Subobjects[edit]
BackgroundImageTemplate[edit]
Class: Engine.UIComp_DrawImage
Inherits from: UIOptionListBase.BackgroundImageTemplate
No new values.
LabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
Inherits from: UIOptionListBase.LabelStringRenderer
No new values.
WidgetEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UIOptionListBase.WidgetEventComponent
No new values.
Functions[edit]
Native functions[edit]
GetCurrentIndex[edit]
native function int GetCurrentIndex () const
Returns:
- Returns the current index of the optionbutton.
GetListValue[edit]
Parameters:
- ListIndex - List index to get the value of.
- OutValue - Storage string for the list value
Returns:
- Returns TRUE if we were able to get a value, FALSE otherwise
SetCurrentIndex[edit]
native function SetCurrentIndex (int NewIndex)
Sets a new index for the option button.
Parameters:
- NewIndex - New index for the option button.
SetNextValue[edit]
native function SetNextValue ()
Increments the widget to the next value
SetPrevValue[edit]
native function SetPrevValue ()
Decrements the widget to the previous value
Other instance functions[edit]
OnSetListIndex[edit]
protected final function OnSetListIndex (UIAction_SetListIndex Action)
