GI.Gtk.Objects.MenuShell

A MenuShell is the abstract base class used to derive the Menu and MenuBar subclasses.

A MenuShell is a container of MenuItem objects arranged in a list which can be navigated, selected, and activated by the user to perform application functions. A MenuItem can have a submenu associated with it, allowing for nested hierarchical menus.

Terminology

A menu item can be “selected”, this means that it is displayed in the prelight state, and if it has a submenu, that submenu will be popped up.

A menu is “active” when it is visible onscreen and the user is selecting from it. A menubar is not active until the user clicks on one of its menuitems. When a menu is active, passing the mouse over a submenu will pop it up.

There is also is a concept of the current menu and a current menu item. The current menu item is the selected menu item that is furthest down in the hierarchy. (Every active menu shell does not necessarily contain a selected menu item, but if it does, then the parent menu shell must also contain a selected menu item.) The current menu is the menu that contains the current menu item. It will always have a GTK grab and receive all key presses.

Exported types

newtype MenuShell

Memory-managed wrapper type.

Constructors

MenuShell (ManagedPtr MenuShell)

Instances

Eq MenuShell

Defined in GI.Gtk.Objects.MenuShell

Methods

(==) :: MenuShell -> MenuShell -> Bool

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

GObject MenuShell

Defined in GI.Gtk.Objects.MenuShell

ManagedPtrNewtype MenuShell

Defined in GI.Gtk.Objects.MenuShell

Methods

toManagedPtr :: MenuShell -> ManagedPtr MenuShell

TypedObject MenuShell

Defined in GI.Gtk.Objects.MenuShell

Methods

glibType :: IO GType

IsGValue MenuShell

Convert MenuShell to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.MenuShell

Methods

toGValue :: MenuShell -> IO GValue

fromGValue :: GValue -> IO MenuShell

HasParentTypes MenuShell

Defined in GI.Gtk.Objects.MenuShell

type ParentTypes MenuShell

Defined in GI.Gtk.Objects.MenuShell

type ParentTypes MenuShell = '[Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf MenuShell o) => IsMenuShell o

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

Instances

(GObject o, IsDescendantOf MenuShell o) => IsMenuShell o

Defined in GI.Gtk.Objects.MenuShell

toMenuShell :: (MonadIO m, IsMenuShell o) => o -> m MenuShell

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

Methods

Overloaded methods

activateItem

menuShellActivateItem

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a, IsWidget b)

=> a

menuShell: a MenuShell

-> b

menuItem: the MenuItem to activate

-> Bool

forceDeactivate: if True, force the deactivation of the menu shell after the menu item is activated

-> m ()

Activates the menu item within the menu shell.

append

menuShellAppend

Arguments

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

=> a

menuShell: a MenuShell

-> b

child: The MenuItem to add

-> m ()

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

bindModel

menuShellBindModel

Arguments

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

=> a

menuShell: a MenuShell

-> Maybe b

model: the MenuModel to bind to or Nothing to remove binding

-> Maybe Text

actionNamespace: the namespace for actions in model

-> Bool

withSeparators: True if toplevel items in shell should have separators between them

-> m ()

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

cancel

menuShellCancel

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m ()

Cancels the selection within the menu shell.

Since: 2.4

deactivate

menuShellDeactivate

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m ()

Deactivates the menu shell.

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

deselect

menuShellDeselect

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m ()

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

getParentShell

menuShellGetParentShell

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m Widget

Returns: the parent MenuShell

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

getSelectedItem

menuShellGetSelectedItem

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m Widget

Returns: the currently selected item

Gets the currently selected item.

Since: 3.0

getTakeFocus

menuShellGetTakeFocus

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> m Bool

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

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

Since: 2.8

insert

menuShellInsert

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a, IsWidget b)

=> a

menuShell: a MenuShell

-> b

child: The MenuItem to add

-> Int32

position: The position in the item list where child is added. Positions are numbered from 0 to n-1

-> m ()

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

prepend

menuShellPrepend

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a, IsWidget b)

=> a

menuShell: a MenuShell

-> b

child: The MenuItem to add

