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

Engine.UIObject

Extends
UIScreenObject
Modifiers
native ( UIPrivate ) abstract

Base class for all UI widgets. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

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

Direct Known Subclasses:

ConsoleEntry, UIButton, UIComboBox, UIContainer, UIEditBox, UIImage, UILabel, UIList, UIMeshWidget, UIOptionListBase, UIPrefab, UIPrefabInstance, UIProgressBar, UIScrollbar, UISlider, UITabControl, UTUI_Widget

Constants Summary
CONTEXTMENU_BINDING_INDEX=101
FIRST_DEFAULT_DATABINDING_INDEX=100
TOOLTIP_BINDING_INDEX=100
Inherited Contants from Engine.UIRoot
ASPECTRATIO_Monitor, ASPECTRATIO_Normal, ASPECTRATIO_Widescreen, DEFAULT_SIZE_X, DEFAULT_SIZE_Y, MAX_SUPPORTED_GAMEPADS, PRIVATE_EditorNoDelete, PRIVATE_EditorNoRename, PRIVATE_EditorNoReparent, PRIVATE_KeepFocusedState, PRIVATE_ManagedStyle, PRIVATE_NotDockable, PRIVATE_NotEditorSelectable, PRIVATE_NotFocusable, PRIVATE_NotRotatable, PRIVATE_PropagateState, PRIVATE_Protected, PRIVATE_TreeHidden, PRIVATE_TreeHiddenRecursive, SCENE_DATASTORE_TAG, TEMP_SPLITSCREEN_INDEX

Variables Summary
UIObjectAnimationParent
vectorAnimationPosition
array<UIAnimSeqRef>AnimStack
boolbEnableActiveCursorUpdates
boolbSupportsPrimaryStyle
UIObjectOwner
UISceneOwnerScene
UIStyleReferencePrimaryStyle
intPrivateFlags
array<UIStyleResolver>StyleSubscribers
WIDGET_IDWidgetID
Data
UIDataStoreBindingContextMenuData
UIDataStoreBindingToolTip
Debug
boolbDebugShowBounds
colorDebugBoundsColor
Focus
UINavigationDataNavigationTargets
intTabIndex
Presentation
UIDockingSetDockTargets
Vector2DRenderBoundsVertices[EUIWidgetFace.UIFACE_MAX]
floatRenderBounds[EUIWidgetFace.UIFACE_MAX]
vectorRenderOffset
UIRotationRotation
nameWidgetTag
Inherited Variables from Engine.UIScreenObject
bHidden, bInitialized, bNeverFocus, bSupports3DPrimitives, Children, DefaultStates, EventProvider, FocusControls, FocusedCue, FocusPropagation, InactiveStates, InitialState, MouseEnterCue, NavigateDownCue, NavigateLeftCue, NavigateRightCue, NavigateUpCue, Opacity, PlayerInputMask, Position, StateStack, ZDepth
Inherited Variables from Engine.UIRoot
CurrentMenuState, ModifierStack

Enumerations Summary
Inherited Enumerations from Engine.UIRoot
EColumnHeaderState, EMaterialAdjustmentType, ENavigationLinkType, EPositionEvalType, ERotationAnchor, EScreenInputMode, ESplitscreenRenderMode, ETextAutoScaleMode, ETextClipMode, EUIAlignment, EUIAspectRatioConstraint, EUIAutoSizeConstraintType, EUIDataProviderFieldType, EUIDefaultPenColor, EUIDockPaddingEvalType, EUIExtentEvalType, EUIListElementState, EUIOrientation, EUIWidgetFace

Structures Summary
Inherited Structures from Engine.UIRoot
AutoSizeData, AutoSizePadding, DefaultEventSpecification, InputEventSubscription, InputKeyAction, PlayerInteractionData, RenderParameters, ScreenPositionRange, StateInputKeyAction, StyleReferenceId, STYLE_ID, TextAutoScaleValue, TextureCoordinates, UIAnchorPosition, UICombinedStyleData, UIDataStoreBinding, UIDockingNode, UIDockingSet, UIFocusPropagationData, UIImageAdjustmentData, UIImageStyleOverride, UIInputAliasClassMap, UIInputAliasMap, UIInputAliasStateMap, UIMouseBounds, UINavigationData, UIProviderFieldValue, UIProviderScriptFieldValue, UIRangeData, UIRenderingSubregion, UIRotation, UIScreenValue, UIScreenValue_AutoSizeRegion, UIScreenValue_Bounds, UIScreenValue_DockPadding, UIScreenValue_Extent, UIScreenValue_Position, UIStringCaretParameters, UIStringNodeModifier, UIStyleOverride, UIStyleReference, UIStyleSubscriberReference, UITextAttributes, UITextStyleOverride, WIDGET_ID

