Cogito, ergo sum
Difference between revisions of "UE3:UILabel (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 6)) |
(No difference)
| |
Latest revision as of 06:50, 17 January 2010
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UILabel |
- Package:
- Engine
- Implemented interfaces:
- UIDataStoreSubscriber, UIStringRenderer
- Direct subclass:
- UIFocusHint
- 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 text in the UI.
Properties[edit]
Property group 'Components'[edit]
LabelBackground[edit]
Type: UIComp_DrawImage
Modifiers: editinline, const
Optional component for rendering a background image for this UILabel
StringRenderComponent[edit]
Type: UIComp_DrawString
Modifiers: editinline, const, noclear
Renders the text displayed by this label
Default value: UIComp_DrawString'LabelStringRenderer'
Property group 'Data'[edit]
DataSource[edit]
Type: UIRoot.UIDataStoreBinding
Modifiers: private
the text that will be rendered by this label
Default value:
| Member | Value |
|---|---|
| MarkupString | "Initial Label Text" |
Default values[edit]
| Property | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| bSupportsPrimaryStyle | False | ||||||||||
| Position |
|
||||||||||
| PrimaryStyle |
|
Subobjects[edit]
LabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
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.
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.
SetTextAlignment[edit]
Specified by: UIStringRenderer.SetTextAlignment
Sets the text alignment for the string that the widget is rendering.
Parameters:
- Horizontal - Horizontal alignment to use for text, UIALIGN_MAX means no change.
- Vertical - Vertical alignment to use for text, UIALIGN_MAX means no change.
SetValue[edit]
Change the value of this label at runtime.
Parameters:
- NewText - the new text that should be displayed in the label
Other instance functions[edit]
GetValue[edit]
Retrieve the value of this label
IgnoreMarkup[edit]
Changes whether this label's string should process markup
Parameters:
- bShouldIgnoreMarkup - if TRUE, markup will not be processed by this label's string
Note: does not update any existing text contained by the label.