-> m ()

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

selectFirst

menuShellSelectFirst

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> Bool

searchSensitive: if True, search for the first selectable menu item, otherwise select nothing if the first item isn’t sensitive. This should be False if the menu is being popped up initially.

-> m ()

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

selectItem

menuShellSelectItem

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a, IsWidget b)

=> a

menuShell: a MenuShell

-> b

menuItem: The MenuItem to select

-> m ()

Selects the menu item from the menu shell.

setTakeFocus

menuShellSetTakeFocus

Arguments

:: (HasCallStack, MonadIO m, IsMenuShell a)

=> a

menuShell: a MenuShell

-> Bool

takeFocus: True if the menu shell should take the keyboard focus on popup

-> m ()

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

Properties

takeFocus

A boolean that determines whether the menu and its submenus grab the keyboard focus. See menuShellSetTakeFocus and menuShellGetTakeFocus.

Since: 2.8

constructMenuShellTakeFocus :: (IsMenuShell o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getMenuShellTakeFocus :: (MonadIO m, IsMenuShell o) => o -> m Bool

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

get menuShell #takeFocus

setMenuShellTakeFocus :: (MonadIO m, IsMenuShell o) => o -> Bool -> m ()

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

set menuShell [ #takeFocus := value ]

Signals

activateCurrent

type C_MenuShellActivateCurrentCallback = Ptr () -> CInt -> Ptr () -> IO ()

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

type MenuShellActivateCurrentCallback

Arguments

 = Bool

forceHide: if True, hide the menu after activating the menu item

-> IO ()

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

afterMenuShellActivateCurrent :: (IsMenuShell a, MonadIO m) => a -> MenuShellActivateCurrentCallback -> m SignalHandlerId

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

after menuShell #activateCurrent callback

genClosure_MenuShellActivateCurrent :: MonadIO m => MenuShellActivateCurrentCallback -> m (GClosure C_MenuShellActivateCurrentCallback)

Wrap the callback into a GClosure.

mk_MenuShellActivateCurrentCallback :: C_MenuShellActivateCurrentCallback -> IO (FunPtr C_MenuShellActivateCurrentCallback)

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

noMenuShellActivateCurrentCallback :: Maybe MenuShellActivateCurrentCallback

A convenience synonym for Nothing :: Maybe MenuShellActivateCurrentCallback.

onMenuShellActivateCurrent :: (IsMenuShell a, MonadIO m) => a -> MenuShellActivateCurrentCallback -> m SignalHandlerId

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

on menuShell #activateCurrent callback

wrap_MenuShellActivateCurrentCallback :: MenuShellActivateCurrentCallback -> C_MenuShellActivateCurrentCallback

Wrap a MenuShellActivateCurrentCallback into a C_MenuShellActivateCurrentCallback.

cancel

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

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

type MenuShellCancelCallback = IO ()

An action signal which cancels the selection within the menu shell. Causes the selectionDone signal to be emitted.

afterMenuShellCancel :: (IsMenuShell a, MonadIO m) => a -> MenuShellCancelCallback -> m SignalHandlerId

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

genClosure_MenuShellCancel :: MonadIO m => MenuShellCancelCallback -> m (GClosure C_MenuShellCancelCallback)

Wrap the callback into a GClosure.

mk_MenuShellCancelCallback :: C_MenuShellCancelCallback -> IO (FunPtr C_MenuShellCancelCallback)

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

noMenuShellCancelCallback :: Maybe MenuShellCancelCallback

A convenience synonym for Nothing :: Maybe MenuShellCancelCallback.

onMenuShellCancel :: (IsMenuShell a, MonadIO m) => a -> MenuShellCancelCallback -> m SignalHandlerId

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_MenuShellCancelCallback :: MenuShellCancelCallback -> C_MenuShellCancelCallback

Wrap a MenuShellCancelCallback into a C_MenuShellCancelCallback.

cycleFocus

type C_MenuShellCycleFocusCallback = Ptr () -> CUInt -> Ptr () -> IO ()

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

type MenuShellCycleFocusCallback

Arguments

 = DirectionType

direction: the direction to cycle in

-> IO ()

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

afterMenuShellCycleFocus :: (IsMenuShell a, MonadIO m) => a -> MenuShellCycleFocusCallback -> m SignalHandlerId

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

after menuShell #cycleFocus callback

genClosure_MenuShellCycleFocus :: MonadIO m => MenuShellCycleFocusCallback -> m (GClosure C_MenuShellCycleFocusCallback)

Wrap the callback into a GClosure.

mk_MenuShellCycleFocusCallback :: C_MenuShellCycleFocusCallback -> IO (FunPtr C_MenuShellCycleFocusCallback)

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

noMenuShellCycleFocusCallback :: Maybe MenuShellCycleFocusCallback

A convenience synonym for Nothing :: Maybe MenuShellCycleFocusCallback.

onMenuShellCycleFocus :: (IsMenuShell a, MonadIO m) => a -> MenuShellCycleFocusCallback -> m SignalHandlerId

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

on menuShell #cycleFocus callback

wrap_MenuShellCycleFocusCallback :: MenuShellCycleFocusCallback -> C_MenuShellCycleFocusCallback

Wrap a MenuShellCycleFocusCallback into a C_MenuShellCycleFocusCallback.

deactivate

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

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

type MenuShellDeactivateCallback = IO ()

This signal is emitted when a menu shell is deactivated.

afterMenuShellDeactivate :: (IsMenuShell a, MonadIO m) => a -> MenuShellDeactivateCallback -> m SignalHandlerId

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

genClosure_MenuShellDeactivate :: MonadIO m => MenuShellDeactivateCallback -> m (GClosure C_MenuShellDeactivateCallback)

Wrap the callback into a GClosure.

mk_MenuShellDeactivateCallback :: C_MenuShellDeactivateCallback -> IO (FunPtr C_MenuShellDeactivateCallback)

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

noMenuShellDeactivateCallback :: Maybe MenuShellDeactivateCallback

A convenience synonym for Nothing :: Maybe MenuShellDeactivateCallback.

onMenuShellDeactivate :: (IsMenuShell a, MonadIO m) => a -> MenuShellDeactivateCallback -> m SignalHandlerId

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_MenuShellDeactivateCallback :: MenuShellDeactivateCallback -> C_MenuShellDeactivateCallback

Wrap a MenuShellDeactivateCallback into a C_MenuShellDeactivateCallback.

insert

type C_MenuShellInsertCallback = Ptr () -> Ptr Widget -> Int32 -> Ptr () -> IO ()

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

type MenuShellInsertCallback

Arguments

 = Widget

child: the MenuItem that is being inserted

-> Int32

position: the position at which the insert occurs

-> IO ()

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

The inverse of this signal is the GtkContainer[removed](#g:signal:removed) signal.

Since: 3.2

afterMenuShellInsert :: (IsMenuShell a, MonadIO m) => a -> MenuShellInsertCallback -> m SignalHandlerId

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

genClosure_MenuShellInsert :: MonadIO m => MenuShellInsertCallback -> m (GClosure C_MenuShellInsertCallback)

Wrap the callback into a GClosure.

mk_MenuShellInsertCallback :: C_MenuShellInsertCallback -> IO (FunPtr C_MenuShellInsertCallback)

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

noMenuShellInsertCallback :: Maybe MenuShellInsertCallback

A convenience synonym for Nothing :: Maybe MenuShellInsertCallback.

onMenuShellInsert :: (IsMenuShell a, MonadIO m) => a -> MenuShellInsertCallback -> m SignalHandlerId

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_MenuShellInsertCallback :: MenuShellInsertCallback -> C_MenuShellInsertCallback

Wrap a MenuShellInsertCallback into a C_MenuShellInsertCallback.

moveCurrent

type C_MenuShellMoveCurrentCallback = Ptr () -> CUInt -> Ptr () -> IO ()

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

type MenuShellMoveCurrentCallback

Arguments

 = MenuDirectionType

direction: the direction to move

-> IO ()

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

afterMenuShellMoveCurrent :: (IsMenuShell a, MonadIO m) => a -> MenuShellMoveCurrentCallback -> m SignalHandlerId

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

after menuShell #moveCurrent callback

genClosure_MenuShellMoveCurrent :: MonadIO m => MenuShellMoveCurrentCallback -> m (GClosure C_MenuShellMoveCurrentCallback)

Wrap the callback into a GClosure.

mk_MenuShellMoveCurrentCallback :: C_MenuShellMoveCurrentCallback -> IO (FunPtr C_MenuShellMoveCurrentCallback)

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

noMenuShellMoveCurrentCallback :: Maybe MenuShellMoveCurrentCallback

A convenience synonym for Nothing :: Maybe MenuShellMoveCurrentCallback.

onMenuShellMoveCurrent :: (IsMenuShell a, MonadIO m) => a -> MenuShellMoveCurrentCallback -> m SignalHandlerId

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

on menuShell #moveCurrent callback

wrap_MenuShellMoveCurrentCallback :: MenuShellMoveCurrentCallback -> C_MenuShellMoveCurrentCallback

Wrap a MenuShellMoveCurrentCallback into a C_MenuShellMoveCurrentCallback.

moveSelected

type C_MenuShellMoveSelectedCallback = Ptr () -> Int32 -> Ptr () -> IO CInt

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

type MenuShellMoveSelectedCallback

Arguments

 = Int32

distance: +1 to move to the next item, -1 to move to the previous

-> IO Bool

Returns: True to stop the signal emission, False to continue

The moveSelected signal is emitted to move the selection to another item.

Since: 2.12

afterMenuShellMoveSelected :: (IsMenuShell a, MonadIO m) => a -> MenuShellMoveSelectedCallback -> m SignalHandlerId

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

after menuShell #moveSelected callback

genClosure_MenuShellMoveSelected :: MonadIO m => MenuShellMoveSelectedCallback -> m (GClosure C_MenuShellMoveSelectedCallback)

Wrap the callback into a GClosure.

mk_MenuShellMoveSelectedCallback :: C_MenuShellMoveSelectedCallback -> IO (FunPtr C_MenuShellMoveSelectedCallback)

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

noMenuShellMoveSelectedCallback :: Maybe MenuShellMoveSelectedCallback

A convenience synonym for Nothing :: Maybe MenuShellMoveSelectedCallback.

onMenuShellMoveSelected :: (IsMenuShell a, MonadIO m) => a -> MenuShellMoveSelectedCallback -> m SignalHandlerId

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

on menuShell #moveSelected callback

wrap_MenuShellMoveSelectedCallback :: MenuShellMoveSelectedCallback -> C_MenuShellMoveSelectedCallback

Wrap a MenuShellMoveSelectedCallback into a C_MenuShellMoveSelectedCallback.

selectionDone

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

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

type MenuShellSelectionDoneCallback = IO ()

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

afterMenuShellSelectionDone :: (IsMenuShell a, MonadIO m) => a -> MenuShellSelectionDoneCallback -> m SignalHandlerId

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

after menuShell #selectionDone callback

genClosure_MenuShellSelectionDone :: MonadIO m => MenuShellSelectionDoneCallback -> m (GClosure C_MenuShellSelectionDoneCallback)

Wrap the callback into a GClosure.

mk_MenuShellSelectionDoneCallback :: C_MenuShellSelectionDoneCallback -> IO (FunPtr C_MenuShellSelectionDoneCallback)

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

noMenuShellSelectionDoneCallback :: Maybe MenuShellSelectionDoneCallback

A convenience synonym for Nothing :: Maybe MenuShellSelectionDoneCallback.

onMenuShellSelectionDone :: (IsMenuShell a, MonadIO m) => a -> MenuShellSelectionDoneCallback -> m SignalHandlerId

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

on menuShell #selectionDone callback

wrap_MenuShellSelectionDoneCallback :: MenuShellSelectionDoneCallback -> C_MenuShellSelectionDoneCallback

Wrap a MenuShellSelectionDoneCallback into a C_MenuShellSelectionDoneCallback.