Engine.UITabButton

Extends

UILabelButton

Modifiers

native ( inherit ) notplaceable

This widget is used by the UITabControl. It is always associated with a UITabPage. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIButton
            |   
            +-- Engine.UILabelButton
               |   
               +-- Engine.UITabButton

Delegates Summary
	bool	IsActivationAllowed (UITabButton Sender, int PlayerIndex)

Functions Summary
		AddedChild (UIScreenObject WidgetOwner, UIObject NewChild ))
	bool	CanActivateButton (int PlayerIndex)
	UITabPage	GetTabPage ()))
	bool	IsTargeted (optional int PlayerIndex=GetBestPlayerIndex(), optional out int StateIndex ) con)
		OnStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
		RemovedChild (UIScreenObject WidgetOwner, UIObject OldChild, optional array ExclusionSet ))
		RemovedFromParent (UIScreenObject WidgetOwner ))

UITabButton

TabPage Source code

IsActivationAllowed Source code

Callback for allowing others to override activation of this button.
@param Sender the button that is being activated.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this button.

AddedChild Source code

Called immediately after a child has been added to this screen object. This version assigns the TabPage reference to the new child if it's a UITabPage.
@param WidgetOwner the screen object that the NewChild was added as a child for
@param NewChild the widget that was added

CanActivateButton Source code

Determines whether this page can be activated. Calls the IsActivationAllowed delegate to provide other objects a chance to veto the activation of this button. Child classes wishing to perform additional logic for determining whether this button can be activated should hook into the IsActivationAllowed delegate.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
@return TRUE if this button is allowed to become the active tab button.

GetTabPage Source code

Simple accessor for getting a reference to this button's page.

IsTargeted Source code

Returns TRUE if this widget has a UIState_TargetedTab object in its StateStack
@param StateIndex if specified, will be set to the index of the last state in the list of active states that has the class specified

OnStateChanged Source code

Called when a new UIState becomes the widget's currently active state, after all activation logic has occurred. This version ensures that the targeted state is deactivated whenever a tab button becomes focused.
@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.

RemovedChild Source code

Called immediately after a child has been removed from this screen object. This version clears the TabPage reference, if the child being removed is the current tab page.
@param WidgetOwner the screen object that the widget was removed from.
@param OldChild the widget that was removed
@param ExclusionSet used to indicate that multiple widgets are being removed in one batch; useful for preventing references between the widgets being removed from being severed. NOTE: If a value is specified, OldChild will ALWAYS be part of the ExclusionSet, since it is being removed.

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

defaultproperties
{
   Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UILabelButton:LabelStringRenderer'
      StyleResolverTag="TabButtonCaptionStyle"
      ObjectArchetype=UIComp_DrawString'Engine.Default__UILabelButton:LabelStringRenderer'
   End Object
   StringRenderComponent=LabelStringRenderer
   Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UILabelButton:BackgroundImageTemplate'
      StyleResolverTag="TabButtonBackgroundStyle"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UILabelButton:BackgroundImageTemplate'
   End Object
   BackgroundImageComponent=BackgroundImageTemplate
   PrivateFlags=931
   DefaultStates(5)=Class'Engine.UIState_TargetedTab'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UILabelButton:WidgetEventComponent'
      DisabledEventAliases(0)="NextControl"
      DisabledEventAliases(1)="PrevControl"
      DisabledEventAliases(2)="NavFocusUp"
      DisabledEventAliases(3)="NavFocusDown"
      DisabledEventAliases(4)="NavFocusLeft"
      DisabledEventAliases(5)="NavFocusRight"
      ObjectArchetype=UIComp_Event'Engine.Default__UILabelButton:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UITabButton"
   ObjectArchetype=UILabelButton'Engine.Default__UILabelButton'
}