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 unsafe fn init_for_hwnd(&self, hwnd: isize) -> Result<(), Error>

Adds this menu to a win32 window.

Safety

The hwnd must be a valid window HWND.

Note about accelerators:

For accelerators to work, the event loop needs to call TranslateAcceleratorW with the HACCEL returned from Menu::haccel

Example:

let menu = Menu::new();
unsafe {
    let mut msg: MSG = std::mem::zeroed();
    while GetMessageW(&mut msg, std::ptr::null_mut(), 0, 0) == 1 {
        let translated = TranslateAcceleratorW(msg.hwnd, menu.haccel() as _, &msg as *const _);
        if translated != 1{
            TranslateMessage(&msg);
            DispatchMessageW(&msg);
        }
    }
}

pub unsafe fn init_for_hwnd_with_theme( &self, hwnd: isize, theme: MenuTheme, ) -> Result<(), Error>

Adds this menu to a win32 window using the specified theme.

See Menu::init_for_hwnd for more info.

Note that the theme only affects the menu bar itself and not submenus or context menu.

Safety

The hwnd must be a valid window HWND.

pub unsafe fn set_theme_for_hwnd( &self, hwnd: isize, theme: MenuTheme, ) -> Result<(), Error>

Set a theme for the menu bar on this window.

Note that the theme only affects the menu bar itself and not submenus or context menu.

Safety

The hwnd must be a valid window HWND.

pub fn haccel(&self) -> isize

Returns The HACCEL associated with this menu It can be used with TranslateAcceleratorW in the event loop to enable accelerators

The returned HACCEL is valid as long as the Menu is.

pub unsafe fn remove_for_hwnd(&self, hwnd: isize) -> Result<(), Error>

Removes this menu from a win32 window

Safety

The hwnd must be a valid window HWND.

pub unsafe fn hide_for_hwnd(&self, hwnd: isize) -> Result<(), Error>

Hides this menu from a win32 window

Safety

The hwnd must be a valid window HWND.

pub unsafe fn show_for_hwnd(&self, hwnd: isize) -> Result<(), Error>

Shows this menu on a win32 window

Safety

The hwnd must be a valid window HWND.

pub unsafe fn is_visible_on_hwnd(&self, hwnd: isize) -> bool

Returns whether this menu visible on a on a win32 window

Safety

The hwnd must be a valid window HWND.

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

fn hpopupmenu(&self) -> isize

Get the popup HMENU for this menu.

unsafe fn show_context_menu_for_hwnd( &self, hwnd: isize, position: Option<Position>, )

Shows this menu as a context menu inside a win32 window.

unsafe fn attach_menu_subclass_for_hwnd(&self, hwnd: isize)

Attach the menu subclass handler to the given hwnd so you can recieve events from that window using MenuEvent::receiver

unsafe fn detach_menu_subclass_from_hwnd(&self, hwnd: isize)

Remove the menu subclass handler from the given hwnd

impl Default for Menu

fn default() -> Menu

Returns the “default value” for a type.