GI.Gtk.Objects.MenuItem

The MenuItem widget and the derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus.

As a GtkMenuItem derives from Bin it can hold any valid child widget, although only a few are really useful.

By default, a GtkMenuItem sets a AccelLabel as its child. GtkMenuItem has direct functions to set the label and its mnemonic. For more advanced label settings, you can fetch the child widget from the GtkBin.

An example for setting markup and accelerator on a MenuItem:

C code

GtkWidget *child = gtk_bin_get_child (GTK_BIN (menu_item));
gtk_label_set_markup (GTK_LABEL (child), "<i>new label</i> with <b>markup</b>");
gtk_accel_label_set_accel (GTK_ACCEL_LABEL (child), GDK_KEY_1, 0);

GtkMenuItem as GtkBuildable

The GtkMenuItem implementation of the Buildable interface supports adding a submenu by specifying “submenu” as the “type” attribute of a <child> element.

An example of UI definition fragment with submenus: > >class="GtkMenuItem" > type="submenu" > class="GtkMenu"/ > /child >/object

CSS nodes

plain code

menuitem
├── <child>
╰── [arrow.right]

GtkMenuItem has a single CSS node with name menuitem. If the menuitem has a submenu, it gets another CSS node with name arrow, which has the .left or .right style class.

Exported types

newtype MenuItem

Constructors

MenuItem (ManagedPtr MenuItem)

Instances

GObject MenuItem

Methods

gobjectType :: MenuItem -> IO GType

IsImplementorIface MenuItem

IsObject MenuItem

IsWidget MenuItem

IsMenuItem MenuItem

IsContainer MenuItem

IsBin MenuItem

IsBuildable MenuItem

IsActivatable MenuItem

IsActionable MenuItem

class GObject o => IsMenuItem o

Instances

(GObject a, UnknownAncestorError Constraint MenuItem a) => IsMenuItem a

IsMenuItem MenuItem

IsMenuItem CheckMenuItem

IsMenuItem ImageMenuItem

IsMenuItem RadioMenuItem

IsMenuItem SeparatorMenuItem

IsMenuItem TearoffMenuItem

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

noMenuItem :: Maybe MenuItem

Methods

activate

menuItemActivate

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: the menu item

-> m ()

Emits the MenuItem::activate signal on the given item

deselect

menuItemDeselect

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: the menu item

-> m ()

Emits the MenuItem::deselect signal on the given item.

getAccelPath

menuItemGetAccelPath

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a valid MenuItem

-> m (Maybe Text)

Returns: the accelerator path corresponding to this menu item’s functionality, or Nothing if not set

Retrieve the accelerator path that was previously set on menuItem.

See menuItemSetAccelPath for details.

Since: 2.14

getLabel

menuItemGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> m Text

Returns: The text in the menuItem label. This is the internal string used by the label, and must not be modified.

Sets text on the menuItem label

Since: 2.16

getReserveIndicator

menuItemGetReserveIndicator

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> m Bool

Returns: True if menuItem always reserves space for the submenu indicator

Returns whether the menuItem reserves space for the submenu indicator, regardless if it has a submenu or not.

Since: 3.0

getRightJustified

menuItemGetRightJustified

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> m Bool

Returns: True if the menu item will appear at the far right if added to a menu bar.

Deprecated: (Since version 3.2)See menuItemSetRightJustified

Gets whether the menu item appears justified at the right side of the menu bar.

getSubmenu

menuItemGetSubmenu

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> m (Maybe Widget)

Returns: submenu for this menu item, or Nothing if none

Gets the submenu underneath this menu item, if any. See menuItemSetSubmenu.

getUseUnderline

menuItemGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> m Bool

Returns: True if an embedded underline in the label indicates the mnemonic accelerator key.

Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Since: 2.16

new

menuItemNew

Arguments

:: (HasCallStack, MonadIO m)

=> m MenuItem

Returns: the newly created MenuItem

Creates a new MenuItem.

newWithLabel

menuItemNewWithLabel

Arguments

:: (HasCallStack, MonadIO m)

=> Text

label: the text for the label

-> m MenuItem

Returns: the newly created MenuItem

Creates a new MenuItem whose child is a Label.

newWithMnemonic

menuItemNewWithMnemonic

Arguments

:: (HasCallStack, MonadIO m)

=> Text

label: The text of the button, with an underscore in front of the mnemonic character

-> m MenuItem

Returns: a new MenuItem

Creates a new MenuItem containing a label.

The label will be created using labelNewWithMnemonic, so underscores in label indicate the mnemonic for the menu item.

select

menuItemSelect

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: the menu item

-> m ()

Emits the MenuItem::select signal on the given item.

setAccelPath

menuItemSetAccelPath

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a valid MenuItem

-> Maybe Text

accelPath: accelerator path, corresponding to this menu item’s functionality, or Nothing to unset the current path.

-> m ()

