Enum MenuItem 

pub enum MenuItem {
    Command(SharedString),
    Run {
        title: SharedString,
        icon: Option<IconName>,
        command: SharedString,
        args: Value,
        checked: bool,
    },
    Provided(SharedString),
    Separator,
    Label(SharedString),
    Submenu {
        title: SharedString,
        icon: Option<IconName>,
        items: Vec<MenuItem>,
    },
}

An entry of a menu.

Variants

Command(SharedString)

A registered command, by id.

Run

A registered command run with arguments, under its own title: one entry per image, per recent file, per model. Greyed with the command’s reason when it cannot run.

Fields

title: SharedString

What the entry says.

icon: Option<IconName>

Its icon (the command’s when None).

command: SharedString

The command’s id.

args: Value

Its arguments.

checked: bool

A check mark (the entry is the current choice).

Provided(SharedString)

The entries the provider id makes when the menu opens (Registry::provide).

Separator

A line between groups.

Label(SharedString)

A heading (not clickable).

Submenu

A menu inside the menu.

Fields

title: SharedString

What the entry says.

icon: Option<IconName>

Its icon.

items: Vec<MenuItem>

What it holds.

Implementations

impl MenuItem

pub fn command(id: impl Into<SharedString>) -> Self

The command id.

pub fn submenu(title: impl Into<SharedString>, items: Vec<MenuItem>) -> Self

A submenu title holding items.

pub fn submenu_with_icon( title: impl Into<SharedString>, icon: IconName, items: Vec<MenuItem>, ) -> Self

A submenu title with icon, holding items.

pub fn run( title: impl Into<SharedString>, command: impl Into<SharedString>, args: Value, ) -> Self

The command command run with args, titled title.

pub fn provided(id: impl Into<SharedString>) -> Self

The entries of the provider id.

pub fn label(text: impl Into<SharedString>) -> Self

A heading.

pub fn icon(self, with: IconName) -> Self

Sets the icon of a MenuItem::Run or a submenu (other entries are unchanged).

pub fn checked(self, on: bool) -> Self

Sets the check mark of a MenuItem::Run (other entries are unchanged).

Trait Implementations

impl Clone for MenuItem

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 MenuItem

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

Formats the value using the given formatter.

impl PartialEq for MenuItem

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MenuItem