checkbox.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 CheckBox_Impl;
43 
45 class CL_API_GUI CheckBox : public GUIComponent
46 {
49 public:
50 
54  CheckBox(GUIComponent *parent);
55 
56  virtual ~CheckBox();
57 
61 public:
63 
67  static CheckBox *get_named_item(GUIComponent *reference_component, const std::string &id);
68 
72  bool is_indeterminated() const;
73 
77  bool is_checked() const;
78 
82  bool is_3state() const;
83 
84  const std::string &get_text() const;
85 
89 public:
90 
92  void set_indeterminated();
93 
97  void set_checked(bool enable);
98 
102  void set_3state(bool enable);
103 
107  void set_text(const std::string &text);
108 
112 public:
113 
117  Callback_v0 &func_checked();
118 
122  Callback_v0 &func_unchecked();
123 
127  Callback_v0 &func_indeterminated();
128 
132  Callback_v0 &func_state_changed();
133 
137 private:
138  std::shared_ptr<CheckBox_Impl> impl;
140 };
141 
142 }
143 
GUI base component class.
Definition: gui_component.h:80
Check box component.
Definition: checkbox.h:45
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
Callback_v0.
Definition: callback_v0.h:152