GI.Gio.Objects.MenuItem

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

Since: 2.32

Exported types

newtype MenuItem

Memory-managed wrapper type.

Constructors

MenuItem (ManagedPtr MenuItem)

Instances

Eq MenuItem

Defined in GI.Gio.Objects.MenuItem

Methods

(==) :: MenuItem -> MenuItem -> Bool

(/=) :: MenuItem -> MenuItem -> Bool

GObject MenuItem

Defined in GI.Gio.Objects.MenuItem

Methods

gobjectType :: IO GType

IsGValue MenuItem

Convert MenuItem to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.MenuItem

Methods

toGValue :: MenuItem -> IO GValue

fromGValue :: GValue -> IO MenuItem

HasParentTypes MenuItem

Defined in GI.Gio.Objects.MenuItem

type ParentTypes MenuItem

Defined in GI.Gio.Objects.MenuItem

type ParentTypes MenuItem = '[Object]

class (GObject o, IsDescendantOf MenuItem o) => IsMenuItem o

Type class for types which can be safely cast to MenuItem, for instance with toMenuItem.

Instances

(GObject o, IsDescendantOf MenuItem o) => IsMenuItem o

Defined in GI.Gio.Objects.MenuItem

toMenuItem :: (MonadIO m, IsMenuItem o) => o -> m MenuItem

Cast to MenuItem, for types for which this is known to be safe. For general casts, use castTo.

noMenuItem :: Maybe MenuItem

A convenience alias for Nothing :: Maybe MenuItem.

Methods

Overloaded methods

getAttributeValue

menuItemGetAttributeValue

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Text

attribute: the attribute name to query

-> Maybe VariantType

expectedType: the expected type of the attribute

-> m GVariant

Returns: the attribute value, or Nothing

Queries the named attribute on menuItem.

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

Since: 2.34

getLink

menuItemGetLink

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Text

link: the link name to query

-> m MenuModel

Returns: the link, or Nothing

Queries the named link on menuItem.

Since: 2.34

new

menuItemNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

label: the section label, or Nothing

-> Maybe Text

detailedAction: the detailed action string, or Nothing

-> m MenuItem

Returns: a new MenuItem

Creates a new MenuItem.

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

If detailedAction is non-Nothing it is used to set the "action" and possibly the "target" attribute of the new item. See menuItemSetDetailedAction for more information.

Since: 2.32

newFromModel

menuItemNewFromModel

Arguments

:: (HasCallStack, MonadIO m, IsMenuModel a)

=> a

model: a MenuModel

-> Int32

itemIndex: the index of an item in model

-> m MenuItem

Returns: a new MenuItem.

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

itemIndex must be valid (ie: be sure to call menuModelGetNItems first).

Since: 2.34

newSection

menuItemNewSection

Arguments

:: (HasCallStack, MonadIO m, IsMenuModel a)

=> Maybe Text

label: the section label, or Nothing

-> a

section: a MenuModel with the items of the section

-> m MenuItem

Returns: a new MenuItem

Creates a new MenuItem representing a section.

This is a convenience API around menuItemNew and menuItemSetSection.

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 menuItem is added to.

Visual separation is typically displayed between two non-empty sections. If label is non-Nothing 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: > >id='edit-menu' > section > label='Undo'/ > label='Redo'/ > /section > section > label='Cut'/ > label='Copy'/ > 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). > >id='edit-menu' > item > name='section' > label='Undo'/ > label='Redo'/ > /link > /item > item > name='section' > label='Cut'/ > label='Copy'/ > label='Paste'/ > /link > /item >/menu

Since: 2.32

newSubmenu

menuItemNewSubmenu

Arguments

:: (HasCallStack, MonadIO m, IsMenuModel a)

=> Maybe Text

label: the section label, or Nothing

-> a

submenu: a MenuModel with the items of the submenu

-> m MenuItem

Returns: a new MenuItem

Creates a new MenuItem representing a submenu.

This is a convenience API around menuItemNew and menuItemSetSubmenu.

Since: 2.32

setActionAndTargetValue

menuItemSetActionAndTargetValue

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Maybe Text

action: the name of the action for this item

-> Maybe GVariant

targetValue: a GVariant to use as the action target

-> m ()

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

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

If action is non-Nothing then the "action" attribute is set. The "target" attribute is then set to the value of targetValue if it is non-Nothing 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 g_menu_item_set_action_and_target() or menuItemSetDetailedAction for two equivalent calls that are probably more convenient for most uses.

Since: 2.32

setAttributeValue

menuItemSetAttributeValue

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Text

attribute: the attribute to set

-> Maybe GVariant

value: a GVariant to use as the value, or Nothing

-> m ()

Sets or unsets an attribute on menuItem.

The attribute to set or unset is specified by attribute. This can be one of the standard attribute names MENU_ATTRIBUTE_LABEL, MENU_ATTRIBUTE_ACTION, 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-Nothing then it is used as the new value for the attribute. If value is Nothing 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.

Since: 2.32

setDetailedAction

menuItemSetDetailedAction

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Text

detailedAction: the "detailed" action string

-> m ()

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

The format of detailedAction is the same format parsed by actionParseDetailedName.

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

See also menuItemSetActionAndTargetValue for a description of the semantics of the action and target attributes.

Since: 2.32

setIcon

menuItemSetIcon

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a, IsIcon b)

=> a

menuItem: a MenuItem

-> b

icon: a Icon, or Nothing

-> m ()

Sets (or unsets) the icon on menuItem.

This call is the same as calling iconSerialize and using the result as the value to menuItemSetAttributeValue for 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 Nothing then the icon is unset.

Since: 2.38

setLabel

menuItemSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Maybe Text

label: the label to set, or Nothing to unset

-> m ()

Sets or unsets the "label" attribute of menuItem.

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

Since: 2.32

setLink

menuItemSetLink

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a, IsMenuModel b)

=> a

menuItem: a MenuItem

-> Text

link: type of link to establish or unset

-> Maybe b

model: the MenuModel to link to (or Nothing to unset)

-> m ()

Creates a link from menuItem to model if non-Nothing, or unsets it.

Links are used to establish a relationship between a particular menu item and another menu. For example, MENU_LINK_SUBMENU is used to associate a submenu with a particular menu item, and 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.

Since: 2.32

setSection

menuItemSetSection

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a, IsMenuModel b)

=> a

menuItem: a MenuItem

-> Maybe b

section: a MenuModel, or Nothing

-> m ()

Sets or unsets the "section" link of menuItem 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 menuItem is added to. See menuItemNewSection for more information about what it means for a menu item to be a section.

Since: 2.32

setSubmenu

menuItemSetSubmenu

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a, IsMenuModel b)

=> a

menuItem: a MenuItem

-> Maybe b

submenu: a MenuModel, or Nothing

-> m ()

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

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

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

Since: 2.32