Set the accelerator path on menuItem, through which runtime changes of the menu item’s accelerator caused by the user can be identified and saved to persistent storage (see accelMapSave on this). To set up a default accelerator for this menu item, call accelMapAddEntry with the same accelPath. See also accelMapAddEntry on the specifics of accelerator paths, and menuSetAccelPath for a more convenient variant of this function.

This function is basically a convenience wrapper that handles calling widgetSetAccelPath with the appropriate accelerator group for the menu item.

Note that you do need to set an accelerator on the parent menu with menuSetAccelGroup for this to work.

Note that accelPath string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with internStaticString.

setLabel

menuItemSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Text

label: the text you want to set

-> m ()

Sets text on the menuItem label

Since: 2.16

setReserveIndicator

menuItemSetReserveIndicator

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Bool

reserve: the new value

-> m ()

Sets whether the menuItem should reserve space for the submenu indicator, regardless if it actually has a submenu or not.

There should be little need for applications to call this functions.

Since: 3.0

setRightJustified

menuItemSetRightJustified

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem.

-> Bool

rightJustified: if True the menu item will appear at the far right if added to a menu bar

-> m ()

Deprecated: (Since version 3.2)If you insist on using it, use widgetSetHexpand and widgetSetHalign.

Sets whether the menu item appears justified at the right side of a menu bar. This was traditionally done for “Help” menu items, but is now considered a bad idea. (If the widget layout is reversed for a right-to-left language like Hebrew or Arabic, right-justified-menu-items appear at the left.)

setSubmenu

menuItemSetSubmenu

Arguments

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

=> a

menuItem: a MenuItem

-> Maybe b

submenu: the submenu, or Nothing

-> m ()

Sets or replaces the menu item’s submenu, or removes it when a Nothing submenu is passed.

setUseUnderline

menuItemSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: a MenuItem

-> Bool

setting: True if underlines in the text indicate mnemonics

-> m ()

If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Since: 2.16

toggleSizeAllocate

menuItemToggleSizeAllocate

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: the menu item.

-> Int32

allocation: the allocation to use as signal data.

-> m ()

Emits the MenuItem::toggle-size-allocate signal on the given item.

toggleSizeRequest

menuItemToggleSizeRequest

Arguments

:: (HasCallStack, MonadIO m, IsMenuItem a)

=> a

menuItem: the menu item

-> Int32

requisition: the requisition to use as signal data.

-> m Int32

Emits the MenuItem::toggle-size-request signal on the given item.

Properties

accelPath

clearMenuItemAccelPath :: (MonadIO m, IsMenuItem o) => o -> m ()

constructMenuItemAccelPath :: IsMenuItem o => Text -> IO (GValueConstruct o)

getMenuItemAccelPath :: (MonadIO m, IsMenuItem o) => o -> m (Maybe Text)

setMenuItemAccelPath :: (MonadIO m, IsMenuItem o) => o -> Text -> m ()

label

constructMenuItemLabel :: IsMenuItem o => Text -> IO (GValueConstruct o)

getMenuItemLabel :: (MonadIO m, IsMenuItem o) => o -> m Text

setMenuItemLabel :: (MonadIO m, IsMenuItem o) => o -> Text -> m ()

rightJustified

constructMenuItemRightJustified :: IsMenuItem o => Bool -> IO (GValueConstruct o)

getMenuItemRightJustified :: (MonadIO m, IsMenuItem o) => o -> m Bool

setMenuItemRightJustified :: (MonadIO m, IsMenuItem o) => o -> Bool -> m ()

submenu

clearMenuItemSubmenu :: (MonadIO m, IsMenuItem o) => o -> m ()

constructMenuItemSubmenu :: (IsMenuItem o, IsMenu a) => a -> IO (GValueConstruct o)

getMenuItemSubmenu :: (MonadIO m, IsMenuItem o) => o -> m (Maybe Menu)

setMenuItemSubmenu :: (MonadIO m, IsMenuItem o, IsMenu a) => o -> a -> m ()

useUnderline

constructMenuItemUseUnderline :: IsMenuItem o => Bool -> IO (GValueConstruct o)

getMenuItemUseUnderline :: (MonadIO m, IsMenuItem o) => o -> m Bool

setMenuItemUseUnderline :: (MonadIO m, IsMenuItem o) => o -> Bool -> m ()

Signals

activate

type C_MenuItemActivateCallback = Ptr () -> Ptr () -> IO ()

type MenuItemActivateCallback = IO ()

afterMenuItemActivate :: (IsMenuItem a, MonadIO m) => a -> MenuItemActivateCallback -> m SignalHandlerId

genClosure_MenuItemActivate :: MenuItemActivateCallback -> IO Closure

mk_MenuItemActivateCallback :: C_MenuItemActivateCallback -> IO (FunPtr C_MenuItemActivateCallback)

noMenuItemActivateCallback :: Maybe MenuItemActivateCallback

onMenuItemActivate :: (IsMenuItem a, MonadIO m) => a -> MenuItemActivateCallback -> m SignalHandlerId

wrap_MenuItemActivateCallback :: MenuItemActivateCallback -> Ptr () -> Ptr () -> IO ()

