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

UTGame.UTUIStatsList

Extends
UIScrollFrame
Modifiers
placeable native ( UIFrontEnd ) implements ( UIDataStoreSubscriber )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Stats widget, auto generates labels for all of the fields in the bound datasource.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UIScrollFrame
               |   
               +-- UTGame.UTUIStatsList

Variables Summary
UIListElementProviderDataProvider
array<GeneratedStatisticInfo>GeneratedObjects
Data
UIDataStoreBindingDataSource
Inherited Variables from Engine.UIScrollFrame
bRecalculateClientRegion, bRefreshScrollbars, ClientRegionPosition, FrameBounds[EUIWidgetFace.UIFACE_MAX], HorizontalClientRegion, ScrollbarHorizontal, ScrollbarVertical, StaticBackgroundImage, VerticalClientRegion
Inherited Variables from Engine.UIContainer
AutoAlignment

Structures Summary
GeneratedStatisticInfo
DataTag, KeyObj, ValueObj

Functions Summary
function ClearBoundDataStores ()
function GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
functionstring GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
function NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
event PostInitialize ()))
functionbool RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
function RegenerateOptions ()
function RepositionOptions ()
function SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
function SetStatsIndex (int ResultIdx)
Inherited Functions from Engine.UIScrollFrame
AddedChild, GetClientRegionPosition, GetClientRegionPositionVector, GetClientRegionSize, GetClientRegionSizeVector, GetClipRegion, GetVisibleRegionPercentage, OnApplyScrolling, OnChildRepositioned, ReapplyFormatting, RefreshScrollbars, RemovedChild, ScrollRegion, ScrollZoneClicked, SetClientRegionPosition, SetClientRegionPositionVector


Variables Detail

DataProvider Source code

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

GeneratedObjects Source code

var transient array<GeneratedStatisticInfo> GeneratedObjects;
List of auto-generated objects, anything in this array will be removed from the children's array before presave.

Data

DataSource Source code

var(Data) UIDataStoreBinding DataSource;
The data store that this list is bound to


Structures Detail

GeneratedStatisticInfo Source code

struct GeneratedStatisticInfo
{
var name DataTag;
var UILabel KeyObj;
var UILabel ValueObj;
};
Info about an option we have generated.


Functions Detail

ClearBoundDataStores Source code

native final virtual function ClearBoundDataStores ( )
Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores Source code

native final virtual function GetBoundDataStores ( out array<UIDataStore> out_BoundDataStores )
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

native final virtual const function string GetDataStoreBinding ( optional int BindingIndex=INDEX_NONE ) con )
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:

NotifyDataStoreValueUpdated Source code

native function NotifyDataStoreValueUpdated ( UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex )
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.

PostInitialize Source code

event PostInitialize ( ) )
Post initialize, binds callbacks for all of the generated options.

RefreshSubscriberValue Source code

native final virtual function bool RefreshSubscriberValue ( optional int BindingIndex=INDEX_NONE )
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.

RegenerateOptions Source code

native function RegenerateOptions ( )
Generates widgets for all of the options.

RepositionOptions Source code

native function RepositionOptions ( )
Repositions all of the visible options.

SetDataStoreBinding Source code

native final virtual function SetDataStoreBinding ( string MarkupText, optional int BindingIndex=INDEX_NONE )
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.

SetStatsIndex Source code

native function SetStatsIndex ( int ResultIdx )
Sets which result row to get stats values from and then retrieves the stats values.


Defaultproperties

defaultproperties
{
   DataSource=(RequiredFieldType=DATATYPE_Collection)
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIScrollFrame:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIScrollFrame:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIStatsList"
   ObjectArchetype=UIScrollFrame'Engine.Default__UIScrollFrame'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:59.506 - Created with UnCodeX