Delegates Summary
delegatebool OnClicked (UIScreenObject EventObject, int PlayerIndex)
delegatebool OnCloseContextMenu (UIContextMenu ContextMenu, int PlayerIndex)
delegate OnContextMenuItemSelected (UIContextMenu ContextMenu, int PlayerIndex, int ItemIndex)
delegate OnCreate (UIObject CreatedWidget, UIScreenObject CreatorContainer)
delegate OnDoubleClick (UIScreenObject EventObject, int PlayerIndex)
delegatebool OnOpenContextMenu (UIObject Sender, int PlayerIndex, out UIContextMenu CustomContextMenu)
delegate OnPressed (UIScreenObject EventObject, int PlayerIndex)
delegate OnPressRelease (UIScreenObject EventObject, int PlayerIndex)
delegate OnPressRepeat (UIScreenObject EventObject, int PlayerIndex)
delegatebool OnQueryToolTip (UIObject Sender, out UIToolTip CustomToolTip)
delegatebool OnRefreshSubscriberValue (UIObject Sender, int BindingIndex)
delegate OnUIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)
delegate OnValueChanged (UIObject Sender, int PlayerIndex)
Inherited Delegates from Engine.UIScreenObject
NotifyActiveSkinChanged, NotifyActiveStateChanged, NotifyPositionChanged, NotifyResolutionChanged, NotifyVisibilityChanged, OnPreRenderCallBack, OnProcessInputAxis, OnProcessInputKey, OnRawInputAxis, OnRawInputKey

