xtd - Reference Guide  0.1.1
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
check_box.h
Go to the documentation of this file.
1 #pragma once
5 #include "appearance.h"
6 #include "button_base.h"
7 #include "check_state.h"
8 #include "visual_styles/check_box_state.h"
9 
11 namespace xtd {
13  namespace forms {
52  class forms_export_ check_box : public button_base {
53  public:
59  check_box();
60 
67  virtual forms::appearance appearance() const {return appearance_;}
71  virtual check_box& appearance(forms::appearance appearance);
72 
79  virtual bool auto_check() const {return auto_check_;}
83  virtual check_box& auto_check(bool auto_check);
84 
87  virtual content_alignment check_align() const {return check_align_;}
90  virtual check_box& check_align(content_alignment check_align);
91 
98  virtual bool checked() const {return checked_;}
102  virtual check_box& checked(bool checked);
103 
116  virtual forms::check_state check_state() const {return check_state_;}
128  virtual check_box& check_state(forms::check_state check_state);
129 
132  drawing::size default_size() const override {return {104, 25};}
133 
140  virtual bool three_state() const {return three_state_;}
144  virtual check_box& three_state(bool three_state);
145 
148  event<check_box, event_handler> appearance_changed;
149 
152  event<check_box, event_handler> checked_changed;
153 
156  event<check_box, event_handler> check_state_changed;
157 
158  protected:
161  forms::create_params create_params() const override;
162 
166  drawing::size measure_control() const override;
167 
172  virtual void on_appearance_changed(const event_args& e) {
173  appearance_changed(*this, e);
174  if (flat_style_ != xtd::forms::flat_style::system) invalidate();
175  }
176 
181  virtual void on_checked_changed(const event_args& e) {
182  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
183  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::check_box_state::unchecked_normal;
184  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::check_box_state::checked_normal;
185  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::check_box_state::mixed_normal;
186  }
187  checked_changed(*this, e);
188  if (flat_style_ != xtd::forms::flat_style::system) invalidate();
189  }
190 
195  virtual void on_check_state_changed(const event_args& e) {
196  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
197  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::check_box_state::unchecked_normal;
198  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::check_box_state::checked_normal;
199  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::check_box_state::mixed_normal;
200  }
201  check_state_changed(*this, e);
202  if (flat_style_ != xtd::forms::flat_style::system) invalidate();
203  }
204 
205  void on_enabled_changed(const event_args& e) override {
206  if (flat_style_ != xtd::forms::flat_style::system) {
207  if (check_state_ == xtd::forms::check_state::unchecked) state_ = enabled() ? xtd::forms::visual_styles::check_box_state::unchecked_normal : xtd::forms::visual_styles::check_box_state::unchecked_disabled;
208  else if (check_state_ == xtd::forms::check_state::checked) state_ = enabled() ? xtd::forms::visual_styles::check_box_state::checked_normal : xtd::forms::visual_styles::check_box_state::checked_disabled;
209  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = enabled() ? xtd::forms::visual_styles::check_box_state::mixed_normal : xtd::forms::visual_styles::check_box_state::mixed_disabled;
210  }
211  button_base::on_enabled_changed(e);
212  }
213 
214  void on_handle_created(const event_args& e) override;
215 
216  void on_mouse_down(const mouse_event_args& e) override {
217  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
218  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::check_box_state::unchecked_pressed;
219  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::check_box_state::checked_pressed;
220  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::check_box_state::mixed_pressed;
221  }
222  button_base::on_mouse_down(e);
223  }
224 
225  void on_mouse_enter(const event_args& e) override {
226  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
227  if (check_state_ == xtd::forms::check_state::unchecked) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::check_box_state::unchecked_pressed : xtd::forms::visual_styles::check_box_state::unchecked_hot;
228  else if (check_state_ == xtd::forms::check_state::checked) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::check_box_state::checked_pressed : xtd::forms::visual_styles::check_box_state::checked_hot;
229  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::check_box_state::mixed_pressed : xtd::forms::visual_styles::check_box_state::mixed_hot;
230  }
231  button_base::on_mouse_enter(e);
232  }
233 
234  void on_mouse_leave(const event_args& e) override {
235  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
236  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::check_box_state::unchecked_normal;
237  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::check_box_state::checked_normal;
238  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::check_box_state::mixed_normal;
239  }
240  button_base::on_mouse_leave(e);
241  }
242 
243  void on_mouse_up(const mouse_event_args& e) override {
244  if (flat_style_ != xtd::forms::flat_style::system && enabled() && (state_ == xtd::forms::visual_styles::check_box_state::unchecked_pressed || state_ == xtd::forms::visual_styles::check_box_state::checked_pressed || state_ == xtd::forms::visual_styles::check_box_state::mixed_pressed)) {
245  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::check_box_state::unchecked_hot;
246  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::check_box_state::checked_hot;
247  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::check_box_state::mixed_hot;
248  }
249  button_base::on_mouse_up(e);
250  }
251 
252  void on_paint(paint_event_args& e) override;
253 
255  void wnd_proc(message& message) override;
256  virtual void wm_mouse_double_click(message& message);
257  virtual void wm_mouse_down(message& message);
258  virtual void wm_mouse_up(message& message);
259 
260  forms::appearance appearance_ = forms::appearance::normal;
261  bool auto_check_ = true;
262  bool three_state_ = 0;
263  bool checked_ = false;
264  content_alignment check_align_ = content_alignment::middle_left;
265  forms::check_state check_state_ = forms::check_state::unchecked;
266  xtd::forms::visual_styles::check_box_state state_ = xtd::forms::visual_styles::check_box_state::unchecked_normal;
268  };
269  }
270 }
appearance.h
Contains xtd::forms::appearance enum class.
button_base.h
Contains xtd::forms::button_base class.
check_box_state.h
Contains xtd::forms::visual_styles::check_box_state enum class.
check_state.h
Contains xtd::forms::check_state enum class.
xtd::drawing::size
Stores an ordered pair of integers, which specify a height and width.
Definition: size.h:25
xtd::event_args
Represents the base class for classes that contain event data, and provides a value to use for events...
Definition: event_args.h:18
xtd::event
Represents an event.
Definition: event.h:21
xtd::forms::button_base
Implements the basic functionality common to button controls.
Definition: button_base.h:26
xtd::forms::button_base::on_enabled_changed
void on_enabled_changed(const event_args &e) override
Raises the control::enabled_changed event.
Definition: button_base.h:139
xtd::forms::button_base::on_mouse_up
void on_mouse_up(const mouse_event_args &e) override
Raises the control::mouse_up event.
Definition: button_base.h:176
xtd::forms::button_base::on_mouse_down
void on_mouse_down(const mouse_event_args &e) override
Raises the control::mouse_down event.
Definition: button_base.h:161
xtd::forms::button_base::on_mouse_enter
void on_mouse_enter(const event_args &e) override
Raises the control::mouse_enter event.
Definition: button_base.h:166
xtd::forms::button_base::on_mouse_leave
void on_mouse_leave(const event_args &e) override
Raises the control::mouse_leave event.
Definition: button_base.h:171
xtd::forms::check_box
Represents a Windows check_box.
Definition: check_box.h:52
xtd::forms::check_box::on_handle_created
void on_handle_created(const event_args &e) override
Raises the control::handle_created event.
xtd::forms::check_box::on_check_state_changed
virtual void on_check_state_changed(const event_args &e)
Raises the check_box::check_state_changed event.
Definition: check_box.h:195
xtd::forms::check_box::appearance
virtual check_box & appearance(forms::appearance appearance)
Gets the value that determines the appearance of a check_box control.
xtd::forms::check_box::on_mouse_up
void on_mouse_up(const mouse_event_args &e) override
Raises the control::mouse_up event.
Definition: check_box.h:243
xtd::forms::check_box::check_align
virtual content_alignment check_align() const
Gets the horizontal and vertical alignment of the check mark on a check_box control.
Definition: check_box.h:87
xtd::forms::check_box::on_mouse_leave
void on_mouse_leave(const event_args &e) override
Raises the control::mouse_leave event.
Definition: check_box.h:234
xtd::forms::check_box::on_mouse_down
void on_mouse_down(const mouse_event_args &e) override
Raises the control::mouse_down event.
Definition: check_box.h:216
xtd::forms::check_box::on_appearance_changed
virtual void on_appearance_changed(const event_args &e)
Raises the check_box::appearance_changed event.
Definition: check_box.h:172
xtd::forms::check_box::measure_control
drawing::size measure_control() const override
Measure this control.
xtd::forms::check_box::appearance
virtual forms::appearance appearance() const
Gets the value that determines the appearance of a check_box control.
Definition: check_box.h:67
xtd::forms::check_box::auto_check
virtual bool auto_check() const
Gets a value indicating whether the checked or check_state values and the check_box's appearance are ...
Definition: check_box.h:79
xtd::forms::check_box::checked
virtual check_box & checked(bool checked)
Sets a value indicating whether the check_box is in the checked state.
xtd::forms::check_box::check_align
virtual check_box & check_align(content_alignment check_align)
Sets the horizontal and vertical alignment of the check mark on a check_box control.
xtd::forms::check_box::on_checked_changed
virtual void on_checked_changed(const event_args &e)
Raises the check_box::checked_changed event.
Definition: check_box.h:181
xtd::forms::check_box::three_state
virtual check_box & three_state(bool three_state)
Gets a value indicating whether the check_box will allow three check states rather than two.
xtd::forms::check_box::on_mouse_enter
void on_mouse_enter(const event_args &e) override
Raises the control::mouse_enter event.
Definition: check_box.h:225
xtd::forms::check_box::auto_check
virtual check_box & auto_check(bool auto_check)
Sets a value indicating whether the checked or check_state values and the check_box's appearance are ...
xtd::forms::check_box::create_params
forms::create_params create_params() const override
Gets the required creation parameters when the control handle is created.
xtd::forms::check_box::default_size
drawing::size default_size() const override
Gets the default size of the control.
Definition: check_box.h:132
xtd::forms::check_box::on_paint
void on_paint(paint_event_args &e) override
Raises the control::paint event.
xtd::forms::check_box::on_enabled_changed
void on_enabled_changed(const event_args &e) override
Raises the control::enabled_changed event.
Definition: check_box.h:205
xtd::forms::check_box::check_state
virtual check_box & check_state(forms::check_state check_state)
Sets the state of the check_box.
xtd::forms::check_box::check_state
virtual forms::check_state check_state() const
Gets the state of the check_box.
Definition: check_box.h:116
xtd::forms::check_box::check_box
check_box()
Initializes a new instance of the CheckBox class.
xtd::forms::check_box::three_state
virtual bool three_state() const
Gets a value indicating whether the check_box will allow three check states rather than two.
Definition: check_box.h:140
xtd::forms::check_box::checked
virtual bool checked() const
Gets a value indicating whether the check_box is in the checked state.
Definition: check_box.h:98
xtd::forms::message
Implements a Windows message.
Definition: message.h:25
xtd::forms::mouse_event_args
Provides data for the xtd::forms::control::mouse_up, xtd::forms::control::mouse_down,...
Definition: mouse_event_args.h:29
xtd::forms::paint_event_args
Provides data for the paint event.
Definition: paint_event_args.h:26
xtd::forms::check_box::appearance_changed
event< check_box, event_handler > appearance_changed
Occurs when the value of the appearance property changes.
Definition: check_box.h:148
xtd::forms::check_box::check_state_changed
event< check_box, event_handler > check_state_changed
Occurs when the value of the check_state property changes.
Definition: check_box.h:156
xtd::forms::check_box::checked_changed
event< check_box, event_handler > checked_changed
Occurs when the value of the checked property changes.
Definition: check_box.h:152
forms_export_
#define forms_export_
Define shared library export.
Definition: forms_export.h:13
xtd::console_key::e
@ e
The E key.
xtd::forms::check_state
check_state
Specifies the state of a control, such as a check box, that can be checked, unchecked,...
Definition: check_state.h:19
xtd::forms::visual_styles::check_box_state
check_box_state
Specifies the visual state of a check box that is drawn with visual styles.
Definition: check_box_state.h:20
xtd::forms::content_alignment
content_alignment
Specifies alignment of content on the drawing surface.
Definition: content_alignment.h:17
xtd::forms::appearance
appearance
Specifies the appearance of a control.
Definition: appearance.h:18
xtd::forms::check_state::checked
@ checked
The control is checked.
xtd::forms::check_state::indeterminate
@ indeterminate
The control is indeterminate. An indeterminate control generally has a shaded appearance.
xtd::forms::check_state::unchecked
@ unchecked
The control is unchecked.
xtd::forms::visual_styles::check_box_state::mixed_normal
@ mixed_normal
The check box is three-state.
xtd::forms::visual_styles::check_box_state::mixed_pressed
@ mixed_pressed
The check box is three-state and pressed.
xtd::forms::visual_styles::check_box_state::unchecked_normal
@ unchecked_normal
The check box is unchecked.
xtd::forms::visual_styles::check_box_state::checked_normal
@ checked_normal
The check box is checked.
xtd::forms::visual_styles::check_box_state::checked_disabled
@ checked_disabled
The check box is checked and disabled.
xtd::forms::visual_styles::check_box_state::unchecked_pressed
@ unchecked_pressed
The check box is unchecked and pressed.
xtd::forms::visual_styles::check_box_state::mixed_hot
@ mixed_hot
The check box is three-state and hot.
xtd::forms::visual_styles::check_box_state::checked_hot
@ checked_hot
The check box is checked and hot.
xtd::forms::visual_styles::check_box_state::unchecked_hot
@ unchecked_hot
The check box is unchecked and hot.
xtd::forms::visual_styles::check_box_state::unchecked_disabled
@ unchecked_disabled
The check box is unchecked and disabled.
xtd::forms::visual_styles::check_box_state::checked_pressed
@ checked_pressed
The check box is checked and pressed.
xtd::forms::visual_styles::check_box_state::mixed_disabled
@ mixed_disabled
The check box is three-state and disabled.
xtd::forms::flat_style::system
@ system
The appearance of the control is determined by the user's operating system.
xtd::forms::mouse_buttons::left
@ left
The left mouse button was pressed.
xtd::forms::content_alignment::middle_left
@ middle_left
Content is vertically aligned in the middle, and horizontally aligned on the left.
xtd::forms::appearance::normal
@ normal
The default appearance defined by the control class.
xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition: about_box.h:13
xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition: system_report.h:17
Generated on Mon Jul 17 2023 23:13:05 for xtd - Reference Guide by Gammasoft. All rights reserved.