Struct gio::Menu

pub struct Menu(_, _);

Menu is a simple implementation of MenuModel. You populate a Menu by adding MenuItem instances to it.

There are some convenience functions to allow you to directly add items (avoiding MenuItem) for the common cases. To add a regular item, use Menu::insert. To add a section, use Menu::insert_section. To add a submenu, use Menu::insert_submenu.

Implements

MenuModelExt, glib::object::ObjectExt

Methods

impl Menu

pub fn new() -> Menu

Creates a new Menu.

The new menu has no items.

Returns

a new Menu

pub fn append(&self, label: Option<&str>, detailed_action: Option<&str>)

Convenience function for appending a normal menu item to the end of self. Combine MenuItem::new and Menu::insert_item for a more flexible alternative.

label

the section label, or None

detailed_action

the detailed action string, or None

pub fn append_item(&self, item: &MenuItem)

Appends item to the end of self.

See Menu::insert_item for more information.

item

a MenuItem to append

pub fn append_section<P: IsA<MenuModel>>(
    &self,
    label: Option<&str>,
    section: &P
)

Convenience function for appending a section menu item to the end of self. Combine MenuItem::new_section and Menu::insert_item for a more flexible alternative.

label

the section label, or None

section

a MenuModel with the items of the section

pub fn append_submenu<P: IsA<MenuModel>>(
    &self,
    label: Option<&str>,
    submenu: &P
)

Convenience function for appending a submenu menu item to the end of self. Combine MenuItem::new_submenu and Menu::insert_item for a more flexible alternative.

label

the section label, or None

submenu

a MenuModel with the items of the submenu

pub fn freeze(&self)

Marks self as frozen.

After the menu is frozen, it is an error to attempt to make any changes to it. In effect this means that the Menu API must no longer be used.

This function causes MenuModelExt::is_mutable to begin returning false, which has some positive performance implications.

pub fn insert(
    &self,
    position: i32,
    label: Option<&str>,
    detailed_action: Option<&str>
)

Convenience function for inserting a normal menu item into self. Combine MenuItem::new and Menu::insert_item for a more flexible alternative.

position

the position at which to insert the item

label

the section label, or None

detailed_action

the detailed action string, or None

pub fn insert_item(&self, position: i32, item: &MenuItem)

Inserts item into self.

The "insertion" is actually done by copying all of the attribute and link values of item and using them to form a new item within self. As such, item itself is not really inserted, but rather, a menu item that is exactly the same as the one presently described by item.

This means that item is essentially useless after the insertion occurs. Any changes you make to it are ignored unless it is inserted again (at which point its updated values will be copied).

You should probably just free item once you're done.

There are many convenience functions to take care of common cases. See Menu::insert, Menu::insert_section and Menu::insert_submenu as well as "prepend" and "append" variants of each of these functions.

position

the position at which to insert the item

item

the MenuItem to insert

pub fn insert_section<P: IsA<MenuModel>>(
    &self,
    position: i32,
    label: Option<&str>,
    section: &P
)

Convenience function for inserting a section menu item into self. Combine MenuItem::new_section and Menu::insert_item for a more flexible alternative.

position

the position at which to insert the item

label

the section label, or None

section

a MenuModel with the items of the section

pub fn insert_submenu<P: IsA<MenuModel>>(
    &self,
    position: i32,
    label: Option<&str>,
    submenu: &P
)

Convenience function for inserting a submenu menu item into self. Combine MenuItem::new_submenu and Menu::insert_item for a more flexible alternative.

position

the position at which to insert the item

label

the section label, or None

submenu

a MenuModel with the items of the submenu

pub fn prepend(&self, label: Option<&str>, detailed_action: Option<&str>)

Convenience function for prepending a normal menu item to the start of self. Combine MenuItem::new and Menu::insert_item for a more flexible alternative.

label

the section label, or None

detailed_action

the detailed action string, or None

pub fn prepend_item(&self, item: &MenuItem)

Prepends item to the start of self.

See Menu::insert_item for more information.

item

a MenuItem to prepend

pub fn prepend_section<P: IsA<MenuModel>>(
    &self,
    label: Option<&str>,
    section: &P
)

Convenience function for prepending a section menu item to the start of self. Combine MenuItem::new_section and Menu::insert_item for a more flexible alternative.

label

the section label, or None

section

a MenuModel with the items of the section

pub fn prepend_submenu<P: IsA<MenuModel>>(
    &self,
    label: Option<&str>,
    submenu: &P
)

Convenience function for prepending a submenu menu item to the start of self. Combine MenuItem::new_submenu and Menu::insert_item for a more flexible alternative.

label

the section label, or None

submenu

a MenuModel with the items of the submenu

pub fn remove(&self, position: i32)

Removes an item from the menu.

position gives the index of the item to remove.

It is an error if position is not in range the range from 0 to one less than the number of items in the menu.

It is not possible to remove items by identity since items are added to the menu simply by copying their links and attributes (ie: identity of the item itself is not preserved).

position

the position of the item to remove

pub fn remove_all(&self)

Removes all items in the menu.

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 Debug for Menu

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

Formats the value using the given formatter.

impl Default for Menu

fn default() -> Self

Returns the "default value" for a type.

impl Display for Menu

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

Formats the value using the given formatter.

impl Eq for Menu

impl Hash for Menu

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IsA<MenuModel> for Menu

impl Ord for Menu

fn cmp(&self, other: &Menu) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for Menu

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Menu

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Menu

fn static_type() -> Type

Returns the type identifier of Self.