There is no spoon
UE3:UILabelButton (UDK)
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UILabelButton |
Contents
- Package:
- Engine
- Implemented interfaces:
- UIDataStorePublisher
- Direct subclasses:
- UICalloutButton, UITabButton, UIToggleButton, UTUIButtonBarButton
- 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. |
This UIButton displays a label on the button.
Properties[edit]
Property group 'Components'[edit]
StringRenderComponent[edit]
Type: UIComp_DrawString
Modifiers: editinline, const, noclear
Renders the caption for this button
Default value: UIComp_DrawString'LabelStringRenderer'
Property group 'Data'[edit]
CaptionDataSource[edit]
Type: UIRoot.UIDataStoreBinding
Modifiers: protected
the text that will be rendered by this label
Default value:
| Member | Value |
|---|---|
| MarkupString | "Button Text" |
Default values[edit]
| Property | Value | ||||||
|---|---|---|---|---|---|---|---|
| bSupportsFocusHint | True | ||||||
| PrimaryStyle |
|
Subobjects[edit]
BackgroundImageTemplate[edit]
Class: Engine.UIComp_DrawImage
Inherits from: UIButton.BackgroundImageTemplate
No new values.
LabelStringRenderer[edit]
Class: Engine.UIComp_DrawString
| Property | Value | ||||
|---|---|---|---|---|---|
| StringStyle |
|
||||
| StyleResolverTag | 'Caption Style' |
WidgetEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UIButton.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.
SetCaption[edit]
Sets the caption for this button.
Parameters:
- NewText - the new caption for the button
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]
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.
Events[edit]
GetCaption[edit]
Retrieves the caption for this button.