activateItem

type C_MenuItemActivateItemCallback = Ptr () -> Ptr () -> IO ()

type MenuItemActivateItemCallback = IO ()

afterMenuItemActivateItem :: (IsMenuItem a, MonadIO m) => a -> MenuItemActivateItemCallback -> m SignalHandlerId

genClosure_MenuItemActivateItem :: MenuItemActivateItemCallback -> IO Closure

mk_MenuItemActivateItemCallback :: C_MenuItemActivateItemCallback -> IO (FunPtr C_MenuItemActivateItemCallback)

noMenuItemActivateItemCallback :: Maybe MenuItemActivateItemCallback

onMenuItemActivateItem :: (IsMenuItem a, MonadIO m) => a -> MenuItemActivateItemCallback -> m SignalHandlerId

wrap_MenuItemActivateItemCallback :: MenuItemActivateItemCallback -> Ptr () -> Ptr () -> IO ()

deselect

type C_MenuItemDeselectCallback = Ptr () -> Ptr () -> IO ()

type MenuItemDeselectCallback = IO ()

afterMenuItemDeselect :: (IsMenuItem a, MonadIO m) => a -> MenuItemDeselectCallback -> m SignalHandlerId

genClosure_MenuItemDeselect :: MenuItemDeselectCallback -> IO Closure

mk_MenuItemDeselectCallback :: C_MenuItemDeselectCallback -> IO (FunPtr C_MenuItemDeselectCallback)

noMenuItemDeselectCallback :: Maybe MenuItemDeselectCallback

onMenuItemDeselect :: (IsMenuItem a, MonadIO m) => a -> MenuItemDeselectCallback -> m SignalHandlerId

wrap_MenuItemDeselectCallback :: MenuItemDeselectCallback -> Ptr () -> Ptr () -> IO ()

select

type C_MenuItemSelectCallback = Ptr () -> Ptr () -> IO ()

type MenuItemSelectCallback = IO ()

afterMenuItemSelect :: (IsMenuItem a, MonadIO m) => a -> MenuItemSelectCallback -> m SignalHandlerId

genClosure_MenuItemSelect :: MenuItemSelectCallback -> IO Closure

mk_MenuItemSelectCallback :: C_MenuItemSelectCallback -> IO (FunPtr C_MenuItemSelectCallback)

noMenuItemSelectCallback :: Maybe MenuItemSelectCallback

onMenuItemSelect :: (IsMenuItem a, MonadIO m) => a -> MenuItemSelectCallback -> m SignalHandlerId

wrap_MenuItemSelectCallback :: MenuItemSelectCallback -> Ptr () -> Ptr () -> IO ()

toggleSizeAllocate

type C_MenuItemToggleSizeAllocateCallback = Ptr () -> Int32 -> Ptr () -> IO ()

type MenuItemToggleSizeAllocateCallback = Int32 -> IO ()

afterMenuItemToggleSizeAllocate :: (IsMenuItem a, MonadIO m) => a -> MenuItemToggleSizeAllocateCallback -> m SignalHandlerId

genClosure_MenuItemToggleSizeAllocate :: MenuItemToggleSizeAllocateCallback -> IO Closure

mk_MenuItemToggleSizeAllocateCallback :: C_MenuItemToggleSizeAllocateCallback -> IO (FunPtr C_MenuItemToggleSizeAllocateCallback)

noMenuItemToggleSizeAllocateCallback :: Maybe MenuItemToggleSizeAllocateCallback

onMenuItemToggleSizeAllocate :: (IsMenuItem a, MonadIO m) => a -> MenuItemToggleSizeAllocateCallback -> m SignalHandlerId

wrap_MenuItemToggleSizeAllocateCallback :: MenuItemToggleSizeAllocateCallback -> Ptr () -> Int32 -> Ptr () -> IO ()

toggleSizeRequest

type C_MenuItemToggleSizeRequestCallback = Ptr () -> Ptr () -> Ptr () -> IO ()

type MenuItemToggleSizeRequestCallback = Ptr () -> IO ()

afterMenuItemToggleSizeRequest :: (IsMenuItem a, MonadIO m) => a -> MenuItemToggleSizeRequestCallback -> m SignalHandlerId

genClosure_MenuItemToggleSizeRequest :: MenuItemToggleSizeRequestCallback -> IO Closure

mk_MenuItemToggleSizeRequestCallback :: C_MenuItemToggleSizeRequestCallback -> IO (FunPtr C_MenuItemToggleSizeRequestCallback)

noMenuItemToggleSizeRequestCallback :: Maybe MenuItemToggleSizeRequestCallback

onMenuItemToggleSizeRequest :: (IsMenuItem a, MonadIO m) => a -> MenuItemToggleSizeRequestCallback -> m SignalHandlerId

wrap_MenuItemToggleSizeRequestCallback :: MenuItemToggleSizeRequestCallback -> Ptr () -> Ptr () -> Ptr () -> IO ()