Memory-managed wrapper type.

Type class for types which can be safely cast to MenuShell, for instance with toMenuShell.

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

A convenience alias for Nothing :: Maybe MenuShell.

Activates the menu item within the menu shell.

Adds a new MenuItem to the end of the menu shell's item list.

Establishes a binding between a MenuShell and a MenuModel.

The contents of shell are removed and then refilled with menu items according to model. When model changes, shell is updated. Calling this function twice on shell with different model will cause the first binding to be replaced with a binding to the new model. If model is Nothing then any previous binding is undone and all children are removed.

withSeparators determines if toplevel items (eg: sections) have separators inserted between them. This is typically desired for menus but doesn’t make sense for menubars.

If actionNamespace is non-Nothing then the effect is as if all actions mentioned in the model have their names prefixed with the namespace, plus a dot. For example, if the action “quit” is mentioned and actionNamespace is “app” then the effective action name is “app.quit”.

This function uses Actionable to define the action name and target values on the created menu items. If you want to use an action group other than “app” and “win”, or if you want to use a MenuShell outside of a ApplicationWindow, then you will need to attach your own action group to the widget hierarchy using widgetInsertActionGroup. As an example, if you created a group with a “quit” action and inserted it with the name “mygroup” then you would use the action name “mygroup.quit” in your MenuModel.

For most cases you are probably better off using menuNewFromModel or menuBarNewFromModel or just directly passing the MenuModel to applicationSetAppMenu or applicationSetMenubar.

Since: 3.6

Cancels the selection within the menu shell.

Since: 2.4

Deactivates the menu shell.

Typically this results in the menu shell being erased from the screen.

Deselects the currently selected item from the menu shell, if any.

Gets the parent menu shell.

The parent menu shell of a submenu is the Menu or MenuBar from which it was opened up.

Since: 3.0

Gets the currently selected item.

Since: 3.0

Returns True if the menu shell will take the keyboard focus on popup.

Since: 2.8

Adds a new MenuItem to the menu shell’s item list at the position indicated by position.

Adds a new MenuItem to the beginning of the menu shell's item list.

Select the first visible or selectable child of the menu shell; don’t select tearoff items unless the only item is a tearoff item.

Since: 2.2

Selects the menu item from the menu shell.

If takeFocus is True (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus.

Setting takeFocus to False is useful only for special applications like virtual keyboard implementations which should not take keyboard focus.

The takeFocus state of a menu or menu bar is automatically propagated to submenus whenever a submenu is popped up, so you don’t have to worry about recursively setting it for your entire menu hierarchy. Only when programmatically picking a submenu and popping it up manually, the takeFocus property of the submenu needs to be set explicitly.

Note that setting it to False has side-effects:

If the focus is in some other app, it keeps the focus and keynav in the menu doesn’t work. Consequently, keynav on the menu will only work if the focus is on some toplevel owned by the onscreen keyboard.

To avoid confusing the user, menus with takeFocus set to False should not display mnemonics or accelerators, since it cannot be guaranteed that they will work.

See also keyboardGrab

Since: 2.8

Construct a GValueConstruct with valid value for the “take-focus” property. This is rarely needed directly, but it is used by new.

Get the value of the “take-focus” property. When overloading is enabled, this is equivalent to

get menuShell #takeFocus

Set the value of the “take-focus” property. When overloading is enabled, this is equivalent to

set menuShell [ #takeFocus := value ]

Type for the callback on the (unwrapped) C side.

An action signal that activates the current menu item within the menu shell.

Connect a signal handler for the “activate-current” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #activateCurrent callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellActivateCurrentCallback.

A convenience synonym for Nothing :: Maybe MenuShellActivateCurrentCallback.

Connect a signal handler for the “activate-current” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #activateCurrent callback

Wrap a MenuShellActivateCurrentCallback into a C_MenuShellActivateCurrentCallback.

Type for the callback on the (unwrapped) C side.

An action signal which cancels the selection within the menu shell. Causes the MenuShell::selection-done signal to be emitted.

Connect a signal handler for the “cancel” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #cancel callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellCancelCallback.

A convenience synonym for Nothing :: Maybe MenuShellCancelCallback.

Connect a signal handler for the “cancel” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #cancel callback

Wrap a MenuShellCancelCallback into a C_MenuShellCancelCallback.

Type for the callback on the (unwrapped) C side.

A keybinding signal which moves the focus in the given direction.

Connect a signal handler for the “cycle-focus” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #cycleFocus callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellCycleFocusCallback.

A convenience synonym for Nothing :: Maybe MenuShellCycleFocusCallback.

Connect a signal handler for the “cycle-focus” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #cycleFocus callback

Wrap a MenuShellCycleFocusCallback into a C_MenuShellCycleFocusCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when a menu shell is deactivated.

Connect a signal handler for the “deactivate” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #deactivate callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellDeactivateCallback.

A convenience synonym for Nothing :: Maybe MenuShellDeactivateCallback.

Connect a signal handler for the “deactivate” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #deactivate callback

Wrap a MenuShellDeactivateCallback into a C_MenuShellDeactivateCallback.

Type for the callback on the (unwrapped) C side.

The ::insert signal is emitted when a new MenuItem is added to a MenuShell. A separate signal is used instead of GtkContainer::add because of the need for an additional position parameter.

The inverse of this signal is the GtkContainer::removed signal.

Since: 3.2

Connect a signal handler for the “insert” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #insert callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellInsertCallback.

A convenience synonym for Nothing :: Maybe MenuShellInsertCallback.

Connect a signal handler for the “insert” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #insert callback

Wrap a MenuShellInsertCallback into a C_MenuShellInsertCallback.

Type for the callback on the (unwrapped) C side.

An keybinding signal which moves the current menu item in the direction specified by direction.

Connect a signal handler for the “move-current” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #moveCurrent callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellMoveCurrentCallback.

A convenience synonym for Nothing :: Maybe MenuShellMoveCurrentCallback.

Connect a signal handler for the “move-current” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #moveCurrent callback

Wrap a MenuShellMoveCurrentCallback into a C_MenuShellMoveCurrentCallback.

Type for the callback on the (unwrapped) C side.

The ::move-selected signal is emitted to move the selection to another item.

Since: 2.12

Connect a signal handler for the “move-selected” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #moveSelected callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellMoveSelectedCallback.

A convenience synonym for Nothing :: Maybe MenuShellMoveSelectedCallback.

Connect a signal handler for the “move-selected” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #moveSelected callback

Wrap a MenuShellMoveSelectedCallback into a C_MenuShellMoveSelectedCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when a selection has been completed within a menu shell.

Connect a signal handler for the “selection-done” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuShell #selectionDone callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MenuShellSelectionDoneCallback.

A convenience synonym for Nothing :: Maybe MenuShellSelectionDoneCallback.

Connect a signal handler for the “selection-done” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuShell #selectionDone callback

Wrap a MenuShellSelectionDoneCallback into a C_MenuShellSelectionDoneCallback.