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.
toggle_button.h
Go to the documentation of this file.
1 #pragma once
5 #include "button_base.h"
6 #include "check_state.h"
7 #include "visual_styles/toggle_button_state.h"
8 
10 namespace xtd {
12  namespace forms {
30  class forms_export_ toggle_button : public button_base {
31  public:
34  toggle_button();
35 
39  virtual bool auto_check() const {return auto_check_;}
43  virtual toggle_button& auto_check(bool auto_check);
44 
47  virtual content_alignment check_align() const {return check_align_;}
50  virtual toggle_button& check_align(content_alignment check_align);
51 
55  virtual bool checked() const {return checked_;}
59  virtual toggle_button& checked(bool checked);
60 
70  virtual forms::check_state check_state() const {return check_state_;}
79  virtual toggle_button& check_state(forms::check_state check_state);
80 
83  drawing::size default_size() const override {return {104, 25};}
84 
88  virtual bool three_state() const {return three_state_;}
92  virtual toggle_button& three_state(bool three_state);
93 
96  event<toggle_button, event_handler> checked_changed;
97 
100  event<toggle_button, event_handler> check_state_changed;
101 
102  protected:
105  forms::create_params create_params() const override;
106 
110  drawing::size measure_control() const override;
111 
116  virtual void on_checked_changed(const event_args& e) {
117  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
118  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_normal;
119  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::toggle_button_state::checked_normal;
120  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::toggle_button_state::mixed_normal;
121  }
122  checked_changed(*this, e);
123  if (flat_style_ != xtd::forms::flat_style::system) invalidate();
124  }
125 
130  virtual void on_check_state_changed(const event_args& e) {
131  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
132  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_normal;
133  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::toggle_button_state::checked_normal;
134  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::toggle_button_state::mixed_normal;
135  }
136  check_state_changed(*this, e);
137  if (flat_style_ != xtd::forms::flat_style::system) invalidate();
138  }
139 
140  void on_enabled_changed(const event_args& e) override {
141  if (flat_style_ != xtd::forms::flat_style::system) {
142  if (check_state_ == xtd::forms::check_state::unchecked) state_ = enabled() ? xtd::forms::visual_styles::toggle_button_state::unchecked_normal : xtd::forms::visual_styles::toggle_button_state::unchecked_disabled;
143  else if (check_state_ == xtd::forms::check_state::checked) state_ = enabled() ? xtd::forms::visual_styles::toggle_button_state::checked_normal : xtd::forms::visual_styles::toggle_button_state::checked_disabled;
144  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = enabled() ? xtd::forms::visual_styles::toggle_button_state::mixed_normal : xtd::forms::visual_styles::toggle_button_state::mixed_disabled;
145  }
146  button_base::on_enabled_changed(e);
147  }
148 
151  void on_handle_created(const event_args& e) override;
152 
153  void on_mouse_down(const mouse_event_args& e) override {
154  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
155  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_pressed;
156  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::toggle_button_state::checked_pressed;
157  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::toggle_button_state::mixed_pressed;
158  }
159  button_base::on_mouse_down(e);
160  }
161 
162  void on_mouse_enter(const event_args& e) override {
163  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
164  if (check_state_ == xtd::forms::check_state::unchecked) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::toggle_button_state::unchecked_pressed : xtd::forms::visual_styles::toggle_button_state::unchecked_hot;
165  else if (check_state_ == xtd::forms::check_state::checked) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::toggle_button_state::checked_pressed : xtd::forms::visual_styles::toggle_button_state::checked_hot;
166  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = (mouse_buttons_ & mouse_buttons::left) == mouse_buttons::left ? xtd::forms::visual_styles::toggle_button_state::mixed_pressed : xtd::forms::visual_styles::toggle_button_state::mixed_hot;
167  }
168  button_base::on_mouse_enter(e);
169  }
170 
171  void on_mouse_leave(const event_args& e) override {
172  if (flat_style_ != xtd::forms::flat_style::system && enabled()) {
173  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_normal;
174  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::toggle_button_state::checked_normal;
175  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::toggle_button_state::mixed_normal;
176  }
177  button_base::on_mouse_leave(e);
178  }
179 
180  void on_mouse_up(const mouse_event_args& e) override {
181  if (flat_style_ != xtd::forms::flat_style::system && enabled() && (state_ == xtd::forms::visual_styles::toggle_button_state::unchecked_pressed || state_ == xtd::forms::visual_styles::toggle_button_state::checked_pressed || state_ == xtd::forms::visual_styles::toggle_button_state::mixed_pressed)) {
182  if (check_state_ == xtd::forms::check_state::unchecked) state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_hot;
183  else if (check_state_ == xtd::forms::check_state::checked) state_ = xtd::forms::visual_styles::toggle_button_state::checked_hot;
184  else if (check_state_ == xtd::forms::check_state::indeterminate) state_ = xtd::forms::visual_styles::toggle_button_state::mixed_hot;
185  }
186  button_base::on_mouse_up(e);
187  }
188 
189  void on_paint(paint_event_args& e) override;
190 
192  void wnd_proc(message& message) override;
193  virtual void wm_mouse_double_click(message& message);
194  virtual void wm_mouse_down(message& message);
195  virtual void wm_mouse_up(message& message);
196 
197  bool auto_check_ = true;
198  bool three_state_ = 0;
199  bool checked_ = false;
200  content_alignment check_align_ = content_alignment::middle_left;
201  forms::check_state check_state_ = forms::check_state::unchecked;
202  xtd::forms::visual_styles::toggle_button_state state_ = xtd::forms::visual_styles::toggle_button_state::unchecked_normal;
204  };
205  }
206 }
button_base.h
Contains xtd::forms::button_base 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::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::toggle_button
Represents a Windows toggle_button.
Definition: toggle_button.h:30
xtd::forms::toggle_button::on_enabled_changed
void on_enabled_changed(const event_args &e) override
Raises the control::enabled_changed event.
Definition: toggle_button.h:140
xtd::forms::toggle_button::on_handle_created
void on_handle_created(const event_args &e) override
Raises the handle_created event.
xtd::forms::toggle_button::check_state
virtual forms::check_state check_state() const
Gets the state of the toggle_button.
Definition: toggle_button.h:70
xtd::forms::toggle_button::three_state
virtual toggle_button & three_state(bool three_state)
Gets a value indicating whether the toggle_button will allow three check states rather than two.
xtd::forms::toggle_button::three_state
virtual bool three_state() const
Gets a value indicating whether the toggle_button will allow three check states rather than two.
Definition: toggle_button.h:88
xtd::forms::toggle_button::on_check_state_changed
virtual void on_check_state_changed(const event_args &e)
Raises the toggle_button::check_state_changed event.
Definition: toggle_button.h:130
xtd::forms::toggle_button::on_mouse_up
void on_mouse_up(const mouse_event_args &e) override
Raises the control::mouse_up event.
Definition: toggle_button.h:180
xtd::forms::toggle_button::auto_check
virtual toggle_button & auto_check(bool auto_check)
Sets a value indicating whether the checked or check_state values and the toggle_button's appearance ...
xtd::forms::toggle_button::default_size
drawing::size default_size() const override
Gets the default size of the control.
Definition: toggle_button.h:83
xtd::forms::toggle_button::on_mouse_down
void on_mouse_down(const mouse_event_args &e) override
Raises the control::mouse_down event.
Definition: toggle_button.h:153
xtd::forms::toggle_button::auto_check
virtual bool auto_check() const
Gets a value indicating whether the checked or check_state values and the toggle_button's appearance ...
Definition: toggle_button.h:39
xtd::forms::toggle_button::on_checked_changed
virtual void on_checked_changed(const event_args &e)
Raises the toggle_button::checked_changed event.
Definition: toggle_button.h:116
xtd::forms::toggle_button::check_state
virtual toggle_button & check_state(forms::check_state check_state)
Sets the state of the toggle_button.
xtd::forms::toggle_button::on_paint
void on_paint(paint_event_args &e) override
Raises the control::paint event.
xtd::forms::toggle_button::toggle_button
toggle_button()
Initializes a new instance of the CheckBox class.
xtd::forms::toggle_button::create_params
forms::create_params create_params() const override
Gets the required creation parameters when the control handle is created.
xtd::forms::toggle_button::checked
virtual bool checked() const
Gets a value indicating whether the toggle_button is in the checked state.
Definition: toggle_button.h:55
xtd::forms::toggle_button::check_align
virtual content_alignment check_align() const
Gets the horizontal and vertical alignment of the check mark on a toggle_button control.
Definition: toggle_button.h:47
xtd::forms::toggle_button::checked
virtual toggle_button & checked(bool checked)
Sets a value indicating whether the toggle_button is in the checked state.
xtd::forms::toggle_button::check_align
virtual toggle_button & check_align(content_alignment check_align)
Sets the horizontal and vertical alignment of the check mark on a toggle_button control.
xtd::forms::toggle_button::measure_control
drawing::size measure_control() const override
Measure this control.
xtd::forms::toggle_button::on_mouse_enter
void on_mouse_enter(const event_args &e) override
Raises the control::mouse_enter event.
Definition: toggle_button.h:162
xtd::forms::toggle_button::on_mouse_leave
void on_mouse_leave(const event_args &e) override
Raises the control::mouse_leave event.
Definition: toggle_button.h:171
xtd::forms::toggle_button::checked_changed
event< toggle_button, event_handler > checked_changed
Occurs when the value of the checked property changes.
Definition: toggle_button.h:96
xtd::forms::toggle_button::check_state_changed
event< toggle_button, event_handler > check_state_changed
Occurs when the value of the check_state property changes.
Definition: toggle_button.h:100
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::toggle_button_state
toggle_button_state
Specifies the visual state of a check box that is drawn with visual styles.
Definition: toggle_button_state.h:20
xtd::forms::content_alignment
content_alignment
Specifies alignment of content on the drawing surface.
Definition: content_alignment.h:17
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::toggle_button_state::mixed_normal
@ mixed_normal
The check box is three-state.
xtd::forms::visual_styles::toggle_button_state::mixed_pressed
@ mixed_pressed
The check box is three-state and pressed.
xtd::forms::visual_styles::toggle_button_state::unchecked_normal
@ unchecked_normal
The check box is unchecked.
xtd::forms::visual_styles::toggle_button_state::checked_normal
@ checked_normal
The check box is checked.
xtd::forms::visual_styles::toggle_button_state::checked_disabled
@ checked_disabled
The check box is checked and disabled.
xtd::forms::visual_styles::toggle_button_state::unchecked_pressed
@ unchecked_pressed
The check box is unchecked and pressed.
xtd::forms::visual_styles::toggle_button_state::mixed_hot
@ mixed_hot
The check box is three-state and hot.
xtd::forms::visual_styles::toggle_button_state::checked_hot
@ checked_hot
The check box is checked and hot.
xtd::forms::visual_styles::toggle_button_state::unchecked_hot
@ unchecked_hot
The check box is unchecked and hot.
xtd::forms::visual_styles::toggle_button_state::unchecked_disabled
@ unchecked_disabled
The check box is unchecked and disabled.
xtd::forms::visual_styles::toggle_button_state::checked_pressed
@ checked_pressed
The check box is checked and pressed.
xtd::forms::visual_styles::toggle_button_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
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
toggle_button_state.h
Contains xtd::forms::visual_styles::toggle_button_state enum class.
Generated on Mon Jul 17 2023 23:13:05 for xtd - Reference Guide by Gammasoft. All rights reserved.