Struct MenuItemProps 

pub struct MenuItemProps {
    pub label: String,
    pub icon: Option<Icon>,
    pub destructive: bool,
    pub checked: Option<bool>,
    pub disabled: bool,
    pub reason: Option<String>,
    pub group: Option<String>,
    pub key: Option<String>,
    pub choose: Event,
}

One command of a menu: what it shows, and what choosing it does.

Fields

label: String

What choosing it does, in a word or two.

icon: Option<Icon>

A glyph before the label, for recognition; the label stays its name.

destructive: bool

It takes something away: drawn as destructive, and undone rather than confirmed.

checked: Option<bool>

Whether it is the one chosen now, in a menu of choices (a sort order).

disabled: bool

It cannot run now (a require of its action does not hold). It is listed all the same, drawn as unavailable, and says reason.

reason: Option<String>

Why it cannot run now, in the person’s words (require’s own): read with the row, and kept beside the label so a person sees what it waits on.

group: Option<String>

The run of commands it stands in (group: "Due"), as the app names it: consecutive rows of one run fold into one row that opens them.

key: Option<String>

The plain key that runs it while the window it belongs to has the keyboard, as the app’s action declared it (key: "e"), shown at the row’s trailing edge as the keyboard in use spells it.

choose: Event

It was chosen.

Implementations

impl MenuItemProps

pub fn into_item(self) -> MenuItem

The command as a menu row.

pub fn into_entry(self) -> MenuEntry

The command as an entry of a context menu.

Trait Implementations

impl Component for MenuItemProps

const NAME: &'static str = "MenuItem"

The component’s name, as code calls it.

fn describe() -> Description

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

The props source gives.

impl Default for MenuItemProps

fn default() -> MenuItemProps

Returns the “default value” for a type.

impl From<OfferedAction> for MenuItemProps

fn from(action: OfferedAction) -> MenuItemProps

An action offered to the person as a command: choosing it runs the action.