tooltip.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** 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
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29 
30 
31 #pragma once
32 
33 #include "../api_gui.h"
34 #include "../gui_component.h"
35 
36 namespace clan
37 {
40 
41 class GUIManager;
42 class ToolTip_Impl;
43 
45 class CL_API_GUI ToolTip : public GUIComponent
46 {
49 public:
50 
54  ToolTip(GUIManager gui_manager);
55 
56  virtual ~ToolTip();
57 
61 public:
62 
64 
68  static ToolTip *get_named_item(GUIComponent *reference_component, const std::string &id);
69 
73  std::string get_text() const;
74 
78 public:
79 
83  void set_text(const std::string &text);
84 
88  void show(const Point &position);
89 
94  void show_delayed(const Point &position, int delay_time = 750);
95 
97  void hide();
98 
102 private:
103  std::shared_ptr<ToolTip_Impl> impl;
105 };
106 
107 }
108 
GUI base component class.
Definition: gui_component.h:80
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
Tool tip component.
Definition: tooltip.h:45
GUI manager.
Definition: gui_manager.h:64
2D (x,y) point structure - Integer
Definition: point.h:63