reference_guides/latest/toggle__button_8hpp_source.html

#pragma once

#include "visual_styles/toggle_button_state.hpp"

#include "button_base.hpp"

#include "check_state.hpp"


namespace xtd {

  namespace forms {


    class forms_export_ toggle_button : public xtd::forms::button_base {

      struct data;


    public:


      toggle_button();


      virtual bool auto_check() const noexcept;

      virtual toggle_button& auto_check(bool auto_check);


      virtual content_alignment check_align() const noexcept;

      virtual toggle_button& check_align(content_alignment check_align);


      virtual bool checked() const noexcept;

      virtual toggle_button& checked(bool checked);


      virtual forms::check_state check_state() const noexcept;

      virtual toggle_button& check_state(forms::check_state check_state);


      virtual bool three_state() const noexcept;

      virtual toggle_button& three_state(bool three_state);


      static toggle_button create();

      static toggle_button create(const drawing::point& location);

      static toggle_button create(const drawing::point& location, const drawing::size& size);

      static toggle_button create(const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const xtd::string& text);

      static toggle_button create(const xtd::string& text, const drawing::point& location);

      static toggle_button create(const xtd::string& text, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const xtd::string& text, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const xtd::string& text, xtd::forms::check_state check_state);

      static toggle_button create(const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location);

      static toggle_button create(const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const xtd::string& text, bool three_state, xtd::forms::check_state check_state);

      static toggle_button create(const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location);

      static toggle_button create(const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const control& parent);

      static toggle_button create(const control& parent, const drawing::point& location);

      static toggle_button create(const control& parent, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const control& parent, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const control& parent, const xtd::string& text);

      static toggle_button create(const control& parent, const xtd::string& text, const drawing::point& location);

      static toggle_button create(const control& parent, const xtd::string& text, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const control& parent, const xtd::string& text, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const control& parent, const xtd::string& text, xtd::forms::check_state check_state);

      static toggle_button create(const control& parent, const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location);

      static toggle_button create(const control& parent, const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const control& parent, const xtd::string& text, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size, const xtd::string& name);

      static toggle_button create(const control& parent, const xtd::string& text, bool three_state, xtd::forms::check_state check_state);

      static toggle_button create(const control& parent, const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location);

      static toggle_button create(const control& parent, const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size);

      static toggle_button create(const control& parent, const xtd::string& text, bool three_state, xtd::forms::check_state check_state, const drawing::point& location, const drawing::size& size, const xtd::string& name);


      event<toggle_button, event_handler> checked_changed;


      event<toggle_button, event_handler> check_state_changed;


    protected:


      forms::create_params create_params() const noexcept override;


      xtd::uptr<xtd::object> clone() const override;


      drawing::size measure_control() const noexcept override;


      virtual void on_checked_changed(const event_args& e);


      virtual void on_check_state_changed(const event_args& e);


      void on_enabled_changed(const event_args& e) override;


      void on_handle_created(const event_args& e) override;


      void on_mouse_down(const mouse_event_args& e) override;

      void on_mouse_enter(const event_args& e) override;

      void on_mouse_leave(const event_args& e) override;

      void on_mouse_up(const mouse_event_args& e) override;

      void on_paint(paint_event_args& e) override;


      xtd::forms::visual_styles::toggle_button_state state() const noexcept;


      void wnd_proc(message& message) override;


    private:

      void wm_mouse_double_click(message& message);

      void wm_mouse_down(message& message);

      void wm_mouse_up(message& message);


      xtd::sptr<data> data_;

    };

    class forms_export_ toggle_button : public xtd::forms::button_base {…};

  }

}

button_base.hpp
Contains xtd::forms::button_base class.

check_state.hpp
Contains xtd::forms::check_state enum class.

xtd::event_args
Represents the base class for classes that contain event data, and provides a value to use for events...
Definition event_args.hpp:18

xtd::event
Represents an event.
Definition event.hpp:21

xtd::forms::button_base
Implements the basic functionality common to button controls.
Definition button_base.hpp:37

xtd::forms::control
Defines the base class for controls, which are components with visual representation.
Definition control.hpp:81

xtd::forms::control::location
virtual drawing::point location() const noexcept
Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its...

xtd::forms::control::name
virtual const xtd::string & name() const noexcept
Gets the name of the control.

xtd::forms::control::text
virtual const xtd::string & text() const noexcept
Gets the text associated with this control.

