Enum MenuRole 

pub enum MenuRole {
    Custom,
    Separator,
    Cut,
    Copy,
    Paste,
    SelectAll,
    LookUp,
}

What an item means, as far as anything outside the app is concerned.

The roles exist for two reasons and neither is decoration. A host with a native menu maps them onto its own standard items, so Copy is the platform’s Copy — its wording, its accelerator, its position; and the core acts on the ones it can act on without asking anybody (MenuRole::SelectAll) or with one round trip through the host (the clipboard three). MenuRole::Custom is an item the app invented, which only the app can perform.

Variants

Custom

The app’s own item: choosing it posts the item’s payload and the core does nothing else.

Separator

A divider. Never focusable, never chosen, no payload.

Cut

Copy

Paste

SelectAll

LookUp

Show the platform’s definition/Look Up panel for the selection. The core cannot draw one: with no host to answer it, the item is not offered.

Implementations

impl MenuRole

pub const ALL: [MenuRole; 7]

Every role, in wire order: the index a binding that spells roles as numbers sends (C’s KUI_MENU_*), pinned there by name. Append-only, like every list a C enum restates.

pub fn from_name(name: &str) -> Option<MenuRole>

The role a wire name spells, for the bindings that take roles as strings: the inverse of Self::name, so a binding cannot accept a spelling the event will not report back. None for a name that is no role.

pub fn name(self) -> &'static str

The wire name, for the bindings and the report.

pub fn default_label(self) -> &'static str

The label the stock renderer draws when the item declares none. A native renderer ignores this and uses the platform’s wording, which is the point of having a role at all.

pub fn default_accel(self) -> &'static str

The shortcut the stock renderer draws beside the row when the item declares none, spelled the way the platform spells it — Command on macOS, Control elsewhere, the same split KeyMods::primary makes for the key that produces it.

Display only, like every accelerator here: the core binds nothing, and the row only names the key the host is already handling. Empty for the roles with no standard shortcut — Custom above all, since an app’s own accelerator is the app’s to declare (MenuItem::accel) — and empty for LookUp, whose shortcut belongs to the one platform that has the panel and draws its own menu anyway.

pub fn is_builtin(self) -> bool

Whether the core performs this itself, or with one hand from the host. false is an item only the app can carry out.

Trait Implementations

impl Clone for MenuRole

fn clone(&self) -> MenuRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MenuRole

impl Debug for MenuRole

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

Formats the value using the given formatter.

impl Default for MenuRole

fn default() -> MenuRole

Returns the “default value” for a type.

impl Eq for MenuRole

impl PartialEq for MenuRole

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MenuRole