Engine.UIDataProvider

Extends

UIRoot

Modifiers

native ( UIPrivate ) transient abstract

Base class for all classes which provide data stores with data about specific instances of a particular data type. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider

Direct Known Subclasses:

UIConfigProvider, UIDataProvider_OnlinePlayerDataBase, UIDataProvider_OnlineProfileSettingsArray, UIDataProvider_SettingsArray, UIDataStore, UIDynamicFieldProvider, UIPropertyDataProvider, UTUIDataProvider_Character, UTUIDataProvider_CharacterFaction, UTUIDataProvider_CharacterPart, UTUIDataProvider_SimpleElementProvider

Delegates Summary
		OnDataProviderPropertyChange (UIDataProvider SourceProvider, optional name PropTag)

Functions Summary
		AddPropertyNotificationChangeRequest (delegate<OnDataProviderPropertyChange> InDelegate))
	string	GenerateFillerData (string DataTag)
	string	GenerateScriptMarkupString (Name DataTag)
	bool	GetFieldValue (string FieldName, out UIProviderScriptFieldValue FieldValue, optional int ArrayIndex=INDEX_NONE)
		GetSupportedScriptFields (out array<UIDataProviderField> out_Fields)
		NotifyPropertyChanged (optional name PropTag))
		RemovePropertyNotificationChangeRequest (delegate<OnDataProviderPropertyChange> InDelegate))
	bool	SetFieldValue (string FieldName, const out UIProviderScriptFieldValue FieldValue, optional int ArrayIndex=INDEX_NONE)

ProviderChangedNotifies Source code

The list of delegates to call when data exposed by this provider has been updated. @todo - change into a map of property name => delegate, so that when a property name is passed to NotifyPropertyChanged, only those delegates are called.

WriteAccessType Source code

Determines whether/how subscribers to this data store are allowed to publish changes to property values.

EProviderAccessType Source code

Types of write access that data providers can specify.

UIDataProviderField Source code

Contains data about a single data field exposed by this data provider.
FieldProviders:

The list of providers associated with this field. Only relevant if FieldType is DATATYPE_Provider or DATATYPE_ProviderCollection. If FieldType is DATATYPE_Provider, the list should contain only one element.

FieldTag:

the tag used to access this field

FieldType:

the type of field this tag corresponds to

OnDataProviderPropertyChange Source code

Delegate that notifies that a property has changed Intended only for use between data providers and their owning data stores. For external notifications, use the callbacks in UIDataStore instead.
@param SourceProvider the data provider that generated the notification
@param PropTag the property that changed

AddPropertyNotificationChangeRequest Source code

Subscribes a function for receiving notifications that a property in this data provider has changed. Intended only for use between data providers and their owning data stores. For external notifications, use the callbacks in UIDataStore instead.
@param InDelegate the delegate to add to the notification list

GenerateFillerData Source code

Callback to allow script-only child classes to return filler data for their own data fields.
@param DataTag the tag corresponding to the data field that we want filler data for
@return a string of made-up data which is indicative of the typical values for the specified field.

GenerateScriptMarkupString Source code

Callback to allow script-only child classes to generate a markup string for their own data fields. Called from the native implementation of GenerateDataMarkupString if the tag specified doesn't correspond to any tags in the data store.
@param DataTag the data field tag to generate the markup string for
@return a datastore markup string which resolves to the datastore field associated with DataTag, in the format:

GetFieldValue Source code

Resolves the value of the data field specified and stores it in the output parameter.
@param FieldName the data field to resolve the value for; guaranteed to correspond to a property that this provider can resolve the value for (i.e. not a tag corresponding to an internal provider, etc.)
@param out_FieldValue receives the resolved value for the property specified.
@see ParseDataStoreReference for additional notes
@param ArrayIndex optional array index for use with data collections
@return TRUE to indicate that this value was processed by script.

GetSupportedScriptFields Source code

Callback to allow script-only child classes to add their own supported tags when GetSupportedDataFields is called.
@param out_Fields the list of data tags supported by this data store.

NotifyPropertyChanged Source code

Iterates over the list of subscribed delegates and fires off the event. Called whenever the value of a field managed by this data provider is modified.
@param PropTag the name of the property that changed

RemovePropertyNotificationChangeRequest Source code

Removes the delegate from the notification list
@param InDelegate the delegate to remove from the list

SetFieldValue Source code

Resolves the value of the data field specified and stores the value specified to the appropriate location for that field.
@param FieldName the data field to resolve the value for; guaranteed to correspond to a property that this provider can resolve the value for (i.e. not a tag corresponding to an internal provider, etc.)
@param FieldValue the value to store for the property specified.
@param ArrayIndex optional array index for use with data collections
@return TRUE to indicate that this value was processed by script.

defaultproperties
{
   Name="Default__UIDataProvider"
   ObjectArchetype=UIRoot'Engine.Default__UIRoot'
}