Engine.UITabPage

Extends

UIContainer

Modifiers

native ( inherit ) implements ( UIDataStoreSubscriber ) placeable HideDropDown

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 1998-2008 Epic Games, Inc. All Rights Reserved

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage

Direct Known Subclasses:

UTTabPage

Functions Summary
	bool	ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus=true ))
		AddedToTabControl (UITabControl TabControl)
	bool	CanActivatePage (int PlayerIndex ))
		ClearBoundDataStores ()
	UITabButton	CreateTabButton (UITabControl TabControl ))
		GetBoundDataStores (out array<UIDataStore> out_BoundDataStores)
	string	GetDataStoreBinding (optional int BindingIndex=INDEX_NONE ) con)
	UITabControl	GetOwnerTabControl () con)
	UITabButton	GetTabButton (UITabControl TabControl=None ))
	bool	IsActivePage ()))
	bool	LinkToTabButton (UITabButton NewButton, UITabControl TabControl ))
		NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)
		OnActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
	bool	RefreshSubscriberValue (optional int BindingIndex=INDEX_NONE)
		RemovedFromParent (UIScreenObject WidgetOwner ))
		SetDataStoreBinding (string MarkupText, optional int BindingIndex=INDEX_NONE)
		SetTabCaption (string NewButtonMarkup))

CAPTION_DATABINDING_INDEX Source code

DESCRIPTION_DATABINDING_INDEX Source code

TOOLTIP_DATABINDING_INDEX Source code

ButtonClass Source code

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

TabButton Source code

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

Data

ButtonCaption Source code

provides the caption for this page's tab button

ButtonToolTip Source code

provides the tooltip for this page's tab button

PageDescription Source code

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

ActivatePage Source code

Causes this page to become (or no longer be) the tab control's currently active page.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
@param bActivate TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
@param bTakeFocus specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)
@return TRUE if this page successfully changed its active state; FALSE otherwise.

AddedToTabControl Source code

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.
@param TabControl the tab control that this page was just added to.

CanActivatePage Source code

Callback for determining whether this page can be activated.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.

ClearBoundDataStores Source code

Notifies this subscriber to unbind itself from all bound data stores

CreateTabButton Source code

Creates a new UITabButton for this page. Child classes can override this method in order to do perform additional initialization of the tab button.
@param TabControl the tab control that is requesting the button.

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:

GetOwnerTabControl Source code

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

GetTabButton Source code

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.
@param 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.
@return the page's tab button

IsActivePage Source code

Wrapper for determining whether this is the currently active page.
@return TRUE if this is the tab control's currently active page.

LinkToTabButton Source code

Associates this UITabPage with the specified tab button.
@param NewButton the tab button to link this tab page to
@param TabControl the tab control which will contain this tab page.
@return TRUE if this tab page was successfully linked to the tab button.

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.

OnActiveStateChanged Source code

Called when a new UIState becomes the widget's currently active state, after all activation logic has occurred.
@param Sender the widget that changed states.
@param PlayerIndex the index [into the GamePlayers array] for the player that activated this state.
@param NewlyActiveState the state that is now active
@param PreviouslyActiveState the state that used the be the widget's currently active state.

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.

RemovedFromParent Source code

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.
@param WidgetOwner the screen object that this widget was removed from.

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.

SetTabCaption Source code

Sets the caption for this pages button
@param NewButtonMarkup The Markup to set the caption to.

defaultproperties
{
   ButtonClass=Class'Engine.UITabButton'
   ButtonToolTip=
   PageDescription=
   PrivateFlags=640
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UITabPage"
   ObjectArchetype=UIContainer'Engine.Default__UIContainer'
}