xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Loading...
Searching...
No Matches
Public Attributes | Public Member Functions | Protected Member Functions | List of all members
xtd::forms::toggle_button Class Reference

#include <toggle_button.h>

Definition

Represents a Windows toggle_button.

Namespace
xtd::forms
Library
xtd.forms
Remarks
Use a toggle_button to give the user an option, such as true/false or yes/no. The toggle_button control can display an image or text or both.
toggle_button and radio_button controls have a similar function: they allow the user to choose from a list of options. toggle_button controls let the user pick a combination of options. In contrast, radio_button controls allow a user to choose from mutually exclusive options.
The appearance property determines whether the toggle_button appears as a typical toggle_button or as a button.
The three_state property determines whether the control supports two or three states. Use the checked property to get or set the value of a two-state toggle_button control and use the check_state property to get or set the value of a three-state toggle_button control.
Note
If the three_state property is set to true, the checked property will return true for either a checked or indeterminate state.
Remarks
The flat_style property determines the style and appearance of the control. If the flat_style property is set to flat_style::system, the user's operating system determines the appearance of the control.
Note
When the flat_style property is set to flat_style::system, the check_align property is ignored and the control is displayed using the content_alignment::middle_left or content_alignment::middle_right alignment. If the check_align property is set to one of the right alignments, the control is displayed using the content_alignment::middle_right alignment; otherwise, it is displayed using the content_alignment::middle_left alignment.
Remarks
The following describes an indeterminate state: You have a toggle_button that determines if the selected text in a rich_text_box is bold. When you select text you can click the toggle_button to bold the selection. Likewise, when you select some text, the toggle_button displays whether the selected text is bold. If your selected text contains text that is bold and normal, the toggle_button will have an indeterminate state.
Examples
The following code example demonstrate the use of toggle_button control.
#include <xtd/xtd>
using namespace xtd;
using namespace xtd::forms;
namespace examples {
class form1 : public form {
public:
form1() {
text("Toggle button example");
controls().push_back_range({toggle_button1, toggle_button2, toggle_button3});
toggle_button1.auto_check(false);
toggle_button1.click += [&] {
//toggle_button1.checked(!toggle_button1.checked());
toggle_button1.text(ustring::format("{}", toggle_button1.check_state()));
};
toggle_button1.location({30, 30});
toggle_button1.text(ustring::format("{}", toggle_button1.check_state()));
toggle_button1.width(120);
toggle_button2.check_state_changed += [&] {
toggle_button2.text(ustring::format("{}", toggle_button2.check_state()));
};
toggle_button2.checked(true);
toggle_button2.location({30, 60});
toggle_button2.width(120);
toggle_button3.auto_size(true);
toggle_button3.check_state_changed += [&] {
toggle_button3.text(ustring::format("{}", toggle_button3.check_state()));
};
toggle_button3.check_state(forms::check_state::indeterminate);
toggle_button3.three_state(true);
toggle_button3.location({30, 90});
toggle_button3.width(120);
}
private:
toggle_button toggle_button1;
toggle_button toggle_button2;
toggle_button toggle_button3;
};
}
int main() {
application::run(examples::form1());
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
static void enable_visual_styles()
Enables visual styles for the application.
Represents a window or dialog box that makes up an application's user interface.
Definition: form.h:40
Represents a Windows toggle_button.
Definition: toggle_button.h:30
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition: about_box.h:13
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition: system_report.h:17
Examples
collapsible_panel.cpp, and toggle_button.cpp.

Inherits xtd::forms::button_base.

Public Attributes

event< toggle_button, event_handlercheck_state_changed
 Occurs when the value of the check_state property changes.
 
event< toggle_button, event_handlerchecked_changed
 Occurs when the value of the checked property changes.
 
- Public Attributes inherited from xtd::forms::button_base
event< button_base, event_handlerimage_changed
 Occurs when the value of the image property changes.
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the auto_size property changes.
 
event< control, event_handlerback_color_changed
 Occurs when the value of the back_color property changes.
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the background_image property changes.
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the background_image_layout property changes.
 
event< control, event_handlerclick
 Occurs when the control is clicked.
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the client_size property changes.
 
event< control, control_event_handlercontrol_added
 Occurs when a new control is added to the control::control_collection.
 
event< control, control_event_handlercontrol_removed
 Occurs when a new control is removed to the control::control_collection.
 
event< control, event_handlercursor_changed
 Occurs when the value of the cursor property changes.
 
event< control, event_handlerdock_changed
 Occurs when the value of the dock property changes.
 
event< control, event_handlerdouble_click
 Occurs when the control is double-clicked.
 
event< control, event_handlerenabled_changed
 Occurs when the value of the enabled property changes.
 
event< control, event_handlerfont_changed
 Occurs when the value of the font property changes.
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the fore_color property changes.
 
event< control, event_handlergot_focus
 Occurs when the control receives focus.
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the control.
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed.
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the control has focus.
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the control has focus.
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the control has focus.
 
event< control, event_handlerlayout
 Occurs when a control should reposition its child controls.
 
event< control, event_handlerlocation_changed
 Occurs when the value of the location property changes.
 
event< control, event_handlerlost_focus
 Occurs when the control loses focus.
 
event< control, mouse_event_handlermouse_click
 Occurs when the control is clicked by the mouse.
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the control is double clicked by the mouse.
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the control and a mouse button is pressed.
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the control.
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse horizontal wheel moves while the control has focus.
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the control.
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the control.
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the control and a mouse button is released.
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the control has focus.
 
event< control, paint_event_handlerpaint
 Occurs when the control is redrawn.
 
event< control, event_handlerparent_changed
 Occurs when the value of the parent property changes.
 
event< control, event_handlerresize
 Occurs when the control is resized.
 
event< control, event_handlersize_changed
 Occurs when the value of the size property changes.
 
event< control, event_handlertext_changed
 Occurs when the value of the text property changes.
 
event< control, event_handlervisible_changed
 Occurs when the value of the visible property changes.
 

Public Member Functions

 toggle_button ()
 Initializes a new instance of the CheckBox class.
 
virtual bool auto_check () const
 Gets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.
 
virtual toggle_buttonauto_check (bool auto_check)
 Sets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.
 
virtual content_alignment check_align () const
 Gets the horizontal and vertical alignment of the check mark on a toggle_button control.
 
virtual toggle_buttoncheck_align (content_alignment check_align)
 Sets the horizontal and vertical alignment of the check mark on a toggle_button control.
 
virtual forms::check_state check_state () const
 Gets the state of the toggle_button.
 
virtual toggle_buttoncheck_state (forms::check_state check_state)
 Sets the state of the toggle_button.
 
virtual bool checked () const
 Gets a value indicating whether the toggle_button is in the checked state.
 
virtual toggle_buttonchecked (bool checked)
 Sets a value indicating whether the toggle_button is in the checked state.
 
drawing::size default_size () const override
 Gets the default size of the control.
 
virtual bool three_state () const
 Gets a value indicating whether the toggle_button will allow three check states rather than two.
 
virtual toggle_buttonthree_state (bool three_state)
 Gets a value indicating whether the toggle_button will allow three check states rather than two.
 
- Public Member Functions inherited from xtd::forms::button_base
bool auto_ellipsis () const
 Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control.
 
virtual button_baseauto_ellipsis (bool auto_ellipsis)
 Sets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control.
 
bool auto_size () const override
 Gets a value that indicates whether the control resizes based on its contents.
 
controlauto_size (bool auto_size) override
 Sets a value that indicates whether the control resizes based on its contents.
 
xtd::forms::flat_button_appearanceflat_appearance ()
 Gets the appearance of the border and the colors used to indicate check state and mouse state.
 
const xtd::forms::flat_button_appearanceflat_appearance () const
 Gets the appearance of the border and the colors used to indicate check state and mouse state.
 
virtual xtd::forms::flat_style flat_style () const
 Gets the flat style appearance of the button control.
 
virtual xtd::forms::button_baseflat_style (xtd::forms::flat_style flat_style)
 Sets the flat style appearance of the button control.
 
virtual const drawing::imageimage () const
 Gets the image that is displayed on a button control.
 
virtual button_baseimage (const drawing::image &value)
 Sets the image that is displayed on a button control.
 
virtual content_alignment image_align () const
 Gets the alignment of the image on the button control.
 
virtual button_baseimage_align (content_alignment value)
 Gets the alignment of the image on the button control.
 
virtual int32_t image_index () const
 Gets the image list index value of the image displayed on the button control.
 
virtual button_baseimage_index (int32_t value)
 Sets the image list index value of the image displayed on the button control.
 
virtual forms::image_listimage_list ()
 Gets the image_list that contains the image displayed on a button control.
 
virtual const forms::image_listimage_list () const
 Gets the image_list that contains the image displayed on a button control.
 
virtual button_baseimage_list (const forms::image_list &value)
 Sets the image_list that contains the image displayed on a button control.
 
virtual content_alignment text_align () const
 Gets the alignment of the text on the button control.
 
virtual button_basetext_align (content_alignment value)
 Gets the alignment of the text on the button control.
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the control class with default settings.
 
 control (const control &parent, const xtd::ustring &text)
 Initializes a new instance of the control class as a child control, with specific text.
 
 control (const control &parent, const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class as a child control, with specific text, size, and location.
 
 control (const xtd::ustring &text)
 Initializes a new instance of the control class with specific text.
 
 control (const xtd::ustring &text, int32_t left, int32_t top, int32_t width, int32_t height)
 Initializes a new instance of the control class with specific text, size, and location.
 
virtual anchor_styles anchor () const
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
 
virtual controlanchor (anchor_styles anchor)
 Gets the edges of the container to which a control is bound and determines how a control is resized with its parent.
 
virtual drawing::point auto_scroll_point () const
 Gets where this control is scrolled to in scroll_control_into_view(control).
 
virtual bool auto_size () const
 Gets a value that indicates whether the control resizes based on its contents.
 
virtual controlauto_size (bool auto_size)
 Sets a value that indicates whether the control resizes based on its contents.
 
virtual drawing::color back_color () const
 Gets the background color for the control.
 
virtual controlback_color (const drawing::color &color)
 Sets the background color for the control.
 
virtual const xtd::drawing::imagebackground_image () const
 Gets the background image displayed in the control.
 
virtual controlbackground_image (const xtd::drawing::image &background_image)
 Sets the background image displayed in the control.
 
virtual xtd::forms::image_layout background_image_layout () const
 Gets the background image layout as defined in the xtd::forms::image_layout enumeration.
 
virtual controlbackground_image_layout (xtd::forms::image_layout background_image_layout)
 Sets the background image layout as defined in the xtd::forms::image_layout enumeration.
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void()> value)
 Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on.
 
std::shared_ptr< xtd::iasync_resultbegin_invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate asynchronously with the specified arguments, on the thread that the control's underlying handle was created on.
 
virtual int32_t bottom () const
 Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area.
 
virtual drawing::rectangle bounds () const
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
 
virtual controlbounds (const drawing::rectangle &bounds)
 Sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
 
virtual void bring_to_front ()
 Brings the control to the front of the z-order.
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus.
 
bool can_raise_events () const override
 Determines if events can be raised on the control.
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected.
 
virtual const drawing::rectangleclient_rectangle () const
 Gets the rectangle that represents the client area of the control.
 
virtual const drawing::sizeclient_size () const
 Gets the height and width of the client area of the control.
 
virtual controlclient_size (const drawing::size &client_size)
 Sets the height and width of the client area of the control.
 
virtual xtd::ustring company_name () const
 Gets the name of the company or creator of the application containing the control.
 
virtual control_collectioncontrols ()
 Gets the collection of controls contained within the control.
 
virtual const control_collectioncontrols () const
 Gets the collection of controls contained within the control.
 
void create_control ()
 Forces the creation of the visible control, including the creation of the handle and any visible child controls.
 
drawing::graphics create_graphics () const
 Creates the xtd::drawing::graphics for the control.
 
virtual void create_handle ()
 Creates a handle for the control.
 
virtual bool created ()
 Gets a value indicating whether the control has been created.
 
virtual forms::cursor cursor () const
 Gets the cursor that is displayed when the mouse pointer is over the control.
 
virtual controlcursor (const forms::cursor &cursor)
 Sets the cursor that is displayed when the mouse pointer is over the control.
 
virtual drawing::color default_back_color () const
 Gets the default background color of the control.
 
virtual forms::cursor default_cursor () const
 Gets the default cursor for the control.
 
virtual drawing::font default_font () const
 Gets the default font of the control.
 
virtual drawing::color default_fore_color () const
 Gets the default foreground color of the control.
 
virtual drawing::size default_size () const
 Gets the default size of the control.
 
virtual void destroy_control ()
 Forces the destruction of the visible control, including the destruction of the handle and any visible child controls.
 
virtual void destroy_handle ()
 Destroys the handle associated with the control.
 
virtual drawing::rectangle display_rectangle () const
 Gets the rectangle that represents the display area of the control.
 
virtual dock_style dock () const
 Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
 
virtual controldock (dock_style dock)
 Sets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
 
virtual bool double_buffered () const
 Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
 
virtual controldouble_buffered (bool double_buffered)
 Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker.
 
virtual bool enabled () const
 Gets a value indicating whether the control can respond to user interaction.
 
virtual controlenabled (bool enabled)
 Sets a value indicating whether the control can respond to user interaction.
 
void end_invoke (std::shared_ptr< xtd::iasync_result > async)
 Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed.
 
bool focus ()
 Sets input focus to the control.
 
virtual bool focused () const
 Gets a value indicating whether the control has input focus.
 
virtual drawing::font font () const
 Gets the font of the text displayed by the control.
 
virtual controlfont (const drawing::font &font)
 Sets the font of the text displayed by the control.
 
virtual drawing::color fore_color () const
 Gets the foreground color of the control.
 
virtual controlfore_color (const drawing::color &color)
 Sets the foreground color of the control.
 
size_t get_child_index (intptr_t child) const
 Retrieves the index of a control within the control collection.
 
size_t get_child_index (intptr_t child, bool &throw_exception) const
 Retrieves the index of the specified child control within the control collection, and optionally raises an exception if the specified control is not within the control collection.
 
intptr_t handle () const override
 Gets the window handle that the control is bound to.
 
virtual int32_t height () const
 Gets the height of the control.
 
virtual controlheight (int32_t height)
 Sets the height of the control.
 
virtual void hide ()
 Conceals the control from the user.
 
virtual void invalidate () const
 Invalidates the entire surface of the control and causes the control to be redrawn.
 
virtual void invalidate (bool invalidate_children) const
 Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
 
virtual void invalidate (const drawing::rectangle &rect) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control.
 
virtual void invalidate (const drawing::rectangle &rect, bool invalidate_children) const
 Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control.
 
void invoke (delegate< void()> value)
 Executes the specified delegate on the thread that owns the control's underlying window handle.
 
void invoke (delegate< void(std::vector< std::any >)> value, const std::vector< std::any > &args)
 Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
 
bool is_handle_created () const
 Gets a value indicating whether the control has a handle associated with it.
 
virtual int32_t left () const
 Gets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
 
virtual controlleft (int32_t left)
 Sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
 
virtual drawing::point location () const
 Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
 
virtual controllocation (const drawing::point &location)
 Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
 
virtual forms::padding margin () const
 Gets the space between controls.
 
virtual controlmargin (const forms::padding &margin)
 Sets the space between controls.
 
virtual const drawing::sizemaximum_size () const
 Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlmaximum_size (const drawing::size &size)
 Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify.
 
virtual const drawing::sizeminimum_size () const
 Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
virtual controlminimum_size (const drawing::size &size)
 Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify.
 
virtual const xtd::ustringname () const
 Gets the name of the control.
 
virtual controlname (const xtd::ustring &name)
 Sets the name of the control.
 
virtual forms::padding padding () const
 Gets padding within the control.
 
virtual controlpadding (const forms::padding &padding)
 Sets padding within the control.
 
virtual std::optional< control_refparent () const
 Gets the parent container of the control.
 
virtual controlparent (const control &parent)
 Sets the parent container of the control.
 
virtual controlparent (std::nullptr_t)
 Resets the parent container of the control.
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls.
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 Computes the location of the specified screen point into client coordinates.
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 Computes the location of the specified client point into screen coordinates.
 
virtual bool pre_process_message (xtd::forms::message &message)
 Preprocesses keyboard or input messages within the message loop before they are dispatched.
 
virtual xtd::ustring product_name () const
 Gets the product name of the assembly containing the control.
 
bool recreating_handle () const
 Gets a value indicating whether the control is currently re-creating its handle.
 
virtual void refresh () const
 Forces the control to invalidate its client area and immediately redraw itself and any child controls.
 
void resume_layout ()
 Resumes usual layout logic.
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests.
 
virtual int32_t right () const
 Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area.
 
intptr_t send_message (intptr_t hwnd, int32_t msg, intptr_t wparam, intptr_t lparam) const
 Send a message with specified hwnd, message, wparam and lparam.
 
void set_auto_size_mode (auto_size_mode auto_size_mode)
 Sets a value indicating how a control will behave when its auto_size property is enabled.
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height)
 Sets the bounds of the control to the specified location and size.
 
