ClanLib  2.3.7
tooltip.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
32 
33 #pragma once
34 
35 #include "../api_gui.h"
36 #include "../gui_component.h"
37 
38 class CL_GUIManager;
39 class CL_ToolTip_Impl;
40 
45 {
48 public:
49 
53  CL_ToolTip(CL_GUIManager gui_manager);
54 
55  virtual ~CL_ToolTip();
56 
60 public:
61 
63 
67  static CL_ToolTip *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
68 
72  CL_StringRef get_text() const;
73 
77 public:
78 
82  void set_text(const CL_StringRef &text);
83 
87  void show(const CL_Point &position);
88 
93  void show_delayed(const CL_Point &position, int delay_time = 750);
94 
96  void hide();
97 
101 private:
102  CL_SharedPtr<CL_ToolTip_Impl> impl;
104 };
105