I'm a doctor, not a mechanic
UE3:UIToolTip (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UILabel >> UIToolTip |
Contents |
| This is an auto-generated page and may need human attention. Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
This specialized label is used for rendering tooltips in the UI.
Copyright 2007 Epic Games, Inc. All Rights Reserved
[edit] Properties
[edit] Property group 'UIToolTip'
[edit] bAutoHideOnInput
Type: bool
Determines whether this tooltip will automatically deactivate if input is received by the UI system.
Default value: True
[edit] bFollowCursor
Type: bool
Indicates whether the tooltip will remain in the location where it was initially shown, or follow the cursor.
[edit] Internal variables
[edit] bPendingPositionUpdate
Type: bool
Modifiers: const, transient
Used to indicate that the position of this tool tip widget should be updated during the next tick
[edit] 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
[edit] SecondsActive
Type: float
Modifiers: const, transient
The amount of time this tooltip has been active, in seconds. Updated from TickToolTip().
[edit] Default values
| Property | Value |
|---|---|
| EventProvider | None |
| LabelBackground | UIComp_DrawImage'TooltipBackgroundRenderer' |
| PrivateFlags | 986 |
[edit] Subobjects
[edit] LabelStringRenderer
Class: Engine.UIComp_DrawString
Inherits from: UILabel.LabelStringRenderer
| Property | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AutoSizeParameters[0] |
|
||||||||||||
| AutoSizeParameters[1] |
|
||||||||||||
| StringStyle |
|
||||||||||||
| StyleResolverTag | 'ToolTip String Style' | ||||||||||||
| TextStyleCustomization |
|
[edit] TooltipBackgroundRenderer
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'ToolTip Background Style' |
[edit] Delegates
[edit] ActivateToolTip
Wrapper for BeginTracking which allows owning widgets to easily override the default behavior for tooltip activation
[edit] CanShowToolTip
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.
[edit] DeactivateToolTip
Wrapper for EndTracking which allows owning widgets to easily override the default behavior for tooltip de-activation
[edit] Native functions
[edit] 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.
[edit] 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.
[edit] 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.
