struct GtkMenuShell

struct GtkMenuShell;

gtk_menu_shell_append ()

void                gtk_menu_shell_append               (GtkMenuShell *menu_shell,
                                                         GtkWidget *child);

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

gtk_menu_shell_prepend ()

void                gtk_menu_shell_prepend              (GtkMenuShell *menu_shell,
                                                         GtkWidget *child);

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

gtk_menu_shell_insert ()

void                gtk_menu_shell_insert               (GtkMenuShell *menu_shell,
                                                         GtkWidget *child,
                                                         gint position);

Adds a new GtkMenuItem to the menu shell's item list at the position indicated by position.

gtk_menu_shell_deactivate ()

void                gtk_menu_shell_deactivate           (GtkMenuShell *menu_shell);

Deactivates the menu shell.

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

gtk_menu_shell_select_item ()

void                gtk_menu_shell_select_item          (GtkMenuShell *menu_shell,
                                                         GtkWidget *menu_item);

Selects the menu item from the menu shell.

gtk_menu_shell_select_first ()

void                gtk_menu_shell_select_first         (GtkMenuShell *menu_shell,
                                                         gboolean search_sensitive);

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

gtk_menu_shell_deselect ()

void                gtk_menu_shell_deselect             (GtkMenuShell *menu_shell);

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

gtk_menu_shell_activate_item ()

void                gtk_menu_shell_activate_item        (GtkMenuShell *menu_shell,
                                                         GtkWidget *menu_item,
                                                         gboolean force_deactivate);

Activates the menu item within the menu shell.

gtk_menu_shell_cancel ()

void                gtk_menu_shell_cancel               (GtkMenuShell *menu_shell);

Cancels the selection within the menu shell.

Since 2.4

gtk_menu_shell_set_take_focus ()

void                gtk_menu_shell_set_take_focus       (GtkMenuShell *menu_shell,
                                                         gboolean take_focus);

If take_focus 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 take_focus to FALSE is useful only for special applications like virtual keyboard implementations which should not take keyboard focus.

The take_focus 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 take_focus property of the submenu needs to be set explicitely.

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 take_focus set to FALSE should not display mnemonics or accelerators, since it cannot be guaranteed that they will work.

See also gdk_keyboard_grab()

Since 2.8

gtk_menu_shell_get_take_focus ()

gboolean            gtk_menu_shell_get_take_focus       (GtkMenuShell *menu_shell);

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

Since 2.8

gtk_menu_shell_get_selected_item ()

GtkWidget *         gtk_menu_shell_get_selected_item    (GtkMenuShell *menu_shell);

Gets the currently selected item.

Since 3.0

gtk_menu_shell_get_parent_shell ()

GtkWidget *         gtk_menu_shell_get_parent_shell     (GtkMenuShell *menu_shell);

Gets the parent menu shell.

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

Since 3.0

enum GtkMenuDirectionType

typedef enum
{
  GTK_MENU_DIR_PARENT,
  GTK_MENU_DIR_CHILD,
  GTK_MENU_DIR_NEXT,
  GTK_MENU_DIR_PREV
} GtkMenuDirectionType;

An enumeration representing directional movements within a menu.

The "take-focus" property

  "take-focus"               gboolean              : Read / Write

A boolean that determines whether the menu and its submenus grab the keyboard focus. See gtk_menu_shell_set_take_focus() and gtk_menu_shell_get_take_focus().

Default value: TRUE

Since 2.8

The "activate-current" signal

void                user_function                      (GtkMenuShell *menushell,
                                                        gboolean      force_hide,
                                                        gpointer      user_data)       : Action

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

The "cancel" signal

void                user_function                      (GtkMenuShell *menushell,
                                                        gpointer      user_data)      : Action

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

The "cycle-focus" signal

void                user_function                      (GtkMenuShell    *menushell,
                                                        GtkDirectionType direction,
                                                        gpointer         user_data)      : Action

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

The "deactivate" signal

void                user_function                      (GtkMenuShell *menushell,
                                                        gpointer      user_data)      : Run First

This signal is emitted when a menu shell is deactivated.

The "move-current" signal

void                user_function                      (GtkMenuShell        *menushell,
                                                        GtkMenuDirectionType direction,
                                                        gpointer             user_data)      : Action

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

The "move-selected" signal

gboolean            user_function                      (GtkMenuShell *menu_shell,
                                                        gint          distance,
                                                        gpointer      user_data)       : Run Last

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

Since 2.12

The "selection-done" signal

void                user_function                      (GtkMenuShell *menushell,
                                                        gpointer      user_data)      : Run First

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