Struct Button

pub struct Button(/* private fields */);

Available on crate feature gui only.

Native button control.

Examples

Basic structure of a program with a main window and a button, both created programmatically:

use winsafe::{self as w, co, gui, prelude::*};

fn main() {
    if let Err(err) = Main::create_and_run() {
        w::HWND::NULL
            .MessageBox(&err.to_string(), "Uncaught error", co::MB::ICONERROR)
            .unwrap();
    }
}

#[derive(Clone)]
struct Main {
    wnd: gui::WindowMain,
    btn: gui::Button,
}

impl Main {
    #[must_use]
    fn create_and_run() -> w::AnyResult<i32> {
        let wnd = gui::WindowMain::new(gui::WindowMainOpts {
            title: "Main window".to_owned(),
            ..Default::default()
        });
        let btn = gui::Button::new(
            &wnd,
            gui::ButtonOpts {
                text: "&Click me".to_owned(),
                position: gui::dpi(20, 20),
                ..Default::default()
            },
        );

        let new_self = Self { wnd, btn };
        new_self.events();

        new_self.wnd.run_main(None)
    }

    fn events(&self) {
        let self2 = self.clone();
            self.btn.on().bn_clicked(move || {
            self2.wnd.hwnd().SetWindowText("Button clicked")?;
            Ok(())
        });
    }
}

Implementations

impl Button

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 specific control events.

Panics

Panics if the control is already created. Events must be set before control creation.

impl Button

pub fn new(parent: &(impl GuiParent + 'static), opts: ButtonOpts) -> Self

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

Panics

Panics if the parent window was already created – that is, you cannot dynamically create a Button in an event closure.

pub fn new_dlg( parent: &(impl GuiParent + 'static), ctrl_id: u16, resize_behavior: (Horz, Vert), ) -> Self

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

Panics

Panics if the parent dialog was already created – that is, you cannot dynamically create a Button in an event closure.

pub fn trigger_click(&self)

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

Trait Implementations

impl Clone for Button

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl GuiControl for Button

fn ctrl_id(&self) -> u16

Returns the control ID, which is defined at control creation.

fn focus(&self) -> SysResult<()>

If the control belongs to an ordinary window, simply calls HWND:SetFocus.

impl GuiWindow for Button

fn hwnd(&self) -> &HWND

Returns the underlying handle for this window.

fn as_any(&self) -> &dyn Any

Converts a reference to the Any trait. This is useful when storing a collection of polymorphic controls, because Any allows downcasting.

impl Send for Button