gtk2hs Contents Index

MenuShell

Description

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

Synopsis

menuShellAppend :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO () menuShellPrepend :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO () menuShellInsert :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> Int -> IO () menuShellDeactivate :: MenuShellClass ms => ms -> IO () menuShellSelectItem :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO () menuShellDeselect :: MenuShellClass ms => ms -> IO () onActivateCurrent :: MenuShellClass ms => ms -> (Bool -> IO ()) -> IO (ConnectId ms) afterActivateCurrent :: MenuShellClass ms => ms -> (Bool -> IO ()) -> IO (ConnectId ms) onCancel :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms) afterCancel :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms) onDeactivated :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms) afterDeactivated :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms) data MenuDirectionType = MenuDirParent | MenuDirChild | MenuDirNext | MenuDirPrev onMoveCurrent :: MenuShellClass ms => ms -> (MenuDirectionType -> IO ()) -> IO (ConnectId ms) afterMoveCurrent :: MenuShellClass ms => ms -> (MenuDirectionType -> IO ()) -> IO (ConnectId ms) onSelectionDone :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms) afterSelectionDone :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

Documentation

menuShellAppend :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()

Append the new entry child to a menu.

menuShellPrepend :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()

Prepend the new entry child to a menu.

menuShellInsert :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> Int -> IO ()

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

menuShellDeactivate :: MenuShellClass ms => ms -> IO ()

Temporary deactivate a complete menu definition.

menuShellSelectItem :: (MenuShellClass ms, MenuItemClass w) => ms -> w -> IO ()

Select a specific item within the menu.

menuShellDeselect :: MenuShellClass ms => ms -> IO ()

Deselect a the selected item within the menu.

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

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

afterActivateCurrent :: MenuShellClass ms => ms -> (Bool -> IO ()) -> IO (ConnectId ms)

onCancel :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

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.

afterCancel :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

onDeactivated :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

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

afterDeactivated :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

data MenuDirectionType

From where was a menu item entered? Constructors MenuDirParent MenuDirChild MenuDirNext MenuDirPrev Instances Enum MenuDirectionType

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

This signal is emitted for each move the cursor makes.

afterMoveCurrent :: MenuShellClass ms => ms -> (MenuDirectionType -> IO ()) -> IO (ConnectId ms)

onSelectionDone :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

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

afterSelectionDone :: MenuShellClass ms => ms -> IO () -> IO (ConnectId ms)

Produced by Haddock version 0.6