Engine.UIProgressBar

Extends

UIObject

Modifiers

native ( UIPrivate ) implements ( UIDataStorePublisher )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

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

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)
		OnGetProgressBarValue (UIAction_GetProgressBarValue Action ))
		OnSetProgressBarValue (UIAction_SetProgressBarValue Action ))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
	bool	SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE)
		SetBackgroundImage (Surface NewImage ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetFillImage (Surface NewImage ))
		SetOverlayImage (Surface NewImage ))
	bool	SetValue (coerce float NewValue, optional bool bPercentageValue)

Data

DataSource Source code

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

Image

BackgroundImageComponent Source code

Component for rendering the background image

bDrawOverlay Source code

specifies whether to draw the overlay texture or not

FillImageComponent Source code

Component for rendering the fill image

OverlayImageComponent Source code

Component for rendering the overlay image

ProgressBar

ProgressBarOrientation Source code

Controls whether this progressbar is vertical or horizontal

ProgressBarValue Source code

The value and range parameters for this progressbar.

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 progressbar
@param bPercentageValue TRUE to format the result as a percentage of the total range of this progressbar.

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.

OnGetProgressBarValue Source code

OnSetProgressBarValue Source code

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 progressbar, creating the wrapper UITexture if necessary.
@param NewBarImage the new surface to use for the progressbar's background 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.

SetFillImage Source code

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

SetOverlayImage Source code

Changes the overlay image for this progressbar, creating the wrapper UITexture if necessary.
@param NewOverlayImage the new surface to use for the progressbar's overlay image

SetValue Source code

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

defaultproperties
{
   Begin Object Class=UIComp_DrawImage Name=ProgressBarBackgroundImageTemplate ObjName=ProgressBarBackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style"
      ImageStyle=(DefaultStyleTag="DefaultSliderStyle")
      Name="ProgressBarBackgroundImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent=ProgressBarBackgroundImageTemplate
   Begin Object Class=UIComp_DrawImage Name=ProgressBarFillImageTemplate ObjName=ProgressBarFillImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Fill Image Style"
      ImageStyle=(DefaultStyleTag="DefaultSliderBarStyle")
      Name="ProgressBarFillImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   FillImageComponent=ProgressBarFillImageTemplate
   Begin Object Class=UIComp_DrawImage Name=ProgressBarOverlayImageTemplate ObjName=ProgressBarOverlayImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Overlay Image Style"
      Name="ProgressBarOverlayImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   OverlayImageComponent=ProgressBarOverlayImageTemplate
   DataSource=(RequiredFieldType=DATATYPE_RangeProperty)
   ProgressBarValue=(CurrentValue=33.000000,MaxValue=100.000000,NudgeValue=1.000000)
   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__UIProgressBar"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}