Name

MenuShell —

An abstract base class which provides the control of navigation through menu items.

Synopsis

menuShellActivateItem:: (MenuShellClass ms, MenuItemClass w) => ms -> w -> Bool -> IO ()
menuShellAppend:: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()
menuShellDeactivate:: MenuShellClass ms => ms -> IO ()
menuShellDeselect:: MenuShellClass ms => ms -> IO ()
menuShellInsert:: (MenuShellClass ms, MenuItemClass w) => ms -> w -> Int -> IO ()
menuShellPrepend:: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()
menuShellSelectItem:: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()
onActivateCurrent:: MenuShellClass ms => ms -> (Bool -> IO ()) -> IO (ConnectId ms)
onCancel:: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)
onDeactivated:: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)
onMoveCurrent:: MenuShellClass ms => ms -> (MenuDirectionType -> IO ()) -> IO (ConnectId ms)
onSelectionDone:: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

Methods

menuShellActivateItem

Activate a specific item in the menu. If the menu was deactivated and force is set, the previously deactivated menu is reactivated.

menuShellActivateItem:: ms:: w:: Bool:: IO ()
mschildforce

menuShellAppend

Append the new entry child to a menu.

menuShellAppend:: ms:: w:: IO ()
mschild

menuShellDeactivate

Temporary deactivate a complete menu definition.

menuShellDeactivate:: ms:: IO ()
ms

menuShellDeselect

Deselect a the selected item within the menu.

menuShellDeselect:: ms:: IO ()
ms

menuShellInsert

Insert the child menu item at the specified position (0..n-1).

menuShellInsert:: ms:: w:: Int:: IO ()
mschildpos

menuShellPrepend

Prepend the new entry child to a menu.

menuShellPrepend:: ms:: w:: IO ()
mschild

menuShellSelectItem

Select a specific item within the menu.

menuShellSelectItem:: ms:: w:: IO ()
mschild

Signals

onActivateCurrent

This signal is called if an item is activated. The boolean flag hide is True whenever the menu will behidden after this action.

onActivateCurrent:: ms:: (Bool -> IO ()):: IO (ConnectId ms)

onCancel

This signal will be emitted when a selection is aborted and thus does not lead to an activation. This is in contrast to the selection done signal which is always emitted.

onCancel:: ms:: IO ():: IO (ConnectId ms)

onDeactivated

This signal is sent whenever the menu shell is deactivated (hidden).

onDeactivated:: ms:: IO ():: IO (ConnectId ms)

onMoveCurrent

This signal is emitted for each move the cursor makes.

onMoveCurrent:: ms:: (MenuDirectionType -> IO ()):: IO (ConnectId ms)

onSelectionDone

This signal is emitted when the user finished using the menu. Note that this signal is emitted even if no menu item was activated.

onSelectionDone:: ms:: IO ():: IO (ConnectId ms)