Struct MenuModel 

pub struct MenuModel { /* private fields */ }

A declarative menu tree shared by the in-window MenuBar and the native OS menu bar. Cloneable by handle (Rc inside); a clone shares the same nodes and version signal, so mutating one updates every view.

Implementations

impl MenuModel

pub fn new() -> Self

An empty model.

pub fn menu( self, title: impl Into<LocalizedString>, build: impl FnOnce(MenuItems) -> MenuItems, ) -> Self

Append a top-level menu with the given title and contents (auto id).

pub fn menu_with_id( self, id: MenuItemId, title: impl Into<LocalizedString>, build: impl FnOnce(MenuItems) -> MenuItems, ) -> Self

Append a top-level menu with a caller-supplied id, so it can be addressed later by push_item / remove.

pub fn standard(self, role: StandardMenuRole) -> Self

Append a platform-standard top-level menu (macOS App / Window / Help) with default (English) labels. Use standard_menu to supply localized labels.

pub fn standard_menu(self, menu: StandardMenu) -> Self

Append a platform-standard top-level menu with localized labels.

pub fn version(&self) -> Signal<u64>

A Signal<u64> bumped whenever the tree’s structure changes. The native bridge re-installs the menu on a bump; per-item state changes go through the finer-grained update_item path instead.

pub fn nodes(&self) -> Ref<'_, Vec<MenuNode>>

Borrow the top-level nodes.

pub fn modify(&self, f: impl FnOnce(&mut Vec<MenuNode>))

Mutate the node tree directly, then bump version. The escape hatch for any structural change the typed helpers don’t cover (reorder, retitle, bulk edits). MenuNode / MenuEntry are public, so the closure can build whatever it needs.

pub fn push_menu( &self, title: impl Into<LocalizedString>, build: impl FnOnce(MenuItems) -> MenuItems, ) -> MenuItemId

Append a top-level menu at runtime, returning its id. Mirrors menu but takes &self.

pub fn push_item(&self, into: MenuItemId, entry: MenuEntry) -> bool

Append entry to the submenu identified by into (a top-level menu or nested submenu id). Returns true if the submenu was found.

pub fn push_separator(&self, into: MenuItemId) -> bool

Append a separator to the submenu identified by into. Returns true if the submenu was found.

pub fn insert_menu_at( &self, index: usize, id: MenuItemId, title: impl Into<LocalizedString>, build: impl FnOnce(MenuItems) -> MenuItems, )

Insert a top-level menu at index, under a caller-supplied id.

push_menu appends, which puts a menu after Help — fine for something added once at startup, wrong for a menu that comes and goes, since a writer looking for it needs it in the same place every time. The id is the caller’s for the same reason: a menu that will be removed again has to be nameable before it exists.

index is clamped, so a model that has since grown or shrunk cannot panic a caller holding a stale position.

pub fn contains(&self, id: MenuItemId) -> bool

Whether a node with this id is anywhere in the tree.

The companion to remove for callers that add and remove the same node as state changes: without it, “is it already there?” can only be answered by removing it and seeing what comes back, which bumps the version and re-installs the native menu for nothing.

pub fn remove(&self, id: MenuItemId) -> bool

Remove the item or submenu with the given id, anywhere in the tree. Returns true if a node was removed.

Trait Implementations

impl Clone for MenuModel

fn clone(&self) -> MenuModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MenuModel

fn default() -> Self

Returns the “default value” for a type.