Struct ButtonProps 

pub struct ButtonProps {

    pub label: String,
    pub accessible_name: Option<String>,
    pub icon: Option<Icon>,
    pub icon_only: bool,
    pub faces: Vec<String>,
    pub role: Option<ButtonRole>,
    pub toggled: Option<bool>,
    pub size: ControlSize,
    pub enabled: bool,
    pub description: Option<String>,
    pub key: Option<String>,
    pub count: Option<i64>,
    pub dot: bool,
    pub alert: bool,
    pub in_menu: bool,
    pub group: Option<String>,
    pub press: Event,
}

A button: pressing it does one thing. Its role says what kind of thing, which decides its whole look: the window’s one primary action, a destructive one, or an ordinary one.

Fields

label: String

What pressing it does, in a word or two. An icon-only button is still named by it.

accessible_name: Option<String>

How assistive technology names it, where that says more than the label shows: the charge reads “61%” beside its charging glyph and is named “61%, charging”. Unset, the label names it.

icon: Option<Icon>

A glyph before the label, or instead of it when icon_only.

icon_only: bool

Show only the icon, the label naming the button to assistive technology.

faces: Vec<String>

Who is here, as their faces: up to three faces, then a face counting the rest, and nothing else on the button at any width. icon_only’s rule holds for it too: the label is the name assistive technology hears, naming the people (“Mia Clayton and Sam Okafor are here”). One press opens the roster of everyone here.

role: Option<ButtonRole>

What kind of action it is: secondary unless said, plain for an icon-only one.

toggled: Option<bool>

A toggle button, and whether it is on: on, it stands on a lift of its ground and is announced as pressed.

size: ControlSize

How prominent it is: regular unless said.

enabled: bool

Whether it can be pressed now. A button with nothing to do never can.

description: Option<String>

Why it cannot be pressed now, where the label does not say: the requirement an action does not meet. Its tooltip, and the description assistive technology reads beside the name it announces.

key: Option<String>

The plain key that presses it while its window has the keyboard (and, on a row’s action, while that row is selected), as the app declared it (key: "e"): the host answers it beside the pressed control’s own event. Never drawn here; the header shows it at the action’s menu row.

count: Option<i64>

How many new things wait behind it (unread notifications, new mail), on an icon-only button: a count standing on its icon’s top-trailing corner, as an app icon’s does, and nothing at 0. The button keeps room for it, so it never covers the control beside it. The label says the count to assistive technology.

dot: bool

Something new behind it without a number: a dot on its icon’s corner.

alert: bool

It needs the person: the count or the dot in the warning tone, not in your colour.

in_menu: bool

It belongs in its header’s menu rather than in the row (crate::widget::Button::in_menu).

group: Option<String>

The run of its owner’s actions it stands in (group: "Due"), as the app names it: the header’s menu shows rows of one run together, under the run’s own row.

press: Event

It was pressed (a click, Enter or Space, an assistive technology).

Trait Implementations

impl Component for ButtonProps

const NAME: &'static str = "Button"

The component’s name, as code calls it.

fn describe() -> Description

fn from_source(source: &mut dyn Source) -> Result<ButtonProps, Error>

The props source gives.

impl Default for ButtonProps

fn default() -> ButtonProps

Returns the “default value” for a type.