tgui::ToolTip Class Reference

Interface to set the settings for the tool tips. More...

#include <TGUI/ToolTip.hpp>

Static Public Member Functions
static void	setInitialDelay (Duration delay)
	Sets the time that the mouse has to stand still before the tooltip becomes visible.
static TGUI_NODISCARD Duration	getInitialDelay ()
	Returns the time that the mouse has to stand still before the tooltip becomes visible.
static void	setDistanceToMouse (const Vector2f &distance)
	Sets the default distance between the mouse position and the tool tip.
static TGUI_NODISCARD Vector2f	getDistanceToMouse ()
	Returns the default distance between the mouse position and the tool tip.
static void	setShowOnDisabledWidget (bool show)
	Sets whether the tool tip is shown even when the widget is disabled.
static TGUI_NODISCARD bool	getShowOnDisabledWidget ()
	Returns whether the tool tip is shown even when the widget is disabled.

Detailed Description

Interface to set the settings for the tool tips.

Member Function Documentation

getDistanceToMouse()

static TGUI_NODISCARD Vector2f tgui::ToolTip::getDistanceToMouse ( )

static

Returns the default distance between the mouse position and the tool tip.

Returns

Distance between mouse and tool tip

getInitialDelay()

static TGUI_NODISCARD Duration tgui::ToolTip::getInitialDelay ( )

static

Returns the time that the mouse has to stand still before the tooltip becomes visible.

Returns

Time before displaying tooltip

getShowOnDisabledWidget()

static TGUI_NODISCARD bool tgui::ToolTip::getShowOnDisabledWidget ( )

static

Returns whether the tool tip is shown even when the widget is disabled.

Returns

Would the tool tip be displayed when the mouse is on top of a disabled widget

setDistanceToMouse()

static void tgui::ToolTip::setDistanceToMouse ( const Vector2f & distance )

static

Sets the default distance between the mouse position and the tool tip.

Parameters

distance

Distance between mouse and tool tip

setInitialDelay()

static void tgui::ToolTip::setInitialDelay ( Duration delay )

static

Sets the time that the mouse has to stand still before the tooltip becomes visible.

Parameters

delay

Time before displaying tooltip

setShowOnDisabledWidget()

static void tgui::ToolTip::setShowOnDisabledWidget ( bool show )

static

Sets whether the tool tip is shown even when the widget is disabled.

Parameters

show	Show the tool tip or not when the mouse is on top of a disabled widget

Tool tips are shown on disabled widgets by default.

---

The documentation for this class was generated from the following file:

• include/TGUI/ToolTip.hpp