Struct MenuSpec 

pub struct MenuSpec {
    pub menus: Vec<Submenu>,
}

The whole menu bar: top-level menus in order. On macOS the first is the application menu (its title is replaced by the app name by the OS).

Fields

menus: Vec<Submenu>

Implementations

impl MenuSpec

pub fn new(menus: Vec<Submenu>) -> MenuSpec

pub fn from_commands(commands: &[CommandInfo], order: &[&str]) -> MenuSpec

A menu bar mirrored from a command list: each command with a non-empty menu path goes into the submenu that path names (["File", "Export"] = File ▸ Export), in list order, with its label, shortcut (normalized when it parses), enabled state and disabled reason. Top-level menus follow order; menus not in it come after, in first-seen order. Paths deeper than MAX_DEPTH are cut there. Separators, check marks and roles are the app’s to add (Self::separator_before, Self::set_checked).

pub fn from_items<P>( entries: impl IntoIterator<Item = (P, Item)>, order: &[&str], ) -> MenuSpec

where P: AsRef<[String]>,

A menu bar from items with their menu paths, for apps whose menu entries carry more than a CommandInfo (check marks, translated titles): each (path, item) goes into the submenu path names (["File", "Export"] = File ▸ Export), in order, each submenu created where its first item appears. Entries with an empty path are skipped; paths deeper than MAX_DEPTH are cut there. Top-level menus follow order; menus not in it come after, in first-seen order.

pub fn items(&self) -> Vec<&Item>

Every item, depth first.

pub fn find(&self, id: &str) -> Option<&Item>

The item with id (for items built from commands, the command id).

pub fn walk<'a>(&'a self, f: &mut dyn FnMut(&[usize], &'a MenuNode))

Visit every node with its path, depth first, at most MAX_DEPTH deep.

pub fn separator_before(&mut self, id: &str) -> bool

Insert a separator before the item id, unless it is first in its menu or already follows one. Returns whether the item was found.

pub fn set_checked(&mut self, id: &str, checked: Option<bool>) -> bool

Set the check mark of the item id (None: a plain item again). Returns whether it was found.

pub fn structure_hash(&self) -> u64

Fingerprint of everything that needs a native rebuild when it changes: the tree’s shape, item ids, check-item-ness, roles and menu key equivalents. Labels, enabled and checked state are patched in place instead.

pub fn state_hash(&self) -> u64

Fingerprint of what is patched in place: labels, enabled and checked state, disabled reasons.

pub fn validate(&self) -> Result<(), Vec<String>>

Check the spec: unique non-empty ids, bounded size, depth and text, parseable accelerators. Returns every problem found.

pub fn node(&self, path: &[usize]) -> Option<&MenuNode>

The node at path, if any.

Trait Implementations

impl Clone for MenuSpec

fn clone(&self) -> MenuSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuSpec

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

Formats the value using the given formatter.

impl Default for MenuSpec

fn default() -> MenuSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MenuSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<MenuSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MenuSpec

impl Hash for MenuSpec

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MenuSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MenuSpec

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MenuSpec