TGUI  1.3.0
Loading...
Searching...
No Matches
ToolTip.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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/Vector2.hpp>
31#include <TGUI/Duration.hpp>
32
34
35TGUI_MODULE_EXPORT namespace tgui
36{
40 class TGUI_API ToolTip
41 {
42 public:
43
49 static void setInitialDelay(Duration delay);
50
51
57 TGUI_NODISCARD static Duration getInitialDelay();
58
59
66 static void setDistanceToMouse(const Vector2f& distance);
67
68
75 TGUI_NODISCARD static Vector2f getDistanceToMouse();
76
77
85 static void setShowOnDisabledWidget(bool show);
86
87
93 TGUI_NODISCARD static bool getShowOnDisabledWidget();
94
95
97 private:
98
99 static Duration m_initialDelay;
100 static Vector2f m_distanceToMouse;
101 static bool m_showOnDisabledWidget;
102
104 };
105
106
108
109}
110
112
113#endif // TGUI_TOOLTIP_HPP
Wrapper for durations.
Definition Duration.hpp:56
Interface to set the settings for the tool tips.
Definition ToolTip.hpp:41
static TGUI_NODISCARD Duration getInitialDelay()
Returns the time that the mouse has to stand still before the tooltip becomes visible.
static void setShowOnDisabledWidget(bool show)
Sets whether the tool tip is shown even when the widget is disabled.
static void setDistanceToMouse(const Vector2f &distance)
Sets the default distance between the mouse position and the tool tip.
static TGUI_NODISCARD bool getShowOnDisabledWidget()
Returns whether the tool tip is shown even when the widget is disabled.
static void setInitialDelay(Duration delay)
Sets the time that the mouse has to stand still before the tooltip becomes visible.
static TGUI_NODISCARD Vector2f getDistanceToMouse()
Returns the default distance between the mouse position and the tool tip.
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39