Functions Summary
function AddStyleSubscriber (const out UIStyleResolver Subscriber)
function AnimSetBottom (float NewBottom)
function AnimSetColor (LinearColor NewColor)
function AnimSetLeft (float NewLeft)
function AnimSetOpacity (float NewOpacity)
function AnimSetPosition (Vector NewPosition)
function AnimSetRelPosition (Vector NewPosition, Vector InitialPosition)
function AnimSetRight (float NewRight)
function AnimSetRotation (Rotator NewRotation)
function AnimSetScale (float NewScale)
function AnimSetTop (float NewTop)
function AnimSetVisibility (bool bIsVisible)
functionbool CanAcceptFocus (optional int PlayerIndex=0 ) con)
function ClearDefaultDataBinding (int BindingIndex)
event ClearUIAnimation (name AnimName, optional UIAnimationSeq AnimSeq))
functionint FindStyleSubscriberIndex (const out UIStyleResolver Subscriber)
functionint FindStyleSubscriberIndexById (name StyleSubscriberId)
functionstring GenerateSceneDataStoreMarkup (optional string Group="ContextMenuItems" ) con)
functionMatrix GenerateTransformMatrix (optional bool bIncludeParentTransforms=true ) con)
functionvector GetAnchorPosition (optional bool bRelativeToWidget=true, optional bool bPixelSpace ) con)
functionstring GetDefaultDataBinding (int BindingIndex ) con)
function GetDefaultDataStores (out array<UIDataStore> out_BoundDataStores)
functionUIObject GetOwner ()))
functionUIScreenObject GetParent ()))
functionfloat GetPositionExtent (EUIWidgetFace Face, optional bool bIncludeRotation ) con)
function GetPositionExtents (out float MinX, out float MaxX, out float MinY, out float MaxY, optional bool bIncludeRotation ) con)
functionMatrix GetRotationMatrix (optional bool bIncludeParentRotations=true ) con)
functionUIScene GetScene ()))
functionstring GetToolTipValue ()
functionbool HasTransform (optional bool bIncludeParentTransforms=true ) con)
functionbool IsContainedBy (UIObject TestWidget)
functionbool IsDockedTo (const UIScreenObject TargetWidget, optional EUIWidgetFace SourceFace=UIFACE_MAX, optional EUIWidgetFace TargetFace=UIFACE_MAX ) con)
functionbool IsPrivateBehaviorSet (int Behavior ) con)
function LogRenderBounds (int Indent ))
functionbool NeedsActiveCursorUpdates () con)
function NotifyValueChanged (optional int PlayerIndex=INDEX_NONE, optional int NotifyFlags=0)
function OnSetDatastoreBinding (UIAction_SetDatastoreBinding Action ))
event PlayUIAnimation (name AnimName, optional UIAnimationSeq AnimSeqTemplate, optional float PlaybackRate=1.0, ptional bool bLoop, optional float InitialPosition=0.0))
function RemoveStyleSubscriber (const out UIStyleResolver Subscriber)
functionbool ResolveDefaultDataBinding (int BindingIndex)
functionbool ResolveStyles (optional bool bClearExistingValue)
function RotateWidget (rotator NewRotationAmount, optional bool bAccumulateRotation)
function SetActiveCursorUpdate (bool bShouldReceiveCursorUpdates)
function SetAnchorPosition (vector NewAnchorPosition, optional EPositionEvalType InputType=EVALPOS_PixelViewport)
function SetDefaultDataBinding (string MarkupText, int BindingIndex)
functionbool SetDockPadding (EUIWidgetFace SourceFace, float PaddingValue, optional EUIDockPaddingEvalType PaddingInputType=UIPADDINGEVAL_Pixels, optional bool bModifyPaddingScaleType)
functionbool SetDockParameters (EUIWidgetFace SourceFace, UIScreenObject Target, EUIWidgetFace TargetFace, float PaddingValue, optional EUIDockPaddingEvalType PaddingInputType=UIPADDINGEVAL_Pixels, optional bool bModifyPaddingScaleType)
functionbool SetDockTarget (EUIWidgetFace SourceFace, UIScreenObject Target, EUIWidgetFace TargetFace)
functionbool SetForcedNavigationTarget (EUIWidgetFace Face, UIObject NavTarget, bool bIsNullOverride=FALSE)
functionbool SetNavigationTarget (EUIWidgetFace Face, UIObject NewNavTarget)
function SetPrivateBehavior (int Behavior, bool Value, optional bool bRecurse)
functionbool SetWidgetStyleByName (name StyleResolverTagToSet, name StyleFriendlyName)
event StopUIAnimation (name AnimName, optional UIAnimationSeq AnimSeq, optional bool bFinalize))
function TickAnim (FLOAT DeltaTime)
event UIAnimEnd (int SeqIndex))
function UpdateRotationMatrix ()
Inherited Functions from Engine.UIScreenObject
AcceptsPlayerInput, ActivateEventByClass, ActivateState, ActivateStateByClass, AddedChild, CanAcceptFocus, CanPlayOnline, CanPropagateFocusFor, CanvasToScreen, ConditionalPropagateEnabledState, ContainsChild, ContainsChildOfClass, CreatePlayerData, CreateWidget, DeactivateState, DeactivateStateByClass, DeProject, DisablePlayerInput, DisableWidget, EnablePlayerInput, EnableWidget, FindChild, FindChildIndex, FindChildUsingID, FindEventsOfClass, FocusFirstControl, FocusLastControl, GetActivePlayerCount, GetAspectRatioAutoScaleFactor, GetBestControllerId, GetBestPlayerIndex, GetBounds, GetCanvasToScreen, GetChildren, GetCurrentState, GetDockedWidgets, GetFocusedControl, GetInverseCanvasToScreen, GetLastFocusedControl, GetLoginStatus, GetNATType, GetObjectCount, GetParent, GetPlayerOwner, GetPosition, GetPositionVector, GetSupportedPlayerCount, GetSupportedUIActionKeyNames, GetViewportHeight, GetViewportOffset, GetViewportOrigin, GetViewportScale, GetViewportSize, GetViewportWidth, GetWidgetPathName, HasActiveStateOfClass, HasLinkConnection, Initialize, Initialized, InitializePlayerTracking, InsertChild, IsActive, IsEnabled, IsFocused, IsHidden, IsHoldingAlt, IsHoldingCtrl, IsHoldingShift, IsInitialized, IsLoggedIn, IsNeverFocused, IsPressed, IsVisible, KillFocus, LogCurrentState, NavigateFocus, NextControl, OnChangeVisibility, OnConsoleCommand, OnSetControllerId, OnShowAchievementsUI, OnShowContentMarketplaceUI, OnShowFeedbackUI, OnShowFriendInviteUI, OnShowFriendsUI, OnShowGamerCardUI, OnShowMembershipMarketplaceUI, OnShowMessagesUI, OnShowPlayersUI, OverrideLastFocusedControl, PixelToCanvas, PixelToScreen, PlayUISound, PostInitialize, PrevControl, PrivateSetVisibility, Project, RebuildNavigationLinks, RemoveChild, RemoveChildren, RemovedChild, RemovedFromParent, RemovePlayerData, ReplaceChild, RequestFormattingUpdate, RequestPrimitiveReview, RequestSceneUpdate, ScreenToCanvas, ScreenToPixel, SetEnabled, SetFocus, SetFocusToChild, SetInputMask, SetPosition, SetVisibility
Inherited Functions from Engine.UIRoot
<, =, ConvertWidgetIDToString, GetCurrentUIController, GetCursorPosition, GetCursorSize, GetDataStoreFieldValue, GetDataStoreStringValue, GetFaceOrientation, GetPrimitiveTransform, GetSceneClient, IsConsole, SetDataStoreFieldValue, SetDataStoreStringValue, SetMouseCaptureOverride


Constants Detail

CONTEXTMENU_BINDING_INDEX Source code

const CONTEXTMENU_BINDING_INDEX = 101;

FIRST_DEFAULT_DATABINDING_INDEX Source code

const FIRST_DEFAULT_DATABINDING_INDEX = 100;
used to differentiate tooltip bindings from others

TOOLTIP_BINDING_INDEX Source code

const TOOLTIP_BINDING_INDEX = 100;


Variables Detail

AnimationParent Source code

var UIObject AnimationParent;
Used as the parent in animation sequences

AnimationPosition Source code

var transient vector AnimationPosition;
- The following is used in UTGame's UI animation system. - It is subject to change at any time.

AnimStack Source code

var transient array<UIAnimSeqRef> AnimStack;
This is the stack of animations currently being applied to this UIObject

bEnableActiveCursorUpdates Source code

var private bool bEnableActiveCursorUpdates;
Indicates that this widget should receive a call each tick with the location of the mouse cursor while it's the active control (NotifyMouseOver) (caution: slightly degrades performance)

