TGUI  0.8.9
ToolTip.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 
26 #ifndef TGUI_TOOLTIP_HPP
27 #define TGUI_TOOLTIP_HPP
28 
29 #include <TGUI/Config.hpp>
30 #include <TGUI/Vector2f.hpp>
31 #include <SFML/System/Time.hpp>
32 
34 
35 namespace tgui
36 {
40  class TGUI_API ToolTip
41  {
42  public:
43 
44 #ifndef TGUI_REMOVE_DEPRECATED_CODE
51  TGUI_DEPRECATED("Use setInitialDelay instead") static void setTimeToDisplay(const sf::Time& timeToDisplay);
52 
53 
60  TGUI_DEPRECATED("Use getInitialDelay instead") static sf::Time getTimeToDisplay();
61 #endif
62 
68  static void setInitialDelay(const sf::Time& delay);
69 
70 
76  static sf::Time getInitialDelay();
77 
78 
85  static void setDistanceToMouse(const Vector2f& distance);
86 
87 
95 
96 
98  private:
99 
100  static sf::Time m_initialDelay;
101  static Vector2f m_distanceToMouse;
102 
104  };
105 
106 
108 
109 }
110 
112 
113 #endif // TGUI_TOOLTIP_HPP
Interface to set the settings for the tool tips.
Definition: ToolTip.hpp:41
static sf::Time 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 void setInitialDelay(const sf::Time &delay)
Sets the time that the mouse has to stand still before the tooltip becomes visible.
static Vector2f getDistanceToMouse()
Returns the default distance between the mouse position and the tool tip.
Definition: Vector2f.hpp:39
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:37