ClanLib  2.3.7
toolbar_item.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_Sprite;
39 class CL_ToolBarItem_Impl;
40 class CL_ToolBar;
41 
46 {
49 
50 public:
53 
57  CL_ToolBarItem(int id);
58 
62  CL_ToolBarItem(const CL_SharedPtr<CL_ToolBarItem_Impl> &impl);
63 
64  virtual ~CL_ToolBarItem();
65 
69 
70 public:
71 
75  CL_StringRef get_text() const;
76 
80  int get_id() const;
81 
83  bool is_null() const { return !impl; }
84 
86  void throw_if_null() const;
87 
91  bool is_disabled() const;
92 
96  bool is_toggling() const;
97 
101  bool is_pressed() const;
102 
106 
107 public:
108 
112 
113 public:
114 
118  void set_id(int id);
119 
123  void set_text(const CL_StringRef &text);
124 
129  void set_icon(const CL_Sprite &image, int frame = 0);
130 
132  void set_toggling(bool toggling);
133 
137  void set_pressed(bool value);
138 
142 
143 private:
144  CL_SharedPtr<CL_ToolBarItem_Impl> impl;
145 
146  friend class CL_ToolBar;
147  friend class CL_ToolBar_Impl;
149 };
150