Engine.UISlider

Extends

UIObject

Modifiers

native ( UIPrivate ) implements ( UIDataStorePublisher )

This widget presents the user with an interface for choosing a value within a certain range. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. @todo - make rendering the caption optional @todo - hook up data store resolution

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

Direct Known Subclasses:

UTUISlider

Functions Summary
		ClearBoundDataStores ()
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	float	GetValue (optional bool bPercentageValue ) con)
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SetBackgroundImage (Surface NewImage ))
		SetBarImage (Surface NewImage ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetMarkerImage (Surface NewImage ))
	bool	SetValue (coerce float NewValue, optional bool bPercentageValue)

Data

CaptionRenderComponent Source code

Renders the caption for this slider

DataSource Source code

The data source that this slider's value will be linked to.

Image

BackgroundImageComponent Source code

Component for rendering the slider background image

MarkerImageComponent Source code

Component for rendering the slider marker image

SliderBarImageComponent Source code

Component for rendering the slider bar image

Slider

BarSize Source code

Controls the size of the slider's bar. If slider is horizontal, controls the height of the bar; if slider is vertical, controls the width of the bar

bRenderCaption Source code

Controls whether the caption is rendered above the slider marker

MarkerHeight Source code

@fixme - temp....the size of the region to use for rendering the marker

MarkerWidth Source code

@fixme - temp....the size of the region to use for rendering the marker

SliderOrientation Source code

Controls whether this slider is vertical or horizontal not fully implemented

SliderValue Source code

The value and range parameters for this slider.

Sound

DecrementCue Source code

this sound is played when the slider is decremented

IncrementCue Source code

this sound is played when the slider is incremented

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.

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:

GetValue Source code

Gets the current value of this slider
@param bPercentageValue TRUE to format the result as a percentage of the total range of this slider.

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.

OnStateChanged Source code

Called when a new UIState becomes the widget's currently active state, after all activation logic has occurred.
@param Sender the widget that changed states.
@param PlayerIndex the index [into the GamePlayers array] for the player that activated this state.
@param NewlyActiveState the state that is now active
@param PreviouslyActiveState the state that used the be the widget's currently active state.

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.

SetBackgroundImage Source code

Changes the background image for this slider, creating the wrapper UITexture if necessary.
@param NewBarImage the new surface to use for the slider's background image

SetBarImage Source code

Changes the bar image for this slider, creating the wrapper UITexture if necessary.
@param NewBarImage the new surface to use for the slider's bar image

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.

SetMarkerImage Source code

Changes the marker image for this slider, creating the wrapper UITexture if necessary.
@param NewImage the new surface to use for slider's marker

SetValue Source code

Change the value of this slider at runtime.
@param NewValue the new value for the slider.
@param bPercentageValue TRUE indicates that the new value is formatted as a percentage of the total range of this slider.
@return TRUE if the slider's value was changed

defaultproperties
{
   Begin Object Class=UIComp_DrawImage Name=SliderBackgroundImageTemplate ObjName=SliderBackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Slider Background Style"
      ImageStyle=(DefaultStyleTag="DefaultSliderStyle")
      Name="SliderBackgroundImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent=SliderBackgroundImageTemplate
   Begin Object Class=UIComp_DrawImage Name=SliderBarImageTemplate ObjName=SliderBarImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Slider Bar Style"
      ImageStyle=(DefaultStyleTag="DefaultSliderBarStyle")
      Name="SliderBarImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   SliderBarImageComponent=SliderBarImageTemplate
   Begin Object Class=UIComp_DrawImage Name=SliderMarkerImageTemplate ObjName=SliderMarkerImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Slider Marker Style"
      ImageStyle=(DefaultStyleTag="DefaultSliderMarkerStyle")
      Name="SliderMarkerImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   MarkerImageComponent=SliderMarkerImageTemplate
   DataSource=(RequiredFieldType=DATATYPE_RangeProperty)
   SliderValue=(MaxValue=100.000000,NudgeValue=1.000000)
   bRenderCaption=True
   BarSize=(Value=32.000000)
   MarkerHeight=(Value=16.000000,Orientation=UIORIENT_Vertical)
   MarkerWidth=(Value=16.000000)
   IncrementCue="SliderIncrement"
   DecrementCue="SliderDecrement"
   PrimaryStyle=(DefaultStyleTag="DefaultSliderStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   bSupportsPrimaryStyle=False
   Position=(Value[3]=32.000000,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'Engine.Default__UIObject:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UISlider"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}