TGUI  0.8-dev
tgui::ToolTip Class Reference

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

#include <ToolTip.hpp>

Static Public Member Functions

static void setTimeToDisplay (const sf::Time &timeToDisplay)
 Sets the time that the mouse has to stand still before the tooltip becomes visible. More...
 
static sf::Time getTimeToDisplay ()
 Returns the time that the mouse has to stand still before the tooltip becomes visible. More...
 
static void setDistanceToMouse (const sf::Vector2f &distance)
 Sets the default distance between the mouse position and the tool tip. More...
 
static sf::Vector2f getDistanceToMouse ()
 Returns the default distance between the mouse position and the tool tip. More...
 

Detailed Description

Interface to set the settings for the tool tips.

Member Function Documentation

◆ getDistanceToMouse()

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

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

Returns
Distance between mouse and tool tip

◆ getTimeToDisplay()

static sf::Time tgui::ToolTip::getTimeToDisplay ( )
static

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

Returns
Time before displaying tooltip

◆ setDistanceToMouse()

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

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

Parameters
distanceDistance between mouse and tool tip

◆ setTimeToDisplay()

static void tgui::ToolTip::setTimeToDisplay ( const sf::Time &  timeToDisplay)
static

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

Parameters
timeToDisplayTime before displaying tooltip

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