Engine.UILabel

Extends

UIObject

Modifiers

native ( UIPrivate ) implements ( UIDataStoreSubscriber , UIStringRenderer )

A simple widget for displaying text in the UI. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

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

Direct Known Subclasses:

UIToolTip

Functions Summary
		ClearBoundDataStores ()
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	string	GetValue ()))
		IgnoreMarkup (bool bShouldIgnoreMarkup ))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnGetTextValue (UIAction_GetTextValue Action ))
		OnSetLabelText (UIAction_SetLabelText Action ))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
		SetArrayValue (array ValueArray ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetTextAlignment (EUIAlignment Horizontal, EUIAlignment Vertical)
		SetValue (string NewText)

Data

DataSource Source code

the text that will be rendered by this label

StringRenderComponent Source code

Renders the text displayed by this label

Image

LabelBackground Source code

Optional component for rendering a background image for this UILabel

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

Retrieve the value of this label

IgnoreMarkup Source code

Changes whether this label's string should process markup
@param bShouldIgnoreMarkup if TRUE, markup will not be processed by this label's string
@note: does not update any existing text contained by the label.

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.

OnGetTextValue Source code

Handler for GetTextValue action.

OnSetLabelText Source code

=== Kismet Action Handlers ===

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.

SetArrayValue Source code

=== Unrealscript ===

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.

SetTextAlignment Source code

Sets the text alignment for the string that the widget is rendering.
@param Horizontal Horizontal alignment to use for text, UIALIGN_MAX means no change.
@param Vertical Vertical alignment to use for text, UIALIGN_MAX means no change.

SetValue Source code

Change the value of this label at runtime.
@param NewText the new text that should be displayed in the label

defaultproperties
{
   DataSource=(MarkupString="Initial Label Text")
   Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
      Name="LabelStringRenderer"
      ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
   End Object
   StringRenderComponent=LabelStringRenderer
   PrimaryStyle=(RequiredStyleClass=Class'Engine.UIStyle_Combo')
   bSupportsPrimaryStyle=False
   Position=(Value[2]=100.000000,Value[3]=40.000000,ScaleType[2]=EVALPOS_PixelOwner,ScaleType[3]=EVALPOS_PixelOwner)
   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__UILabel"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}