Window Framework v1.2.4
Window Framework for Unity UI Toolkit
Loading...
Searching...
No Matches
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.

Inheritance 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 ()
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

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

Constructor & Destructor Documentation

◆ WindowFrameTooltip()

GWG.WindowFramework.WindowFrameTooltip.WindowFrameTooltip ( )

Member Function Documentation

◆ Close()

void GWG.WindowFramework.WindowFrameTooltip.Close ( )

◆ CloseNow()

void GWG.WindowFramework.WindowFrameTooltip.CloseNow ( )

◆ FadeInTooltip()

void GWG.WindowFramework.WindowFrameTooltip.FadeInTooltip ( )
private

◆ FadeOutTooltip()

void GWG.WindowFramework.WindowFrameTooltip.FadeOutTooltip ( )
private

◆ Show()

void GWG.WindowFramework.WindowFrameTooltip.Show ( VisualElement target)
Parameters
targetThe UI element to display the tooltip for.

◆ UpdateTheme()

void GWG.WindowFramework.WindowFrameTooltip.UpdateTheme ( List< StyleSheet > sheets,
List< StyleSheet > oldTheme )
private
Parameters
newThemeThe new theme stylesheet to apply.

Member Data Documentation

◆ _label

Label GWG.WindowFramework.WindowFrameTooltip._label
private

◆ _task

IVisualElementScheduledItem GWG.WindowFramework.WindowFrameTooltip._task
private

◆ _tooltipFadeType

TooltipFadeType GWG.WindowFramework.WindowFrameTooltip._tooltipFadeType
private