xtd::forms::ibutton_control Class Reference

Inheritance diagram for xtd::forms::ibutton_control:

Definition

Allows a control to act like a button on a form.

Header

#include <xtd/forms/ibutton_cntrol>

Namespace

xtd::forms

Library

xtd.forms

Remarks

An example of where this interface might be implemented is default and cancel button processing. Default buttons are notified when an unprocessed ENTER key is entered for a form, just like a dialog box would be closed. Similarly, cancel buttons are notified whenever an unprocessed ESC key is entered on a form, much like a dialog box would be dismissed.

Notes to implementers

Implement this interface in classes that act as button controls. The members of this interface will provide basic button functionality, such as providing a dialog_result to the parent form or the ability to perform a click event, or acting as the default button of a form.

Public Properties
virtual auto	dialog_result () const noexcept -> xtd::forms::dialog_result=0
	Gets the value returned to the parent form when the button is clicked.
virtual auto	dialog_result (xtd::forms::dialog_result value) -> xtd::forms::control &=0
	Sets the value returned to the parent form when the button is clicked.

Public Methods
virtual auto	notify_default (bool value) -> void=0
	Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly.
virtual auto	perform_click () -> void=0
	Generates a click event for the control.

Member Function Documentation

dialog_result() [1/2]

virtual auto xtd::forms::ibutton_control::dialog_result ( ) const -> xtd::forms::dialog_result

nodiscardpure virtualnoexcept

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

Returns

One of the xtd::forms::dialog_result values. The default value is xtd::forms::dialog_result::none.

Remarks

When a form is shown as a dialog box using the xtd::forms::form::show_dialog method and one of its buttons is clicked, the button's xtd::forms::dialog_result value is assigned to the form's xtd::forms::dialog_result property.

Implemented in xtd::forms::button.

dialog_result() [2/2]

virtual auto xtd::forms::ibutton_control::dialog_result ( xtd::forms::dialog_result value ) -> xtd::forms::control &

pure virtual

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

Parameters

value

One of the xtd::forms::dialog_result values. The default value is xtd::forms::dialog_result::none.

Remarks

When a form is shown as a dialog box using the xtd::forms::form::show_dialog method and one of its buttons is clicked, the button's xtd::forms::dialog_result value is assigned to the form's xtd::forms::dialog_result property.

Implemented in xtd::forms::button.

notify_default()

virtual auto xtd::forms::ibutton_control::notify_default ( bool value ) -> void

pure virtual

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

Parameters

value

true 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.

Implemented in xtd::forms::button.

perform_click()

virtual auto xtd::forms::ibutton_control::perform_click ( ) -> void

pure virtual

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.

Implemented in xtd::forms::button.

---

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

• xtd.forms/include/xtd/forms/ibutton_control.hpp