bSupportsPrimaryStyle Source code

var const bool bSupportsPrimaryStyle;
Temp hack to allow widgets to remove "Primary Style" from the styles listed in the context menu for that widget if they no longer use it. Will be removed once I am ready to deprecate the PrimaryStyle property.

Owner Source code

var const private duplicatetransient UIObject Owner;
the UIObject that contains this widget in its Children array

OwnerScene Source code

var const private duplicatetransient UIScene OwnerScene;
The scene that owns this widget

PrimaryStyle Source code

var UIStyleReference PrimaryStyle;
Specifies the style data to use for this widget

PrivateFlags Source code

var private int PrivateFlags;
Stores a bitmask of flags which modify/define which operations may be performed to this widget (such as renaming, reparenting, selecting, etc.). Valid behavior flags are defined in UIRoot.uc, as consts which begin with PRIVATE_

StyleSubscribers Source code

var transient array<UIStyleResolver> StyleSubscribers;
List of objects/components contained by this widget which contain their own style references. When this widget's style is resolved, each element in this list will receive a notification to resolve its style references as well. Elements should be added to this list either from the native InitializeStyleSubscribers method [for native classes], the Initialized event [for non-native classes], or the native PostEditChange method (when e.g. components are created or removed using the UI editor's property window). You should NEVER add elements to this array using defaultproperties, since interface properties will not be updated to point to the subobject/component instance when this widget is created.

WidgetID Source code

var noimport WIDGET_ID WidgetID;
Unique identifier for this widget

Data

ContextMenuData Source code

var(Data) private editconst UIDataStoreBinding ContextMenuData;

ToolTip Source code

var(Data) private UIDataStoreBinding ToolTip;
The tool tip for this widget; only relevant for widgets that implement the UIDataStoreSubscriber interface.

Debug

bDebugShowBounds Source code

var(Debug) bool bDebugShowBounds;
Set to true to render an outline marking the widget's RenderBounds.

DebugBoundsColor Source code

var(Debug) color DebugBoundsColor;
if bRenderBoundingRegion is TRUE, specifies the color to use for this widget.

Focus

NavigationTargets Source code

var(Focus) UINavigationData NavigationTargets;
Controls which widgets are given focus when this widget receives an event that changes the currently focused widget.

TabIndex Source code

var(Focus) int TabIndex;
Allows the designer to specify where this widget occurs in the bound (i.e. tab, shift+tab) navigation network of this widget's parent.

Presentation

DockTargets Source code

var(Presentation) editconst UIDockingSet DockTargets;
The widgets that this widget should be docked to. For the 'right' and 'bottom' faces, if the widget has no dock target, it is considered docked to the 'left' and 'top' faces, respectively.

RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX] Source code

var(Presentation) editconst private const transient Vector2D RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX];
Represents the location of the corners of the widget including any tranforms, in absolute pixels (pixel space). Starts at the upper-left corner of the widget and goes clockwise.

RenderBounds[EUIWidgetFace.UIFACE_MAX] Source code

var(Presentation) editconst private const transient float RenderBounds[EUIWidgetFace.UIFACE_MAX];
Represents the bounding region available for the widget to render itself in. Set through the docking system.

RenderOffset Source code

var(Presentation) vector RenderOffset;
Screenspace offset to apply to the widget's rendering.

Rotation Source code

var(Presentation) UIRotation Rotation;
Rotation of the widget.

WidgetTag Source code

var(Presentation) editconst name WidgetTag;
Unique non-localized name for this widget which is used to reference the widget without needing to know its GUID


Delegates Detail

OnClicked Source code

delegate bool OnClicked ( UIScreenObject EventObject, int PlayerIndex )
Called when the widget is no longer being pressed. Not implemented by all widget types. The difference between this delegate and the OnPressRelease delegate is that OnClick will only be called on the widget that received the matching key press. OnPressRelease will be called on whichever widget was under the cursor when the key was released, which might not necessarily be the widget that received the key press.
@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.

OnCloseContextMenu Source code

delegate bool OnCloseContextMenu ( UIContextMenu ContextMenu, int PlayerIndex )
Called when the system wants to close the currently active context menu.
@param ContextMenu the context menu that is going to be closed
@param PlayerIndex the index of the player that generated the request for the context menu to be closed.
@return TRUE to allow the specified context menu to be closed; FALSE to prevent the context menu from being closed. Note that there are certain situations where the context menu will be closed regardless of the return value, such as when the scene which owns the context menu is being closed.

OnContextMenuItemSelected Source code

