Struct gio::MenuItem

pub struct MenuItem(_, _);

MenuItem is an opaque structure type. You must access it using the functions below.

Implements

glib::object::ObjectExt

Methods

impl MenuItem

pub fn new(label: Option<&str>, detailed_action: Option<&str>) -> MenuItem

Creates a new MenuItem.

If label is non-None it is used to set the "label" attribute of the new item.

If detailed_action is non-None it is used to set the "action" and possibly the "target" attribute of the new item. See MenuItem::set_detailed_action for more information.

label

the section label, or None

detailed_action

the detailed action string, or None

Returns

a new MenuItem

pub fn new_from_model<P: IsA<MenuModel>>(model: &P, item_index: i32) -> MenuItem

Creates a MenuItem as an exact copy of an existing menu item in a MenuModel.

item_index must be valid (ie: be sure to call MenuModelExt::get_n_items first).

model

a MenuModel

item_index

the index of an item in model

Returns

a new MenuItem.

pub fn new_section<P: IsA<MenuModel>>(
    label: Option<&str>,
    section: &P
) -> MenuItem

Creates a new MenuItem representing a section.

This is a convenience API around MenuItem::new and MenuItem::set_section.

The effect of having one menu appear as a section of another is exactly as it sounds: the items from section become a direct part of the menu that menu_item is added to.

Visual separation is typically displayed between two non-empty sections. If label is non-None then it will be encorporated into this visual indication. This allows for labeled subsections of a menu.

As a simple example, consider a typical "Edit" menu from a simple program. It probably contains an "Undo" and "Redo" item, followed by a separator, followed by "Cut", "Copy" and "Paste".

This would be accomplished by creating three Menu instances. The first would be populated with the "Undo" and "Redo" items, and the second with the "Cut", "Copy" and "Paste" items. The first and second menus would then be added as submenus of the third. In XML format, this would look something like the following:

<menu id='edit-menu'>
  <section>
    <item label='Undo'/>
    <item label='Redo'/>
  </section>
  <section>
    <item label='Cut'/>
    <item label='Copy'/>
    <item label='Paste'/>
  </section>
</menu>

The following example is exactly equivalent. It is more illustrative of the exact relationship between the menus and items (keeping in mind that the 'link' element defines a new menu that is linked to the containing one). The style of the second example is more verbose and difficult to read (and therefore not recommended except for the purpose of understanding what is really going on).

<menu id='edit-menu'>
  <item>
    <link name='section'>
      <item label='Undo'/>
      <item label='Redo'/>
    </link>
  </item>
  <item>
    <link name='section'>
      <item label='Cut'/>
      <item label='Copy'/>
      <item label='Paste'/>
    </link>
  </item>
</menu>

label

the section label, or None

section

a MenuModel with the items of the section

Returns

a new MenuItem

pub fn new_submenu<P: IsA<MenuModel>>(
    label: Option<&str>,
    submenu: &P
) -> MenuItem

Creates a new MenuItem representing a submenu.

This is a convenience API around MenuItem::new and MenuItem::set_submenu.

label

the section label, or None

submenu

a MenuModel with the items of the submenu

Returns

a new MenuItem

pub fn get_attribute_value(
    &self,
    attribute: &str,
    expected_type: Option<&VariantTy>
) -> Option<Variant>

Queries the named attribute on self.

If expected_type is specified and the attribute does not have this type, None is returned. None is also returned if the attribute simply does not exist.

attribute

the attribute name to query

expected_type

the expected type of the attribute

Returns

the attribute value, or None

pub fn get_link(&self, link: &str) -> Option<MenuModel>

Queries the named link on self.

link

the link name to query

Returns

the link, or None

pub fn set_action_and_target_value(
    &self,
    action: Option<&str>,
    target_value: Option<&Variant>
)

Sets or unsets the "action" and "target" attributes of self.

If action is None then both the "action" and "target" attributes are unset (and target_value is ignored).

If action is non-None then the "action" attribute is set. The "target" attribute is then set to the value of target_value if it is non-None or unset otherwise.

Normal menu items (ie: not submenu, section or other custom item types) are expected to have the "action" attribute set to identify the action that they are associated with. The state type of the action help to determine the disposition of the menu item. See Action and ActionGroup for an overview of actions.

