Engine.UIOptionListBase

Extends

UIObject

Modifiers

native ( UIPrivate ) notplaceable implements ( UIDataStorePublisher ) abstract

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Base class for a widget that wants to display a list of strings, one at a time, and to increment and decrement that list via buttons.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIOptionListBase

Direct Known Subclasses:

UINumericOptionList, UIOptionList

Delegates Summary
	UIOptionListButton	CreateCustomDecrementButton (UIOptionListBase ButtonOwner)
	UIOptionListButton	CreateCustomIncrementButton (UIOptionListBase ButtonOwner)

Functions Summary
		ClearBoundDataStores ()
		Created (UIObject CreatedWidget, UIScreenObject CreatorContainer ))
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	bool	HasNextValue () con)
	bool	HasPrevValue () con)
		Initialized ()))
		InitializeInternalControls ()))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
	bool	OnButtonClicked (UIScreenObject Sender, int PlayerIndex))
		OnMoveSelectionLeft (int PlayerIndex)
		OnMoveSelectionRight (int PlayerIndex)
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)

UIKEY_MoveCursorLeft Source code

UI Key Action Events

UIKEY_MoveCursorRight Source code

DecrementButton Source code

Increment and decrement buttons for this widget. @todo - need script accessors for safely replacing the Buttons with a new type, since the var is const

DecrementStyle Source code

The styles used for the increment, decrement buttons

IncrementButton Source code

IncrementStyle Source code

OptionListButtonClass Source code

The class to use for creating the buttons. If more control of the creation is necessary, or to use an existing button, subscribe to the CreateCustomComboButton delegate instead.

Data

DataSource Source code

The data store that this list is bound to

StringRenderComponent Source code

Renders the text displayed by this label

Image

BackgroundImageComponent Source code

Component for rendering the label's background image

Presentation

ButtonSpacing Source code

Spacing between buttons and text.

Sound

DecrementCue Source code

This sound is played when the index is decremented

IncrementCue Source code

This sound is played when the index is incremented

UIOptionListBase

bWrapOptions Source code

Whether we should wrap the options or not, meaning if the user hits the beginning or the end of the list, they will wrap to the other end of the list.

CreateCustomDecrementButton Source code

Provides a convenient way to override the creation of the OptionList's components. Called when this UIOptionList is first initialized.
@return if a custom component is desired, a pointer to a fully configured instance of the desired component class. You must use UIScreenObject.CreateWidget to create the widget instances. The returned instance will be inserted into the combo box's Children array and initialized.

CreateCustomIncrementButton Source code

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

Created Source code

Called when this widget is created
@param CreatedWidget the widget that was created
@param CreatorContainer the container that created the widget

GetBoundDataStores Source code

Retrieves the list of data stores bound by this subscriber.
@param out_BoundDataStores receives the array of data stores that subscriber is bound to.

GetDataStoreBinding Source code

Retrieves the markup string corresponding to the data store that this object is bound to.
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.
@return a datastore markup string which resolves to the datastore field that this object is bound to, in the format:

HasNextValue Source code

@return TRUE if the user is allowed to increment the value of this widget

HasPrevValue Source code

@return TRUE if the user is allowed to decrement the value of this widget

Initialized Source code

Called after the widget has been initialized, but before it's resolved its style or initialized its children

InitializeInternalControls Source code

Performs initialization for the increment and decrement buttons that cannot be handled in default properties.

NotifyDataStoreValueUpdated Source code

Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. notify subscribers when they should refresh their values from this data store.
@param SourceDataStore the data store that generated the refresh notification; useful for subscribers with multiple data store bindings, to tell which data store sent the notification.
@param PropertyTag the tag associated with the data field that was updated; Subscribers can use this tag to determine whether there is any need to refresh their data values.
@param SourceProvider for data stores which contain nested providers, the provider that contains the data which changed.
@param ArrayIndex for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

OnButtonClicked Source code

Handler for the Increment/Decrement button's Onclick delegate.

OnMoveSelectionLeft Source code

Moves the current selection to the left.

OnMoveSelectionRight Source code

Moves the current selection to the right.

RefreshSubscriberValue Source code

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.
@return TRUE if this subscriber successfully resolved and applied the updated value.

SaveSubscriberValue Source code

Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store.
@param out_BoundDataStores contains the array of data stores that widgets have saved values to. Each widget that implements this method should add its resolved data store to this array after data values have been published. Once SaveSubscriberValue has been called on all widgets in a scene, OnCommit will be called on all data stores in this array.
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.
@return TRUE if the value was successfully published to the data store.

SetDataStoreBinding Source code

Sets the data store binding for this object to the text specified.
@param MarkupText a markup string which resolves to data exposed by a data store. The expected format is:
@param BindingIndex optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

defaultproperties
{
   DecrementStyle=(DefaultStyleTag="DefaultIncrementButtonStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   IncrementStyle=(DefaultStyleTag="DefaultDecrementButtonStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   DecrementButton=UIOptionListButton'Engine.Default__UIOptionListBase:DecrementButtonTemplate'
   IncrementButton=UIOptionListButton'Engine.Default__UIOptionListBase:IncrementButtonTemplate'
   OptionListButtonClass=Class'Engine.UIOptionListButton'
   Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style"
      ImageStyle=(DefaultStyleTag="ButtonBackground")
      Name="BackgroundImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent=BackgroundImageTemplate
   Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
      StyleResolverTag="Caption Style"
      StringStyle=(DefaultStyleTag="DefaultLabelButtonStyle")
      Name="LabelStringRenderer"
      ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
   End Object
   StringRenderComponent=LabelStringRenderer
   IncrementCue="SliderIncrement"
   DecrementCue="SliderDecrement"
   DataSource=(RequiredFieldType=DATATYPE_Collection)
   PrivateFlags=1024
   bSupportsPrimaryStyle=False
   __OnCreate__Delegate=Default__UIOptionListBase.Created
   Position=(Value[2]=256.000000,Value[3]=32.000000,ScaleType[2]=EVALPOS_PixelOwner,ScaleType[3]=EVALPOS_PixelOwner)
   Children(0)=UIOptionListButton'Engine.Default__UIOptionListBase:DecrementButtonTemplate'
   Children(1)=UIOptionListButton'Engine.Default__UIOptionListBase:IncrementButtonTemplate'
   DefaultStates(2)=Class'Engine.UIState_Focused'
   DefaultStates(3)=Class'Engine.UIState_Active'
   DefaultStates(4)=Class'Engine.UIState_Pressed'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIOptionListBase"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}