xtd::forms::control::size
virtual drawing::size size() const noexcept
Gets the height and width of the control.

xtd::forms::control::parent
virtual std::optional< control_ref > parent() const noexcept
Gets the parent container of the control.

xtd::forms::mouse_event_args
Provides data for the xtd::forms::control::mouse_up, xtd::forms::control::mouse_down,...
Definition mouse_event_args.hpp:34

xtd::forms::paint_event_args
Provides data for the xtd::forms::control::paint event.
Definition paint_event_args.hpp:30

xtd::forms::toggle_button::on_enabled_changed
void on_enabled_changed(const event_args &e) override
Raises the xtd::forms::control::enabled_changed event.

xtd::forms::toggle_button::on_handle_created
void on_handle_created(const event_args &e) override
Raises the xtd::forms::control::handle_created event.

xtd::forms::toggle_button::check_align
virtual content_alignment check_align() const noexcept
Gets the horizontal and vertical alignment of the check mark on a toggle_button control.

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.

xtd::forms::toggle_button::on_mouse_up
void on_mouse_up(const mouse_event_args &e) override
Raises the xtd::forms::control::mouse_up event.

xtd::forms::toggle_button::auto_check
virtual bool auto_check() const noexcept
Gets a value indicating whether the checked or check_state values and the toggle_button's appearance ...

xtd::forms::toggle_button::measure_control
drawing::size measure_control() const noexcept override
Measure this control.

xtd::forms::toggle_button::checked
virtual bool checked() const noexcept
Gets a value indicating whether the toggle_button is in the checked state.

xtd::forms::toggle_button::three_state
virtual bool three_state() const noexcept
Gets a value indicating whether the toggle_button will allow three check states rather than two.

xtd::forms::toggle_button::on_mouse_down
void on_mouse_down(const mouse_event_args &e) override
Raises the xtd::forms::control::mouse_down event.

xtd::forms::toggle_button::state
xtd::forms::visual_styles::toggle_button_state state() const noexcept
Gets state.

xtd::forms::toggle_button::on_checked_changed
virtual void on_checked_changed(const event_args &e)
Raises the toggle_button::checked_changed event.

xtd::forms::toggle_button::on_paint
void on_paint(paint_event_args &e) override
Raises the xtd::forms::control::paint event.

xtd::forms::toggle_button::check_state
virtual forms::check_state check_state() const noexcept
Gets the state of the toggle_button.

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 noexcept override
Gets the required creation parameters when the control handle is created.

xtd::forms::toggle_button::create
static toggle_button create()
A factory to create an xtd::forms::toggle_button.

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.hpp:332

xtd::forms::toggle_button::clone
xtd::uptr< xtd::object > clone() const override
Creates a new object that is a copy of the current instance.

xtd::forms::toggle_button::wnd_proc
void wnd_proc(message &message) override
Processes Windows messages.

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.hpp:336

xtd::forms::toggle_button::on_mouse_enter
void on_mouse_enter(const event_args &e) override
Raises the xtd::forms::control::mouse_enter event.

xtd::forms::toggle_button::on_mouse_leave
void on_mouse_leave(const event_args &e) override
Raises the xtd::forms::control::mouse_leave event.

xtd::event_handler
generic_event_handler< const xtd::event_args & > event_handler
Represents the method that will handle an event that has no event data.
Definition event_handler.hpp:24

forms_export_
#define forms_export_
Define shared library export.
Definition forms_export.hpp:13

xtd::sptr
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25

xtd::uptr
xtd::unique_ptr_object< type_t > uptr
The xtd::uptr object is a unique pointer.
Definition uptr.hpp:25

xtd::forms::content_alignment
content_alignment
Specifies alignment of content on the drawing surface.
Definition content_alignment.hpp:21

xtd::forms::keys::e
@ e
The E key.
Definition keys.hpp:207

xtd::drawing
The xtd::drawing namespace provides access to GDI+ basic graphics functionality. More advanced functi...
Definition actions_system_images.hpp:10

xtd::forms::visual_styles
The xtd::forms::visual_styles namespace contains classes for rendering controls and other windows use...
Definition check_box_state.hpp:12

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:219

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

xtd::data
constexpr const_pointer data() const noexcept
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:201

xtd::forms::message
Implements a Windows message.
Definition message.hpp:33

toggle_button_state.hpp
Contains xtd::forms::visual_styles::toggle_button_state enum class.