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.
Public Member Functions | Protected Member Functions | List of all members
xtd::forms::button Class Reference

Represents a Windows button control. More...

#include <button.h>

Public Member Functions

 button ()
 Initializes a new instance of the button class. More...
 
virtual bool auto_repeat () const
 Gets if this button instance is auto repeat. More...
 
virtual buttonauto_repeat (bool auto_repeat)
 Sets if this button instance is auto repeat. More...
 
virtual int32_t auto_repeat_delay () const
 Gets the auto repeat delay. More...
 
virtual buttonauto_repeat_delay (int32_t auto_repeat_delay)
 Gets the auto repeat delay. More...
 
virtual int32_t auto_repeat_interval () const
 Gets the auto repeat interval. More...
 
virtual buttonauto_repeat_interval (int32_t auto_repeat_interval)
 Gets the auto repeat interval. More...
 
virtual forms::auto_size_mode auto_size_mode () const
 Gets the mode by which the button automatically resizes itself. More...
 
virtual buttonauto_size_mode (forms::auto_size_mode value)
 Sets the mode by which the button automatically resizes itself. More...
 
forms::dialog_result dialog_result () const override
 Gets the value returned to the parent form when the button is clicked. More...
 
controldialog_result (forms::dialog_result dialog_result) override
 Sets the value returned to the parent form when the button is clicked. More...
 
void notify_default (bool value) override
 Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. More...
 
void perform_click () override
 Generates a click event for the control. More...
 
- 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. More...
 
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. More...
 
bool auto_size () const override
 Gets a value that indicates whether the control resizes based on its contents. More...
 
controlauto_size (bool auto_size) override
 Sets a value that indicates whether the control resizes based on its contents. More...
 
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. More...
 
xtd::forms::flat_button_appearanceflat_appearance ()
 Gets the appearance of the border and the colors used to indicate check state and mouse state. More...
 
virtual xtd::forms::flat_style flat_style () const
 Gets the flat style appearance of the button control. More...
 
virtual xtd::forms::button_baseflat_style (xtd::forms::flat_style flat_style)
 Sets the flat style appearance of the button control. More...
 
virtual const drawing::imageimage () const
 Gets the image that is displayed on a button control. More...
 
virtual button_baseimage (const drawing::image &value)
 Sets the image that is displayed on a button control. More...
 
virtual content_alignment image_align () const
 Gets the alignment of the image on the button control. More...
 
virtual button_baseimage_align (content_alignment value)
 Gets the alignment of the image on the button control. More...
 
virtual int32_t image_index () const
 Gets the image list index value of the image displayed on the button control. More...
 
virtual button_baseimage_index (int32_t value)
 Sets the image list index value of the image displayed on the button control. More...
 
virtual const forms::image_listimage_list () const
 Gets the image_list that contains the image displayed on a button control. More...
 
virtual forms::image_listimage_list ()
 Gets the image_list that contains the image displayed on a button control. More...
 
virtual button_baseimage_list (const forms::image_list &value)
 Sets the image_list that contains the image displayed on a button control. More...
 
virtual content_alignment text_align () const
 Gets the alignment of the text on the button control. More...
 
virtual button_basetext_align (content_alignment value)
 Gets the alignment of the text on the button control. More...
 