delegate OnContextMenuItemSelected ( UIContextMenu ContextMenu, int PlayerIndex, int ItemIndex )
Called when the user selects a choice from a context menu.
@param ContextMenu the context menu that called this delegate.
@param PlayerIndex the index of the player that generated the event.
@param ItemIndex the index [into the context menu's MenuItems array] for the item that was selected.

OnCreate Source code

delegate OnCreate ( UIObject CreatedWidget, UIScreenObject CreatorContainer )
Called when this widget is created
@param CreatedWidget the widget that was created
@param CreatorContainer the container that created the widget

OnDoubleClick Source code

delegate OnDoubleClick ( UIScreenObject EventObject, int PlayerIndex )
Called when the widget has received a double-click input event. Not implemented by all widget types.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

OnOpenContextMenu Source code

delegate bool OnOpenContextMenu ( UIObject Sender, int PlayerIndex, out UIContextMenu CustomContextMenu )
Called when the user right-clicks (or whatever input key is configured to activate the ShowContextMenu UI input alias) this widget. Provides a way for widgets to customize the context menu that is used or prevent the context menu from being shown entirely. For script customization of the context menu, a custom context menu object must be assigned to the CustomContextMenu variable. It is possible to provide data for the context menu without creating or modifying any existing data stores. First, get a reference to the scene's default context menu (GetScene()->GetDefaultContextMenu()). Add the desired elements to the scene's data store then bind the context menu to that data field.
@param Sender the widget that will be displaying the context menu
@param PlayerIndex index of the player that generated the input event that triggered the context menu display.
@param CustomContextMenu to provide a custom tooltip implementation, fill in in this value and return TRUE. The custom context menu will then be activated by native code.
@return return FALSE to prevent a context menu from being shown, including any from parent widgets. Return TRUE to indicate that the context menu for this widget can be displayed; if a value is not provided for CustomContextMenu, the default context menu will be displayed, using this widget's context menu data binding to generate the items.

OnPressed Source code

delegate OnPressed ( UIScreenObject EventObject, int PlayerIndex )
Called when this widget is pressed. Not implemented by all widget types.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

OnPressRelease Source code

delegate OnPressRelease ( UIScreenObject EventObject, int PlayerIndex )
Called when the widget is no longer being pressed. Not implemented by all widget types.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

OnPressRepeat Source code

delegate OnPressRepeat ( UIScreenObject EventObject, int PlayerIndex )
Called when the widget been pressed and the user is holding the button down. Not implemented by all widget types.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

OnQueryToolTip Source code

delegate bool OnQueryToolTip ( UIObject Sender, out UIToolTip CustomToolTip )
Called when this widget (or one of its children) becomes the ActiveControl. Provides a way for child classes or containers to easily override or short-circuit the standard tooltip that is normally shown. If this delegate is not assigned to any function, the default tool-tip will be displayed if this widget has a data store binding property named "ToolTipBinding" which is bound to a valid data store.
@param Sender the widget that will be displaying the tooltip
@param CustomToolTip to provide a custom tooltip implementation, fill in in this value and return TRUE. The custom tool tip object will then be activated by native code.
@return return FALSE to prevent any tool-tips from being shown, including parents.

OnRefreshSubscriberValue Source code

delegate bool OnRefreshSubscriberValue ( UIObject Sender, int BindingIndex )
Called when this widget receives a call to RefreshSubscriberValue.
@param Sender the widget that is refreshing their value
@param BindingIndex optional parameter for indicating which data store binding is being refreshed, 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, while values greater than FIRST_DEFAULT_DATABINDING_INDEX correspond to tooltips and context menus.
@return TRUE to indicate that this widget is going to refresh its value manually.

OnUIAnimEnd Source code

delegate OnUIAnimEnd ( UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq )
If set, this delegate is called whenever an animation is finished

OnValueChanged Source code

delegate OnValueChanged ( UIObject Sender, int PlayerIndex )
Called when the value of this UIObject is changed. Only called for widgets that contain data values.
@param Sender the UIObject whose value changed
@param PlayerIndex the index of the player that generated the call to this method; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.


Functions Detail

AddStyleSubscriber Source code

native final function AddStyleSubscriber ( const out UIStyleResolver Subscriber )
Adds the specified StyleResolver to the list of StyleSubscribers
@param StyleSubscriberId the name to associate with this UIStyleResolver; used for differentiating styles from multiple UIStyleResolvers of the same class
@param Subscriber the UIStyleResolver to add.

AnimSetBottom Source code

native function AnimSetBottom ( float NewBottom )

AnimSetColor Source code

native function AnimSetColor ( LinearColor NewColor )

AnimSetLeft Source code

native function AnimSetLeft ( float NewLeft )

AnimSetOpacity Source code

native function AnimSetOpacity ( float NewOpacity )
Note these are accessor functions for the animation system. They should be subclassed.

AnimSetPosition Source code

native function AnimSetPosition ( Vector NewPosition )

AnimSetRelPosition Source code

native function AnimSetRelPosition ( Vector NewPosition, Vector InitialPosition )

AnimSetRight Source code

native function AnimSetRight ( float NewRight )

AnimSetRotation Source code

native function AnimSetRotation ( Rotator NewRotation )

AnimSetScale Source code

native function AnimSetScale ( float NewScale )

AnimSetTop Source code

native function AnimSetTop ( float NewTop )

AnimSetVisibility Source code

native function AnimSetVisibility ( bool bIsVisible )

CanAcceptFocus Source code

native const function bool CanAcceptFocus ( optional int PlayerIndex=0 ) con )
Determines whether this widget can become the focused control. In the case of this widget we don't want it to gain focus.
@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.