void set_bounds (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Sets the specified bounds of the control to the specified location and size.
 
virtual void show ()
 Displays the control to the user.
 
virtual const drawing::sizesize () const
 Gets the height and width of the control.
 
virtual controlsize (const drawing::size &size)
 Sets the height and width of the control.
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control.
 
virtual std::any tag () const
 Gets the object that contains data about the control.
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control.
 
virtual const xtd::ustringtext () const
 Gets the text associated with this control.
 
virtual controltext (const xtd::ustring &text)
 Sets the text associated with this control.
 
xtd::ustring to_string () const noexcept override
 Returns a string containing the name of the control, if any.
 
virtual int32_t top () const
 Gets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
 
virtual controltop (int32_t top)
 Sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
 
virtual std::optional< control_reftop_level_control () const
 Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in.
 
virtual void update () const
 Causes the control to redraw the invalidated regions within its client area.
 
virtual bool visible () const
 Gets a value indicating whether the control and all its child controls are displayed.
 
virtual controlvisible (bool visible)
 Sets a value indicating whether the control and all its child controls are displayed.
 
virtual int32_t width () const
 Gets the width of the control.
 
virtual controlwidth (int32_t width)
 Sets the width of the control.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance.
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object.
 
virtual intptr_t handle () const =0
 Gets the handle to the window represented by the implementer.
 

Protected Member Functions

forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created.
 
drawing::size measure_control () const override
 Measure this control.
 
virtual void on_check_state_changed (const event_args &e)
 Raises the toggle_button::check_state_changed event.
 
virtual void on_checked_changed (const event_args &e)
 Raises the toggle_button::checked_changed event.
 
void on_enabled_changed (const event_args &e) override
 Raises the control::enabled_changed event.
 
void on_handle_created (const event_args &e) override
 Raises the handle_created event.
 
void on_mouse_down (const mouse_event_args &e) override
 Raises the control::mouse_down event.
 
void on_mouse_enter (const event_args &e) override
 Raises the control::mouse_enter event.
 
void on_mouse_leave (const event_args &e) override
 Raises the control::mouse_leave event.
 
void on_mouse_up (const mouse_event_args &e) override
 Raises the control::mouse_up event.
 
void on_paint (paint_event_args &e) override
 Raises the control::paint event.
 
- Protected Member Functions inherited from xtd::forms::button_base
 button_base ()
 Initializes a new instance of the ButtonBase class.
 
forms::create_params create_params () const override
 Gets the required creation parameters when the control handle is created.
 
drawing::size default_size () const override
 Gets the default size of the control.
 
drawing::size measure_control () const override
 Measure this control.
 
void on_back_color_changed (const event_args &e) override
 Raises the control::back_color_changed event.
 
void on_enabled_changed (const event_args &e) override
 Raises the control::enabled_changed event.
 
void on_font_changed (const xtd::event_args &e) override
 Raises the control::font_changed event.
 
void on_fore_color_changed (const event_args &e) override
 Raises the control::fore_color_changed event.
 
virtual void on_image_changed (const xtd::event_args &e)
 Raises the button_base::image_changed event.
 
void on_mouse_down (const mouse_event_args &e) override
 Raises the control::mouse_down event.
 
void on_mouse_enter (const event_args &e) override
 Raises the control::mouse_enter event.
 
void on_mouse_leave (const event_args &e) override
 Raises the control::mouse_leave event.
 
void on_mouse_up (const mouse_event_args &e) override
 Raises the control::mouse_up event.
 
void on_parent_back_color_changed (const event_args &e) override
 Raises the control::parent_back_color_changed event.
 
void on_parent_fore_color_changed (const event_args &e) override
 Raises the control::parent_fore_color_changed event.
 
void on_resize (const xtd::event_args &e) override
 Raises the control::resize event.
 
void on_text_changed (const xtd::event_args &e) override
 Raises the control::text_changed event.
 
- Protected Member Functions inherited from xtd::forms::control
virtual forms::create_params create_params () const
 Gets the required creation parameters when the control handle is created.
 
virtual void def_wnd_proc (message &message)
 Sends the specified message to the default window procedure.
 
bool get_style (control_styles flag) const
 Retrieves the value of the specified control style bit for the control.
 
virtual drawing::size measure_control () const
 Measure this control.
 
drawing::size measure_text () const
 Measure this control text.
 
virtual void on_auto_size_changed (const event_args &e)
 Raises the control::auto_size_changed event.
 
virtual void on_back_color_changed (const event_args &e)
 Raises the control::back_color_changed event.
 
virtual void on_background_image_changed (const event_args &e)
 Raises the control::background_image_changed event.
 
virtual void on_background_image_layout_changed (const event_args &e)
 Raises the control::background_image_layout_changed event.
 
virtual void on_click (const event_args &e)
 Raises the control::click event.
 
virtual void on_client_size_changed (const event_args &e)
 Raises the control::client_size_changed event.
 
virtual void on_control_added (const control_event_args &e)
 Raises the control::control_added event.
 
virtual void on_control_removed (const control_event_args &e)
 Raises the control::control_removed event.
 
virtual void on_create_control ()
 Raises the control::create_control event.
 
virtual void on_cursor_changed (const event_args &e)
 Raises the control::cursor_changed event.
 
virtual void on_dock_changed (const event_args &e)
 Raises the control::dock_changed event.
 
virtual void on_double_click (const event_args &e)
 Raises the double_click event.
 
virtual void on_enabled_changed (const event_args &e)
 Raises the control::enabled_changed event.
 
virtual void on_font_changed (const event_args &e)
 Raises the control::font_changed event.
 
virtual void on_fore_color_changed (const event_args &e)
 Raises the control::fore_color_changed event.
 
virtual void on_got_focus (const event_args &e)
 Raises the control::got_focus event.
 
virtual void on_handle_created (const event_args &e)
 Raises the control::handle_created event.
 
virtual void on_handle_destroyed (const event_args &e)
 Raises the control::handle_destroyed event.
 
virtual void on_key_down (key_event_args &e)
 Raises the control::key_down event.
 
virtual void on_key_press (key_press_event_args &e)
 Raises the control::key_press event.
 
virtual void on_key_up (key_event_args &e)
 Raises the control::key_up event.
 
virtual void on_layout (const event_args &e)
 Raises the control::layout event.
 
virtual void on_location_changed (const event_args &e)
 Raises the control::location_changed event.
 
virtual void on_lost_focus (const event_args &e)
 Raises the control::lost_focus event.
 
virtual void on_mouse_click (const mouse_event_args &e)
 Raises the control::mouse_click event.
 
virtual void on_mouse_double_click (const mouse_event_args &e)
 Raises the control::mouse_double_click event.
 
virtual void on_mouse_down (const mouse_event_args &e)
 Raises the control::mouse_down event.
 
virtual void on_mouse_enter (const event_args &e)
 Raises the control::mouse_enter event.
 
virtual void on_mouse_horizontal_wheel (const mouse_event_args &e)
 Raises the control::mouse_horizontal_wheel event.
 
virtual void on_mouse_leave (const event_args &e)
 Raises the control::mouse_leave event.
 
virtual void on_mouse_move (const mouse_event_args &e)
 Raises the control::mouse_move event.
 
virtual void on_mouse_up (const mouse_event_args &e)
 Raises the control::mouse_up event.
 
virtual void on_mouse_wheel (const mouse_event_args &e)
 Raises the control::mouse_wheel event.
 
virtual void on_paint (paint_event_args &e)
 Raises the control::paint event.
 
virtual void on_parent_back_color_changed (const event_args &e)
 Raises the control::parent_back_color_changed event.
 
virtual void on_parent_changed (const event_args &e)
 Raises the control::parent_changed event.
 
virtual void on_parent_cursor_changed (const event_args &e)
 Raises the control::parent_cursor_changed event.
 
virtual void on_parent_enabled_changed (const event_args &e)
 Raises the xtd::control::enabled_changed event when the xtd::control::enabled property value of the control's container changes..
 
virtual void on_parent_font_changed (const event_args &e)
 Raises the control::parent_font_changed event.
 
virtual void on_parent_fore_color_changed (const event_args &e)
 Raises the control::parent_fore_color_changed event.
 
virtual void on_resize (const event_args &e)
 Raises the control::resize event.
 
virtual void on_size_changed (const event_args &e)
 Raises the control::size_changed event.
 
virtual void on_text_changed (const event_args &e)
 Raises the control::text_changed event.
 
virtual void on_visible_changed (const event_args &e)
 Raises the control::visible_changed event.
 
virtual void recreate_handle ()
 Forces the re-creation of the handle for the control.
 
virtual void set_bounds_core (int32_t x, int32_t y, int32_t width, int32_t height, bounds_specified specified)
 Performs the work of setting the specified bounds of this control.
 
virtual void set_client_size_core (int32_t width, int32_t height)
 Sets the size of the client area of the control.
 
void set_style (control_styles flag, bool value)
 Sets a specified control_styles flag to either true or false.
 
virtual void wnd_proc (message &m)
 Processes Windows messages.
 
- Protected Member Functions inherited from xtd::forms::component
 component ()=default
 Initialises a new instance of the component class.
 
virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event.
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode.
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::forms::control
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified parent, location ,size back_color and fore_color.
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified parent, text, location ,size back_color and fore_color.
 
template<typename control_t >
static std::unique_ptr< control_t > create (const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified location ,size back_color and fore_color.
 
template<typename control_t >
static std::unique_ptr< control_t > create (const xtd::ustring &text, const drawing::point &location={-1, -1}, const drawing::size &size={-1, -1}, const drawing::color &back_color=drawing::color::empty, const drawing::color &fore_color=drawing::color::empty)
 A factory to create a specified control with specified text, location ,size back_color and fore_color.
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 Retrieves the control that contains the specified handle.
 
static std::optional< control_reffrom_handle (intptr_t handle)
 Returns the control that is currently associated with the specified handle.
 
static forms::keys modifier_keys ()
 Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state.
 
static forms::mouse_buttons mouse_buttons ()
 Gets a value indicating which of the mouse buttons is in a pressed state.
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ toggle_button()

xtd::forms::toggle_button::toggle_button ( )

Initializes a new instance of the CheckBox class.

Remarks
By default, when a new toggle_button is instantiated, auto_check is set to true, checked is set to false, and appearance is set to normal.

Member Function Documentation

◆ auto_check() [1/2]

virtual bool xtd::forms::toggle_button::auto_check ( ) const
inlinevirtual

Gets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.

Returns
true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true.
Remarks
If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler.

◆ auto_check() [2/2]

virtual toggle_button & xtd::forms::toggle_button::auto_check ( bool  auto_check)
virtual

Sets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked.

Parameters
auto_checktrue if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true.
Remarks
If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler.

◆ check_align() [1/2]

virtual content_alignment xtd::forms::toggle_button::check_align ( ) const
inlinevirtual

Gets the horizontal and vertical alignment of the check mark on a toggle_button control.

Returns
One of the content_alignment values. The default value is middle_left.

◆ check_align() [2/2]

virtual toggle_button & xtd::forms::toggle_button::check_align ( content_alignment  check_align)
virtual

Sets the horizontal and vertical alignment of the check mark on a toggle_button control.

Parameters
check_alignOne of the content_alignment values. The default value is middle_left.

◆ check_state() [1/2]

virtual forms::check_state xtd::forms::toggle_button::check_state ( ) const
inlinevirtual

Gets the state of the toggle_button.

Returns
One of the 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 toggle_button control in its different states for the normal and button style control toggle_button::appearance.
Check_state appearance::normal appearance::button
checked The toggle_button 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.

◆ check_state() [2/2]

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

Sets the state of the toggle_button.

Parameters
chexk_stateOne of the check_state enumeration values. The default value is unchecked.
Remarks
The following table describes the xtd::forms::appearance of the toggle_button control in its different states for the normal and button style control toggle_button::appearance.
Check_state appearance::normal appearance::button
checked The toggle_button 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.

◆ checked() [1/2]

virtual bool xtd::forms::toggle_button::checked ( ) const
inlinevirtual

Gets a value indicating whether the toggle_button is in the checked state.

Returns
true if the toggle_button is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state.
Remarks
When the value is true, the toggle_button portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false.

◆ checked() [2/2]

virtual toggle_button & xtd::forms::toggle_button::checked ( bool  checked)
virtual

Sets a value indicating whether the toggle_button is in the checked state.

Parameters
checkedtrue if the toggle_button is in the checked state; otherwise, false. The default value is false.
Remarks
When the value is true, the toggle_button portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false.

◆ create_params()

forms::create_params xtd::forms::toggle_button::create_params ( ) const
overrideprotectedvirtual

Gets the required creation parameters when the control handle is created.

Returns
A create_params that contains the required creation parameters when the handle to the control is created.

Reimplemented from xtd::forms::button_base.

◆ default_size()

drawing::size xtd::forms::toggle_button::default_size ( ) const
inlineoverridevirtual

Gets the default size of the control.

Returns
The default size.

Reimplemented from xtd::forms::button_base.

◆ measure_control()

drawing::size xtd::forms::toggle_button::measure_control ( ) const
overrideprotectedvirtual

Measure this control.

Returns
The drawing::size size of this control.
Remarks
This metod is not relevant for this class.

Reimplemented from xtd::forms::button_base.

◆ on_check_state_changed()

virtual void xtd::forms::toggle_button::on_check_state_changed ( const event_args e)
inlineprotectedvirtual

Raises the toggle_button::check_state_changed event.

Parameters
eAn event_args that contains the event data.
Remarks
Raising an event invokes the event handler through a delegate.
The on_check_state_changed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

◆ on_checked_changed()

virtual void xtd::forms::toggle_button::on_checked_changed ( const event_args e)
inlineprotectedvirtual

Raises the toggle_button::checked_changed event.

Parameters
eAn event_args that contains the event data.
Remarks
Raising an event invokes the event handler through a delegate.
The on_checked_changed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

◆ on_enabled_changed()

void xtd::forms::toggle_button::on_enabled_changed ( const event_args e)
inlineoverrideprotectedvirtual

Raises the control::enabled_changed event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_handle_created()

void xtd::forms::toggle_button::on_handle_created ( const event_args e)
overrideprotectedvirtual

Raises the handle_created event.

Parameters
eAn event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ on_mouse_down()

void xtd::forms::toggle_button::on_mouse_down ( const mouse_event_args e)
inlineoverrideprotectedvirtual

Raises the control::mouse_down event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_enter()

void xtd::forms::toggle_button::on_mouse_enter ( const event_args e)
inlineoverrideprotectedvirtual

Raises the control::mouse_enter event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_leave()

void xtd::forms::toggle_button::on_mouse_leave ( const event_args e)
inlineoverrideprotectedvirtual

Raises the control::mouse_leave event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_mouse_up()

void xtd::forms::toggle_button::on_mouse_up ( const mouse_event_args e)
inlineoverrideprotectedvirtual

Raises the control::mouse_up event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::button_base.

◆ on_paint()

void xtd::forms::toggle_button::on_paint ( paint_event_args e)
overrideprotectedvirtual

Raises the control::paint event.

Parameters
eAn xtd::event_args that contains the event data.

Reimplemented from xtd::forms::control.

◆ three_state() [1/2]

virtual bool xtd::forms::toggle_button::three_state ( ) const
inlinevirtual

Gets a value indicating whether the toggle_button will allow three check states rather than two.

Returns
true if the toggle_button is able to display three check states; otherwise, false. The default value is false.
Remarks
If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction.

◆ three_state() [2/2]

virtual toggle_button & xtd::forms::toggle_button::three_state ( bool  three_state)
virtual

Gets a value indicating whether the toggle_button will allow three check states rather than two.

Parameters
three_statetrue if the toggle_button is able to display three check states; otherwise, false. The default value is false.
Remarks
If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction.

The documentation for this class was generated from the following file: