Engine.UITabControl

Extends

UIObject

Modifiers

native ( UIPrivate ) config ( UI ) placeable

This widget manages a collection of panels. Only one panel can be active at a time. Each panel is associated with a tab, which is displayed in a row across one edge of the tab control. Users select the tab corresponding to the panel they wish to interact with by clicking with the mouse or using the keyboard/gamepad to activate neighboring panels. A UITabControl is composed of two main areas - the "tab region" and the "client region". The tab region is where the tabs are rendered, while the client region is where the currently active panel is rendered. Copyright 2007 Epic Games, Inc. All Rights Reserved

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

Direct Known Subclasses:

UTUITabControl

Delegates Summary
		OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)
		OnPageInserted (UITabControl Sender, UITabPage NewPage, int PlayerIndex)
		OnPageRemoved (UITabControl Sender, UITabPage OldPage, int PlayerIndex)

Functions Summary
	bool	ActivateBestTab (int PlayerIndex, optional bool bFocusPage=true, optional int StartIndex=0 ))
	bool	ActivateNextPage (int PlayerIndex, optional bool bFocusPage=true, optional bool bAllowWrapping=true ))
	bool	ActivatePage (UITabPage PageToActivate, int PlayerIndex, optional bool bFocusPage=true ))
	bool	ActivatePageByCaption (string PageCaption, int PlayerIndex, optional bool bFocusPage=true ))
	bool	ActivatePreviousPage (int PlayerIndex, optional bool bFocusPage=true, optional bool bAllowWrapping=true ))
		AddedChild (UIScreenObject WidgetOwner, UIObject NewChild ))
	UITabPage	CreateTabPage (class<UITabPage> TabPageClass, optional UITabPage PagePrefab)
	bool	EnableTabPage (UITabPage PageToEnable, int PlayerIndex, bool bEnablePage=true, optional bool bActivatePage, optional bool bFocusPage=true ))
	int	FindPageIndexByButton (UITabButton SearchButton ))
	int	FindPageIndexByCaption (string PageCaption, optional bool bMarkupString ))
	int	FindPageIndexByPageRef (UITabPage SearchPage ))
	UITabButton	FindTargetedTab (int PlayerIndex ) con)
	UITabPage	GetPageAtIndex (int PageIndex ) con)
	int	GetPageCount () con)
	bool	InsertPage (UITabPage PageToInsert, int PlayerIndex, int InsertIndex=INDEX_NONE, optional bool bActivateImmediately=true ))
		PostInitialize ()))
		PrivateActivatePage (UITabPage PageToActivate, int PlayerIndex ))
	bool	ProcessInputKey (const out InputEventParameters EventParms ))
	bool	RemovePage (UITabPage PageToRemove, int PlayerIndex ))
	bool	ReplacePage (UITabPage ExistingPage, UITabPage NewPage, int PlayerIndex, optional bool bFocusPage=true ))
		RequestLayoutUpdate ()
	bool	TabButtonClicked (UIScreenObject EventObject, int PlayerIndex))

bUpdateLayout Source code

set to indicate that the tab control should layout the buttons and panels during the next tick

TabButtonBackgroundStyle Source code

The style to use for the tab button background image

TabButtonCaptionStyle Source code

The style to use for the tab button labels

Presentation

bAllowPagePreviews Source code

Controls whether tab buttons are allowed to enter the targeted state

TabButtonPadding[EUIOrientation.UIORIENT_MAX] Source code

The amount of padding to apply to each button's text. The specified value will be evenly distributed to each sides of the button's caption.

TabButtonSize Source code

The size to use for the tab buttons along the orientation of the TabDockFace (i.e. if tabs are docked at top or bottom, this determines the height of the tabs)

TabDockFace Source code

Controls which face of this UITabControl the tab buttons will be docked to @todo ronp - currently only top and bottom are properly supported. In order to support left & right, we'll probably need to rotate the buttons, but first need to figure out what the docking relationship should be in that case.

TabSizeMode Source code

The mode to use for sizing the tab buttons

Sound

ActivateTabCue Source code

this sound is played when a new tab is activated

UITabControl

ActivePage Source code

Reference to the currently active page

Pages Source code

the list of tab pages managed by this UITabControl

PendingPage Source code

Reference to the page which is about to become active.

EUITabAutosizeType Source code

Different ways to adjust the sizes of tab buttons used in this control.

OnPageActivated Source code

Called when a new page is activated.
@param Sender the tab control that activated the page
@param NewlyActivePage the page that was just activated
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.

OnPageInserted Source code

Called when a new page is added to this tab control.
@param Sender the tab control that added the page
@param NewPage the page that was just added
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.

OnPageRemoved Source code

Called when a page is removed from this tab control.
@param Sender the tab control that removed the page
@param OldPage the page that was removed
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.

ActivateBestTab Source code

Chooses the best tab to activate and activates it.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player to activate this tab for.
@param bFocusPage specify FALSE if the tab control itself should maintain focus.
@param StartIndex if specified, starts the iteration at this index when searching for a new tab to activate.
@return TRUE if a tab was successfully activated.

ActivateNextPage Source code

Activates the page immediately after the currently active page. If the currently active page is the last one, activates the first page.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.
@param bFocusPage specify FALSE if the tab control itself should maintain focus.
@param bAllowWrapping specify false to prevent the first page from being activated if the currently active page is the last page in the stack.
@return TRUE if the next page was successfully activated.

ActivatePage Source code