ClearDefaultDataBinding Source code

native final function ClearDefaultDataBinding ( int BindingIndex )
Clears the reference to the bound data store, if applicable.
@param BindingIndex indicates which data store binding to operate on.

ClearUIAnimation Source code

event ClearUIAnimation ( name AnimName, optional UIAnimationSeq AnimSeq) )
Clears the animation from the stack. Stopping an animation (either naturally or by force) doesn't remove the effects. In those cases you need to clear the animation from the stack. NOTE: This only affects position and rotation animations. All other animations are destructive and can't be easilly reset. @Param AnimName The Name of the animation to play @Param AnimSeq Optional sequence to use. In case you don't know the name

FindStyleSubscriberIndex Source code

native final function int FindStyleSubscriberIndex ( const out UIStyleResolver Subscriber )
Returns the index [into the StyleSubscriber's array] for the specified UIStyleResolver, or INDEX_NONE if Subscriber is NULL or is not found in the StyleSubscriber's array.
@param Subscriber the subscriber to find
@param SubscriberId if specified, it will only be considered a match if the SubscriberId associated with Subscriber matches this value.

FindStyleSubscriberIndexById Source code

native final function int FindStyleSubscriberIndexById ( name StyleSubscriberId )
Returns the index [into the StyleSubscriber's array] for the subscriber which has a StyleResolverTag that matches the specified value or INDEX_NONE if StyleSubscriberId is None or is not found in the StyleSubscriber's array.
@param StyleSubscriberId the tag associated with the UIStyleResolver to find

GenerateSceneDataStoreMarkup Source code

native const function string GenerateSceneDataStoreMarkup ( optional string Group="ContextMenuItems" ) con )
Generates a string which can be used to interact with temporary data in the scene data store specific to this widget.
@param Group for now, doesn't matter, as only "ContextMenuItems" is supported
@return a data store markup string which can be used to reference content specific to this widget in the scene's data store.

GenerateTransformMatrix Source code

native final const function Matrix GenerateTransformMatrix ( optional bool bIncludeParentTransforms=true ) con )
Generates a matrix which contains a translation for this widget's position (from 0,0 screen space) as well as the widget's current rotation, scale, etc.
@param bIncludeParentTransforms if TRUE, the matrix will be relative to the parent widget's own transform matrix.
@return a matrix containing the translation and rotation values of this widget.
@todo ronp - we REALLY need to cache this baby and update it any time the widget's position, anchor, rotation, scale, or parent changes.

GetAnchorPosition Source code

native final const function vector GetAnchorPosition ( optional bool bRelativeToWidget=true, optional bool bPixelSpace ) con )
Returns the current location of the anchor.
@param bRelativeToWidget specify TRUE to return the anchor position relative to the widget's upper left corner. specify FALSE to return the anchor position relative to the viewport's origin.
@param bPixelSpace specify TRUE to convert the anchor position into pixel space (only relevant if the widget is rotated)
@return a vector representing the position of this widget's rotation anchor.

GetDefaultDataBinding Source code

native final const function string GetDefaultDataBinding ( int BindingIndex ) con )
Returns the data binding's current value.
@param BindingIndex indicates which data store binding to operate on.

GetDefaultDataStores Source code

native final function GetDefaultDataStores ( out array<UIDataStore> out_BoundDataStores )
Returns the data store providing the data for all default data bindings.

GetOwner Source code

final function UIObject GetOwner ( ) )
Returns the owner of this widget

GetParent Source code

function UIScreenObject GetParent ( ) )
Returns the scene or widget that contains this widget in its Children array.

GetPositionExtent Source code

native final const function float GetPositionExtent ( EUIWidgetFace Face, optional bool bIncludeRotation ) con )
Gets the minimum or maximum value for the specified widget face position after rotation has been applied.
@param bIncludeRotation Indicates whether the widget's rotation should be applied to the extent values.

GetPositionExtents Source code

native final const function GetPositionExtents ( out float MinX, out float MaxX, out float MinY, out float MaxY, optional bool bIncludeRotation ) con )
Gets the minimum and maximum values for the widget's face positions after rotation (if specified) has been applied.
@param MinX The minimum x position of this widget.
@param MaxX The maximum x position of this widget.
@param MinY The minimum y position of this widget.
@param MaxY The maximum y position of this widget.
@param bIncludeRotation Indicates whether the widget's rotation should be applied to the extent values.

GetRotationMatrix Source code

native final const function Matrix GetRotationMatrix ( optional bool bIncludeParentRotations=true ) con )
Returns this widget's current rotation matrix
@param bIncludeParentRotations if TRUE, the matrix will be relative to the parent widget's own rotation matrix.

GetScene Source code

final function UIScene GetScene ( ) )
Returns the scene that owns this widget

GetToolTipValue Source code

native final function string GetToolTipValue ( )
Returns the ToolTip data binding's current value after being resolved.

HasTransform Source code

native final const function bool HasTransform ( optional bool bIncludeParentTransforms=true ) con )
Determines whether this widget has any tranformation applied to it.
@param bIncludeParentTransforms specify TRUE to check whether this widget's parents are transformed if this one isn't.

