UE3:UIToolTip (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UILabel >> UIToolTip

Package:

Engine

Implemented interfaces:

UIDataStoreSubscriber, UIStringRenderer

This specialized label is used for rendering tooltips in the UI.

Copyright 2007 Epic Games, Inc. All Rights Reserved

Properties

Property group 'UIToolTip'

bAutoHideOnInput

Type: bool

Determines whether this tooltip will automatically deactivate if input is received by the UI system.

Default value: True

bFollowCursor

Type: bool

Indicates whether the tooltip will remain in the location where it was initially shown, or follow the cursor.

Internal variables

bPendingPositionUpdate

Type: bool

Modifiers: const, transient

Used to indicate that the position of this tool tip widget should be updated during the next tick

bResolveToolTipPosition

Type: bool

Modifiers: const, transient

used to indicate that this tooltip's position has been updated and needs to be resolved into actual screen values

SecondsActive

Type: float

Modifiers: const, transient

The amount of time this tooltip has been active, in seconds. Updated from TickToolTip().

Default values

Property	Value
EventProvider	None
LabelBackground	UIComp_DrawImage'TooltipBackgroundRenderer'
PrivateFlags	986

Subobjects

LabelStringRenderer

Class: Engine.UIComp_DrawString

Inherits from: UILabel.LabelStringRenderer

Property	Value
AutoSizeParameters[0]	Member Value bAutoSizeEnabled True Extent Member Value EvalType[1] UIEXTENTEVAL_PercentScene Value[1] 0.3
AutoSizeParameters[1]	Member Value bAutoSizeEnabled True
StringStyle	Member Value DefaultStyleTag 'DefaultToolTipStringStyle'
StyleResolverTag	'ToolTip String Style'
TextStyleCustomization	Member Value bOverrideClipMode True ClipMode CLIP_Normal

TooltipBackgroundRenderer

Class: Engine.UIComp_DrawImage

Property	Value
ImageStyle	Member Value DefaultStyleTag 'DefaultToolTipBackgroundStyle'
StyleResolverTag	'ToolTip Background Style'

Delegates

ActivateToolTip

delegate UIToolTip ActivateToolTip (UIToolTip Sender)

Wrapper for BeginTracking which allows owning widgets to easily override the default behavior for tooltip activation

CanShowToolTip

delegate bool CanShowToolTip (UIToolTip Sender)

Allows widgets to prevent a tooltip from being displayed; called every tick once the number of seconds since the tooltip was linked to a widget (i.e. when ActivateToolTip was called) is greater than UIInteraction.ToolTipInitialDelaySeconds.

Parameters:

• Sender - the tooltip that will be shown

Returns:

returning FALSE resets the tooltip's activation timer to 0; returning TRUE causes the tooltip to be made visible immediately.

DeactivateToolTip

delegate bool DeactivateToolTip ()

Wrapper for EndTracking which allows owning widgets to easily override the default behavior for tooltip de-activation

Native functions

BeginTracking

native final function UIToolTip BeginTracking ()

Initializes the timer used to determine when this tooltip should be shown. Called when the a widet that supports a tooltip becomes the scene client's ActiveControl.

Returns:

returns the tooltip that began tracking, or None if no tooltips were activated.

EndTracking

native final function bool EndTracking ()

Hides the tooltip and resets all internal tracking variables. Called when a widget that supports tooltips is no longer the scene client's ActiveControl.

Returns:

FALSE if the tooltip wishes to abort the deactivation and continue displaying the tooltip. The return value may be ignored if the UIInteraction needs to force the tooltip to disappear, for example if the scene is being closed or a context menu is being activated.

UpdateToolTipPosition

native final function UpdateToolTipPosition ()

Repositions this tool-tip to appear below the mouse cursor (or above if too near the bottom of the screen), without triggering a full scene update.