Enum MenuItem 

pub enum MenuItem {
    Separator,
    Submenu(Menu),
    SystemMenu(OsMenu),
    Action {
        name: SharedString,
        action: Box<dyn Action>,
        os_action: Option<OsAction>,
        checked: bool,
        disabled: bool,
    },
}

An entry in a Menu: a separator, a submenu, a system menu, or an action.

Build entries with the constructors on this type, such as MenuItem::action and MenuItem::separator.

Variants

Separator

A horizontal line that separates groups of entries.

Submenu(Menu)

A menu nested inside another menu.

SystemMenu(OsMenu)

A submenu that the operating system fills in, such as the Services menu on macOS.

Action

An entry that dispatches an action when the user picks it.

Fields

name: SharedString

The label of the entry.

action: Box<dyn Action>

The action dispatched when the entry is picked.

os_action: Option<OsAction>

The standard command this entry stands for, if any. See OsAction.

checked: bool

Whether the entry shows a checkmark. On macOS, the checkmark is shown when this is true.

disabled: bool

Whether the entry is disabled. On macOS, a disabled entry is greyed out and can’t be picked.

Implementations

impl MenuItem

pub fn separator() -> Self

Returns a separator entry.

pub fn submenu(menu: Menu) -> Self

Returns an entry that opens menu as a submenu.

pub fn os_submenu( name: impl Into<SharedString>, menu_type: SystemMenuType, ) -> Self

Returns a submenu titled name that the operating system fills in.

Use it for menus like the macOS Services menu, which the system builds itself.

pub fn action(name: impl Into<SharedString>, action: impl Action) -> Self

Returns an entry titled name that dispatches action when the user picks it.

Use Self::os_action instead when the entry is a standard command, such as Copy or Undo.

pub fn os_action( name: impl Into<SharedString>, action: impl Action, os_action: OsAction, ) -> Self

Returns an entry like Self::action, tagged with the standard command it stands for.

On macOS, Cut, Copy, Paste and Select All are sent to the responder chain, so the focused text view handles them. Undo, Redo and entries without an OsAction dispatch action as usual.

pub fn owned(self) -> OwnedMenuItem

Converts this entry into an OwnedMenuItem.

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

Sets whether the entry shows a checkmark, and returns the entry.

Has an effect only on MenuItem::Action. Other kinds of entry ignore it.

pub fn is_checked(&self) -> bool

Returns whether the entry shows a checkmark.

Returns false for every kind of entry except MenuItem::Action.

pub fn disabled(self, disabled: bool) -> Self

Sets whether the entry is disabled, and returns the entry.

Has an effect on MenuItem::Action and MenuItem::Submenu. Other kinds of entry ignore it.

pub fn is_disabled(&self) -> bool

Returns whether the entry is disabled.

Returns false for separators and system menus.