Class: Gio::MenuItem

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

GMenu::Item is an opaque structure type. You must access it using the functions below.

Instance Method Summary collapse

Instance Method Details

#detailed_action=(detailed_action) ⇒ nil

Sets the “action” and possibly the “target” attribute of menu_item.

The format of detailed_action is the same format parsed by g_action_parse_detailed_name().

See g_menu_item_set_action_and_target() or g_menu_item_set_action_and_target_value() for more flexible (but slightly less convenient) alternatives.

See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes.

Parameters:

  • detailed_action (String) —

    the “detailed” action string

Returns:

  • (nil)

#get_attribute(attribute, format_string, array) ⇒ TrueClass

Queries the named attribute on menu_item.

If the attribute exists and matches the GVariant::Type corresponding to format_string then format_string is used to deconstruct the value into the positional parameters and true is returned.

If the attribute does not exist, or it does exist but has the wrong type, then the positional parameters are ignored and false is returned.

Parameters:

  • attribute (String) —

    the attribute name to query

  • format_string (String) —

    a #GVariant format string

  • array (Array) —

    positional parameters, as per format_string

Returns:

  • (TrueClass) —

    true if the named attribute was found with the expected type

#get_attribute_value(attribute, expected_type) ⇒ GLib::Variant

Queries the named attribute on menu_item.

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

Parameters:

  • attribute (String) —

    the attribute name to query

  • expected_type (GLib::VariantType) —

    the expected type of the attribute

Returns:

  • (GLib::Variant) —

    the attribute value, or nil

#get_link(link) ⇒ Gio::MenuModel

Queries the named link on menu_item.

Parameters:

  • link (String) —

    the link name to query

Returns:

#icon=(icon) ⇒ nil

Sets (or unsets) the icon on menu_item.

This call is the same as calling g_icon_serialize() and using the result as the value to g_menu_item_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 nil then the icon is unset.

Parameters:

Returns:

  • (nil)

#label=(label) ⇒ nil

Sets or unsets the “label” attribute of menu_item.

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

Parameters:

  • label (String) —

    the label to set, or nil to unset

Returns:

  • (nil)

#new(label, detailed_action) ⇒ Gio::MenuItem

Creates a new GMenu::Item.

If label is non-nil it is used to set the “label” attribute of the new item.

If detailed_action is non-nil it is used to set the “action” and possibly the “target” attribute of the new item. See g_menu_item_set_detailed_action() for more information.

Parameters:

  • label (String) —

    the section label, or nil

  • detailed_action (String) —

    the detailed action string, or nil

Returns:

#new_from_model(model, item_index) ⇒ Gio::MenuItem

Creates a GMenu::Item as an exact copy of an existing menu item in a GMenu::Model.

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

Parameters:

  • model (Gio::MenuModel) —

    a GMenu::Model

  • item_index (Integer) —

    the index of an item in model

Returns:

#new_section(label, section) ⇒ Gio::MenuItem

Creates a new GMenu::Item representing a section.

This is a convenience API around g_menu_item_new() and g_menu_item_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-nil 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 #GMenu 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> ]|

Parameters:

  • label (String) —

    the section label, or nil

  • section (Gio::MenuModel) —

    a GMenu::Model with the items of the section

Returns:

#new_submenu(label, submenu) ⇒ Gio::MenuItem

Creates a new GMenu::Item representing a submenu.

This is a convenience API around g_menu_item_new() and g_menu_item_set_submenu().

Parameters:

  • label (String) —

    the section label, or nil

  • submenu (Gio::MenuModel) —

    a GMenu::Model with the items of the submenu

Returns:

#section=(section) ⇒ nil

Sets or unsets the “section” link of menu_item 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 menu_item is added to. See g_menu_item_new_section() for more information about what it means for a menu item to be a section.

Parameters:

Returns:

  • (nil)

#set_action_and_target(action, format_string, array) ⇒ nil

Sets or unsets the “action” and “target” attributes of menu_item.

If action is nil then both the “action” and “target” attributes are unset (and format_string is ignored along with the positional parameters).

If action is non-nil then the “action” attribute is set. format_string is then inspected. If it is non-nil then the proper position parameters are collected to create a #GVariant instance to use as the target value. If it is nil then the positional parameters are ignored and the “target” attribute is unset.

See also g_menu_item_set_action_and_target_value() for an equivalent call that directly accepts a #GVariant. See g_menu_item_set_detailed_action() for a more convenient version that works with string-typed targets.

See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes.

Parameters:

  • action (String) —

    the name of the action for this item

  • format_string (String) —

    a GVariant format string

  • array (Array) —

    positional parameters, as per format_string

Returns:

  • (nil)

#set_action_and_target_value(action, target_value) ⇒ nil

Sets or unsets the “action” and “target” attributes of menu_item.

If action is nil then both the “action” and “target” attributes are unset (and target_value is ignored).

If action is non-nil then the “action” attribute is set. The “target” attribute is then set to the value of target_value if it is non-nil 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 #GAction and GAction::Group 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 g_menu_item_set_action_and_target() or g_menu_item_set_detailed_action() for two equivalent calls that are probably more convenient for most uses.

Parameters:

  • action (String) —

    the name of the action for this item

  • target_value (GLib::Variant) —

    a #GVariant to use as the action target

Returns:

  • (nil)

#set_attribute(attribute, format_string, array) ⇒ nil

Sets or unsets an attribute on menu_item.

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.

If format_string is non-nil then the proper position parameters are collected to create a #GVariant instance to use as the attribute value. If it is nil then the positional parameterrs are ignored and the named attribute is unset.

See also g_menu_item_set_attribute_value() for an equivalent call that directly accepts a #GVariant.

Parameters:

  • attribute (String) —

    the attribute to set

  • format_string (String) —

    a #GVariant format string, or nil

  • array (Array) —

    positional parameters, as per format_string

Returns:

  • (nil)

#set_attribute_value(attribute, value) ⇒ nil

Sets or unsets an attribute on menu_item.

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-nil then it is used as the new value for the attribute. If value is nil then the attribute is unset. If the value #GVariant is floating, it is consumed.

See also g_menu_item_set_attribute() for a more convenient way to do the same.

Parameters:

  • attribute (String) —

    the attribute to set

  • value (GLib::Variant) —

    a #GVariant to use as the value, or nil

Returns:

  • (nil)

#set_link(link, model) ⇒ nil

Creates a link from menu_item to model if non-nil, 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.

Parameters:

  • link (String) —

    type of link to establish or unset

  • model (Gio::MenuModel) —

    the GMenu::Model to link to (or nil to unset)

Returns:

  • (nil)

#submenu=(submenu) ⇒ nil

Sets or unsets the “submenu” link of menu_item to submenu.

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

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

Parameters:

Returns:

  • (nil)