tray_icon::menu

Struct Submenu

Source
pub struct Submenu { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Submenu

Source

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 &&.
Source

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 &&.
Source

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.

Source

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.

Source

pub fn id(&self) -> &MenuId

Returns a unique identifier associated with this submenu.

Source

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

Add a menu item to the end of this menu.

Source

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.

Source

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

Add a menu item to the beginning of this submenu.

Source

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.

Source

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

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

Source

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

Insert menu items at the specified postion in the submenu.

Source

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

Remove a menu item from this submenu.

Source

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

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

Source

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

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

Source

pub fn text(&self) -> String

Get the text for this submenu.

Source

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 &&.

Source

pub fn is_enabled(&self) -> bool

Get whether this submenu is enabled or not.

Source

pub fn set_enabled(&self, enabled: bool)

Enable or disable this submenu.

Source

pub fn into_id(self) -> MenuId

Convert this submenu into its menu ID.

Trait Implementations§

Source§

impl Clone for Submenu

Source§

fn clone(&self) -> Submenu

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ContextMenu for Submenu

Source§

fn hpopupmenu(&self) -> isize

Get the popup HMENU for this menu. Read more
Source§

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

Shows this menu as a context menu inside a win32 window. Read more
Source§

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 Read more
Source§

unsafe fn detach_menu_subclass_from_hwnd(&self, hwnd: isize)

Remove the menu subclass handler from the given hwnd Read more
Source§

impl IsMenuItem for Submenu

Source§

fn kind(&self) -> MenuItemKind

Returns a MenuItemKind associated with this item.
Source§

fn id(&self) -> &MenuId

Returns a unique identifier associated with this menu item.
Source§

fn into_id(self) -> MenuId

Convert this menu item into its menu ID.

Auto Trait Implementations§

§

impl Freeze for Submenu

§

impl !RefUnwindSafe for Submenu

§

impl !Send for Submenu

§

impl !Sync for Submenu

§

impl Unpin for Submenu

§

impl !UnwindSafe for Submenu

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.