UE3:UITabPage (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage

Package: 

Engine

Implemented interfaces: 

UIDataStoreSubscriber

Direct subclass:

UTTabPage

This class in other games:

UDK

This widget is used by the UITabControl as a container for the widgets to be displayed when a tab is activated in the tab control.

Copyright 2007 Epic Games, Inc. All Rights Reserved

Constants

CAPTION_DATABINDING_INDEX

Value: 0

TOOLTIP_DATABINDING_INDEX

Value: 1

DESCRIPTION_DATABINDING_INDEX

Value: 2

Properties

Property group 'Data'

ButtonCaption

Type: UIRoot.UIDataStoreBinding

Modifiers: private

provides the caption for this page's tab button

ButtonToolTip

Type: UIRoot.UIDataStoreBinding

Modifiers: private

provides the tooltip for this page's tab button

PageDescription

Type: UIRoot.UIDataStoreBinding

Modifiers: private

provides the text that will appear in status bars while this page is active

Internal variables

ButtonClass

Type: class<UITabButton>

Modifiers: const

The UITabButton class to use for creating this page's button.

Default value: Class'Engine.UITabButton'

TabButton

Type: UITabButton

Modifiers: protected

The tab button associated with this page; set in GetTabButton()

Default values

Property	Value
PrivateFlags	640

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIContainer.WidgetEventComponent

No new values.

Functions

Static events

CreateTabButton

protected static event UITabButton CreateTabButton (UITabControl TabControl)

Creates a new UITabButton for this page. Child classes can override this method in order to do perform additional initialization of the tab button.

Parameters:

• TabControl - the tab control that is requesting the button.

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>

GetOwnerTabControl

native final function UITabControl GetOwnerTabControl () const

Returns the tab control that contains this tab page, or NULL if it's not part of a tab control.

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

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.

Events

ActivatePage

event bool ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus)

Causes this page to become (or no longer be) the tab control's currently active page.

Parameters:

• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
• bActivate - TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
• bTakeFocus - specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)

Returns:

TRUE if this page successfully changed its active state; FALSE otherwise.

LinkToTabButton

event bool LinkToTabButton (UITabButton NewButton, UITabControl TabControl)

Associates this UITabPage with the specified tab button.

Parameters:

• NewButton - the tab button to link this tab page to
• TabControl - the tab control which will contain this tab page.

Returns:

TRUE if this tab page was successfully linked to the tab button.

RemovedFromParent

event RemovedFromParent (UIScreenObject WidgetOwner)

Overrides: UIScreenObject.RemovedFromParent

Notification that this widget's parent is about to remove this widget from its children array. Allows the widget to clean up any references to the old parent.

This version clears the tab page's reference to it's tab button.

Parameters:

• WidgetOwner - the screen object that this widget was removed from.

Other instance functions

AddedToTabControl

function AddedToTabControl (UITabControl TabControl)

Called when this tab page is inserted into a tab control's list of pages. Child classes can override this function to perform any additional initialization.

Parameters:

• TabControl - the tab control that this page was just added to.

CanActivatePage

function bool CanActivatePage (int PlayerIndex)

Callback for determining whether this page can be activated.

Parameters:

• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.

GetTabButton

function UITabButton GetTabButton (UITabControl TabControl)

Creates the UITabButton for this page, if necessary. Child classes can override this method in order to do perform additional initialization of the tab button.

Parameters:

• TabControl - the tab control that is requesting the button. Should only be specified if the tab page should a new button if one doesn't exist.

Returns:

the page's tab button

IsActivePage

function bool IsActivePage ()

Wrapper for determining whether this is the currently active page.

Returns:

TRUE if this is the tab control's currently active page.

OnActiveStateChanged

function OnActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState)

Called when a new UIState becomes the widget's currently active state, after all activation logic has occurred.

Parameters:

• Sender - the widget that changed states.
• PlayerIndex - the index [into the GamePlayers array] for the player that activated this state.
• NewlyActiveState - the state that is now active
• PreviouslyActiveState - the state that used the be the widget's currently active state.

SetTabCaption

function SetTabCaption (string NewButtonMarkup)

Sets the caption for this pages button

Parameters:

• NewButtonMarkup - The Markup to set the caption to.