check_state() [1/2]

virtual forms::check_state xtd::forms::check_box::check_state ( ) const

virtualnoexcept

Gets the state of the check_box.

Returns

One of the xtd::forms::check_state enumeration values. The default value is unchecked.

Remarks

If the three_state property is set to false, the check_state property value can only be set to check_state::indeterminate in code and not by u ser interaction.

The following table describes the xtd::forms::appearance of the check_box control in its different states for the normal and button style control check_box::appearance.

Check_state	appearance::normal	appearance::button
checked	The check_box displays a check mark.	The control appears sunken.
unchecked	The CheckBox is empty.	The control appears raised.
indeterminate	The CheckBox displays a check mark and is shaded.	The control appears flat.

Examples

The following code example demonstrates the use of check_box check_state.

#include <xtd/forms/application>
#include <xtd/forms/check_box>
#include <xtd/forms/form>
 
using namespace xtd;
using namespace xtd::forms;
 
namespace check_box_example {
  class form1 : public form {
  public:
    form1() {
      text("Check box example");
      controls().push_back_range({check_box1, check_box2, check_box3, check_box4, check_box5});
      
      check_box1.auto_check(false);
      check_box1.click += [&] {
        // Uncomments next line to check / uncheck check box 1 (auto_check is false...)
        //check_box1.checked(!check_box1.checked());
        check_box1.text(string::format("{}", check_box1.check_state()));
      };
      check_box1.location({30, 30});
      check_box1.text(string::format("{}", check_box1.check_state()));
      
      check_box2.check_state_changed += [&] {
        check_box2.text(string::format("{}", check_box2.check_state()));
      };
      check_box2.checked(true);
      check_box2.location({30, 60});
      
      check_box3.auto_size(true);
      check_box3.check_state_changed += [&] {
        check_box3.text(string::format("{}", check_box3.check_state()));
      };
      check_box3.check_state(forms::check_state::indeterminate);
      check_box3.three_state(true);
      check_box3.location({30, 90});
      
      check_box4.appearance(forms::appearance::button);
      check_box4.check_state_changed += [&] {
        check_box4.text(string::format("{}", check_box4.check_state()));
      };
      check_box4.checked(true);
      check_box4.location({30, 120});
      
      check_box5.appearance(forms::appearance::button);
      check_box5.auto_check(false);
      check_box5.click += [&] {
        // Uncomments next line to check / uncheck check box 5 (auto_check is false...)
        //check_box5.checked(!check_box5.checked());
        check_box5.text(string::format("{}", check_box5.check_state()));
      };
      check_box5.location({30, 150});
      check_box5.text(string::format("{}", check_box5.check_state()));
    }
    
  private:
    check_box check_box1;
    check_box check_box2;
    check_box check_box3;
    check_box check_box4;
    check_box check_box5;
  };
}
 
auto main() -> int {
  application::enable_visual_styles();
  application::run(check_box_example::form1 {});
}

Examples

demo.cpp.