In general, clicking on the menu item will result in activation of the named action with the "target" attribute given as the parameter to the action invocation. If the "target" attribute is not set then the action is invoked with no parameter.

If the action has no state then the menu item is usually drawn as a plain menu item (ie: with no additional decoration).

If the action has a boolean state then the menu item is usually drawn as a toggle menu item (ie: with a checkmark or equivalent indication). The item should be marked as 'toggled' or 'checked' when the boolean state is true.

If the action has a string state then the menu item is usually drawn as a radio menu item (ie: with a radio bullet or equivalent indication). The item should be marked as 'selected' when the string state is equal to the value of the target property.

See MenuItem::set_action_and_target or MenuItem::set_detailed_action for two equivalent calls that are probably more convenient for most uses.

action

the name of the action for this item

target_value

a glib::Variant to use as the action target

pub fn set_attribute_value(&self, attribute: &str, value: Option<&Variant>)

Sets or unsets an attribute on self.

The attribute to set or unset is specified by attribute. This can be one of the standard attribute names G_MENU_ATTRIBUTE_LABEL, G_MENU_ATTRIBUTE_ACTION, G_MENU_ATTRIBUTE_TARGET, or a custom attribute name. Attribute names are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes.

must consist only of lowercase ASCII characters, digits and '-'.

If value is non-None then it is used as the new value for the attribute. If value is None then the attribute is unset. If the value glib::Variant is floating, it is consumed.

See also MenuItem::set_attribute for a more convenient way to do the same.

attribute

the attribute to set

value

a glib::Variant to use as the value, or None

pub fn set_detailed_action(&self, detailed_action: &str)

Sets the "action" and possibly the "target" attribute of self.

The format of detailed_action is the same format parsed by Action::parse_detailed_name.

See MenuItem::set_action_and_target or MenuItem::set_action_and_target_value for more flexible (but slightly less convenient) alternatives.

See also MenuItem::set_action_and_target_value for a description of the semantics of the action and target attributes.

detailed_action

the "detailed" action string

pub fn set_icon<P: IsA<Icon>>(&self, icon: &P)

Sets (or unsets) the icon on self.

This call is the same as calling Icon::serialize and using the result as the value to MenuItem::set_attribute_value for G_MENU_ATTRIBUTE_ICON.

This API is only intended for use with "noun" menu items; things like bookmarks or applications in an "Open With" menu. Don't use it on menu items corresponding to verbs (eg: stock icons for 'Save' or 'Quit').

If icon is None then the icon is unset.

icon

a Icon, or None

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

Sets or unsets the "label" attribute of self.

If label is non-None it is used as the label for the menu item. If it is None then the label attribute is unset.

label

the label to set, or None to unset

pub fn set_link<P: IsA<MenuModel>>(&self, link: &str, model: Option<&P>)

Creates a link from self to model if non-None, or unsets it.

Links are used to establish a relationship between a particular menu item and another menu. For example, G_MENU_LINK_SUBMENU is used to associate a submenu with a particular menu item, and G_MENU_LINK_SECTION is used to create a section. Other types of link can be used, but there is no guarantee that clients will be able to make sense of them. Link types are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes.

link

type of link to establish or unset

model

the MenuModel to link to (or None to unset)

pub fn set_section<P: IsA<MenuModel>>(&self, section: Option<&P>)

Sets or unsets the "section" link of self to section.

The effect of having one menu appear as a section of another is exactly as it sounds: the items from section become a direct part of the menu that self is added to. See MenuItem::new_section for more information about what it means for a menu item to be a section.

section

a MenuModel, or None

pub fn set_submenu<P: IsA<MenuModel>>(&self, submenu: Option<&P>)

Sets or unsets the "submenu" link of self to submenu.

If submenu is non-None, it is linked to. If it is None then the link is unset.

The effect of having one menu appear as a submenu of another is exactly as it sounds.

submenu

a MenuModel, or None

Trait Implementations

impl Clone for MenuItem

fn clone(&self) -> MenuItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MenuItem

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

Formats the value using the given formatter.

impl Display for MenuItem

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

Formats the value using the given formatter.

impl Eq for MenuItem

impl Hash for MenuItem

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 Ord for MenuItem

fn cmp(&self, other: &MenuItem) -> 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 MenuItem

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 MenuItem

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 MenuItem

fn static_type() -> Type

Returns the type identifier of Self.