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/.
29 #include "gtkbindings.h"
30 #include "gtkkeyhash.h"
32 #include "gtkmainprivate.h"
33 #include "gtkmarshalers.h"
34 #include "gtkmenubar.h"
35 #include "gtkmenuitemprivate.h"
36 #include "gtkmenushellprivate.h"
37 #include "gtkmenuprivate.h"
38 #include "gtkmnemonichash.h"
39 #include "gtktearoffmenuitem.h"
40 #include "gtkwindow.h"
41 #include "gtkprivate.h"
43 #include "gtktypebuiltins.h"
45 #define MENU_SHELL_TIMEOUT 500
47 #define PACK_DIRECTION(m) \
48 (GTK_IS_MENU_BAR (m) \
49 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
50 : GTK_PACK_DIRECTION_LTR)
70 * A menu item can be "selected", this means that it is displayed
71 * in the prelight state, and if it has a submenu, that submenu
74 * A menu is "active" when it is visible onscreen and the user
75 * is selecting from it. A menubar is not active until the user
76 * clicks on one of its menuitems. When a menu is active,
77 * passing the mouse over a submenu will pop it up.
79 * menu_shell->active_menu_item, is however, not an "active"
80 * menu item (there is no such thing) but rather, the selected
81 * menu item in that MenuShell, if there is one.
83 * There is also is a concept of the current menu and a current
84 * menu item. The current menu item is the selected menu item
85 * that is furthest down in the hierarchy. (Every active menu_shell
86 * does not necessarily contain a selected menu item, but if
87 * it does, then menu_shell->parent_menu_shell must also contain
88 * a selected menu item. The current menu is the menu that
89 * contains the current menu_item. It will always have a GTK
90 * grab and receive all key presses.
95 * ::move_current (GtkMenuDirection *dir)
96 * Moves the current menu item in direction 'dir':
98 * GTK_MENU_DIR_PARENT: To the parent menu shell
99 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
101 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
104 * As a a bit of a hack to get movement between menus and
105 * menubars working, if submenu_placement is different for
106 * the menu and its MenuShell then the following apply:
108 * - For 'parent' the current menu is not just moved to
109 * the parent, but moved to the previous entry in the parent
110 * - For 'child', if there is no child, then current is
111 * moved to the next item in the parent.
113 * Note that the above explanation of ::move_current was written
114 * before menus and menubars had support for RTL flipping and
115 * different packing directions, and therefore only applies for
116 * when text direction and packing direction are both left-to-right.
118 * ::activate_current (GBoolean *force_hide)
119 * Activate the current item. If 'force_hide' is true, hide
120 * the current menu item always. Otherwise, only hide
121 * it if menu_item->klass->hide_on_activate is true.
124 * Cancels the current selection
128 static void gtk_menu_shell_set_property (GObject *object,
132 static void gtk_menu_shell_get_property (GObject *object,
136 static void gtk_menu_shell_realize (GtkWidget *widget);
137 static void gtk_menu_shell_finalize (GObject *object);
138 static void gtk_menu_shell_dispose (GObject *object);
139 static gint gtk_menu_shell_button_press (GtkWidget *widget,
140 GdkEventButton *event);
141 static gint gtk_menu_shell_button_release (GtkWidget *widget,
142 GdkEventButton *event);
143 static gint gtk_menu_shell_key_press (GtkWidget *widget,
145 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
146 GdkEventCrossing *event);
147 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
148 GdkEventCrossing *event);
149 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
150 GdkScreen *previous_screen);
151 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
152 GdkEventGrabBroken *event);
153 static void gtk_menu_shell_add (GtkContainer *container,
155 static void gtk_menu_shell_remove (GtkContainer *container,
157 static void gtk_menu_shell_forall (GtkContainer *container,
158 gboolean include_internals,
159 GtkCallback callback,
160 gpointer callback_data);
161 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
164 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
165 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
167 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
169 static GType gtk_menu_shell_child_type (GtkContainer *container);
170 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
171 GtkWidget *menu_item);
172 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
174 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
175 GtkMenuDirectionType direction);
176 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
177 gboolean force_hide);
178 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
179 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
180 GtkDirectionType dir);
182 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
183 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
185 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
188 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
190 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
193 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
195 GObjectClass *object_class;
196 GtkWidgetClass *widget_class;
197 GtkContainerClass *container_class;
199 GtkBindingSet *binding_set;
201 object_class = (GObjectClass*) klass;
202 widget_class = (GtkWidgetClass*) klass;
203 container_class = (GtkContainerClass*) klass;
205 object_class->set_property = gtk_menu_shell_set_property;
206 object_class->get_property = gtk_menu_shell_get_property;
207 object_class->finalize = gtk_menu_shell_finalize;
208 object_class->dispose = gtk_menu_shell_dispose;
210 widget_class->realize = gtk_menu_shell_realize;
211 widget_class->button_press_event = gtk_menu_shell_button_press;
212 widget_class->button_release_event = gtk_menu_shell_button_release;
213 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
214 widget_class->key_press_event = gtk_menu_shell_key_press;
215 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
216 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
217 widget_class->screen_changed = gtk_menu_shell_screen_changed;
219 container_class->add = gtk_menu_shell_add;
220 container_class->remove = gtk_menu_shell_remove;
221 container_class->forall = gtk_menu_shell_forall;
222 container_class->child_type = gtk_menu_shell_child_type;
224 klass->submenu_placement = GTK_TOP_BOTTOM;
225 klass->deactivate = gtk_real_menu_shell_deactivate;
226 klass->selection_done = NULL;
227 klass->move_current = gtk_real_menu_shell_move_current;
228 klass->activate_current = gtk_real_menu_shell_activate_current;
229 klass->cancel = gtk_real_menu_shell_cancel;
230 klass->select_item = gtk_menu_shell_real_select_item;
231 klass->insert = gtk_menu_shell_real_insert;
232 klass->move_selected = gtk_menu_shell_real_move_selected;
234 menu_shell_signals[DEACTIVATE] =
235 g_signal_new (I_("deactivate"),
236 G_OBJECT_CLASS_TYPE (object_class),
238 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
240 _gtk_marshal_VOID__VOID,
243 menu_shell_signals[SELECTION_DONE] =
244 g_signal_new (I_("selection-done"),
245 G_OBJECT_CLASS_TYPE (object_class),
247 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
249 _gtk_marshal_VOID__VOID,
252 menu_shell_signals[MOVE_CURRENT] =
253 g_signal_new (I_("move-current"),
254 G_OBJECT_CLASS_TYPE (object_class),
255 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
256 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
258 _gtk_marshal_VOID__ENUM,
260 GTK_TYPE_MENU_DIRECTION_TYPE);
262 menu_shell_signals[ACTIVATE_CURRENT] =
263 g_signal_new (I_("activate-current"),
264 G_OBJECT_CLASS_TYPE (object_class),
265 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
266 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
268 _gtk_marshal_VOID__BOOLEAN,
272 menu_shell_signals[CANCEL] =
273 g_signal_new (I_("cancel"),
274 G_OBJECT_CLASS_TYPE (object_class),
275 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
276 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
278 _gtk_marshal_VOID__VOID,
281 menu_shell_signals[CYCLE_FOCUS] =
282 g_signal_new_class_handler (I_("cycle-focus"),
283 G_OBJECT_CLASS_TYPE (object_class),
284 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
285 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
287 _gtk_marshal_VOID__ENUM,
289 GTK_TYPE_DIRECTION_TYPE);
292 * GtkMenuShell::move-selected:
293 * @menu_shell: the object on which the signal is emitted
294 * @distance: +1 to move to the next item, -1 to move to the previous
296 * The ::move-selected signal is emitted to move the selection to
299 * Returns: %TRUE to stop the signal emission, %FALSE to continue
303 menu_shell_signals[MOVE_SELECTED] =
304 g_signal_new (I_("move-selected"),
305 G_OBJECT_CLASS_TYPE (object_class),
307 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
308 _gtk_boolean_handled_accumulator, NULL,
309 _gtk_marshal_BOOLEAN__INT,
313 binding_set = gtk_binding_set_by_class (klass);
314 gtk_binding_entry_add_signal (binding_set,
317 gtk_binding_entry_add_signal (binding_set,
319 "activate-current", 1,
322 gtk_binding_entry_add_signal (binding_set,
323 GDK_KEY_ISO_Enter, 0,
324 "activate-current", 1,
327 gtk_binding_entry_add_signal (binding_set,
329 "activate-current", 1,
332 gtk_binding_entry_add_signal (binding_set,
334 "activate-current", 1,
337 gtk_binding_entry_add_signal (binding_set,
339 "activate-current", 1,
342 gtk_binding_entry_add_signal (binding_set,
345 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
346 gtk_binding_entry_add_signal (binding_set,
347 GDK_KEY_F10, GDK_SHIFT_MASK,
349 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
352 * GtkMenuShell:take-focus:
354 * A boolean that determines whether the menu and its submenus grab the
355 * keyboard focus. See gtk_menu_shell_set_take_focus() and
356 * gtk_menu_shell_get_take_focus().
360 g_object_class_install_property (object_class,
362 g_param_spec_boolean ("take-focus",
364 P_("A boolean that determines whether the menu grabs the keyboard focus"),
366 GTK_PARAM_READWRITE));
368 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
372 gtk_menu_shell_child_type (GtkContainer *container)
374 return GTK_TYPE_MENU_ITEM;
378 gtk_menu_shell_init (GtkMenuShell *menu_shell)
380 GtkMenuShellPrivate *priv;
382 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_shell,
384 GtkMenuShellPrivate);
385 menu_shell->priv = priv;
386 priv->take_focus = TRUE;
390 gtk_menu_shell_set_property (GObject *object,
395 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
399 case PROP_TAKE_FOCUS:
400 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
403 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
409 gtk_menu_shell_get_property (GObject *object,
414 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
418 case PROP_TAKE_FOCUS:
419 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
422 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
428 gtk_menu_shell_finalize (GObject *object)
430 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
431 GtkMenuShellPrivate *priv = menu_shell->priv;
433 if (priv->mnemonic_hash)
434 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
436 _gtk_key_hash_free (priv->key_hash);
438 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
443 gtk_menu_shell_dispose (GObject *object)
445 gtk_menu_shell_deactivate (GTK_MENU_SHELL (object));
447 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->dispose (object);
451 gtk_menu_shell_append (GtkMenuShell *menu_shell,
454 gtk_menu_shell_insert (menu_shell, child, -1);
458 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
461 gtk_menu_shell_insert (menu_shell, child, 0);
465 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
469 GtkMenuShellClass *class;
471 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
472 g_return_if_fail (GTK_IS_MENU_ITEM (child));
474 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
477 class->insert (menu_shell, child, position);
481 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
485 GtkMenuShellPrivate *priv = menu_shell->priv;
487 priv->children = g_list_insert (priv->children, child, position);
489 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
493 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
495 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
497 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
501 gtk_menu_shell_realize (GtkWidget *widget)
503 GtkAllocation allocation;
505 GdkWindowAttr attributes;
506 gint attributes_mask;
507 GtkStyleContext *context;
509 gtk_widget_set_realized (widget, TRUE);
511 gtk_widget_get_allocation (widget, &allocation);
513 attributes.x = allocation.x;
514 attributes.y = allocation.y;
515 attributes.width = allocation.width;
516 attributes.height = allocation.height;
517 attributes.window_type = GDK_WINDOW_CHILD;
518 attributes.wclass = GDK_INPUT_OUTPUT;
519 attributes.visual = gtk_widget_get_visual (widget);
520 attributes.event_mask = gtk_widget_get_events (widget);
521 attributes.event_mask |= (GDK_EXPOSURE_MASK |
522 GDK_BUTTON_PRESS_MASK |
523 GDK_BUTTON_RELEASE_MASK |
525 GDK_ENTER_NOTIFY_MASK |
526 GDK_LEAVE_NOTIFY_MASK);
528 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
530 window = gdk_window_new (gtk_widget_get_parent_window (widget),
531 &attributes, attributes_mask);
532 gtk_widget_set_window (widget, window);
533 gdk_window_set_user_data (window, widget);
535 context = gtk_widget_get_style_context (widget);
536 gtk_style_context_set_background (context, window);
540 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
542 GtkMenuShellPrivate *priv = menu_shell->priv;
548 device = gtk_get_current_event_device ();
550 _gtk_menu_shell_set_grab_device (menu_shell, device);
551 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
553 priv->have_grab = TRUE;
559 gtk_menu_shell_button_press (GtkWidget *widget,
560 GdkEventButton *event)
562 GtkMenuShell *menu_shell;
563 GtkMenuShellPrivate *priv;
564 GtkWidget *menu_item;
567 if (event->type != GDK_BUTTON_PRESS)
570 menu_shell = GTK_MENU_SHELL (widget);
571 priv = menu_shell->priv;
573 if (priv->parent_menu_shell)
574 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
576 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
578 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
580 parent = gtk_widget_get_parent (menu_item);
582 if (menu_item != GTK_MENU_SHELL (parent)->priv->active_menu_item)
584 /* select the menu item *before* activating the shell, so submenus
585 * which might be open are closed the friendly way. If we activate
586 * (and thus grab) this menu shell first, we might get grab_broken
587 * events which will close the entire menu hierarchy. Selecting the
588 * menu item also fixes up the state as if enter_notify() would
589 * have run before (which normally selects the item).
591 if (GTK_MENU_SHELL_GET_CLASS (parent)->submenu_placement != GTK_TOP_BOTTOM)
592 gtk_menu_shell_select_item (GTK_MENU_SHELL (parent), menu_item);
596 if (!priv->active || !priv->button)
598 gboolean initially_active = priv->active;
600 priv->button = event->button;
604 if (_gtk_menu_item_is_selectable (menu_item) &&
605 gtk_widget_get_parent (menu_item) == widget &&
606 menu_item != priv->active_menu_item)
608 _gtk_menu_shell_activate (menu_shell);
609 priv->button = event->button;
611 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
613 priv->activate_time = event->time;
614 gtk_menu_shell_select_item (menu_shell, menu_item);
620 if (!initially_active)
622 gboolean window_drag = FALSE;
624 gtk_widget_style_get (widget,
625 "window-dragging", &window_drag,
630 gtk_menu_shell_deactivate (menu_shell);
631 gtk_window_begin_move_drag (GTK_WINDOW (gtk_widget_get_toplevel (widget)),
642 widget = gtk_get_event_widget ((GdkEvent*) event);
643 if (widget == GTK_WIDGET (menu_shell))
645 gtk_menu_shell_deactivate (menu_shell);
646 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
651 _gtk_menu_item_is_selectable (menu_item) &&
652 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL &&
653 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
655 _gtk_menu_item_popup_submenu (menu_item, FALSE);
656 priv->activated_submenu = TRUE;
663 gtk_menu_shell_grab_broken (GtkWidget *widget,
664 GdkEventGrabBroken *event)
666 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
667 GtkMenuShellPrivate *priv = menu_shell->priv;
669 if (priv->have_xgrab && event->grab_window == NULL)
671 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
672 gtk_menu_shell_deselect (menu_shell);
673 gtk_menu_shell_deactivate (menu_shell);
674 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
681 gtk_menu_shell_button_release (GtkWidget *widget,
682 GdkEventButton *event)
684 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
685 GtkMenuShellPrivate *priv = menu_shell->priv;
689 GtkWidget *menu_item;
690 gboolean deactivate = TRUE;
692 if (priv->button && (event->button != priv->button))
695 if (priv->parent_menu_shell)
696 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
700 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
702 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
704 if (menu_item && (priv->active_menu_item == menu_item) &&
705 _gtk_menu_item_is_selectable (menu_item))
707 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->priv->submenu;
711 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
714 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
715 priv->activated_submenu)
718 GTimeVal *popup_time;
719 gint64 usec_since_popup = 0;
721 g_object_get (gtk_widget_get_settings (widget),
722 "gtk-menu-popdown-delay", &popdown_delay,
725 popup_time = g_object_get_data (G_OBJECT (submenu),
726 "gtk-menu-exact-popup-time");
730 GTimeVal current_time;
732 g_get_current_time (¤t_time);
734 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
735 (gint64) current_time.tv_usec -
736 (gint64) popup_time->tv_sec * 1000 * 1000 -
737 (gint64) popup_time->tv_usec);
739 g_object_set_data (G_OBJECT (submenu),
740 "gtk-menu-exact-popup-time", NULL);
743 /* Only close the submenu on click if we opened the
744 * menu explicitely (usec_since_popup == 0) or
745 * enough time has passed since it was opened by
746 * GtkMenuItem's timeout (usec_since_popup > delay).
748 if (!priv->activated_submenu &&
749 (usec_since_popup == 0 ||
750 usec_since_popup > popdown_delay * 1000))
752 _gtk_menu_item_popdown_submenu (menu_item);
756 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
762 else if (menu_item &&
763 !_gtk_menu_item_is_selectable (menu_item) &&
764 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
768 else if (priv->parent_menu_shell)
771 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
775 /* If we ended up on an item with a submenu, leave the menu up. */
777 (priv->active_menu_item == menu_item) &&
778 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
783 else /* a very fast press-release */
785 /* We only ever want to prevent deactivation on the first
786 * press/release. Setting the time to zero is a bit of a
787 * hack, since we could be being triggered in the first
788 * few fractions of a second after a server time wraparound.
789 * the chances of that happening are ~1/10^6, without
790 * serious harm if we lose.
792 priv->activate_time = 0;
798 gtk_menu_shell_deactivate (menu_shell);
799 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
802 priv->activated_submenu = FALSE;
809 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
810 gboolean keyboard_mode)
812 menu_shell->priv->keyboard_mode = keyboard_mode;
816 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
818 return menu_shell->priv->keyboard_mode;
822 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
824 GtkMenuShell *target;
825 gboolean auto_mnemonics;
827 gboolean mnemonics_visible;
829 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
830 "gtk-auto-mnemonics", &auto_mnemonics,
840 GtkMenuShellPrivate *priv = target->priv;
841 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
843 /* The idea with keyboard mode is that once you start using
844 * the keyboard to navigate the menus, we show mnemonics
845 * until the menu navigation is over. To that end, we spread
846 * the keyboard mode upwards in the menu hierarchy here.
847 * Also see gtk_menu_popup, where we inherit it downwards.
849 if (menu_shell->priv->keyboard_mode)
850 target->priv->keyboard_mode = TRUE;
852 /* While navigating menus, the first parent menu with an active
853 * item is the one where mnemonics are effective, as can be seen
854 * in gtk_menu_shell_key_press below.
855 * We also show mnemonics in context menus. The grab condition is
856 * necessary to ensure we remove underlines from menu bars when
859 mnemonics_visible = target->priv->keyboard_mode &&
860 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
861 (target == menu_shell &&
862 !target->priv->parent_menu_shell &&
863 gtk_widget_has_grab (GTK_WIDGET (target))));
865 /* While menus are up, only show underlines inside the menubar,
866 * not in the entire window.
868 if (GTK_IS_MENU_BAR (target))
870 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
871 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
875 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
877 if (target->priv->active_menu_item || priv->in_unselectable_item)
880 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
885 gtk_menu_shell_key_press (GtkWidget *widget,
888 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
889 GtkMenuShellPrivate *priv = menu_shell->priv;
890 gboolean enable_mnemonics;
892 priv->keyboard_mode = TRUE;
894 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
895 priv->parent_menu_shell)
896 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
898 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
901 g_object_get (gtk_widget_get_settings (widget),
902 "gtk-enable-mnemonics", &enable_mnemonics,
905 if (enable_mnemonics)
906 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
912 gtk_menu_shell_enter_notify (GtkWidget *widget,
913 GdkEventCrossing *event)
915 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
916 GtkMenuShellPrivate *priv = menu_shell->priv;
918 if (event->mode == GDK_CROSSING_GTK_GRAB ||
919 event->mode == GDK_CROSSING_GTK_UNGRAB ||
920 event->mode == GDK_CROSSING_STATE_CHANGED)
925 GtkWidget *menu_item;
928 menu_item = gtk_get_event_widget ((GdkEvent*) event);
933 if (GTK_IS_MENU_ITEM (menu_item) &&
934 !_gtk_menu_item_is_selectable (menu_item))
936 priv->in_unselectable_item = TRUE;
940 parent = gtk_widget_get_parent (menu_item);
941 if (parent == widget &&
942 GTK_IS_MENU_ITEM (menu_item))
944 if (priv->ignore_enter)
947 if (event->detail != GDK_NOTIFY_INFERIOR)
949 if ((gtk_widget_get_state_flags (menu_item) & GTK_STATE_FLAG_PRELIGHT) == 0)
950 gtk_menu_shell_select_item (menu_shell, menu_item);
952 /* If any mouse button is down, and there is a submenu
953 * that is not yet visible, activate it. It's sufficient
954 * to check for any button's mask (not only the one
955 * matching menu_shell->button), because there is no
956 * situation a mouse button could be pressed while
957 * entering a menu item where we wouldn't want to show
960 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
961 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL)
963 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
965 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
967 gboolean touchscreen_mode;
969 g_object_get (gtk_widget_get_settings (widget),
970 "gtk-touchscreen-mode", &touchscreen_mode,
973 if (touchscreen_mode)
974 _gtk_menu_item_popup_submenu (menu_item, TRUE);
979 else if (priv->parent_menu_shell)
981 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
989 gtk_menu_shell_leave_notify (GtkWidget *widget,
990 GdkEventCrossing *event)
992 if (event->mode == GDK_CROSSING_GTK_GRAB ||
993 event->mode == GDK_CROSSING_GTK_GRAB ||
994 event->mode == GDK_CROSSING_STATE_CHANGED)
997 if (gtk_widget_get_visible (widget))
999 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1000 GtkMenuShellPrivate *priv = menu_shell->priv;
1001 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
1002 GtkMenuItem *menu_item;
1004 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1007 menu_item = GTK_MENU_ITEM (event_widget);
1009 if (!_gtk_menu_item_is_selectable (event_widget))
1011 priv->in_unselectable_item = TRUE;
1015 if ((priv->active_menu_item == event_widget) &&
1016 (menu_item->priv->submenu == NULL))
1018 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1019 (gtk_widget_get_state_flags (GTK_WIDGET (menu_item)) & GTK_STATE_FLAG_PRELIGHT) != 0)
1021 gtk_menu_shell_deselect (menu_shell);
1024 else if (priv->parent_menu_shell)
1026 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1034 gtk_menu_shell_screen_changed (GtkWidget *widget,
1035 GdkScreen *previous_screen)
1037 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1041 gtk_menu_shell_add (GtkContainer *container,
1044 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1048 gtk_menu_shell_remove (GtkContainer *container,
1051 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1052 GtkMenuShellPrivate *priv = menu_shell->priv;
1055 was_visible = gtk_widget_get_visible (widget);
1056 priv->children = g_list_remove (priv->children, widget);
1058 if (widget == priv->active_menu_item)
1060 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1061 priv->active_menu_item = NULL;
1064 gtk_widget_unparent (widget);
1066 /* Queue resize regardless of gtk_widget_get_visible (container),
1067 * since that's what is needed by toplevels.
1070 gtk_widget_queue_resize (GTK_WIDGET (container));
1074 gtk_menu_shell_forall (GtkContainer *container,
1075 gboolean include_internals,
1076 GtkCallback callback,
1077 gpointer callback_data)
1079 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1083 children = menu_shell->priv->children;
1086 child = children->data;
1087 children = children->next;
1089 (* callback) (child, callback_data);
1095 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1097 GtkMenuShellPrivate *priv = menu_shell->priv;
1103 priv->active = FALSE;
1104 priv->activate_time = 0;
1106 if (priv->active_menu_item)
1108 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1109 priv->active_menu_item = NULL;
1112 if (priv->have_grab)
1114 priv->have_grab = FALSE;
1115 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1117 if (priv->have_xgrab)
1119 GdkDevice *keyboard;
1121 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1122 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1125 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1127 priv->have_xgrab = FALSE;
1130 priv->keyboard_mode = FALSE;
1131 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1133 _gtk_menu_shell_update_mnemonics (menu_shell);
1138 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1143 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1144 g_return_val_if_fail (child != NULL, FALSE);
1146 parent = gtk_widget_get_parent (child);
1147 while (GTK_IS_MENU_SHELL (parent))
1149 if (parent == (GtkWidget*) menu_shell)
1151 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1158 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1161 GtkWidget *menu_item;
1163 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1165 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1166 menu_item = gtk_widget_get_parent (menu_item);
1168 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1174 /* Handlers for action signals */
1177 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1178 GtkWidget *menu_item)
1180 GtkMenuShellPrivate *priv = menu_shell->priv;
1181 GtkMenuShellClass *class;
1183 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1184 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1186 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1188 if (class->select_item &&
1190 priv->active_menu_item == menu_item))
1191 class->select_item (menu_shell, menu_item);
1194 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1195 GtkSubmenuPlacement placement);
1198 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1199 GtkWidget *menu_item)
1201 GtkMenuShellPrivate *priv = menu_shell->priv;
1202 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1204 if (priv->active_menu_item)
1206 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1207 priv->active_menu_item = NULL;
1210 if (!_gtk_menu_item_is_selectable (menu_item))
1212 priv->in_unselectable_item = TRUE;
1213 _gtk_menu_shell_update_mnemonics (menu_shell);
1217 priv->active_menu_item = menu_item;
1218 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1219 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1222 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1223 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1224 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1226 _gtk_menu_shell_update_mnemonics (menu_shell);
1228 /* This allows the bizarre radio buttons-with-submenus-display-history
1231 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1232 gtk_widget_activate (priv->active_menu_item);
1236 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1238 GtkMenuShellPrivate *priv = menu_shell->priv;
1240 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1242 if (priv->active_menu_item)
1244 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1245 priv->active_menu_item = NULL;
1246 _gtk_menu_shell_update_mnemonics (menu_shell);
1251 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1252 GtkWidget *menu_item,
1253 gboolean force_deactivate)
1255 GSList *slist, *shells = NULL;
1256 gboolean deactivate = force_deactivate;
1258 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1259 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1262 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1264 g_object_ref (menu_shell);
1265 g_object_ref (menu_item);
1269 GtkMenuShell *parent_menu_shell = menu_shell;
1273 g_object_ref (parent_menu_shell);
1274 shells = g_slist_prepend (shells, parent_menu_shell);
1275 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1277 while (parent_menu_shell);
1278 shells = g_slist_reverse (shells);
1280 gtk_menu_shell_deactivate (menu_shell);
1282 /* Flush the x-queue, so any grabs are removed and
1283 * the menu is actually taken down
1285 gdk_display_sync (gtk_widget_get_display (menu_item));
1288 gtk_widget_activate (menu_item);
1290 for (slist = shells; slist; slist = slist->next)
1292 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1293 g_object_unref (slist->data);
1295 g_slist_free (shells);
1297 g_object_unref (menu_shell);
1298 g_object_unref (menu_item);
1301 /* Distance should be +/- 1 */
1303 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1306 GtkMenuShellPrivate *priv = menu_shell->priv;
1308 if (priv->active_menu_item)
1310 GList *node = g_list_find (priv->children, priv->active_menu_item);
1311 GList *start_node = node;
1312 gboolean wrap_around;
1314 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1315 "gtk-keynav-wrap-around", &wrap_around,
1321 while (node != start_node &&
1322 (!node || !_gtk_menu_item_is_selectable (node->data)))
1326 else if (wrap_around)
1327 node = priv->children;
1330 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1338 while (node != start_node &&
1339 (!node || !_gtk_menu_item_is_selectable (node->data)))
1343 else if (wrap_around)
1344 node = g_list_last (priv->children);
1347 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1354 gtk_menu_shell_select_item (menu_shell, node->data);
1360 /* Distance should be +/- 1 */
1362 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1365 gboolean handled = FALSE;
1367 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1368 distance, &handled);
1372 * gtk_menu_shell_select_first:
1373 * @menu_shell: a #GtkMenuShell
1374 * @search_sensitive: if %TRUE, search for the first selectable
1375 * menu item, otherwise select nothing if
1376 * the first item isn't sensitive. This
1377 * should be %FALSE if the menu is being
1378 * popped up initially.
1380 * Select the first visible or selectable child of the menu shell;
1381 * don't select tearoff items unless the only item is a tearoff
1387 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1388 gboolean search_sensitive)
1390 GtkMenuShellPrivate *priv = menu_shell->priv;
1391 GtkWidget *to_select = NULL;
1394 tmp_list = priv->children;
1397 GtkWidget *child = tmp_list->data;
1399 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1400 _gtk_menu_item_is_selectable (child))
1403 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1407 tmp_list = tmp_list->next;
1411 gtk_menu_shell_select_item (menu_shell, to_select);
1415 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1416 gboolean search_sensitive)
1418 GtkMenuShellPrivate *priv = menu_shell->priv;
1419 GtkWidget *to_select = NULL;
1422 tmp_list = g_list_last (priv->children);
1425 GtkWidget *child = tmp_list->data;
1427 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1428 _gtk_menu_item_is_selectable (child))
1431 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1435 tmp_list = tmp_list->prev;
1439 gtk_menu_shell_select_item (menu_shell, to_select);
1443 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1445 GtkMenuShellPrivate *priv = menu_shell->priv;
1446 GtkMenuItem *menu_item;
1448 if (priv->active_menu_item == NULL)
1451 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1453 if (menu_item->priv->submenu)
1455 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1456 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->priv->submenu), TRUE);
1457 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active_menu_item)
1465 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1466 GtkMenuDirectionType direction)
1468 GtkMenuShellPrivate *priv = menu_shell->priv;
1469 GtkMenuShell *parent_menu_shell = NULL;
1470 gboolean had_selection;
1471 gboolean touchscreen_mode;
1473 priv->in_unselectable_item = FALSE;
1475 had_selection = priv->active_menu_item != NULL;
1477 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1478 "gtk-touchscreen-mode", &touchscreen_mode,
1481 if (priv->parent_menu_shell)
1482 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1486 case GTK_MENU_DIR_PARENT:
1487 if (touchscreen_mode &&
1488 priv->active_menu_item &&
1489 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu &&
1490 gtk_widget_get_visible (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu))
1492 /* if we are on a menu item that has an open submenu but the
1493 * focus is not in that submenu (e.g. because it's empty or
1494 * has only insensitive items), close that submenu instead of
1495 * running into the code below which would close *this* menu.
1497 _gtk_menu_item_popdown_submenu (priv->active_menu_item);
1498 _gtk_menu_shell_update_mnemonics (menu_shell);
1500 else if (parent_menu_shell)
1502 if (touchscreen_mode)
1504 /* close menu when returning from submenu. */
1505 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->priv->parent_menu_item);
1506 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1510 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1511 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1512 gtk_menu_shell_deselect (menu_shell);
1515 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1516 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1518 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1519 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1522 /* If there is no parent and the submenu is in the opposite direction
1523 * to the menu, then make the PARENT direction wrap around to
1524 * the bottom of the submenu.
1526 else if (priv->active_menu_item &&
1527 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1528 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1530 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu);
1532 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1533 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1534 _gtk_menu_shell_select_last (submenu, TRUE);
1538 case GTK_MENU_DIR_CHILD:
1539 if (priv->active_menu_item &&
1540 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1541 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1543 if (gtk_menu_shell_select_submenu_first (menu_shell))
1547 /* Try to find a menu running the opposite direction */
1548 while (parent_menu_shell &&
1549 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1550 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1552 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1555 if (parent_menu_shell)
1557 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1558 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1560 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1562 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1566 case GTK_MENU_DIR_PREV:
1567 gtk_menu_shell_move_selected (menu_shell, -1);
1568 if (!had_selection && !priv->active_menu_item && priv->children)
1569 _gtk_menu_shell_select_last (menu_shell, TRUE);
1572 case GTK_MENU_DIR_NEXT:
1573 gtk_menu_shell_move_selected (menu_shell, 1);
1574 if (!had_selection && !priv->active_menu_item && priv->children)
1575 gtk_menu_shell_select_first (menu_shell, TRUE);
1581 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1582 gboolean force_hide)
1584 GtkMenuShellPrivate *priv = menu_shell->priv;
1586 if (priv->active_menu_item &&
1587 _gtk_menu_item_is_selectable (priv->active_menu_item))
1589 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu == NULL)
1590 gtk_menu_shell_activate_item (menu_shell,
1591 priv->active_menu_item,
1594 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1599 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1601 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1602 gtk_menu_shell_deselect (menu_shell);
1603 gtk_menu_shell_deactivate (menu_shell);
1604 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1608 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1609 GtkDirectionType dir)
1611 GtkMenuShellPrivate *priv = menu_shell->priv;
1613 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1615 if (priv->parent_menu_shell)
1616 menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1622 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1626 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1628 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1630 if (klass->get_popup_delay)
1632 return klass->get_popup_delay (menu_shell);
1637 GtkWidget *widget = GTK_WIDGET (menu_shell);
1639 g_object_get (gtk_widget_get_settings (widget),
1640 "gtk-menu-popup-delay", &popup_delay,
1648 * gtk_menu_shell_cancel:
1649 * @menu_shell: a #GtkMenuShell
1651 * Cancels the selection within the menu shell.
1656 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1658 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1660 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1663 static GtkMnemonicHash *
1664 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1667 GtkMenuShellPrivate *priv = menu_shell->priv;
1669 if (!priv->mnemonic_hash && create)
1670 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1672 return priv->mnemonic_hash;
1676 menu_shell_add_mnemonic_foreach (guint keyval,
1680 GtkKeyHash *key_hash = data;
1682 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1686 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1689 GtkMenuShellPrivate *priv = menu_shell->priv;
1690 GtkWidget *widget = GTK_WIDGET (menu_shell);
1692 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1694 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1695 GdkScreen *screen = gtk_widget_get_screen (widget);
1696 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1701 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1703 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1704 menu_shell_add_mnemonic_foreach,
1708 return priv->key_hash;
1712 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1714 GtkMenuShellPrivate *priv = menu_shell->priv;
1718 _gtk_key_hash_free (priv->key_hash);
1719 priv->key_hash = NULL;
1724 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1727 GtkMnemonicHash *mnemonic_hash;
1728 GtkKeyHash *key_hash;
1730 gboolean result = FALSE;
1732 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1736 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1740 entries = _gtk_key_hash_lookup (key_hash,
1741 event->hardware_keycode,
1743 gtk_accelerator_get_default_mod_mask (),
1747 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1748 GPOINTER_TO_UINT (entries->data));
1754 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1758 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1759 g_return_if_fail (GTK_IS_WIDGET (target));
1761 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1763 gtk_menu_shell_reset_key_hash (menu_shell);
1767 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1771 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1772 g_return_if_fail (GTK_IS_WIDGET (target));
1774 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1776 gtk_menu_shell_reset_key_hash (menu_shell);
1780 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1783 GtkMenuShellPrivate *priv = menu_shell->priv;
1785 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1786 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1789 priv->grab_pointer = NULL;
1790 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1791 priv->grab_pointer = gdk_device_get_associated_device (device);
1793 priv->grab_pointer = device;
1797 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1799 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1801 return menu_shell->priv->grab_pointer;
1805 * gtk_menu_shell_get_take_focus:
1806 * @menu_shell: a #GtkMenuShell
1808 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1810 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1815 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1817 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1819 return menu_shell->priv->take_focus;
1823 * gtk_menu_shell_set_take_focus:
1824 * @menu_shell: a #GtkMenuShell
1825 * @take_focus: %TRUE if the menu shell should take the keyboard
1828 * If @take_focus is %TRUE (the default) the menu shell will take
1829 * the keyboard focus so that it will receive all keyboard events
1830 * which is needed to enable keyboard navigation in menus.
1832 * Setting @take_focus to %FALSE is useful only for special applications
1833 * like virtual keyboard implementations which should not take keyboard
1836 * The @take_focus state of a menu or menu bar is automatically
1837 * propagated to submenus whenever a submenu is popped up, so you
1838 * don't have to worry about recursively setting it for your entire
1839 * menu hierarchy. Only when programmatically picking a submenu and
1840 * popping it up manually, the @take_focus property of the submenu
1841 * needs to be set explicitely.
1843 * Note that setting it to %FALSE has side-effects:
1845 * If the focus is in some other app, it keeps the focus and keynav in
1846 * the menu doesn't work. Consequently, keynav on the menu will only
1847 * work if the focus is on some toplevel owned by the onscreen keyboard.
1849 * To avoid confusing the user, menus with @take_focus set to %FALSE
1850 * should not display mnemonics or accelerators, since it cannot be
1851 * guaranteed that they will work.
1853 * See also gdk_keyboard_grab()
1858 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1859 gboolean take_focus)
1861 GtkMenuShellPrivate *priv = menu_shell->priv;
1863 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1865 if (priv->take_focus != take_focus)
1867 priv->take_focus = take_focus;
1868 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1873 * gtk_menu_shell_get_selected_item:
1874 * @menu_shell: a #GtkMenuShell
1876 * Gets the currently selected item.
1878 * Returns: the currently selected item
1883 gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell)
1885 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1887 return menu_shell->priv->active_menu_item;
1891 * gtk_menu_shell_get_parent_shell:
1892 * @menu_shell: a #GtkMenuShell
1894 * Gets the parent menu shell.
1896 * The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
1897 * from which it was opened up.
1899 * Returns: the parent #GtkMenuShell
1904 gtk_menu_shell_get_parent_shell (GtkMenuShell *menu_shell)
1906 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1908 return menu_shell->priv->parent_menu_shell;