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_gtk_window<W, C>( &self, window: &W, container: Option<&C>, ) -> Result<(), Error>

where W: IsA<Window> + IsA<Container>, C: IsA<Container>,

Adds this menu to a [gtk::Window]

• container: this is an optional paramter to specify a container for the [gtk::MenuBar], it is highly recommended to pass a container, otherwise the menubar will be added directly to the window, which is usually not the desired behavior. If using a [gtk::Box] as a container, it is added using Box::pack_start(menubar, false, false, 0) then reordered to be the first child of [gtk::Box] using Box::reorder_child(menubar, 0).

Example:

let window = gtk::Window::builder().build();
let vbox = gtk::Box::new(gtk::Orientation::Vertical, 0);
let menu = muda::Menu::new();
// -- snip, add your menu items --
menu.init_for_gtk_window(&window, Some(&vbox));
// then proceed to add your widgets to the `vbox`

Panics:

Panics if the gtk event loop hasn’t been initialized on the thread.

pub fn remove_for_gtk_window<W>(&self, window: &W) -> Result<(), Error>

where W: IsA<Window>,

Removes this menu from a [gtk::Window]

pub fn hide_for_gtk_window<W>(&self, window: &W) -> Result<(), Error>

where W: IsA<Window>,

Hides this menu from a [gtk::Window]

pub fn show_for_gtk_window<W>(&self, window: &W) -> Result<(), Error>

where W: IsA<Window>,

Shows this menu on a [gtk::Window]

pub fn is_visible_on_gtk_window<W>(&self, window: &W) -> bool

where W: IsA<Window>,

Returns whether this menu visible on a [gtk::Window]

pub fn gtk_menubar_for_gtk_window<W>(self, window: &W) -> Option<MenuBar>

where W: IsA<Window>,

Returns the [gtk::MenuBar] that is associated with this window if it exists. This is useful to get information about the menubar for example its height.

Trait Implementations

impl Clone for Menu

fn clone(&self) -> Menu

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContextMenu for Menu

fn show_context_menu_for_gtk_window( &self, window: &Window, position: Option<Position>, ) -> bool

Shows this menu as a context menu inside a [gtk::Window]

fn gtk_context_menu(&self) -> Menu

Get the underlying gtk menu reserved for context menus.

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(&self) -> Option<&Submenu>

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

fn as_submenu_unchecked(&self) -> &Menu

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

impl Default for Menu

fn default() -> Menu

Returns the “default value” for a type.