Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIButtonBar

Extends
UTUI_Widget
Modifiers
placeable dependson ( UIButton ) native ( UI )

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved. Container class that holds multiple UTUIButtonBarButton instances. This class autopositions itself and its buttons at the bottom of the screen. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTUIButtonBar
Constants Summary
UTUIBUTTONBAR_BUTTON_SPACING=-20
UTUIBUTTONBAR_MAX_BUTTONS=6
Inherited Contants from Engine.UIObject
CONTEXTMENU_BINDING_INDEX, FIRST_DEFAULT_DATABINDING_INDEX, TOOLTIP_BINDING_INDEX

Variables Summary
UTUIButtonBarButtonButtons[UTUIBUTTONBAR_MAX_BUTTONS]
Inherited Variables from UTGame.UTUI_Widget
bRequiresTick, UTSceneOwner
Inherited Variables from Engine.UIObject
AnimationParent, AnimationPosition, AnimStack, bDebugShowBounds, bEnableActiveCursorUpdates, bSupportsPrimaryStyle, ContextMenuData, DebugBoundsColor, DockTargets, NavigationTargets, Owner, OwnerScene, PrimaryStyle, PrivateFlags, RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX], RenderBounds[EUIWidgetFace.UIFACE_MAX], RenderOffset, Rotation, StyleSubscribers, TabIndex, ToolTip, WidgetID, WidgetTag

Functions Summary
functionint AppendButton (string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate))
functionbool CanAcceptFocus (optional int PlayerIndex=0 ) con)
function Clear ()))
function ClearButton (int ButtonIndex))
event PlayUIAnimation (name AnimName, optional UIAnimationSeq AnimSeqTemplate, optional float PlaybackRate=1.0, ptional bool bLoop, optional float InitialPosition=0.0))
event PostInitialize ()))
function SetButton (int ButtonIndex, string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate))
function ToggleButton (int ButtonIdx, bool bActive))
Inherited Functions from UTGame.UTUI_Widget
FindDataStore, GetPlayerControllerId, NotifyGameSessionEnded
Inherited Functions from Engine.UIObject
AddStyleSubscriber, AnimSetBottom, AnimSetColor, AnimSetLeft, AnimSetOpacity, AnimSetPosition, AnimSetRelPosition, AnimSetRight, AnimSetRotation, AnimSetScale, AnimSetTop, AnimSetVisibility, CanAcceptFocus, ClearDefaultDataBinding, ClearUIAnimation, FindStyleSubscriberIndex, FindStyleSubscriberIndexById, GenerateSceneDataStoreMarkup, GenerateTransformMatrix, GetAnchorPosition, GetDefaultDataBinding, GetDefaultDataStores, GetOwner, GetParent, GetPositionExtent, GetPositionExtents, GetRotationMatrix, GetScene, GetToolTipValue, HasTransform, IsContainedBy, IsDockedTo, IsPrivateBehaviorSet, LogRenderBounds, NeedsActiveCursorUpdates, NotifyValueChanged, OnSetDatastoreBinding, PlayUIAnimation, RemoveStyleSubscriber, ResolveDefaultDataBinding, RotateWidget, SetActiveCursorUpdate, SetAnchorPosition, SetDefaultDataBinding, SetDockPadding, SetDockParameters, SetDockTarget, SetForcedNavigationTarget, SetNavigationTarget, SetPrivateBehavior, StopUIAnimation, TickAnim, UIAnimEnd, UpdateRotationMatrix

Constants Detail

UTUIBUTTONBAR_BUTTON_SPACING Source code

const UTUIBUTTONBAR_BUTTON_SPACING = -20;

UTUIBUTTONBAR_MAX_BUTTONS Source code

const UTUIBUTTONBAR_MAX_BUTTONS = 6;

Variables Detail

Buttons[UTUIBUTTONBAR_MAX_BUTTONS] Source code

var instanced UTUIButtonBarButton Buttons[UTUIBUTTONBAR_MAX_BUTTONS];
Array of actual label buttons for the button bar.

Functions Detail

AppendButton Source code

