Struct native_windows_gui::Button

pub struct Button {
    pub handle: ControlHandle,
}

A push button is a rectangle containing an application-defined text label. Use ImageButton if you need to have a button that ONLY contains an icon or a bitmap.

Button is not behind any features.

Builder parameters:

• parent: Required. The button parent container.
• text: The button text.
• size: The button size.
• position: The button position.
• enabled: If the button can be used by the user. It also has a grayed out look if disabled.
• flags: A combination of the ButtonFlags values.
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• font: The font used for the button text
• bitmap: A bitmap to display next to the button text. If this value is set, icon is ignored.
• icon: An icon to display next to the button text
• focus: The control receive focus after being created

Control events:

• OnButtonClick: When the button is clicked once by the user
• OnButtonDoubleClick: When the button is clicked twice rapidly by the user
• MousePress(_): Generic mouse press events on the button
• OnMouseMove: Generic mouse mouse event
• OnMouseWheel: Generic mouse wheel event

use native_windows_gui as nwg;
fn build_button(button: &mut nwg::Button, window: &nwg::Window, font: &nwg::Font) {
    nwg::Button::builder()
        .text("Hello")
        .flags(nwg::ButtonFlags::VISIBLE)
        .font(Some(font))
        .parent(window)
        .build(button);
}

Fields

handle: ControlHandle

Implementations

impl Button

pub fn builder<'a>() -> ButtonBuilder<'a>

pub fn click(&self)

Simulate a user click

pub fn set_bitmap<'a>(&self, image: Option<&'a Bitmap>)

Sets the bitmap image of the button. Replace the current bitmap or icon. Set image to None to remove the image

pub fn set_icon<'a>(&self, image: Option<&'a Icon>)

Sets the bitmap image of the button. Replace the current bitmap or icon. Set image to None to remove the image

pub fn image<'a>(&self, bitmap: &mut Option<Bitmap>, icon: &mut Option<Icon>)

Returns the current image in the button. If the button has a bitmap, the value will be returned in bitmap If the button has a icon, the value will be returned in icon

pub fn font(&self) -> Option<Font>

Returns the font of the control

pub fn set_font(&self, font: Option<&Font>)

Sets the font of the control

pub fn focus(&self) -> bool

Returns true if the control currently has the keyboard focus

pub fn set_focus(&self)

Sets the keyboard focus on the button.

pub fn enabled(&self) -> bool

Returns true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Returns true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Returns the size of the button in the parent window

pub fn set_size(&self, x: u32, y: u32)

Sets the size of the button in the parent window

pub fn position(&self) -> (i32, i32)

Returns the position of the button in the parent window

pub fn set_position(&self, x: i32, y: i32)

Sets the position of the button in the parent window

pub fn text(&self) -> String

Returns the button label

pub fn set_text<'a>(&self, v: &'a str)

Sets the button label

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for Button

fn default() -> Button

Returns the “default value” for a type.

impl Drop for Button

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Button> for ControlHandle

fn from(control: &Button) -> Self

Converts to this type from the input type.

impl From<&mut Button> for ControlHandle

fn from(control: &mut Button) -> Self

Converts to this type from the input type.

impl PartialEq<Button> for Button

fn eq(&self, other: &Button) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Button> for ControlHandle

fn eq(&self, other: &Button) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ControlHandle> for Button

fn eq(&self, other: &ControlHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Button

impl StructuralEq for Button

impl StructuralPartialEq for Button