statusbar.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 Image;
42 class StatusBar_Impl;
43 
45 class CL_API_GUI StatusBar : public GUIComponent
46 {
49 
50 public:
51 
55  StatusBar(GUIComponent *parent);
56 
57  virtual ~StatusBar();
58 
62 
63 public:
64 
66 
70  static StatusBar *get_named_item(GUIComponent *reference_component, const std::string &id);
71 
77  Callback_v0 &func_part_double_clicked(int id);
78 
82 
83 public:
84 
88  void set_status_text(const std::string &text);
89 
94  void set_part_text(int id, const std::string &text);
95 
101  void set_part_text(int id, const Image &icon, const std::string &text);
102 
108  void add_part(int id, int width, GUIComponent *component = 0);
109 
114  void show_part(int id, bool show = true);
115 
119  void remove_part(int id);
120 
124  void show_size_grip(bool show = true);
125 
129 
130 private:
131  std::shared_ptr<StatusBar_Impl> impl;
133 };
134 
135 }
136 
Status bar component.
Definition: statusbar.h:45
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.
Image class.
Definition: image.h:60
Callback_v0.
Definition: callback_v0.h:152