IsContainedBy Source code

native final function bool IsContainedBy ( UIObject TestWidget )
Returns TRUE if TestWidget is in this widget's Owner chain.

IsDockedTo Source code

native final const function bool IsDockedTo ( const UIScreenObject TargetWidget, optional EUIWidgetFace SourceFace=UIFACE_MAX, optional EUIWidgetFace TargetFace=UIFACE_MAX ) con )
Returns TRUE if this widget is docked to the specified widget.
@param TargetWidget the widget to check for docking links to
@param SourceFace if specified, returns TRUE only if the specified face is docked to TargetWidget
@param TargetFace if specified, returns TRUE only if this widget is docked to the specified face on the target widget.

IsPrivateBehaviorSet Source code

native final const function bool IsPrivateBehaviorSet ( int Behavior ) con )
Checks to see if the specified private behavior is set. Valid behavior flags are defined in UIRoot.uc, as consts which begin with PRIVATE_
@param Behavior the flag of the private behavior that is being checked
@return TRUE if the specified flag is set and FALSE if not.

LogRenderBounds Source code

function LogRenderBounds ( int Indent ) )

NeedsActiveCursorUpdates Source code

native final const function bool NeedsActiveCursorUpdates ( ) con )
Returns the value of bEnableActiveCursorUpdates

NotifyValueChanged Source code

native function NotifyValueChanged ( optional int PlayerIndex=INDEX_NONE, optional int NotifyFlags=0 )
Called whenever the value of the UIObject is modified (for those UIObjects which can have values). Calls the OnValueChanged delegate.
@param PlayerIndex the index of the player that generated the call to SetValue; used as the PlayerIndex when activating UIEvents; if not specified, the value of GetBestPlayerIndex() is used instead.
@param NotifyFlags optional parameter for individual widgets to use for passing additional information about the notification.

OnSetDatastoreBinding Source code

function OnSetDatastoreBinding ( UIAction_SetDatastoreBinding Action ) )
Kismet Action Handlers

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

RemoveStyleSubscriber Source code

native final function RemoveStyleSubscriber ( const out UIStyleResolver Subscriber )
Removes the specified StyleResolver from the list of StyleSubscribers.
@param Subscriber the subscriber to remove
@param SubscriberId if specified, Subscriber will only be removed if its SubscriberId matches this value.

ResolveDefaultDataBinding Source code

native final function bool ResolveDefaultDataBinding ( int BindingIndex )
Resolves the data binding's markup string.
@param BindingIndex indicates which data store binding to operate on.
@return TRUE if a data store field was successfully resolved from the data binding

ResolveStyles Source code

native final noexport function bool ResolveStyles ( optional bool bClearExistingValue )
Resolves the style references contained by this widget from the currently active skin.
@param bClearExistingValue if TRUE, style references will be invalidated first.
@return TRUE if all style references were successfully resolved.

RotateWidget Source code

native final function RotateWidget ( rotator NewRotationAmount, optional bool bAccumulateRotation )
Rotates the widget around the current anchor position by the amount specified.
@param RotationDelta amount to rotate the widget by in DEGREES.
@param bAccumulateRotation if FALSE, set the widget's rotation to NewRotationAmount; if TRUE, increments the widget's rotation by NewRotationAmount

SetActiveCursorUpdate Source code

native function SetActiveCursorUpdate ( bool bShouldReceiveCursorUpdates )
Change the value of bEnableActiveCursorUpdates to the specified value.

SetAnchorPosition Source code

native final function SetAnchorPosition ( vector NewAnchorPosition, optional EPositionEvalType InputType=EVALPOS_PixelViewport )
Sets the location of the widget's rotation anchor, relative to the top-left of this widget's bounds.
@param AnchorPosition New location for the widget's rotation anchor.
@param InputType indicates which format the AnchorPos value is in

SetDefaultDataBinding Source code

native final function SetDefaultDataBinding ( string MarkupText, int BindingIndex )
Set the markup text for a default data binding to the value specified.
@param NewMarkupText the new markup text for this widget, either a literal string or a data store markup string
@param BindingIndex indicates which data store binding to operate on.

SetDockPadding Source code

native function bool SetDockPadding ( EUIWidgetFace SourceFace, float PaddingValue, optional EUIDockPaddingEvalType PaddingInputType=UIPADDINGEVAL_Pixels, optional bool bModifyPaddingScaleType )
Sets the padding for the specified docking link.
@param SourceFace the face of this widget to apply the changes to
@param Padding the amount of padding to use for this docking set. Positive values will "push" this widget past the target face of the other widget, while negative values will "pull" this widget away from the target widget.
@param PaddingInputType specifies how the Padding value should be interpreted.
@param bModifyPaddingScaleType specify TRUE to change the DockPadding's ScaleType to the PaddingInputType.
@return TRUE if the changes were successfully applied.

SetDockParameters Source code

