Struct Menu

pub struct Menu { /* private fields */ }

A root menu that can be added to a Window on Windows and Linux and used as the app global menu on macOS.

Implementations

impl Menu

pub fn new() -> Menu

Creates a new menu.

pub fn with_id<I>(id: I) -> Menu

where I: Into<MenuId>,

Creates a new menu with the specified id.

pub fn with_items(items: &[&dyn IsMenuItem]) -> Result<Menu, Error>

Creates a new menu with given items. It calls Menu::new and Menu::append_items internally.

pub fn with_id_and_items<I>( id: I, items: &[&dyn IsMenuItem], ) -> Result<Menu, Error>

where I: Into<MenuId>,

Creates a new menu with the specified id and given items. It calls Menu::new and Menu::append_items internally.

pub fn id(&self) -> &MenuId

Returns a unique identifier associated with this menu.

pub fn append(&self, item: &dyn IsMenuItem) -> Result<(), Error>

Add a menu item to the end of this menu.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn append_items(&self, items: &[&dyn IsMenuItem]) -> Result<(), Error>

Add menu items to the end of this menu. It calls Menu::append in a loop internally.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn prepend(&self, item: &dyn IsMenuItem) -> Result<(), Error>

Add a menu item to the beginning of this menu.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn prepend_items(&self, items: &[&dyn IsMenuItem]) -> Result<(), Error>

Add menu items to the beginning of this menu. It calls Menu::insert_items with position of 0 internally.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn insert( &self, item: &dyn IsMenuItem, position: usize, ) -> Result<(), Error>

Insert a menu item at the specified postion in the menu.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn insert_items( &self, items: &[&dyn IsMenuItem], position: usize, ) -> Result<(), Error>

Insert menu items at the specified postion in the menu.

Platform-spcific:

• macOS: Only Submenu can be added to the menu

pub fn remove(&self, item: &dyn IsMenuItem) -> Result<(), Error>

Remove a menu item from this menu.

pub fn remove_at(&self, position: usize) -> Option<MenuItemKind>

Remove the menu item at the specified position from this menu and returns it.

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

Returns a list of menu items that has been added to this menu.

pub fn init_for_nsapp(&self)

Adds this menu to an NSApp.

pub fn remove_for_nsapp(&self)

Removes this menu from an NSApp.

Trait Implementations

impl Clone for Menu

fn clone(&self) -> Menu

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContextMenu for Menu

unsafe fn show_context_menu_for_nsview( &self, view: *const c_void, position: Option<Position>, )

Shows this menu as a context menu for the specified NSView.

fn ns_menu(&self) -> *mut c_void

Get the underlying NSMenu reserved for context menus.

impl Default for Menu

fn default() -> Menu

Returns the “default value” for a type.