Struct winsafe::gui::Button

pub struct Button(_);

Native button control.

Implements Child trait.

Implementations

impl Button

pub fn new(parent: &dyn Parent, opts: ButtonOpts) -> Button

Instantiates a new Button object, to be created on the parent window with HWND::CreateWindowEx.

pub fn new_dlg(parent: &dyn Parent, ctrl_id: u16) -> Button

Instantiates a new Button object, to be loaded from a dialog resource with HWND::GetDlgItem.

pub fn hwnd(&self) -> HWND

Returns the underlying handle for this control.

Note: the handle is initially null, receiving an actual value only after the control is physically created, what usually happens right before WM_CREATE or WM_INITDIALOG events.

pub fn ctrl_id(&self) -> u16

Returns the control ID.

pub fn focus(&self) -> WinResult<()>

Focuses the control by sending a wm::NextDlgCtl message.

pub fn on_subclass(&self) -> &WindowEvents

Exposes the subclass events. If at least one event exists, the control will be subclassed.

Note: Subclassing may impact performance, use with care.

Panics

Panics if the control or the parent window are already created. Events must be set before control and parent window creation.

pub fn on(&self) -> &ButtonEvents

Exposes the control events.

These event methods are just proxies to the WindowEvents of the parent window, who is the real responsible for the child event handling.

Panics

Panics if the control or the parent window are already created. Events must be set before control and parent window creation.

pub fn trigger_click(&self)

Fires the click event for the button by sending a bm::Click message.

Trait Implementations

impl Child for Button

fn hwnd_ref(&self) -> &HWND

Returns a reference to the HWND of the child control.

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Button

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for Button

impl Sync for Button