Struct Menu

pub struct Menu { /* private fields */ }

GMenu is a simple implementation of MenuModel. You populate a GMenu 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 insert(). To add a section, use insert_section(). To add a submenu, use insert_submenu().

Implements

MenuModelExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Menu

pub fn new() -> Menu

Creates a new #GMenu.

The new menu has no items.

Returns

a new #GMenu

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 g_menu_item_new() and g_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 g_menu_insert_item() for more information.

item

a #GMenuItem to append

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

Convenience function for appending a section menu item to the end of @self. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative.

label

the section label, or None

section

a #GMenuModel with the items of the section

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

Convenience function for appending a submenu menu item to the end of @self. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative.

label

the section label, or None

submenu

a #GMenuModel 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 #GMenu API must no longer be used.

This function causes g_menu_model_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 g_menu_item_new() and g_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 g_menu_insert(), g_menu_insert_section() and g_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 #GMenuItem to insert

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

Convenience function for inserting a section menu item into @self. Combine g_menu_item_new_section() and g_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 #GMenuModel with the items of the section

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

Convenience function for inserting a submenu menu item into @self. Combine g_menu_item_new_submenu() and g_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 #GMenuModel 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 g_menu_item_new() and g_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 g_menu_insert_item() for more information.

item

a #GMenuItem to prepend

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

Convenience function for prepending a section menu item to the start of @self. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative.

label

the section label, or None

section

a #GMenuModel with the items of the section

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

Convenience function for prepending a submenu menu item to the start of @self. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative.

label

the section label, or None

submenu

a #GMenuModel 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) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

type ParamSpec = ParamSpecObject

type SetValue = Menu

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Menu>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Menu

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Menu

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Menu

type Parent = MenuModel

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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.

impl Eq for Menu

impl IsA<MenuModel> for Menu