Struct Menu 

pub struct Menu<MK: MenuKind> { /* private fields */ }

Available on crate feature ui only.

Generic menu (top-level or submenu).

Implementations

impl<MK: MenuKind> Menu<MK>

pub fn new() -> Result<Self>

pub fn new_from_items<I>(items: I) -> Result<Self>

where I: IntoIterator<Item = MK::MenuItem>,

pub fn as_handle(&self) -> &MenuHandle

pub fn insert_menu_item( &mut self, item: MK::MenuItem, index: Option<u32>, ) -> Result<()>

Inserts a menu item before the item with the given index.

If no index is given, it will be inserted after the last item.

Panics

Will panic if the given index is greater than the current amount of items.

pub fn insert_menu_items<I>(&mut self, items: I) -> Result<()>

where I: IntoIterator<Item = MK::MenuItem>,

pub fn modify_menu_item_by_index( &mut self, index: u32, modify_fn: impl FnOnce(&mut MK::MenuItem) -> Result<()>, ) -> Result<()>

Modifies a menu item at the given index using the given closure.

Panics

Will panic if the given index is out of bounds.

pub fn remove_menu_item(&mut self, index: u32) -> Result<()>

Removes a menu item.

Panics

Will panic if the given index is out of bounds.

impl Menu<SubMenuKind>

pub fn modify_text_menu_items_by_id( &mut self, id: u32, modify_fn: impl FnMut(&mut TextMenuItem) -> Result<()>, ) -> Result<()>

Modifies all text menu items with the given ID using the given closure.

Will do nothing if no item with a matching ID is found.

pub fn show_menu(&self, window: WindowHandle, coords: Point) -> Result<()>

Shows the popup menu at the given coordinates.

The coordinates can for example be retrieved from the window message handler, see crate::ui::messaging::ListenerMessageVariant::NotificationIconContextSelect

The given window needs to be the foreground window for the menu to show (use WindowHandle::set_as_foreground).

Trait Implementations

impl<MK: Debug + MenuKind> Debug for Menu<MK>

where MK::MenuItem: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<MK: MenuKind> Drop for Menu<MK>

fn drop(&mut self)

Executes the destructor for this type.