UE3:UICheckbox (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UICheckbox

Package: 

Engine

Implemented interfaces: 

UIDataStorePublisher

Direct subclass:

UTUICollectionCheckBox

This class in other games:

UDK

A button that has two (and possibly three, in the future) state - checked and unchecked.

Todo: implement data store binding Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'Data'

ValueDataSource

Type: UIRoot.UIDataStoreBinding

Modifiers: private

the data store that this checkbox retrieves its value from

Property group 'Image'

CheckedImageComponent

Type: UIComp_DrawImage

Modifiers: editinline, const, noclear

Component for rendering the button background image

Default value: UIComp_DrawImage'CheckedImageTemplate'

Property group 'Sound'

CheckedCue

Type: name

this sound is played when this widget is checked

Default value: 'CheckboxChecked'

UncheckedCue

Type: name

this sound is played when this widget is unchecked

Default value: 'CheckboxUnchecked'

Property group 'Value'

bIsChecked

Type: bool

Modifiers: private

Controls whether this button is considered checked. When bIsChecked is TRUE, CheckedImage will be rendered over the button background image, using the current style.

Default values

Property	Value
ClickedCue

Subobjects

BackgroundImageTemplate

Class: Engine.UIComp_DrawImage

Inherits from: UIButton.BackgroundImageTemplate

No new values.

CheckedImageTemplate

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'DefaultCheckbox'
StyleResolverTag	'Check Style'

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIButton.WidgetEventComponent

No new values.

Functions

Native functions

ClearBoundDataStores

native final function ClearBoundDataStores ()

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores

native final virtual function GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)

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

native final virtual function string GetDataStoreBinding (optional int BindingIndex) const

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

native final virtual function NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)

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

native final virtual function bool RefreshSubscriberValue (optional int BindingIndex)

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

native virtual function bool SaveSubscriberValue (out array<UIDataStore> out_BoundDataStores, optional int BindingIndex)

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

native final virtual function SetDataStoreBinding (string MarkupText, optional int BindingIndex)

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.

SetValue

native function SetValue (bool bShouldBeChecked, optional int PlayerIndex)

Changed the checked state of this checkbox and activates a checked event.

Parameters:

• bShouldBeChecked - TRUE to turn the checkbox on, FALSE to turn it off
• PlayerIndex - the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.

Other instance functions

IsChecked

final function bool IsChecked ()

Returns TRUE if this button is in the checked state, FALSE if in the

OnSetBoolValue

final function OnSetBoolValue (UIAction_SetBoolValue Action)

SetCheckImage

final function SetCheckImage (Surface NewImage)

Changes the checked image for this checkbox, creating the wrapper UITexture if necessary.

Parameters:

• NewImage - the new surface to use for this UIImage