- Public Member Functions inherited from xtd::forms::control
 control ()
 Initializes a new instance of the control class with default settings. More...
 
 control (const std::string &text)
 Initializes a new instance of the control class with specific text. More...
 
 control (const control &parent, const std::string &text)
 nitializes a new instance of the control class as a child control, with specific text. More...
 
 control (const std::string &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. More...
 
 control (const control &parent, const std::string &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. More...
 
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. More...
 
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. More...
 
virtual drawing::point auto_scroll_point () const
 Gets where this control is scrolled to in scroll_control_into_view(control). More...
 
virtual drawing::color back_color () const
 Gets the background color for the control. More...
 
virtual controlback_color (const drawing::color &color)
 Sets the background color for the control. More...
 
virtual const xtd::drawing::imagebackground_image () const
 Gets the background image displayed in the control. More...
 
virtual controlbackground_image (const xtd::drawing::image &background_image)
 Sets the background image displayed in the control. More...
 
virtual xtd::forms::image_layout background_image_layout () const
 Gets the background image layout as defined in the xtd::forms::image_layout enumeration. More...
 
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. More...
 
async_result_invoke begin_invoke (delegate< void()> value)
 Executes the specified delegate asynchronously on the thread that the control's underlying handle was created on. More...
 
async_result_invoke begin_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. More...
 
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. More...
 
virtual drawing::rectangle bounds () const
 Gets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. More...
 
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. More...
 
virtual void bring_to_front ()
 Brings the control to the front of the z-order. More...
 
virtual bool can_focus () const
 Gets a value indicating whether the control can receive focus. More...
 
bool can_raise_events () const override
 Determines if events can be raised on the control. More...
 
virtual bool can_select () const
 Gets a value indicating whether the control can be selected. More...
 
virtual const drawing::rectangleclient_rectangle () const
 Gets the rectangle that represents the client area of the control. More...
 
virtual const drawing::sizeclient_size () const
 Gets the height and width of the client area of the control. More...
 
virtual controlclient_size (const drawing::size &client_size)
 Sets the height and width of the client area of the control. More...
 
virtual std::string compagny_name () const
 Gets the name of the company or creator of the application containing the control. More...
 
virtual control_collectioncontrols ()
 Gets the collection of controls contained within the control. More...
 
virtual const control_collectioncontrols () const
 Gets the collection of controls contained within the control. More...
 
void create_control ()
 Forces the creation of the visible control, including the creation of the handle and any visible child controls. More...
 
drawing::graphics create_graphics () const
 Creates the xtd::drawing::graphics for the control. More...
 
virtual void create_handle ()
 Creates a handle for the control. More...
 
virtual bool created ()
 Gets a value indicating whether the control has been created. More...
 
virtual forms::cursor cursor () const
 Gets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual controlcursor (const forms::cursor &cursor)
 Sets the cursor that is displayed when the mouse pointer is over the control. More...
 
virtual drawing::color default_back_color () const
 Gets the default background color of the control. More...
 
virtual forms::cursor default_cursor () const
 Gets the default cursor for the control. More...
 
virtual drawing::font default_font () const
 Gets the default font of the control. More...
 
virtual drawing::color default_fore_color () const
 Gets the default foreground color of the control. More...
 
virtual void destroy_control ()
 Forces the destruction of the visible control, including the destruction of the handle and any visible child controls. More...
 
virtual void destroy_handle ()
 Destroys the handle associated with the control. More...
 
virtual drawing::rectangle display_rectangle () const
 Gets the rectangle that represents the display area of the control. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual bool enabled () const
 Gets a value indicating whether the control can respond to user interaction. More...
 
virtual controlenabled (bool enabled)
 Sets a value indicating whether the control can respond to user interaction. More...
 
void end_invoke (async_result_invoke async)
 Retrieves the return value of the asynchronous operation represented by the async_result_invoke passed. More...
 
bool focus ()
 Sets input focus to the control. More...
 
virtual bool focused () const
 Gets a value indicating whether the control has input focus. More...
 
virtual drawing::font font () const
 Gets the font of the text displayed by the control. More...
 
virtual controlfont (const drawing::font &font)
 Sets the font of the text displayed by the control. More...
 
virtual drawing::color fore_color () const
 Gets the foreground color of the control. More...
 
virtual controlfore_color (const drawing::color &color)
 Sets the foreground color of the control. More...
 
size_t get_child_index (intptr_t child) const
 Retrieves the index of a control within the control collection. More...
 
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. More...
 
intptr_t handle () const override
 Gets the window handle that the control is bound to. More...
 
virtual int32_t height () const
 Gets the height of the control. More...
 
virtual controlheight (int32_t height)
 Sets the height of the control. More...
 
virtual void hide ()
 Conceals the control from the user. More...
 
virtual void invalidate () const
 Invalidates the entire surface of the control and causes the control to be redrawn. More...
 
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. More...
 
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. More...
 
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. More...
 
void invoke (delegate< void()> value)
 Executes the specified delegate on the thread that owns the control's underlying window handle. More...
 
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. More...
 
bool is_handle_created () const
 Gets a value indicating whether the control has a handle associated with it. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual forms::padding margin () const
 Gets the space between controls. More...
 
virtual controlmargin (const forms::padding &margin)
 Sets the space between controls. More...
 
virtual const drawing::sizemaximum_size () const
 Gets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlmaximum_size (const drawing::size &size)
 Sets the size that is the upper limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const drawing::sizeminimum_size () const
 Gets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual controlminimum_size (const drawing::size &size)
 Sets the size that is the lower limit that xtd::forms::control::get_preferred_size can specify. More...
 
virtual const std::string & name () const
 Gets the name of the control. More...
 
virtual controlname (const std::string &name)
 Sets the name of the control. More...
 
virtual forms::padding padding () const
 Gets padding within the control. More...
 
virtual controlpadding (const forms::padding &padding)
 Sets padding within the control. More...
 
virtual std::optional< control_refparent () const
 Gets the parent container of the control. More...
 
virtual controlparent (const control &parent)
 Sets the parent container of the control. More...
 
virtual controlparent (std::nullptr_t)
 Resets the parent container of the control. More...
 
void perform_layout ()
 Forces the control to apply layout logic to all its child controls. More...
 
xtd::drawing::point point_to_client (const xtd::drawing::point &p)
 Computes the location of the specified screen point into client coordinates. More...
 
xtd::drawing::point point_to_screen (const xtd::drawing::point &p)
 Computes the location of the specified client point into screen coordinates. More...
 
virtual bool pre_process_message (xtd::forms::message &message)
 Preprocesses keyboard or input messages within the message loop before they are dispatched. More...
 
virtual std::string product_name () const
 Gets the product name of the assembly containing the control. More...
 
bool recreating_handle () const
 Gets a value indicating whether the control is currently re-creating its handle. More...
 
virtual void refresh () const
 Forces the control to invalidate its client area and immediately redraw itself and any child controls. More...
 
void resume_layout ()
 Resumes usual layout logic. More...
 
void resume_layout (bool perform_layout)
 Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void show ()
 Displays the control to the user. More...
 
virtual const drawing::sizesize () const
 Gets the height and width of the control. More...
 
virtual controlsize (const drawing::size &size)
 Sets the height and width of the control. More...
 
void suspend_layout ()
 Temporarily suspends the layout logic for the control. More...
 
virtual std::any tag () const
 Gets the object that contains data about the control. More...
 
virtual controltag (std::any tag)
 Sets the object that contains data about the control. More...
 
virtual const std::string & text () const
 Gets the text associated with this control. More...
 
virtual controltext (const std::string &text)
 Sets the text associated with this control. More...
 
std::string to_string () const noexcept override
 Returns a string containing the name of the control, if any. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void update () const
 Causes the control to redraw the invalidated regions within its client area. More...
 
virtual bool visible () const
 Gets a value indicating whether the control and all its child controls are displayed. More...
 
virtual controlvisible (bool visible)
 Sets a value indicating whether the control and all its child controls are displayed. More...
 
virtual int32_t width () const
 Gets the width of the control. More...
 
virtual controlwidth (int32_t width)
 Sets the width of the control. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::shared_ptr< objectmemberwise_clone () const
 Gets the type of the current instance. More...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from xtd::forms::control
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. More...
 
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. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const std::string &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. More...
 
template<typename control_t >
static std::unique_ptr< control_t > create (const control &parent, const std::string &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. More...
 
static std::optional< control_reffrom_child_handle (intptr_t handle)
 Retrieves the control that contains the specified handle. More...
 
static std::optional< control_reffrom_handle (intptr_t handle)
 Returns the control that is currently associated with the specified handle. More...
 
static forms::keys modifier_keys ()
 Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. More...
 
static forms::mouse_buttons mouse_buttons ()
 Gets a value indicating which of the mouse buttons is in a pressed state. More...
 
- 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. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 
- Public Attributes inherited from xtd::forms::button_base
event< button_base, event_handlerimage_changed
 Occurs when the value of the image property changes. More...
 
- Public Attributes inherited from xtd::forms::control
event< control, event_handlerauto_size_changed
 Occurs when the value of the auto_size property changes. More...
 
event< control, event_handlerback_color_changed
 Occurs when the value of the back_color property changes. More...
 
event< control, event_handlerbackground_image_changed
 Occurs when the value of the background_image property changes. More...
 
event< control, event_handlerbackground_image_layout_changed
 Occurs when the value of the background_image_layouot property changes. More...
 
event< control, event_handlerclick
 Occurs when the control is clicked. More...
 
event< control, event_handlerclient_size_changed
 Occurs when the value of the client_size property changes. More...
 
event< control, control_event_handlercontrol_added
 Occurs when a new control is added to the control::control_collection. More...
 
event< control, control_event_handlercontrol_removed
 Occurs when a new control is removed to the control::control_collection. More...
 
event< control, event_handlercursor_changed
 Occurs when the value of the cursor property changes. More...
 
event< control, event_handlerdock_changed
 Occurs when the value of the dock property changes. More...
 
event< control, event_handlerdouble_click
 Occurs when the control is double-clicked. More...
 
event< control, event_handlerenabled_changed
 Occurs when the value of the enabled property changes. More...
 
event< control, event_handlerfont_changed
 Occurs when the value of the font property changes. More...
 
event< control, event_handlerfore_color_changed
 Occurs when the value of the fore_color property changes. More...
 
event< control, event_handlergot_focus
 Occurs when the control receives focus. More...
 
event< control, event_handlerhandle_created
 Occurs when a handle is created for the control. More...
 
event< control, event_handlerhandle_destroyed
 Occurs when the control's handle is in the process of being destroyed. More...
 
event< control, key_event_handlerkey_down
 Occurs when a key is pressed while the control has focus. More...
 
event< control, key_press_event_handlerkey_press
 Occurs when a character. space or backspace key is pressed while the control has focus. More...
 
event< control, key_event_handlerkey_up
 Occurs when a key is released while the control has focus. More...
 
event< control, event_handlerlayout
 Occurs when a control should reposition its child controls. More...
 
event< control, event_handlerlocation_changed
 Occurs when the value of the location property changes. More...
 
event< control, event_handlerlost_focus
 Occurs when the control loses focus. More...
 
event< control, mouse_event_handlermouse_click
 Occurs when the control is clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_double_click
 Occurs when the control is double clicked by the mouse. More...
 
event< control, mouse_event_handlermouse_down
 Occurs when the mouse pointer is over the control and a mouse button is pressed. More...
 
event< control, event_handlermouse_enter
 Occurs when the mouse pointer enters the control. More...
 
event< control, mouse_event_handlermouse_horizontal_wheel
 Occurs when the mouse hoirontal wheel moves while the control has focus. More...
 
event< control, event_handlermouse_leave
 Occurs when the mouse pointer leaves the control. More...
 
event< control, mouse_event_handlermouse_move
 Occurs when the mouse pointer is moved over the control. More...
 
event< control, mouse_event_handlermouse_up
 Occurs when the mouse pointer is over the control and a mouse button is released. More...
 
event< control, mouse_event_handlermouse_wheel
 Occurs when the mouse wheel moves while the control has focus. More...
 
event< control, paint_event_handlerpaint
 Occurs when the control is redrawn. More...
 
event< control, event_handlerparent_changed
 Occurs when the value of the parent property changes. More...
 
event< control, event_handlerresize
 Occurs when the control is resized. More...
 
event< control, event_handlersize_changed
 Occurs when the value of the size property changes. More...
 
event< control, event_handlertext_changed
 Occurs when the value of the text property changes. More...
 
event< control, event_handlervisible_changed
 Occurs when the value of the visible property changes. More...
 

Detailed Description

Represents a Windows button control.

Appearance
Mode Windows macOS Gnome
Light
control_button_w.png
html control_button_m.png html control_button_g.png
Dark
control_button_wd.png
html control_button_md.png html control_button_gd.png
Library
xtd.forms
Remarks
A Button can be clicked by using the mouse, ENTER key, or SPACEBAR if the button has focus.
Set the accept_button or cancel_button property of a form to allow users to click a button by pressing the ENTER or ESC keys even if the button does not have focus. This gives the form the behavior of a dialog box.
When you display a form using the show_dialog method, you can use the dialog_result property of a button to specify the return value of show_dialog.
You can change the button's appearance. For example, to make it appear flat for a Web look, set the flat_style property to flat_style::flat. The flat_style property can also be set to flat_style::popup, which appears flat until the mouse pointer passes over the button; then the button takes on the standard Windows button appearance.
Note
If the control that has focus accepts and processes the ENTER key press, the button does not process it. For example, if a multiline text_box or another button has focus, that control processes the ENTER key press instead of the accept button.
Examples
The following code example demonstrate the use of button control.
#include <xtd/xtd>
using namespace xtd;
using namespace xtd::forms;
namespace examples {
class form1 : public form {
public:
form1() {
text("Button example");
button1.parent(*this);
button1.text("Button 1");
button1.location({50, 50});
button1.click += [&] {
label1.text(ustring::format("Button 1 clicked {} times", ++button1_clicked));
};
button2.parent(*this);
button2.text("Button 2");
button2.location({50, 100});
button2.auto_repeat(true);
button2.size({200, 75});
button2.click += [&] {
label2.text(ustring::format("Button 2 clicked {} times", ++button2_clicked));
};
label1.parent(*this);
label1.text("Button 1 clicked 0 times");
label1.location({50, 200});
label1.width(200);
label2.parent(*this);
label2.text("Button 2 clicked 0 times");
label2.location({50, 230});
label2.width(200);
}
private:
label label1;
label label2;
int button1_clicked = 0;
int button2_clicked = 0;
};
}
int main() {
application::run(examples::form1());
}
Windows
button_w.png

button_wd.png
macOS
button_m.png

button_md.png
Gnome
button_g.png

button_gd.png
Examples
The following code example demonstrate the use of button control witth bitmap.
#include <xtd/xtd>
#include "../resources/gammasoft_16x16.xpm"
#include "../resources/gammasoft_32x32.xpm"
#include "../resources/gammasoft_64x64.xpm"
using namespace xtd;
using namespace xtd::drawing;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
text("Bitmap button example");
button1.location({50, 50});
button1.width(100);
button1.text("Gammasoft");
button2.location({50, 80});
button2.width(120);
button2.image(image::from_data(gammasoft_16x16_xpm));
button2.text("Gammasoft");
button3.location({50, 110});
button3.size({140, 40});
button3.image(image::from_data(gammasoft_32x32_xpm));
button3.text("Gammasoft");
button4.location({50, 155});
button4.size({70, 70});
button4.image(image::from_data(gammasoft_64x64_xpm));
}
private:
button button4;
};
int main() {
application::run(form1());
}
Windows
bitmap_button_w.png

bitmap_button_wd.png
macOS
bitmap_button_m.png

bitmap_button_md.png
Gnome
bitmap_button_g.png

bitmap_button_gd.png
Examples:
about_box.cpp, about_dialog.cpp, about_dialog_system.cpp, application_and_exception.cpp, bitmap_button.cpp, busy_box.cpp, busy_dialog.cpp, button.cpp, collapsible_panel.cpp, color_box.cpp, color_dialog.cpp, debug_form.cpp, enable_debug.cpp, exception_box.cpp, exception_dialog.cpp, folder_browser_dialog.cpp, font_dialog.cpp, form.cpp, image_list.cpp, input_box.cpp, input_dialog.cpp, input_dialog_multiline.cpp, input_dialog_password.cpp, message_box.cpp, message_dialog.cpp, open_file_dialog.cpp, progress_dialog.cpp, save_file_dialog.cpp, timer.cpp, trace_form.cpp, and use_wait_cursor.cpp.

Constructor & Destructor Documentation

◆ button()

xtd::forms::button::button ( )
inline

Initializes a new instance of the button class.

Remarks
By default the button displays no caption. To specify the caption text, set the text property.

Member Function Documentation

◆ auto_repeat() [1/2]

virtual bool xtd::forms::button::auto_repeat ( ) const
inlinevirtual

Gets if this button instance is auto repeat.

Returns
true, if is auto repeat; otherwise false. Default is false.

◆ auto_repeat() [2/2]

virtual button& xtd::forms::button::auto_repeat ( bool  auto_repeat)
inlinevirtual

Sets if this button instance is auto repeat.

Parameters
auto_repeattrue, if is auto repeat; otherwise false. Default is false.
Returns
This button.

◆ auto_repeat_delay() [1/2]

virtual int32_t xtd::forms::button::auto_repeat_delay ( ) const
inlinevirtual

Gets the auto repeat delay.

Returns
Auto repeat delay in milliseconds. Default is 300 ms.

◆ auto_repeat_delay() [2/2]

virtual button& xtd::forms::button::auto_repeat_delay ( int32_t  auto_repeat_delay)
inlinevirtual

Gets the auto repeat delay.

Parameters
auto_repeat_delayAuto repeat delay in milliseconds. Default is 300 ms.
Returns
This button.

◆ auto_repeat_interval() [1/2]

virtual int32_t xtd::forms::button::auto_repeat_interval ( ) const
inlinevirtual

Gets the auto repeat interval.

Returns
Auto repeat interval in milliseconds. Default is 100 ms.

◆ auto_repeat_interval() [2/2]

virtual button& xtd::forms::button::auto_repeat_interval ( int32_t  auto_repeat_interval)
inlinevirtual

Gets the auto repeat interval.

Parameters
auto_repeat_delayAuto repeat interval in milliseconds. Default is 100 ms.
Returns
This button.

◆ auto_size_mode() [1/2]

virtual forms::auto_size_mode xtd::forms::button::auto_size_mode ( ) const
inlinevirtual

Gets the mode by which the button automatically resizes itself.

Returns
One of the AutoSizeMode values. The default value is grow_only.

◆ auto_size_mode() [2/2]

virtual button& xtd::forms::button::auto_size_mode ( forms::auto_size_mode  value)
virtual

Sets the mode by which the button automatically resizes itself.

Parameters
valueOne of the AutoSizeMode values. The default value is growonly.

◆ create_params()

forms::create_params xtd::forms::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.
Remarks
The create_params property should not be overridden and used to adjust the properties of your derived control. Properties such as the create_params::caption, create_params::width, and create_params::height should be set by the corresponding properties in your control such as control::text, control::width and control::height. The create_params should only be extended when you are wrapping a standard Windows control class or to set styles not provided by the forms namespace.
Notes for inheritors
When overriding the create_params property in a derived class, use the base class's create_params property to extend the base implementation. Otherwise, you must provide all the implementation.

Reimplemented from xtd::forms::control.

◆ dialog_result() [1/2]

forms::dialog_result xtd::forms::button::dialog_result ( ) const
inlineoverridevirtual

Gets the value returned to the parent form when the button is clicked.

Returns
One of the DialogResult values.
Remarks
When a form is shown as a dialog box using the show_dialog method and one of its buttons is clicked, the button's dialog_result value is assigned to the form's dialog_result property.

Implements xtd::forms::ibutton_control.

◆ dialog_result() [2/2]

control& xtd::forms::button::dialog_result ( forms::dialog_result  dialog_result)
overridevirtual

Sets the value returned to the parent form when the button is clicked.

Parameters
dialog_resultOne of the DialogResult values.
Remarks
When a form is shown as a dialog box using the show_dialog method and one of its buttons is clicked, the button's dialog_result value is assigned to the form's dialog_result property.

Implements xtd::forms::ibutton_control.

◆ measure_control()

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

Measure this control.

Returns
The drawing::size size of this control.

Reimplemented from xtd::forms::control.

◆ notify_default()

void xtd::forms::button::notify_default ( bool  value)
overridevirtual

Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly.

Parameters
valuetrue if the control should behave as a default button; otherwise false.
Remarks
This method is called by a parent form to make a control the default button. Default buttons are set to have an extra thick border.

Implements xtd::forms::ibutton_control.

◆ on_click()

void xtd::forms::button::on_click ( const event_args e)
overrideprotectedvirtual

Raises the control::click event.

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

Reimplemented from xtd::forms::control.

◆ on_enabled_changed()

void xtd::forms::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::control.

◆ on_handle_created()

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

Raises the control::handle_created event.

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

Reimplemented from xtd::forms::control.

◆ on_image_changed()

void xtd::forms::button::on_image_changed ( const xtd::event_args e)
overrideprotectedvirtual

Raises the button_base::image_changed event.

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

Reimplemented from xtd::forms::button_base.

◆ on_mouse_down()

void xtd::forms::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::control.

◆ on_mouse_enter()

void xtd::forms::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::control.

◆ on_mouse_leave()

void xtd::forms::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::control.

◆ on_mouse_up()

void xtd::forms::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::control.

◆ on_paint()

void xtd::forms::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.

◆ perform_click()

void xtd::forms::button::perform_click ( )
overridevirtual

Generates a click event for the control.

Remarks
This method is called for the button that has focus, or for the default button (if no other button has focus) when the user presses the ENTER key. This method is also called when the user presses the ESC key if the button is set as the cancel button.

Implements xtd::forms::ibutton_control.


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