Attempts to activate the specified tab page.
@param PageToActivate the tab page that should be become the active page
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player to activate this tab for.
@param bFocusPage specify FALSE if the tab control itself should maintain focus.
@return TRUE if the specified page was successfully activated.

ActivatePageByCaption Source code

Attempts to activate the specified tab page.
@param PageToActivate the tab page that should be become the active page
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player to activate this tab for.
@param bFocusPage specify FALSE if the tab control itself should maintain focus.
@return TRUE if the specified page was successfully activated.

ActivatePreviousPage Source code

Activates the page immediately before the currently active page. If the currently active page is the first one, activates the last page.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.
@param bFocusPage specify FALSE if the tab control itself should maintain focus.
@param bAllowWrapping specify false to prevent the first page from being activated if the currently active page is the last page in the stack.
@return TRUE if the previous page was successfully activated.

AddedChild Source code

Called immediately after a child has been added to this screen object. This version hooks up the OnClicked delegate for the newly added button.
@param WidgetOwner the screen object that the NewChild was added as a child for
@param NewChild the widget that was added

CreateTabPage Source code

Creates a new UITabPage of the specified class as well as its associated tab button.
@param TabPageClass the class to use for creating the tab page.
@param PagePrefab if specified, the prefab to use for creating this tab page.
@return a pointer to a new instance of the specified UITabPage class

EnableTabPage Source code

Enables/disables a tab page and its associated tab button.
@param PageToEnable the page to enable/disable.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.
@param bEnablePage controls whether the page should be enabled or disabled.
@param bActivatePage if true, the page will also be activated (only relevant if bEnablePage is true).
@param bFocusPage specify FALSE if the new page should not become the focused control (only relevant if bActivatePage is true)
@return TRUE if the page was successfully enabled/disabled.

FindPageIndexByButton Source code

Returns the index [into the Pages array] for the page which has the specified button.
@return INDEX_NONE if no page was found with the specified button.

FindPageIndexByCaption Source code

Returns the index [into the Pages array] for the page which has a button with the specified caption.
@param PageCaption the caption to use for searching for the page
@param bMarkupString if TRUE, searches for the button that has PageCaption as its data store binding.
@return INDEX_NONE if no page was found with the specified caption.

FindPageIndexByPageRef Source code

Returns the index [into the Pages array] for the specified page.
@return INDEX_NONE if the specified was None or isn't in the Pages array.

FindTargetedTab Source code

Returns a reference to the tab button which is currently in the Targeted state, or NULL if no buttons are in that state.

GetPageAtIndex Source code

Returns a reference to the page at the specified index.

GetPageCount Source code

Returns the number of pages in this tab control.

InsertPage Source code

Inserts a page at the specified location.
@param PageToInsert the tab page to insert
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this action.
@param InsertIndex location to insert the page in the Pages array. If not specified, page is inserted at the end.
@param bActivateImmediately if TRUE, immediately activates the page and gives it focus
@return TRUE if the page was successfully added to this tab control

PostInitialize Source code

Called after this screen object's children have been initialized

PrivateActivatePage Source code

Worker method for setting a new active page. Handles deactivating the previously active page and firing the appropriate notifications.
@param PageToActivate the tab page that should be become the active page
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player to activate this tab for.
@return TRUE if the specified page was successfully activated.

ProcessInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input. Allows the user to use the left/right arrow keys to preview other panels if this widget is the globally focused control
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

RemovePage Source code

Removes the specified page from this tab control's list of pages.
@param PageToRemove the tab page to remove
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this action.
@return TRUE if the page was successfully removed from the pages array.

ReplacePage Source code

Replaces one tab page with another one.
@param ExistingPage the tab page to replace; must be a page that is currently in this tab control's Pages array.
@param NewPage the tab page that will replace the existing one.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this action.
@param bFocusPage if TRUE, immediately activates the page and gives it focus
@return TRUE if the page was successfully replaced.

RequestLayoutUpdate Source code

Enables the bUpdateLayout flag and triggers a scene update to occur during the next frame.

TabButtonClicked Source code

Called when the user clicks on a tab button and releases the mouse. Begins activating the associated tab page.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.
@return return TRUE to prevent the kismet OnClick event from firing.

defaultproperties
{
   TabDockFace=UIFACE_Top
   TabSizeMode=TAST_Auto
   TabButtonSize=(Value=0.020000,ScaleType=UIEXTENTEVAL_PercentOwner,Orientation=UIORIENT_Vertical)
   TabButtonPadding(0)=(Value=0.020000,ScaleType=UIEXTENTEVAL_PercentOwner)
   TabButtonPadding(1)=(Value=0.020000,ScaleType=UIEXTENTEVAL_PercentOwner,Orientation=UIORIENT_Vertical)
   TabButtonBackgroundStyle=(DefaultStyleTag="TabButtonBackgroundStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   TabButtonCaptionStyle=(DefaultStyleTag="DefaultTabButtonStringStyle",RequiredStyleClass=Class'Engine.UIStyle_Combo')
   bAllowPagePreviews=True
   bSupportsPrimaryStyle=False
   DefaultStates(2)=Class'Engine.UIState_Focused'
   DefaultStates(3)=Class'Engine.UIState_Pressed'
   DefaultStates(4)=Class'Engine.UIState_Active'
   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
   __OnRawInputKey__Delegate=Default__UITabControl.ProcessInputKey
   Name="Default__UITabControl"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}