native final function bool SetDockParameters ( EUIWidgetFace SourceFace, UIScreenObject Target, EUIWidgetFace TargetFace, float PaddingValue, optional EUIDockPaddingEvalType PaddingInputType=UIPADDINGEVAL_Pixels, optional bool bModifyPaddingScaleType )
Combines SetDockTarget and SetDockPadding into a single function.
@param SourceFace the face of this widget to apply the changes to
@param Target the widget to dock to
@param TargetFace the face on the Target widget that SourceFace will dock to
@param Padding the amount of padding to use for this docking set. Positive values will "push" this widget past the target face of the other widget, while negative values will "pull" this widget away from the target widget.
@param PaddingInputType specifies how the Padding value should be interpreted.
@param bModifyPaddingScaleType specify TRUE to change the DockPadding's ScaleType to the PaddingInputType.
@return TRUE if the changes were successfully applied.

SetDockTarget Source code

native function bool SetDockTarget ( EUIWidgetFace SourceFace, UIScreenObject Target, EUIWidgetFace TargetFace )
Sets the docking target for the specified face.
@param SourceFace the face of this widget to apply the changes to
@param Target the widget to dock to
@param TargetFace the face on the Target widget that SourceFace will dock to
@return TRUE if the changes were successfully applied.

SetForcedNavigationTarget Source code

native final function bool SetForcedNavigationTarget ( EUIWidgetFace Face, UIObject NavTarget, bool bIsNullOverride=FALSE )
Sets the designer-specified navigation target for the specified face. When navigation links for the scene are rebuilt, the designer-specified navigation target will always override any auto-calculated targets. If the new value is different from the current value, requests the owning scene to update the navigation links for the entire scene.
@param Face the face to set the navigation link for
@param NavTarget the widget to set as the link for the specified face
@param bIsNullOverride if NavTarget is NULL, specify TRUE to indicate that this face's nav target should not be automatically calculated.
@return TRUE if the nav link was successfully set.

SetNavigationTarget Source code

native final function bool SetNavigationTarget ( EUIWidgetFace Face, UIObject NewNavTarget )
Sets the actual navigation target for the specified face. If the new value is different from the current value, requests the owning scene to update the navigation links for the entire scene.
@param Face the face to set the navigation link for
@param NewNavTarget the widget to set as the link for the specified face
@return TRUE if the nav link was successfully set.

SetPrivateBehavior Source code

native final function SetPrivateBehavior ( int Behavior, bool Value, optional bool bRecurse )
Set the specified private behavior for this UIObject. Valid behavior flags are defined in UIRoot.uc, as consts which begin with PRIVATE_
@param Behavior the flag of the private behavior that is being set
@param Value whether the flag is being enabled or disabled
@param bRecurse specify TRUE to apply the flag in all children of this widget as well.

SetWidgetStyleByName Source code

native final function bool SetWidgetStyleByName ( name StyleResolverTagToSet, name StyleFriendlyName )
Sets a style in the widget using the name of the style.
@param StyleResolverTagToSet the tag associated with the UIStyleResolver to set
@param StyleFriendlyName the name of the style to set the widget to
@return TRUE if the style was successfully applied to this widget

StopUIAnimation Source code

event StopUIAnimation ( name AnimName, optional UIAnimationSeq AnimSeq, optional bool bFinalize) )
Stop an animation that is playing. @Param AnimName The Name of the animation to play @Param AnimSeq Optional sequence to use. In case you don't know the name @Param bFinalize If true, we will force the end frame

TickAnim Source code

native function TickAnim ( FLOAT DeltaTime )
Itterate over the AnimStack and tick each active sequence @Param DeltaTime How much time since the last call

UIAnimEnd Source code

event UIAnimEnd ( int SeqIndex) )
AnimEnd is always called when an animation stops playing either by ending, or when StopAnim is called on it. It's responsible for unsubscribing from the scene client and performing any housekeeping

UpdateRotationMatrix Source code

native final function UpdateRotationMatrix ( )
Updates the widget's rotation matrix based on the widget's current rotation.


Defaultproperties

defaultproperties
{
   PrimaryStyle=(DefaultStyleTag="DefaultComboStyle")
   TabIndex=-1
   DockTargets=(TargetFace[0]=(INVALID),TargetFace[1]=(INVALID),TargetFace[2]=(INVALID),TargetFace[3]=(INVALID))
   Rotation=(AnchorPosition=(ScaleType[0]=EVALPOS_PixelOwner,ScaleType[1]=EVALPOS_PixelOwner),AnchorType=RA_Center)
   ToolTip=
   ContextMenuData=(RequiredFieldType=DATATYPE_Collection)
   bSupportsPrimaryStyle=True
   DebugBoundsColor=(B=255,G=128,R=255,A=255)
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIComp_Event'
      DefaultEvents(0)=(EventTemplate=UIEvent_Initialized'Engine.Default__UIObject:WidgetInitializedEvent')
      Name="WidgetEventComponent"
      ObjectArchetype=UIComp_Event'Engine.Default__UIComp_Event'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIObject"
   ObjectArchetype=UIScreenObject'Engine.Default__UIScreenObject'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:47.486 - Created with UnCodeX