Struct Submenu 

pub struct Submenu { /* private fields */ }

Available on crate feature tray only.

A menu that can be added to a Menu or another Submenu.

Implementations

impl Submenu

pub fn new<S>(text: S, enabled: bool) -> Submenu

where S: AsRef<str>,

Create a new submenu.

• text could optionally contain an & before a character to assign this character as the mnemonic for this submenu. To display a & without assigning a mnemenonic, use &&.

pub fn with_id<I, S>(id: I, text: S, enabled: bool) -> Submenu

where I: Into<MenuId>, S: AsRef<str>,

Create a new submenu with the specified id.

• text could optionally contain an & before a character to assign this character as the mnemonic for this submenu. To display a & without assigning a mnemenonic, use &&.

pub fn with_items<S>( text: S, enabled: bool, items: &[&dyn IsMenuItem], ) -> Result<Submenu, Error>

where S: AsRef<str>,

Creates a new submenu with given items. It calls Submenu::new and Submenu::append_items internally.

pub fn with_id_and_items<I, S>( id: I, text: S, enabled: bool, items: &[&dyn IsMenuItem], ) -> Result<Submenu, Error>

where I: Into<MenuId>, S: AsRef<str>,

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

pub fn id(&self) -> &MenuId

Returns a unique identifier associated with this submenu.

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

Add a menu item to the end of this menu.

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

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

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

Add a menu item to the beginning of this submenu.

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

Add menu items to the beginning of this submenu. It calls Menu::prepend on the first element and passes the rest to Menu::insert_items with position of 1.

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

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

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

Insert menu items at the specified postion in the submenu.

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

Remove a menu item from this submenu.

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

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

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

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

pub fn text(&self) -> String

Get the text for this submenu.

pub fn set_text<S>(&self, text: S)

where S: AsRef<str>,

Set the text for this submenu. text could optionally contain an & before a character to assign this character as the mnemonic for this submenu. To display a & without assigning a mnemenonic, use &&.

pub fn is_enabled(&self) -> bool

Get whether this submenu is enabled or not.

pub fn set_enabled(&self, enabled: bool)

Enable or disable this submenu.

pub fn set_as_windows_menu_for_nsapp(&self)

Available on macOS only.

Set this submenu as the Window menu for the application on macOS. This will cause macOS to automatically add window-switching items and certain other items to the menu.

Must be called after adding this submenu to Menu and after calling Menu::init_for_nsapp on that menu.

Note

Because a Submenu can be added multiple times to the same Menu this method will set the first instance of this submenu as the Window menu for the application.

It is not recommended to add the same submenu multiple times to the same menu, but if you do, be aware of this behavior.

pub fn set_as_help_menu_for_nsapp(&self)

Available on macOS only.

Set this submenu as the Help menu for the application on macOS. This will cause macOS to automatically add a search box to the menu.

Must be called after adding this submenu to Menu and after calling Menu::init_for_nsapp on that menu.

If no menu is set as the Help menu, macOS will automatically use any menu which has a title matching the localized word “Help”.

Note

Because a Submenu can be added multiple times to the same Menu this method will set the first instance of this submenu as the Help menu for the application.

It is not recommended to add the same submenu multiple times to the same menu, but if you do, be aware of this behavior.

pub fn into_id(self) -> MenuId

Convert this submenu into its menu ID.

pub fn set_icon(&self, icon: Option<Icon>)

Change this menu item icon or remove it.

pub fn set_native_icon(&self, _icon: Option<NativeIcon>)

Change this menu item icon to a native image or remove it.

Platform-specific:

• Windows / Linux: Unsupported.

Trait Implementations

impl Clone for Submenu

fn clone(&self) -> Submenu

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContextMenu for Submenu

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

Available on macOS only.

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

fn ns_menu(&self) -> *mut c_void

Available on macOS only.

Get the underlying NSMenu reserved for context menus.

fn as_submenu(&self) -> Option<&Submenu>

Cast this context menu to a Submenu, and returns None if it wasn’t.

fn as_menu(&self) -> Option<&Menu>

Cast this context menu to a Menu, and returns None if it wasn’t.

fn as_menu_unchecked(&self) -> &Menu

Casts this context menu to a Menu, and panics if it wasn’t.

fn as_submenu_unchecked(&self) -> &Menu

Casts this context menu to a Submenu, and panics if it wasn’t.

impl IsMenuItem for Submenu

fn kind(&self) -> MenuItemKind

Returns a MenuItemKind associated with this item.

fn id(&self) -> &MenuId

Returns a unique identifier associated with this menu item.

fn into_id(self) -> MenuId

Convert this menu item into its menu ID.