toolbar.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 #include "../../Core/Signals/callback_v0.h"
36 
37 namespace clan
38 {
41 
42 class Sprite;
43 class ToolBarItem;
44 class ToolBar_Impl;
45 
47 class CL_API_GUI ToolBar : public GUIComponent
48 {
51 
52 public:
53 
57  ToolBar(GUIComponent *parent);
58 
59  virtual ~ToolBar();
60 
64 
65 public:
66 
68 
72  static ToolBar *get_named_item(GUIComponent *reference_component, const std::string &id);
73 
77  Size get_css_size() const;
78 
84  ToolBarItem get_item_by_id(int id);
85 
91  ToolBarItem get_item(int index);
92 
98  int get_item_index(int id);
99 
103  int get_item_count() const;
104 
108 
109 public:
110 
119  ToolBarItem add_item(const Sprite &icon, int frame, const std::string &text, int id);
120 
130  ToolBarItem insert_item(const Sprite &icon, int frame, const std::string &text, int id = -1, int index = -1);
131 
137  ToolBarItem insert_separator(int index = -1);
138 
142  void delete_item(int index);
143 
147  void set_single_selection(bool value);
148 
150  void clear_selection();
151 
155 
156 public:
157  Callback_v1<ToolBarItem> &func_item_clicked();
158 
159  Callback_v1<ToolBarItem> &func_item_selected();
160 
161  Callback_v1<ToolBarItem> &func_item_unselected();
162 
165  Callback_v2<Point, int> &func_mouse_right_up();
166 
170 
171 private:
172  std::shared_ptr<ToolBar_Impl> impl;
174 };
175 
176 }
177 
Sprite class.
Definition: sprite.h:57
GUI base component class.
Definition: gui_component.h:81
Callback_v2.
Definition: callback_v2.h:156
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
Callback_v1.
Definition: callback_v1.h:156
Tool bar component.
Definition: toolbar.h:47
2D (width,height) size structure - Integer
Definition: size.h:157
Toolbar menu item.
Definition: toolbar_item.h:46