GWG.WindowFramework.WindowFrameTooltip Class Reference

Represents a tooltip element that displays contextual information for UI elements. The tooltip can be styled dynamically based on the current theme and supports fade-in and fade-out animations. More...

Inheritance diagram for GWG.WindowFramework.WindowFrameTooltip:

Collaboration diagram for GWG.WindowFramework.WindowFrameTooltip:

Public Member Functions
	WindowFrameTooltip ()
	Initializes a new instance of the WindowFrameTooltip class. Sets up the tooltip's default styles and registers theme update callbacks.
void	Close ()
	Closes the tooltip and applies fade-out animation if enabled.
void	CloseNow ()
	Immediately closes the tooltip by pausing its associated task, resetting it, and updating the tooltip's visibility and opacity styles to make it hidden.
void	Show (VisualElement target)
	Displays the tooltip near the specified target element. Positions the tooltip based on hints in the target's tooltip text.

Private Member Functions
	~WindowFrameTooltip ()
void	FadeInTooltip ()
void	FadeOutTooltip ()
void	UpdateTheme (List< StyleSheet > sheets, List< StyleSheet > oldTheme)
	Updates the tooltip's styles based on the provided theme stylesheet. Clears existing stylesheets and applies the new theme.

Private Attributes
Label	_label
IVisualElementScheduledItem	_task
TooltipFadeType	_tooltipFadeType

Detailed Description

Represents a tooltip element that displays contextual information for UI elements. The tooltip can be styled dynamically based on the current theme and supports fade-in and fade-out animations.

Constructor & Destructor Documentation

WindowFrameTooltip()

GWG.WindowFramework.WindowFrameTooltip.WindowFrameTooltip ( )

inline

Initializes a new instance of the WindowFrameTooltip class. Sets up the tooltip's default styles and registers theme update callbacks.

Here is the call graph for this function:

~WindowFrameTooltip()

GWG.WindowFramework.WindowFrameTooltip.~WindowFrameTooltip ( )

inlineprivate

Here is the call graph for this function:

Member Function Documentation

Close()

void GWG.WindowFramework.WindowFrameTooltip.Close ( )

inline

Closes the tooltip and applies fade-out animation if enabled.

Here is the call graph for this function:

CloseNow()

void GWG.WindowFramework.WindowFrameTooltip.CloseNow ( )

inline

Immediately closes the tooltip by pausing its associated task, resetting it, and updating the tooltip's visibility and opacity styles to make it hidden.

Here is the caller graph for this function:

FadeInTooltip()

void GWG.WindowFramework.WindowFrameTooltip.FadeInTooltip ( )

inlineprivate

Here is the caller graph for this function:

FadeOutTooltip()

void GWG.WindowFramework.WindowFrameTooltip.FadeOutTooltip ( )

inlineprivate

Here is the caller graph for this function:

Show()

void GWG.WindowFramework.WindowFrameTooltip.Show ( VisualElement target )

inline

Displays the tooltip near the specified target element. Positions the tooltip based on hints in the target's tooltip text.

Parameters

target

The UI element to display the tooltip for.

Here is the call graph for this function:

UpdateTheme()

void GWG.WindowFramework.WindowFrameTooltip.UpdateTheme ( List< StyleSheet > sheets, List< StyleSheet > oldTheme )

inlineprivate

Updates the tooltip's styles based on the provided theme stylesheet. Clears existing stylesheets and applies the new theme.

Parameters

newTheme

The new theme stylesheet to apply.

Here is the caller graph for this function:

Member Data Documentation

_label

Label GWG.WindowFramework.WindowFrameTooltip._label

private

_task

IVisualElementScheduledItem GWG.WindowFramework.WindowFrameTooltip._task

private

_tooltipFadeType

TooltipFadeType GWG.WindowFramework.WindowFrameTooltip._tooltipFadeType

private