The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:GUIToolTip (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> GUI >> GUIComponent >> GUIToolTip
Package: 
XInterface

Created on: 01/19/2004 Tooltip that appears when this component is moused over

Written by Ron Prestenback © 2003, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'GUIToolTip'[edit]

bMultiLine[edit]

Type: bool

Allow hint text to be wrapped if it's too long

Default value: True

bResetPosition[edit]

Type: bool

Position of this component needs to be updated

bTrackInput[edit]

Type: bool

Should this tooltip disappear when input is received

Default value: True

bTrackMouse[edit]

Type: bool

This tooltip will follow the mouse as it moves

CurrentTime[edit]

Type: float

Modifiers: noexport


ExpirationSeconds[edit]

Type: float

Modifiers: globalconfig


Default value: 3.0

InitialDelay[edit]

Type: float

Modifiers: globalconfig

Number of seconds of inactivity before appearing

Default value: 0.25

Lines[edit]

Type: array<string>

Modifiers: const

If multiline == true, contains the tooltip lines

MaxWidth[edit]

Type: float

Modifiers: globalconfig

Max width of the tooltip area, in percent of the screen width

Default value: 0.3

StartTime[edit]

Type: float

Modifiers: noexport


Text[edit]

Type: string

Modifiers: const

Entire tooltip

Default values[edit]

Property Value
bRequiresStyle True
bVisible False
StyleName "MouseOver"

Delegates[edit]

EnterArea[edit]

delegate GUIToolTip EnterArea ()


GetHeight[edit]

delegate float GetHeight (Canvas C)


GetLeft[edit]

delegate float GetLeft (Canvas C)


GetTop[edit]

delegate float GetTop (Canvas C)


GetWidth[edit]

delegate float GetWidth (Canvas C)


HideToolTip[edit]

delegate HideToolTip ()


LeaveArea[edit]

delegate bool LeaveArea ()


ShowToolTip[edit]

delegate ShowToolTip ()


Tick[edit]

delegate Tick (float RealSeconds)


Functions[edit]

Native functions[edit]

SetTip[edit]

native final function SetTip (coerce string NewTip)


Events[edit]

UpdatePosition[edit]

event UpdatePosition (Canvas C)


Other instance functions[edit]

GetTopAboveCursor[edit]

singular function float GetTopAboveCursor (Canvas C)


GetTopBelowCursor[edit]

singular function float GetTopBelowCursor (Canvas C)


InternalEnterArea[edit]

function GUIToolTip InternalEnterArea ()


InternalLeaveArea[edit]

function bool InternalLeaveArea ()