Difference between revisions of "UE3:UIImage (UDK)"

Revision as of 05:24, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 05:50, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 6))
(No difference)

---

Latest revision as of 05:50, 17 January 2010

Package: 

Engine

Implemented interfaces: 

UIDataStorePublisher

This class in other games:

UT3

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

A simple widget for displaying images in the UI.

Properties[edit]

Property group 'Components'[edit]

ImageComponent[edit]

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the actual image

Default value: UIComp_DrawImage'ImageComponentTemplate'

Property group 'Data'[edit]

ImageDataSource[edit]

Type: UIRoot.UIDataStoreBinding

Modifiers: private

the data store that this image retrieves its value from

Default values[edit]

Property	Value
bSupportsPrimaryStyle	False
Position	Member Value ScaleType[2] EVALPOS_PixelOwner ScaleType[3] EVALPOS_PixelOwner Value[2] 50.0 Value[3] 50.0
PrimaryStyle	Member Value DefaultStyleTag 'DefaultImageStyle' RequiredStyleClass Class'Engine.UIStyle_Image'

Subobjects[edit]

ImageComponentTemplate[edit]

Class: Engine.UIComp_DrawImage

No new values.

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

Functions[edit]

Native functions[edit]

ClearBoundDataStores[edit]

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores[edit]

Specified by: UIDataStoreSubscriber.GetBoundDataStores

Retrieves the list of data stores bound by this subscriber.

Parameters:

• out_BoundDataStores - receives the array of data stores that subscriber is bound to.

GetDataStoreBinding[edit]

Specified by: UIDataStoreSubscriber.GetDataStoreBinding

Retrieves the markup string corresponding to the data store that this object is bound to.

Parameters:

• 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.

Returns:

a datastore markup string which resolves to the datastore field that this object is bound to, in the format: <DataStoreTag:DataFieldTag>

NotifyDataStoreValueUpdated[edit]

Specified by: UIDataStoreSubscriber.NotifyDataStoreValueUpdated

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.

Parameters:

• 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.
• 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.
• SourceProvider - for data stores which contain nested providers, the provider that contains the data which changed.
• ArrayIndex - for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

RefreshSubscriberValue[edit]

Specified by: UIDataStoreSubscriber.RefreshSubscriberValue

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.

Returns:

TRUE if this subscriber successfully resolved and applied the updated value.

SaveSubscriberValue[edit]

Specified by: UIDataStorePublisher.SaveSubscriberValue

Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store.

Parameters:

• 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.
• 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.

Returns:

TRUE if the value was successfully published to the data store.

SetDataStoreBinding[edit]

Specified by: UIDataStoreSubscriber.SetDataStoreBinding

Sets the data store binding for this object to the text specified.

Parameters:

• MarkupText - a markup string which resolves to data exposed by a data store. The expected format is: <DataStoreTag:DataFieldTag>
• 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.

Other instance functions[edit]

SetValue[edit]

Changes this UIImage's Image to the specified surface, creating a wrapper for the surface (if necessary) and applies the current ImageStyle to the new wrapper.

Parameters:

• NewImage - the new surface to use for this UIImage