GI.Gio.Objects.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 menuInsert. To add a section, use menuInsertSection. To add a submenu, use menuInsertSubmenu.

Exported types

newtype Menu

Constructors

Menu (ManagedPtr Menu)

Instances

GObject Menu

Methods

gobjectType :: Menu -> IO GType

IsObject Menu

IsMenuModel Menu

IsMenu Menu

class GObject o => IsMenu o

Instances

(GObject a, UnknownAncestorError Constraint Menu a) => IsMenu a

IsMenu Menu

toMenu :: (MonadIO m, IsMenu o) => o -> m Menu

noMenu :: Maybe Menu

Methods

append

menuAppend

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> Maybe Text

detailedAction: the detailed action string, or Nothing

-> m ()

Convenience function for appending a normal menu item to the end of menu. Combine menuItemNew and menuInsertItem for a more flexible alternative.

Since: 2.32

appendItem

menuAppendItem

Arguments

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

=> a

menu: a Menu

-> b

item: a MenuItem to append

-> m ()

Appends item to the end of menu.

See menuInsertItem for more information.

Since: 2.32

appendSection

menuAppendSection

Arguments

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

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> b

section: a MenuModel with the items of the section

-> m ()

Convenience function for appending a section menu item to the end of menu. Combine menuItemNewSection and menuInsertItem for a more flexible alternative.

Since: 2.32

appendSubmenu

menuAppendSubmenu

Arguments

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

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> b

submenu: a MenuModel with the items of the submenu

-> m ()

Convenience function for appending a submenu menu item to the end of menu. Combine menuItemNewSubmenu and menuInsertItem for a more flexible alternative.

Since: 2.32

freeze

menuFreeze

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> m ()

Marks menu 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 menuModelIsMutable to begin returning False, which has some positive performance implications.

Since: 2.32

insert

menuInsert

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> Int32

position: the position at which to insert the item

-> Maybe Text

label: the section label, or Nothing

-> Maybe Text

detailedAction: the detailed action string, or Nothing

-> m ()

Convenience function for inserting a normal menu item into menu. Combine menuItemNew and menuInsertItem for a more flexible alternative.

Since: 2.32

insertItem

menuInsertItem

Arguments

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

=> a

menu: a Menu

-> Int32

position: the position at which to insert the item

-> b

item: the MenuItem to insert

-> m ()

Inserts item into menu.

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 menu. 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 menuInsert, menuInsertSection and menuInsertSubmenu as well as "prepend" and "append" variants of each of these functions.

Since: 2.32

insertSection

menuInsertSection

Arguments

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

=> a

menu: a Menu

-> Int32

position: the position at which to insert the item

-> Maybe Text

label: the section label, or Nothing

-> b

section: a MenuModel with the items of the section

-> m ()

Convenience function for inserting a section menu item into menu. Combine menuItemNewSection and menuInsertItem for a more flexible alternative.

Since: 2.32

insertSubmenu

menuInsertSubmenu

Arguments

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

=> a

menu: a Menu

-> Int32

position: the position at which to insert the item

-> Maybe Text

label: the section label, or Nothing

-> b

submenu: a MenuModel with the items of the submenu

-> m ()

Convenience function for inserting a submenu menu item into menu. Combine menuItemNewSubmenu and menuInsertItem for a more flexible alternative.

Since: 2.32

new

menuNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Menu

Returns: a new Menu

Creates a new Menu.

The new menu has no items.

Since: 2.32

prepend

menuPrepend

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> Maybe Text

detailedAction: the detailed action string, or Nothing

-> m ()

Convenience function for prepending a normal menu item to the start of menu. Combine menuItemNew and menuInsertItem for a more flexible alternative.

Since: 2.32

prependItem

menuPrependItem

Arguments

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

=> a

menu: a Menu

-> b

item: a MenuItem to prepend

-> m ()

Prepends item to the start of menu.

See menuInsertItem for more information.

Since: 2.32

prependSection

menuPrependSection

Arguments

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

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> b

section: a MenuModel with the items of the section

-> m ()

Convenience function for prepending a section menu item to the start of menu. Combine menuItemNewSection and menuInsertItem for a more flexible alternative.

Since: 2.32

prependSubmenu

menuPrependSubmenu

Arguments

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

=> a

menu: a Menu

-> Maybe Text

label: the section label, or Nothing

-> b

submenu: a MenuModel with the items of the submenu

-> m ()

Convenience function for prepending a submenu menu item to the start of menu. Combine menuItemNewSubmenu and menuInsertItem for a more flexible alternative.

Since: 2.32

remove

menuRemove

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> Int32

position: the position of the item to remove

-> m ()

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).

Since: 2.32

removeAll

menuRemoveAll

Arguments

:: (HasCallStack, MonadIO m, IsMenu a)

=> a

menu: a Menu

-> m ()

Removes all items in the menu.

Since: 2.38