UTGame.UTUIOptionButton

Extends

UTUI_Widget

Modifiers

native ( UI ) placeable implements ( UIDataStorePublisher )

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
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTUIOptionButton

Functions Summary
		ClearBoundDataStores ()
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	int	GetCurrentIndex ()
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	bool	HasNextValue ()
	bool	HasPrevValue ()
		Initialized ()))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
	bool	OnArrowLeft_Clicked (UIScreenObject InButton, int PlayerIndex))
	bool	OnArrowRight_Clicked (UIScreenObject InButton, int PlayerIndex))
		OnMoveSelectionLeft (int PlayerIndex))
		OnMoveSelectionRight (int PlayerIndex))
		PostInitialize ()))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SetCurrentIndex (INT NewIndex)
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetNextValue ()
		SetPrevValue ()
		VerifyArrowButtons ()))

UIKEY_MoveCursorLeft Source code

UI Key Action Events

UIKEY_MoveCursorRight Source code

ArrowLeftButton Source code

Left and right arrow buttons for this widget.

ArrowRightButton Source code

CurrentIndex Source code

Profile settings current index.

DataProvider Source code

the list element provider referenced by DataSource

DecrementStyle Source code

IncrementStyle Source code

The styles used for the increment, decrement and marker buttons

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 button 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

UTUIOptionButton

bCustomPlacement Source code

If true, this widget won't attempt to align it's children

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.

EOptionButtonArrow Source code

Arrow enums.

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

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.

GetCurrentIndex Source code

@return Returns the current index of the optionbutton.

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 CurrentIndex is at the start of the ValueMappings array, FALSE otherwise.

HasPrevValue Source code

@return TRUE if the CurrentIndex is at the start of the ValueMappings array, FALSE otherwise.

Initialized Source code

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.

OnArrowLeft_Clicked Source code

Arrow left clicked callback.

OnArrowRight_Clicked Source code

Arrow right clicked callback.

OnMoveSelectionLeft Source code

Moves the current selection to the left.

OnMoveSelectionRight Source code

Moves the current selection to the right.

PostInitialize Source code

Called after the widget is done initializing.

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.

SetCurrentIndex Source code

Sets a new index for the option button.
@param NewIndex New index for the option button.

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.

SetNextValue Source code

Moves the current index forward by 1 in the valuemappings array if it isn't already at the end of the array.

SetPrevValue Source code

Moves the current index back by 1 in the valuemappings array if it isn't already at the front of the array.

VerifyArrowButtons Source code

defaultproperties
{
   Begin Object Class=UIButton Name=LeftArrowButtonTemplate ObjName=LeftArrowButtonTemplate Archetype=UIButton'Engine.Default__UIButton'
      Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent'
      End Object
      WidgetTag="butArrowLeft"
      TabIndex=0
      PrivateFlags=2087
      Position=(Value[0]=0.603122,Value[1]=0.125000,Value[2]=0.209372,Value[3]=0.750006)
      Name="LeftArrowButtonTemplate"
      ObjectArchetype=UIButton'Engine.Default__UIButton'
   End Object
   ArrowLeftButton=UIButton'UTGame.Default__UTUIOptionButton:LeftArrowButtonTemplate'
   Begin Object Class=UIButton Name=RightArrowButtonTemplate ObjName=RightArrowButtonTemplate Archetype=UIButton'Engine.Default__UIButton'
      Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent'
      End Object
      WidgetTag="butArrowRight"
      TabIndex=1
      PrivateFlags=2087
      Position=(Value[0]=0.790628,Value[1]=0.125000,Value[2]=0.209372,Value[3]=0.750000)
      Name="RightArrowButtonTemplate"
      ObjectArchetype=UIButton'Engine.Default__UIButton'
   End Object
   ArrowRightButton=UIButton'UTGame.Default__UTUIOptionButton:RightArrowButtonTemplate'
   IncrementStyle=(DefaultStyleTag="DefaultOptionButtonRightArrowStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   DecrementStyle=(DefaultStyleTag="DefaultOptionButtonLeftArrowStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   ButtonSpacing=(ScaleType=EVALPOS_PixelOwner)
   Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style"
      ImageStyle=(DefaultStyleTag="OptionButtonBackground")
      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="DefaultOptionButtonStyle")
      Name="LabelStringRenderer"
      ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
   End Object
   StringRenderComponent=LabelStringRenderer
   IncrementCue="SliderIncrement"
   DecrementCue="SliderDecrement"
   bWrapOptions=True
   DataSource=(RequiredFieldType=DATATYPE_Collection)
   Position=(Value[2]=256.000000,Value[3]=32.000000,ScaleType[2]=EVALPOS_PixelOwner,ScaleType[3]=EVALPOS_PixelOwner)
   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'UTGame.Default__UTUI_Widget:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUI_Widget:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIOptionButton"
   ObjectArchetype=UTUI_Widget'UTGame.Default__UTUI_Widget'
}