I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UIToolTip (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

Property group 'UIToolTip'[edit]

bAutoHideOnInput[edit]

Type: bool

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

Default value: True

bFollowCursor[edit]

Type: bool

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

Internal variables[edit]

bPendingPositionUpdate[edit]

Type: bool

Modifiers: const, transient

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

bResolveToolTipPosition[edit]

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[edit]

Type: float

Modifiers: const, transient

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

Default values[edit]

Property Value
EventProvider None
LabelBackground UIComp_DrawImage'TooltipBackgroundRenderer'
PrivateFlags 986

Subobjects[edit]

LabelStringRenderer[edit]

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[edit]

Class: Engine.UIComp_DrawImage

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

Delegates[edit]

ActivateToolTip[edit]

delegate UIToolTip ActivateToolTip (UIToolTip Sender)

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

CanShowToolTip[edit]

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[edit]

delegate bool DeactivateToolTip ()

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

Native functions[edit]

BeginTracking[edit]

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[edit]

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[edit]

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.