Enum MenuItemSpec 

pub enum MenuItemSpec {
    Item {
        id: String,
        label: String,
        accelerator: Option<String>,
        enabled: bool,
    },
    Role {
        role: MenuRole,
        label: Option<String>,
    },
    Separator,
    Submenu {
        label: String,
        menu: MenuSpec,
    },
}

One entry in a MenuSpec.

Deliberately not #[non_exhaustive]: a per-OS shell must match it exhaustively, so a new variant is a compile error in every shell that would otherwise silently drop the item from the menu it builds.

Variants

Item

An app-defined item. Activating it pushes id through frust_reactive::push_menu_event, which app code observes via the facade’s menu_events().

Fields

id: String

The app’s own id for this item, echoed back verbatim on activation.

label: String

The text shown in the menu.

accelerator: Option<String>

An accelerator in the cross-platform "CmdOrCtrl+Shift+P" shorthand (Cmd/Ctrl/Alt/Shift + a key, joined by +), or None for no keyboard shortcut.

Kept a string rather than a parsed chord type because this crate binds no menu library: the per-OS shell parses it with whatever its menu backend already accepts, and is also where an unparseable accelerator is reported — validating it twice, in two vocabularies, would only let the two disagree.

enabled: bool

Whether the item is selectable. false renders it greyed out.

Role

A platform-standard item (MenuRole) the host implements itself — About/Hide/Quit and friends. No activation is reported for these: the platform performs the action, so app code has nothing to handle.

Fields

role: MenuRole

Which standard action this item performs.

label: Option<String>

An override for the platform’s own label, or None to use it (the normal case — a localized system label beats a hand-written one).

Separator

A separator line.

Submenu

A nested menu.

Fields

label: String

The text shown for the submenu itself.

menu: MenuSpec

The submenu’s own contents.

Implementations

impl MenuItemSpec

pub fn item(id: impl Into<String>, label: impl Into<String>) -> Self

An enabled, accelerator-free app item.

pub fn role(role: MenuRole) -> Self

A platform-standard item at the platform’s own label.

pub fn separator() -> Self

A separator line.

pub fn submenu(label: impl Into<String>, menu: MenuSpec) -> Self

A nested menu under label.

pub fn with_accelerator(self, accelerator: impl Into<String>) -> Self

Attach a keyboard accelerator (see Item::accelerator).

Returns the item unchanged for every other variant: a role item’s shortcut is the platform’s own (⌘Q for Quit), and a separator/submenu has nothing to activate.

pub fn disabled(self) -> Self

Mark the item greyed out. Returns the item unchanged for every variant but MenuItemSpec::Item (see with_accelerator).

pub fn with_label(self, label: impl Into<String>) -> Self

Override the label of a MenuItemSpec::Role item. Returns the item unchanged for every other variant (their labels are set at construction).

pub fn id(&self) -> Option<&str>

The activation id this item reports, or None for an item that reports none (a role item, a separator, a submenu).

Trait Implementations

impl Clone for MenuItemSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuItemSpec

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

Formats the value using the given formatter.

impl Eq for MenuItemSpec

impl PartialEq for MenuItemSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MenuItemSpec