Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIOptionList

Extends
UIOptionListBase
Modifiers
native ( UIPrivate ) placeable

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Option widget that works similar to a read only combobox. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIOptionListBase
            |   
            +-- Engine.UIOptionList
Constants Summary
Inherited Contants from Engine.UIOptionListBase
UIKEY_MoveCursorLeft, UIKEY_MoveCursorRight
Inherited Contants from Engine.UIObject
CONTEXTMENU_BINDING_INDEX, FIRST_DEFAULT_DATABINDING_INDEX, TOOLTIP_BINDING_INDEX

Variables Summary
intCurrentIndex
UIListElementProviderDataProvider
Inherited Variables from Engine.UIOptionListBase
BackgroundImageComponent, ButtonSpacing, bWrapOptions, DataSource, DecrementButton, DecrementCue, DecrementStyle, IncrementButton, IncrementCue, IncrementStyle, OptionListButtonClass, StringRenderComponent
Inherited Variables from Engine.UIObject
AnimationParent, AnimationPosition, AnimStack, bDebugShowBounds, bEnableActiveCursorUpdates, bSupportsPrimaryStyle, ContextMenuData, DebugBoundsColor, DockTargets, NavigationTargets, Owner, OwnerScene, PrimaryStyle, PrivateFlags, RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX], RenderBounds[EUIWidgetFace.UIFACE_MAX], RenderOffset, Rotation, StyleSubscribers, TabIndex, ToolTip, WidgetID, WidgetTag

Functions Summary
functionint GetCurrentIndex () con)
functionbool GetListValue (int ListIndex, out string OutValue)
function OnSetListIndex (UIAction_SetListIndex Action ))
function SetCurrentIndex (int NewIndex)
function SetNextValue ()
function SetPrevValue ()
Inherited Functions from Engine.UIOptionListBase
ClearBoundDataStores, Created, GetBoundDataStores, GetDataStoreBinding, HasNextValue, HasPrevValue, Initialized, InitializeInternalControls, NotifyDataStoreValueUpdated, OnButtonClicked, OnMoveSelectionLeft, OnMoveSelectionRight, RefreshSubscriberValue, SaveSubscriberValue, SetDataStoreBinding
Inherited Functions from Engine.UIObject
AddStyleSubscriber, AnimSetBottom, AnimSetColor, AnimSetLeft, AnimSetOpacity, AnimSetPosition, AnimSetRelPosition, AnimSetRight, AnimSetRotation, AnimSetScale, AnimSetTop, AnimSetVisibility, CanAcceptFocus, ClearDefaultDataBinding, ClearUIAnimation, FindStyleSubscriberIndex, FindStyleSubscriberIndexById, GenerateSceneDataStoreMarkup, GenerateTransformMatrix, GetAnchorPosition, GetDefaultDataBinding, GetDefaultDataStores, GetOwner, GetParent, GetPositionExtent, GetPositionExtents, GetRotationMatrix, GetScene, GetToolTipValue, HasTransform, IsContainedBy, IsDockedTo, IsPrivateBehaviorSet, LogRenderBounds, NeedsActiveCursorUpdates, NotifyValueChanged, OnSetDatastoreBinding, PlayUIAnimation, RemoveStyleSubscriber, ResolveDefaultDataBinding, ResolveStyles, RotateWidget, SetActiveCursorUpdate, SetAnchorPosition, SetDefaultDataBinding, SetDockPadding, SetDockParameters, SetDockTarget, SetForcedNavigationTarget, SetNavigationTarget, SetPrivateBehavior, SetWidgetStyleByName, StopUIAnimation, TickAnim, UIAnimEnd, UpdateRotationMatrix

Variables Detail

CurrentIndex Source code

var transient int CurrentIndex;
Current index in the datastore

DataProvider Source code

var transient const UIListElementProvider DataProvider;
the list element provider referenced by DataSource

Functions Detail

GetCurrentIndex Source code

native const function int GetCurrentIndex ( ) con )

@return Returns the current index of the optionbutton.

GetListValue Source code

native final function bool GetListValue ( int ListIndex, out string OutValue )

@param ListIndex List index to get the value of.
@param OutValue Storage string for the list value
@return Returns TRUE if we were able to get a value, FALSE otherwise

OnSetListIndex Source code

protected final function OnSetListIndex ( UIAction_SetListIndex Action ) )

SetCurrentIndex Source code

native function SetCurrentIndex ( int NewIndex )
Sets a new index for the option button.
@param NewIndex New index for the option button.

SetNextValue Source code

native function SetNextValue ( )
Increments the widget to the next value

SetPrevValue Source code

native function SetPrevValue ( )
Decrements the widget to the previous value

Defaultproperties 

defaultproperties
{
   DecrementButton=UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate'
   IncrementButton=UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate'
   Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIOptionListBase:BackgroundImageTemplate'
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIOptionListBase:BackgroundImageTemplate'
   End Object
   BackgroundImageComponent=BackgroundImageTemplate
   Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UIOptionListBase:LabelStringRenderer'
      ObjectArchetype=UIComp_DrawString'Engine.Default__UIOptionListBase:LabelStringRenderer'
   End Object
   StringRenderComponent=LabelStringRenderer
   Children(0)=UIOptionListButton'Engine.Default__UIOptionList:DecrementButtonTemplate'
   Children(1)=UIOptionListButton'Engine.Default__UIOptionList:IncrementButtonTemplate'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIOptionListBase:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIOptionListBase:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIOptionList"
   ObjectArchetype=UIOptionListBase'Engine.Default__UIOptionListBase'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:47.502 - Created with UnCodeX