1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #define GTK_MENU_INTERNALS
30 #include "gdk/gdkkeysyms.h"
31 #include "gtkbindings.h"
32 #include "gtkkeyhash.h"
35 #include "gtkmarshalers.h"
37 #include "gtkmenubar.h"
38 #include "gtkmenuitem.h"
39 #include "gtkmenushell.h"
40 #include "gtkmnemonichash.h"
41 #include "gtktearoffmenuitem.h"
42 #include "gtkwindow.h"
43 #include "gtkprivate.h"
47 #define MENU_SHELL_TIMEOUT 500
49 #define PACK_DIRECTION(m) \
50 (GTK_IS_MENU_BAR (m) \
51 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
52 : GTK_PACK_DIRECTION_LTR)
72 * A menu item can be "selected", this means that it is displayed
73 * in the prelight state, and if it has a submenu, that submenu
76 * A menu is "active" when it is visible onscreen and the user
77 * is selecting from it. A menubar is not active until the user
78 * clicks on one of its menuitems. When a menu is active,
79 * passing the mouse over a submenu will pop it up.
81 * menu_shell->active_menu_item, is however, not an "active"
82 * menu item (there is no such thing) but rather, the selected
83 * menu item in that MenuShell, if there is one.
85 * There is also is a concept of the current menu and a current
86 * menu item. The current menu item is the selected menu item
87 * that is furthest down in the hierarchy. (Every active menu_shell
88 * does not necessarily contain a selected menu item, but if
89 * it does, then menu_shell->parent_menu_shell must also contain
90 * a selected menu item. The current menu is the menu that
91 * contains the current menu_item. It will always have a GTK
92 * grab and receive all key presses.
97 * ::move_current (GtkMenuDirection *dir)
98 * Moves the current menu item in direction 'dir':
100 * GTK_MENU_DIR_PARENT: To the parent menu shell
101 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
103 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
106 * As a a bit of a hack to get movement between menus and
107 * menubars working, if submenu_placement is different for
108 * the menu and its MenuShell then the following apply:
110 * - For 'parent' the current menu is not just moved to
111 * the parent, but moved to the previous entry in the parent
112 * - For 'child', if there is no child, then current is
113 * moved to the next item in the parent.
115 * Note that the above explanation of ::move_current was written
116 * before menus and menubars had support for RTL flipping and
117 * different packing directions, and therefore only applies for
118 * when text direction and packing direction are both left-to-right.
120 * ::activate_current (GBoolean *force_hide)
121 * Activate the current item. If 'force_hide' is true, hide
122 * the current menu item always. Otherwise, only hide
123 * it if menu_item->klass->hide_on_activate is true.
126 * Cancels the current selection
129 #define GTK_MENU_SHELL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShellPrivate))
131 typedef struct _GtkMenuShellPrivate GtkMenuShellPrivate;
133 struct _GtkMenuShellPrivate
135 GtkMnemonicHash *mnemonic_hash;
136 GtkKeyHash *key_hash;
138 GdkDevice *grab_pointer;
140 guint take_focus : 1;
141 guint activated_submenu : 1;
142 /* This flag is a crutch to keep mnemonics in the same menu
143 * if the user moves the mouse over an unselectable menuitem.
145 guint in_unselectable_item : 1;
148 static void gtk_menu_shell_set_property (GObject *object,
152 static void gtk_menu_shell_get_property (GObject *object,
156 static void gtk_menu_shell_realize (GtkWidget *widget);
157 static void gtk_menu_shell_finalize (GObject *object);
158 static gint gtk_menu_shell_button_press (GtkWidget *widget,
159 GdkEventButton *event);
160 static gint gtk_menu_shell_button_release (GtkWidget *widget,
161 GdkEventButton *event);
162 static gint gtk_menu_shell_key_press (GtkWidget *widget,
164 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
165 GdkEventCrossing *event);
166 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
167 GdkEventCrossing *event);
168 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
169 GdkScreen *previous_screen);
170 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
171 GdkEventGrabBroken *event);
172 static void gtk_menu_shell_add (GtkContainer *container,
174 static void gtk_menu_shell_remove (GtkContainer *container,
176 static void gtk_menu_shell_forall (GtkContainer *container,
177 gboolean include_internals,
178 GtkCallback callback,
179 gpointer callback_data);
180 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
183 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
184 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
186 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
188 static GType gtk_menu_shell_child_type (GtkContainer *container);
189 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
190 GtkWidget *menu_item);
191 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
193 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
194 GtkMenuDirectionType direction);
195 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
196 gboolean force_hide);
197 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
198 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
199 GtkDirectionType dir);
201 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
202 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
204 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
207 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
209 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
212 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
214 GObjectClass *object_class;
215 GtkWidgetClass *widget_class;
216 GtkContainerClass *container_class;
218 GtkBindingSet *binding_set;
220 object_class = (GObjectClass*) klass;
221 widget_class = (GtkWidgetClass*) klass;
222 container_class = (GtkContainerClass*) klass;
224 object_class->set_property = gtk_menu_shell_set_property;
225 object_class->get_property = gtk_menu_shell_get_property;
226 object_class->finalize = gtk_menu_shell_finalize;
228 widget_class->realize = gtk_menu_shell_realize;
229 widget_class->button_press_event = gtk_menu_shell_button_press;
230 widget_class->button_release_event = gtk_menu_shell_button_release;
231 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
232 widget_class->key_press_event = gtk_menu_shell_key_press;
233 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
234 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
235 widget_class->screen_changed = gtk_menu_shell_screen_changed;
237 container_class->add = gtk_menu_shell_add;
238 container_class->remove = gtk_menu_shell_remove;
239 container_class->forall = gtk_menu_shell_forall;
240 container_class->child_type = gtk_menu_shell_child_type;
242 klass->submenu_placement = GTK_TOP_BOTTOM;
243 klass->deactivate = gtk_real_menu_shell_deactivate;
244 klass->selection_done = NULL;
245 klass->move_current = gtk_real_menu_shell_move_current;
246 klass->activate_current = gtk_real_menu_shell_activate_current;
247 klass->cancel = gtk_real_menu_shell_cancel;
248 klass->select_item = gtk_menu_shell_real_select_item;
249 klass->insert = gtk_menu_shell_real_insert;
250 klass->move_selected = gtk_menu_shell_real_move_selected;
252 menu_shell_signals[DEACTIVATE] =
253 g_signal_new (I_("deactivate"),
254 G_OBJECT_CLASS_TYPE (object_class),
256 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
258 _gtk_marshal_VOID__VOID,
261 menu_shell_signals[SELECTION_DONE] =
262 g_signal_new (I_("selection-done"),
263 G_OBJECT_CLASS_TYPE (object_class),
265 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
267 _gtk_marshal_VOID__VOID,
270 menu_shell_signals[MOVE_CURRENT] =
271 g_signal_new (I_("move-current"),
272 G_OBJECT_CLASS_TYPE (object_class),
273 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
274 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
276 _gtk_marshal_VOID__ENUM,
278 GTK_TYPE_MENU_DIRECTION_TYPE);
280 menu_shell_signals[ACTIVATE_CURRENT] =
281 g_signal_new (I_("activate-current"),
282 G_OBJECT_CLASS_TYPE (object_class),
283 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
284 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
286 _gtk_marshal_VOID__BOOLEAN,
290 menu_shell_signals[CANCEL] =
291 g_signal_new (I_("cancel"),
292 G_OBJECT_CLASS_TYPE (object_class),
293 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
294 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
296 _gtk_marshal_VOID__VOID,
299 menu_shell_signals[CYCLE_FOCUS] =
300 g_signal_new_class_handler (I_("cycle-focus"),
301 G_OBJECT_CLASS_TYPE (object_class),
302 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
303 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
305 _gtk_marshal_VOID__ENUM,
307 GTK_TYPE_DIRECTION_TYPE);
310 * GtkMenuShell::move-selected:
311 * @menu_shell: the object on which the signal is emitted
312 * @distance: +1 to move to the next item, -1 to move to the previous
314 * The ::move-selected signal is emitted to move the selection to
317 * Returns: %TRUE to stop the signal emission, %FALSE to continue
321 menu_shell_signals[MOVE_SELECTED] =
322 g_signal_new (I_("move-selected"),
323 G_OBJECT_CLASS_TYPE (object_class),
325 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
326 _gtk_boolean_handled_accumulator, NULL,
327 _gtk_marshal_BOOLEAN__INT,
331 binding_set = gtk_binding_set_by_class (klass);
332 gtk_binding_entry_add_signal (binding_set,
335 gtk_binding_entry_add_signal (binding_set,
337 "activate-current", 1,
340 gtk_binding_entry_add_signal (binding_set,
342 "activate-current", 1,
345 gtk_binding_entry_add_signal (binding_set,
347 "activate-current", 1,
350 gtk_binding_entry_add_signal (binding_set,
352 "activate-current", 1,
355 gtk_binding_entry_add_signal (binding_set,
357 "activate-current", 1,
360 gtk_binding_entry_add_signal (binding_set,
363 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
364 gtk_binding_entry_add_signal (binding_set,
365 GDK_F10, GDK_SHIFT_MASK,
367 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
370 * GtkMenuShell:take-focus:
372 * A boolean that determines whether the menu and its submenus grab the
373 * keyboard focus. See gtk_menu_shell_set_take_focus() and
374 * gtk_menu_shell_get_take_focus().
378 g_object_class_install_property (object_class,
380 g_param_spec_boolean ("take-focus",
382 P_("A boolean that determines whether the menu grabs the keyboard focus"),
384 GTK_PARAM_READWRITE));
386 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
390 gtk_menu_shell_child_type (GtkContainer *container)
392 return GTK_TYPE_MENU_ITEM;
396 gtk_menu_shell_init (GtkMenuShell *menu_shell)
398 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
400 menu_shell->children = NULL;
401 menu_shell->active_menu_item = NULL;
402 menu_shell->parent_menu_shell = NULL;
403 menu_shell->active = FALSE;
404 menu_shell->have_grab = FALSE;
405 menu_shell->have_xgrab = FALSE;
406 menu_shell->button = 0;
407 menu_shell->activate_time = 0;
409 priv->mnemonic_hash = NULL;
410 priv->key_hash = NULL;
411 priv->take_focus = TRUE;
412 priv->activated_submenu = FALSE;
416 gtk_menu_shell_set_property (GObject *object,
421 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
425 case PROP_TAKE_FOCUS:
426 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
429 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
435 gtk_menu_shell_get_property (GObject *object,
440 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
444 case PROP_TAKE_FOCUS:
445 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
448 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
454 gtk_menu_shell_finalize (GObject *object)
456 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
457 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
459 if (priv->mnemonic_hash)
460 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
462 _gtk_key_hash_free (priv->key_hash);
464 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
469 gtk_menu_shell_append (GtkMenuShell *menu_shell,
472 gtk_menu_shell_insert (menu_shell, child, -1);
476 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
479 gtk_menu_shell_insert (menu_shell, child, 0);
483 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
487 GtkMenuShellClass *class;
489 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
490 g_return_if_fail (GTK_IS_MENU_ITEM (child));
492 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
495 class->insert (menu_shell, child, position);
499 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
503 menu_shell->children = g_list_insert (menu_shell->children, child, position);
505 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
509 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
511 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
513 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
517 gtk_menu_shell_realize (GtkWidget *widget)
519 GdkWindowAttr attributes;
520 gint attributes_mask;
522 gtk_widget_set_realized (widget, TRUE);
524 attributes.x = widget->allocation.x;
525 attributes.y = widget->allocation.y;
526 attributes.width = widget->allocation.width;
527 attributes.height = widget->allocation.height;
528 attributes.window_type = GDK_WINDOW_CHILD;
529 attributes.wclass = GDK_INPUT_OUTPUT;
530 attributes.visual = gtk_widget_get_visual (widget);
531 attributes.colormap = gtk_widget_get_colormap (widget);
532 attributes.event_mask = gtk_widget_get_events (widget);
533 attributes.event_mask |= (GDK_EXPOSURE_MASK |
534 GDK_BUTTON_PRESS_MASK |
535 GDK_BUTTON_RELEASE_MASK |
537 GDK_ENTER_NOTIFY_MASK |
538 GDK_LEAVE_NOTIFY_MASK);
540 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
541 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
542 gdk_window_set_user_data (widget->window, widget);
544 widget->style = gtk_style_attach (widget->style, widget->window);
545 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
549 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
551 if (!menu_shell->active)
555 device = gtk_get_current_event_device ();
557 _gtk_menu_shell_set_grab_device (menu_shell, device);
558 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
560 menu_shell->have_grab = TRUE;
561 menu_shell->active = TRUE;
566 gtk_menu_shell_button_press (GtkWidget *widget,
567 GdkEventButton *event)
569 GtkMenuShell *menu_shell;
570 GtkWidget *menu_item;
572 if (event->type != GDK_BUTTON_PRESS)
575 menu_shell = GTK_MENU_SHELL (widget);
577 if (menu_shell->parent_menu_shell)
578 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
580 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
582 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
583 menu_item != GTK_MENU_SHELL (menu_item->parent)->active_menu_item)
585 /* select the menu item *before* activating the shell, so submenus
586 * which might be open are closed the friendly way. If we activate
587 * (and thus grab) this menu shell first, we might get grab_broken
588 * events which will close the entire menu hierarchy. Selecting the
589 * menu item also fixes up the state as if enter_notify() would
590 * have run before (which normally selects the item).
592 if (GTK_MENU_SHELL_GET_CLASS (menu_item->parent)->submenu_placement != GTK_TOP_BOTTOM)
594 gtk_menu_shell_select_item (GTK_MENU_SHELL (menu_item->parent), menu_item);
598 if (!menu_shell->active || !menu_shell->button)
600 _gtk_menu_shell_activate (menu_shell);
602 menu_shell->button = event->button;
604 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
605 menu_item->parent == widget &&
606 menu_item != menu_shell->active_menu_item)
608 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
610 menu_shell->activate_time = event->time;
611 gtk_menu_shell_select_item (menu_shell, menu_item);
617 widget = gtk_get_event_widget ((GdkEvent*) event);
618 if (widget == GTK_WIDGET (menu_shell))
620 gtk_menu_shell_deactivate (menu_shell);
621 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
625 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
626 GTK_MENU_ITEM (menu_item)->submenu != NULL &&
627 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
629 GtkMenuShellPrivate *priv;
631 _gtk_menu_item_popup_submenu (menu_item, FALSE);
633 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
634 priv->activated_submenu = TRUE;
641 gtk_menu_shell_grab_broken (GtkWidget *widget,
642 GdkEventGrabBroken *event)
644 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
646 if (menu_shell->have_xgrab && event->grab_window == NULL)
648 /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
651 gtk_menu_shell_deselect (menu_shell);
653 gtk_menu_shell_deactivate (menu_shell);
654 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
661 gtk_menu_shell_button_release (GtkWidget *widget,
662 GdkEventButton *event)
664 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
665 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (widget);
667 if (menu_shell->active)
669 GtkWidget *menu_item;
670 gboolean deactivate = TRUE;
672 if (menu_shell->button && (event->button != menu_shell->button))
674 menu_shell->button = 0;
675 if (menu_shell->parent_menu_shell)
676 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
679 menu_shell->button = 0;
680 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
682 if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
684 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
685 _gtk_menu_item_is_selectable (menu_item))
687 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->submenu;
691 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
695 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
696 priv->activated_submenu)
699 GTimeVal *popup_time;
700 gint64 usec_since_popup = 0;
702 g_object_get (gtk_widget_get_settings (widget),
703 "gtk-menu-popdown-delay", &popdown_delay,
706 popup_time = g_object_get_data (G_OBJECT (submenu),
707 "gtk-menu-exact-popup-time");
711 GTimeVal current_time;
713 g_get_current_time (¤t_time);
715 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
716 (gint64) current_time.tv_usec -
717 (gint64) popup_time->tv_sec * 1000 * 1000 -
718 (gint64) popup_time->tv_usec);
720 g_object_set_data (G_OBJECT (submenu),
721 "gtk-menu-exact-popup-time", NULL);
724 /* only close the submenu on click if we opened the
725 * menu explicitely (usec_since_popup == 0) or
726 * enough time has passed since it was opened by
727 * GtkMenuItem's timeout (usec_since_popup > delay).
729 if (!priv->activated_submenu &&
730 (usec_since_popup == 0 ||
731 usec_since_popup > popdown_delay * 1000))
733 _gtk_menu_item_popdown_submenu (menu_item);
737 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
743 else if (menu_item &&
744 !_gtk_menu_item_is_selectable (menu_item) &&
745 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
749 else if (menu_shell->parent_menu_shell)
751 menu_shell->active = TRUE;
752 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
756 /* If we ended up on an item with a submenu, leave the menu up.
758 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
759 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
764 else /* a very fast press-release */
766 /* We only ever want to prevent deactivation on the first
767 * press/release. Setting the time to zero is a bit of a
768 * hack, since we could be being triggered in the first
769 * few fractions of a second after a server time wraparound.
770 * the chances of that happening are ~1/10^6, without
771 * serious harm if we lose.
773 menu_shell->activate_time = 0;
779 gtk_menu_shell_deactivate (menu_shell);
780 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
783 priv->activated_submenu = FALSE;
790 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
791 gboolean keyboard_mode)
793 menu_shell->keyboard_mode = keyboard_mode;
797 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
799 return menu_shell->keyboard_mode;
803 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
805 GtkMenuShell *target;
806 gboolean auto_mnemonics;
808 gboolean mnemonics_visible;
810 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
811 "gtk-auto-mnemonics", &auto_mnemonics, NULL);
820 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (target);
821 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
823 /* The idea with keyboard mode is that once you start using
824 * the keyboard to navigate the menus, we show mnemonics
825 * until the menu navigation is over. To that end, we spread
826 * the keyboard mode upwards in the menu hierarchy here.
827 * Also see gtk_menu_popup, where we inherit it downwards.
829 if (menu_shell->keyboard_mode)
830 target->keyboard_mode = TRUE;
832 /* While navigating menus, the first parent menu with an active
833 * item is the one where mnemonics are effective, as can be seen
834 * in gtk_menu_shell_key_press below.
835 * We also show mnemonics in context menus. The grab condition is
836 * necessary to ensure we remove underlines from menu bars when
839 mnemonics_visible = target->keyboard_mode &&
840 (((target->active_menu_item || priv->in_unselectable_item) && !found) ||
841 (target == menu_shell &&
842 !target->parent_menu_shell &&
843 gtk_widget_has_grab (GTK_WIDGET (target))));
845 /* While menus are up, only show underlines inside the menubar,
846 * not in the entire window.
848 if (GTK_IS_MENU_BAR (target))
850 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
851 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
855 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
857 if (target->active_menu_item || priv->in_unselectable_item)
860 target = GTK_MENU_SHELL (target->parent_menu_shell);
865 gtk_menu_shell_key_press (GtkWidget *widget,
868 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
869 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
870 gboolean enable_mnemonics;
872 menu_shell->keyboard_mode = TRUE;
874 if (!(menu_shell->active_menu_item || priv->in_unselectable_item) && menu_shell->parent_menu_shell)
875 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent *)event);
877 if (gtk_bindings_activate_event (GTK_OBJECT (widget), event))
880 g_object_get (gtk_widget_get_settings (widget),
881 "gtk-enable-mnemonics", &enable_mnemonics,
884 if (enable_mnemonics)
885 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
891 gtk_menu_shell_enter_notify (GtkWidget *widget,
892 GdkEventCrossing *event)
894 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
896 if (event->mode == GDK_CROSSING_GTK_GRAB ||
897 event->mode == GDK_CROSSING_GTK_UNGRAB ||
898 event->mode == GDK_CROSSING_STATE_CHANGED)
901 if (menu_shell->active)
903 GtkWidget *menu_item;
905 menu_item = gtk_get_event_widget ((GdkEvent*) event);
910 if (GTK_IS_MENU_ITEM (menu_item) &&
911 !_gtk_menu_item_is_selectable (menu_item))
913 GtkMenuShellPrivate *priv;
915 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
916 priv->in_unselectable_item = TRUE;
921 if (menu_item->parent == widget &&
922 GTK_IS_MENU_ITEM (menu_item))
924 if (menu_shell->ignore_enter)
927 if (event->detail != GDK_NOTIFY_INFERIOR)
929 if (gtk_widget_get_state (menu_item) != GTK_STATE_PRELIGHT)
930 gtk_menu_shell_select_item (menu_shell, menu_item);
932 /* If any mouse button is down, and there is a submenu
933 * that is not yet visible, activate it. It's sufficient
934 * to check for any button's mask (not only the one
935 * matching menu_shell->button), because there is no
936 * situation a mouse button could be pressed while
937 * entering a menu item where we wouldn't want to show
940 if ((event->state & (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)) &&
941 GTK_MENU_ITEM (menu_item)->submenu != NULL)
943 GtkMenuShellPrivate *priv;
945 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
946 priv->activated_submenu = TRUE;
948 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
950 gboolean touchscreen_mode;
952 g_object_get (gtk_widget_get_settings (widget),
953 "gtk-touchscreen-mode", &touchscreen_mode,
956 if (touchscreen_mode)
957 _gtk_menu_item_popup_submenu (menu_item, TRUE);
962 else if (menu_shell->parent_menu_shell)
964 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
972 gtk_menu_shell_leave_notify (GtkWidget *widget,
973 GdkEventCrossing *event)
975 if (event->mode == GDK_CROSSING_GTK_GRAB ||
976 event->mode == GDK_CROSSING_GTK_GRAB ||
977 event->mode == GDK_CROSSING_STATE_CHANGED)
980 if (gtk_widget_get_visible (widget))
982 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
983 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
984 GtkMenuItem *menu_item;
986 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
989 menu_item = GTK_MENU_ITEM (event_widget);
991 if (!_gtk_menu_item_is_selectable (event_widget))
993 GtkMenuShellPrivate *priv;
995 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
996 priv->in_unselectable_item = TRUE;
1001 if ((menu_shell->active_menu_item == event_widget) &&
1002 (menu_item->submenu == NULL))
1004 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1005 (gtk_widget_get_state (GTK_WIDGET (menu_item)) != GTK_STATE_NORMAL))
1007 gtk_menu_shell_deselect (menu_shell);
1010 else if (menu_shell->parent_menu_shell)
1012 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
1020 gtk_menu_shell_screen_changed (GtkWidget *widget,
1021 GdkScreen *previous_screen)
1023 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1027 gtk_menu_shell_add (GtkContainer *container,
1030 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1034 gtk_menu_shell_remove (GtkContainer *container,
1037 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1040 was_visible = gtk_widget_get_visible (widget);
1041 menu_shell->children = g_list_remove (menu_shell->children, widget);
1043 if (widget == menu_shell->active_menu_item)
1045 gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
1046 menu_shell->active_menu_item = NULL;
1049 gtk_widget_unparent (widget);
1051 /* queue resize regardless of gtk_widget_get_visible (container),
1052 * since that's what is needed by toplevels.
1055 gtk_widget_queue_resize (GTK_WIDGET (container));
1059 gtk_menu_shell_forall (GtkContainer *container,
1060 gboolean include_internals,
1061 GtkCallback callback,
1062 gpointer callback_data)
1064 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1068 children = menu_shell->children;
1071 child = children->data;
1072 children = children->next;
1074 (* callback) (child, callback_data);
1080 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1082 if (menu_shell->active)
1084 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1086 menu_shell->button = 0;
1087 menu_shell->active = FALSE;
1088 menu_shell->activate_time = 0;
1090 if (menu_shell->active_menu_item)
1092 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1093 menu_shell->active_menu_item = NULL;
1096 if (menu_shell->have_grab)
1098 menu_shell->have_grab = FALSE;
1099 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1101 if (menu_shell->have_xgrab)
1103 GdkDevice *keyboard;
1105 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1106 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1109 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1111 menu_shell->have_xgrab = FALSE;
1114 menu_shell->keyboard_mode = FALSE;
1115 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1117 _gtk_menu_shell_update_mnemonics (menu_shell);
1122 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1127 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1128 g_return_val_if_fail (child != NULL, FALSE);
1130 parent = child->parent;
1131 while (GTK_IS_MENU_SHELL (parent))
1133 if (parent == (GtkWidget*) menu_shell)
1135 parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
1142 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1145 GtkWidget *menu_item;
1147 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1149 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1150 menu_item = menu_item->parent;
1152 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1158 /* Handlers for action signals */
1161 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1162 GtkWidget *menu_item)
1164 GtkMenuShellClass *class;
1166 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1167 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1169 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1171 if (class->select_item &&
1172 !(menu_shell->active &&
1173 menu_shell->active_menu_item == menu_item))
1174 class->select_item (menu_shell, menu_item);
1177 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1178 GtkSubmenuPlacement placement);
1181 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1182 GtkWidget *menu_item)
1184 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1186 if (menu_shell->active_menu_item)
1188 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1189 menu_shell->active_menu_item = NULL;
1192 if (!_gtk_menu_item_is_selectable (menu_item))
1194 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1196 priv->in_unselectable_item = TRUE;
1197 _gtk_menu_shell_update_mnemonics (menu_shell);
1202 menu_shell->active_menu_item = menu_item;
1203 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1204 _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
1207 _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
1208 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1209 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
1211 _gtk_menu_shell_update_mnemonics (menu_shell);
1213 /* This allows the bizarre radio buttons-with-submenus-display-history
1216 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1217 gtk_widget_activate (menu_shell->active_menu_item);
1221 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1223 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1225 if (menu_shell->active_menu_item)
1227 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1228 menu_shell->active_menu_item = NULL;
1229 _gtk_menu_shell_update_mnemonics (menu_shell);
1234 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1235 GtkWidget *menu_item,
1236 gboolean force_deactivate)
1238 GSList *slist, *shells = NULL;
1239 gboolean deactivate = force_deactivate;
1241 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1242 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1245 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1247 g_object_ref (menu_shell);
1248 g_object_ref (menu_item);
1252 GtkMenuShell *parent_menu_shell = menu_shell;
1256 g_object_ref (parent_menu_shell);
1257 shells = g_slist_prepend (shells, parent_menu_shell);
1258 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->parent_menu_shell;
1260 while (parent_menu_shell);
1261 shells = g_slist_reverse (shells);
1263 gtk_menu_shell_deactivate (menu_shell);
1265 /* flush the x-queue, so any grabs are removed and
1266 * the menu is actually taken down
1268 gdk_display_sync (gtk_widget_get_display (menu_item));
1271 gtk_widget_activate (menu_item);
1273 for (slist = shells; slist; slist = slist->next)
1275 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1276 g_object_unref (slist->data);
1278 g_slist_free (shells);
1280 g_object_unref (menu_shell);
1281 g_object_unref (menu_item);
1284 /* Distance should be +/- 1 */
1286 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1289 if (menu_shell->active_menu_item)
1291 GList *node = g_list_find (menu_shell->children,
1292 menu_shell->active_menu_item);
1293 GList *start_node = node;
1294 gboolean wrap_around;
1296 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1297 "gtk-keynav-wrap-around", &wrap_around,
1303 while (node != start_node &&
1304 (!node || !_gtk_menu_item_is_selectable (node->data)))
1308 else if (wrap_around)
1309 node = menu_shell->children;
1312 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1320 while (node != start_node &&
1321 (!node || !_gtk_menu_item_is_selectable (node->data)))
1325 else if (wrap_around)
1326 node = g_list_last (menu_shell->children);
1329 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1336 gtk_menu_shell_select_item (menu_shell, node->data);
1342 /* Distance should be +/- 1 */
1344 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1347 gboolean handled = FALSE;
1349 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1350 distance, &handled);
1354 * gtk_menu_shell_select_first:
1355 * @menu_shell: a #GtkMenuShell
1356 * @search_sensitive: if %TRUE, search for the first selectable
1357 * menu item, otherwise select nothing if
1358 * the first item isn't sensitive. This
1359 * should be %FALSE if the menu is being
1360 * popped up initially.
1362 * Select the first visible or selectable child of the menu shell;
1363 * don't select tearoff items unless the only item is a tearoff
1369 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1370 gboolean search_sensitive)
1372 GtkWidget *to_select = NULL;
1375 tmp_list = menu_shell->children;
1378 GtkWidget *child = tmp_list->data;
1380 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1381 _gtk_menu_item_is_selectable (child))
1384 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1388 tmp_list = tmp_list->next;
1392 gtk_menu_shell_select_item (menu_shell, to_select);
1396 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1397 gboolean search_sensitive)
1399 GtkWidget *to_select = NULL;
1402 tmp_list = g_list_last (menu_shell->children);
1405 GtkWidget *child = tmp_list->data;
1407 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1408 _gtk_menu_item_is_selectable (child))
1411 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1415 tmp_list = tmp_list->prev;
1419 gtk_menu_shell_select_item (menu_shell, to_select);
1423 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1425 GtkMenuItem *menu_item;
1427 if (menu_shell->active_menu_item == NULL)
1430 menu_item = GTK_MENU_ITEM (menu_shell->active_menu_item);
1432 if (menu_item->submenu)
1434 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1435 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1436 if (GTK_MENU_SHELL (menu_item->submenu)->active_menu_item)
1444 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1445 GtkMenuDirectionType direction)
1447 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1448 GtkMenuShell *parent_menu_shell = NULL;
1449 gboolean had_selection;
1450 gboolean touchscreen_mode;
1452 priv->in_unselectable_item = FALSE;
1454 had_selection = menu_shell->active_menu_item != NULL;
1456 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1457 "gtk-touchscreen-mode", &touchscreen_mode,
1460 if (menu_shell->parent_menu_shell)
1461 parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1465 case GTK_MENU_DIR_PARENT:
1466 if (touchscreen_mode &&
1467 menu_shell->active_menu_item &&
1468 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu &&
1469 gtk_widget_get_visible (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu))
1471 /* if we are on a menu item that has an open submenu but the
1472 * focus is not in that submenu (e.g. because it's empty or
1473 * has only insensitive items), close that submenu instead
1474 * of running into the code below which would close *this*
1477 _gtk_menu_item_popdown_submenu (menu_shell->active_menu_item);
1478 _gtk_menu_shell_update_mnemonics (menu_shell);
1480 else if (parent_menu_shell)
1482 if (touchscreen_mode)
1484 /* close menu when returning from submenu. */
1485 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->parent_menu_item);
1486 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1490 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1491 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1492 gtk_menu_shell_deselect (menu_shell);
1495 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1496 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1498 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1499 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1502 /* If there is no parent and the submenu is in the opposite direction
1503 * to the menu, then make the PARENT direction wrap around to
1504 * the bottom of the submenu.
1506 else if (menu_shell->active_menu_item &&
1507 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1508 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1510 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu);
1512 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1513 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1514 _gtk_menu_shell_select_last (submenu, TRUE);
1518 case GTK_MENU_DIR_CHILD:
1519 if (menu_shell->active_menu_item &&
1520 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1521 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1523 if (gtk_menu_shell_select_submenu_first (menu_shell))
1527 /* Try to find a menu running the opposite direction */
1528 while (parent_menu_shell &&
1529 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1530 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1532 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->parent_menu_shell);
1535 if (parent_menu_shell)
1537 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1538 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1540 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1542 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1546 case GTK_MENU_DIR_PREV:
1547 gtk_menu_shell_move_selected (menu_shell, -1);
1548 if (!had_selection &&
1549 !menu_shell->active_menu_item &&
1550 menu_shell->children)
1551 _gtk_menu_shell_select_last (menu_shell, TRUE);
1554 case GTK_MENU_DIR_NEXT:
1555 gtk_menu_shell_move_selected (menu_shell, 1);
1556 if (!had_selection &&
1557 !menu_shell->active_menu_item &&
1558 menu_shell->children)
1559 gtk_menu_shell_select_first (menu_shell, TRUE);
1565 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1566 gboolean force_hide)
1568 if (menu_shell->active_menu_item &&
1569 _gtk_menu_item_is_selectable (menu_shell->active_menu_item))
1571 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu == NULL)
1572 gtk_menu_shell_activate_item (menu_shell,
1573 menu_shell->active_menu_item,
1576 _gtk_menu_item_popup_submenu (menu_shell->active_menu_item, FALSE);
1581 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1583 /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
1585 gtk_menu_shell_deselect (menu_shell);
1587 gtk_menu_shell_deactivate (menu_shell);
1588 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1592 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1593 GtkDirectionType dir)
1595 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1597 if (menu_shell->parent_menu_shell)
1598 menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1604 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1608 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1610 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1612 if (klass->get_popup_delay)
1614 return klass->get_popup_delay (menu_shell);
1619 GtkWidget *widget = GTK_WIDGET (menu_shell);
1621 g_object_get (gtk_widget_get_settings (widget),
1622 "gtk-menu-popup-delay", &popup_delay,
1630 * gtk_menu_shell_cancel:
1631 * @menu_shell: a #GtkMenuShell
1633 * Cancels the selection within the menu shell.
1638 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1640 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1642 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1645 static GtkMnemonicHash *
1646 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1649 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1651 if (!private->mnemonic_hash && create)
1652 private->mnemonic_hash = _gtk_mnemonic_hash_new ();
1654 return private->mnemonic_hash;
1658 menu_shell_add_mnemonic_foreach (guint keyval,
1662 GtkKeyHash *key_hash = data;
1664 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1668 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1671 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1672 GtkWidget *widget = GTK_WIDGET (menu_shell);
1674 if (!private->key_hash && create && gtk_widget_has_screen (widget))
1676 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1677 GdkScreen *screen = gtk_widget_get_screen (widget);
1678 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1683 private->key_hash = _gtk_key_hash_new (keymap, NULL);
1685 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1686 menu_shell_add_mnemonic_foreach,
1690 return private->key_hash;
1694 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1696 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1698 if (private->key_hash)
1700 _gtk_key_hash_free (private->key_hash);
1701 private->key_hash = NULL;
1706 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1709 GtkMnemonicHash *mnemonic_hash;
1710 GtkKeyHash *key_hash;
1712 gboolean result = FALSE;
1714 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1718 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1722 entries = _gtk_key_hash_lookup (key_hash,
1723 event->hardware_keycode,
1725 gtk_accelerator_get_default_mod_mask (),
1729 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1730 GPOINTER_TO_UINT (entries->data));
1736 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1740 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1741 g_return_if_fail (GTK_IS_WIDGET (target));
1743 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1745 gtk_menu_shell_reset_key_hash (menu_shell);
1749 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1753 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1754 g_return_if_fail (GTK_IS_WIDGET (target));
1756 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1758 gtk_menu_shell_reset_key_hash (menu_shell);
1762 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1765 GtkMenuShellPrivate *priv;
1767 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1768 g_return_if_fail (!device || GDK_IS_DEVICE (device));
1770 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1773 priv->grab_pointer = NULL;
1774 else if (device->source == GDK_SOURCE_KEYBOARD)
1775 priv->grab_pointer = gdk_device_get_associated_device (device);
1777 priv->grab_pointer = device;
1781 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1783 GtkMenuShellPrivate *priv;
1785 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1787 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1789 return priv->grab_pointer;
1793 * gtk_menu_shell_get_take_focus:
1794 * @menu_shell: a #GtkMenuShell
1796 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1798 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1803 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1805 GtkMenuShellPrivate *priv;
1807 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1809 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1811 return priv->take_focus;
1815 * gtk_menu_shell_set_take_focus:
1816 * @menu_shell: a #GtkMenuShell
1817 * @take_focus: %TRUE if the menu shell should take the keyboard focus on popup.
1819 * If @take_focus is %TRUE (the default) the menu shell will take the keyboard
1820 * focus so that it will receive all keyboard events which is needed to enable
1821 * keyboard navigation in menus.
1823 * Setting @take_focus to %FALSE is useful only for special applications
1824 * like virtual keyboard implementations which should not take keyboard
1827 * The @take_focus state of a menu or menu bar is automatically propagated
1828 * to submenus whenever a submenu is popped up, so you don't have to worry
1829 * about recursively setting it for your entire menu hierarchy. Only when
1830 * programmatically picking a submenu and popping it up manually, the
1831 * @take_focus property of the submenu needs to be set explicitely.
1833 * Note that setting it to %FALSE has side-effects:
1835 * If the focus is in some other app, it keeps the focus and keynav in
1836 * the menu doesn't work. Consequently, keynav on the menu will only
1837 * work if the focus is on some toplevel owned by the onscreen keyboard.
1839 * To avoid confusing the user, menus with @take_focus set to %FALSE
1840 * should not display mnemonics or accelerators, since it cannot be
1841 * guaranteed that they will work.
1843 * See also gdk_keyboard_grab()
1848 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1849 gboolean take_focus)
1851 GtkMenuShellPrivate *priv;
1853 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1855 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1857 if (priv->take_focus != take_focus)
1859 priv->take_focus = take_focus;
1860 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1864 #define __GTK_MENU_SHELL_C__
1865 #include "gtkaliasdef.c"