function int AppendButton ( string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate) )
Appends a button to the button bar.
@param ButtonTextMarkup Markup for the button's caption
@param ButtonDelegate Delegate to call when the button is clicked on.

CanAcceptFocus Source code

native const function bool CanAcceptFocus ( optional int PlayerIndex=0 ) con )
Determines whether this widget can become the focused control.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player to check focus availability
@return TRUE if this widget (or any of its children) is capable of becoming the focused control.

Clear Source code

function Clear ( ) )
Clears all set buttons.

ClearButton Source code

function ClearButton ( int ButtonIndex) )

PlayUIAnimation Source code

event PlayUIAnimation ( name AnimName, optional UIAnimationSeq AnimSeqTemplate, optional float PlaybackRate=1.0,optional bool bLoop, optional float InitialPosition=0.0) )
Play an animation on this UIObject @Param AnimName The Name of the Animation to play @Param AnimSeq Optional, A Sequence Template. If that's set, we use it instead @Param PlaybackRate Optional, How fast to play back the sequence @Param InitialPosition Optional, Where in the sequence should we start

PostInitialize Source code

event PostInitialize ( ) )

SetButton Source code

function SetButton ( int ButtonIndex, string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate) )
Sets information for one of the button bar buttons.

ToggleButton Source code

function ToggleButton ( int ButtonIdx, bool bActive) )
Used to toggle a button on/off

Defaultproperties 

defaultproperties
{
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate0 ObjName=ButtonTemplate0 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 0")
      WidgetTag="butButtonBarButton0"
      TabIndex=0
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate0"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(0)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate0'
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate1 ObjName=ButtonTemplate1 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 1")
      WidgetTag="butButtonBarButton1"
      TabIndex=1
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate1"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(1)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate1'
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate2 ObjName=ButtonTemplate2 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 2")
      WidgetTag="butButtonBarButton2"
      TabIndex=2
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate2"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(2)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate2'
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate3 ObjName=ButtonTemplate3 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 3")
      WidgetTag="butButtonBarButton3"
      TabIndex=3
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate3"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(3)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate3'
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate4 ObjName=ButtonTemplate4 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 4")
      WidgetTag="butButtonBarButton4"
      TabIndex=4
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate4"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(4)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate4'
   Begin Object Class=UTUIButtonBarButton Name=ButtonTemplate5 ObjName=ButtonTemplate5 Archetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
      Begin Object Class=UIComp_DrawString Name=ButtonBarStringRenderer ObjName=ButtonBarStringRenderer Archetype=UIComp_DrawString'UTGame.Default__UTUIButtonBarButton:ButtonBarStringRenderer'
         ObjectArchetype=UIComp_DrawString'ButtonBarStringRenderer'
      End Object
      Begin Object Class=UIComp_DrawImage Name=ButtonBarBackgroundImageTemplate ObjName=ButtonBarBackgroundImageTemplate Archetype=UIComp_DrawImage'UTGame.Default__UTUIButtonBarButton:ButtonBarBackgroundImageTemplate'
         ObjectArchetype=UIComp_DrawImage'ButtonBarBackgroundImageTemplate'
      End Object
      Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIButtonBarButton:WidgetEventComponent'
         ObjectArchetype=UIComp_Event'WidgetEventComponent'
      End Object
      CaptionDataSource=(MarkupString="Button 5")
      WidgetTag="butButtonBarButton5"
      TabIndex=5
      Position=(Value[0]=0.900000,Value[2]=0.100000,Value[3]=0.700000)
      Name="ButtonTemplate5"
      ObjectArchetype=UTUIButtonBarButton'UTGame.Default__UTUIButtonBarButton'
   End Object
   Buttons(5)=UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate5'
   Position=(Value[1]=0.950000,Value[3]=0.050000)
   DefaultStates(2)=Class'Engine.UIState_Focused'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUI_Widget:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUI_Widget:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIButtonBar"
   ObjectArchetype=UTUI_Widget'UTGame.Default__UTUI_Widget'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Mon 26/11/2007 17:41:32.015 - Created with UnCodeX