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;
508 gtk_widget_set_realized (widget, TRUE);
510 gtk_widget_get_allocation (widget, &allocation);
512 attributes.x = allocation.x;
513 attributes.y = allocation.y;
514 attributes.width = allocation.width;
515 attributes.height = allocation.height;
516 attributes.window_type = GDK_WINDOW_CHILD;
517 attributes.wclass = GDK_INPUT_OUTPUT;
518 attributes.visual = gtk_widget_get_visual (widget);
519 attributes.event_mask = gtk_widget_get_events (widget);
520 attributes.event_mask |= (GDK_EXPOSURE_MASK |
521 GDK_BUTTON_PRESS_MASK |
522 GDK_BUTTON_RELEASE_MASK |
524 GDK_ENTER_NOTIFY_MASK |
525 GDK_LEAVE_NOTIFY_MASK);
527 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
529 window = gdk_window_new (gtk_widget_get_parent_window (widget),
530 &attributes, attributes_mask);
531 gtk_widget_set_window (widget, window);
532 gdk_window_set_user_data (window, widget);
534 gtk_widget_style_attach (widget);
535 gtk_style_set_background (gtk_widget_get_style (widget), window, GTK_STATE_NORMAL);
539 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
541 GtkMenuShellPrivate *priv = menu_shell->priv;
547 device = gtk_get_current_event_device ();
549 _gtk_menu_shell_set_grab_device (menu_shell, device);
550 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
552 priv->have_grab = TRUE;
558 gtk_menu_shell_button_press (GtkWidget *widget,
559 GdkEventButton *event)
561 GtkMenuShell *menu_shell;
562 GtkMenuShellPrivate *priv;
563 GtkWidget *menu_item;
566 if (event->type != GDK_BUTTON_PRESS)
569 menu_shell = GTK_MENU_SHELL (widget);
570 priv = menu_shell->priv;
572 if (priv->parent_menu_shell)
573 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
575 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
577 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
579 parent = gtk_widget_get_parent (menu_item);
581 if (menu_item != GTK_MENU_SHELL (parent)->priv->active_menu_item)
583 /* select the menu item *before* activating the shell, so submenus
584 * which might be open are closed the friendly way. If we activate
585 * (and thus grab) this menu shell first, we might get grab_broken
586 * events which will close the entire menu hierarchy. Selecting the
587 * menu item also fixes up the state as if enter_notify() would
588 * have run before (which normally selects the item).
590 if (GTK_MENU_SHELL_GET_CLASS (parent)->submenu_placement != GTK_TOP_BOTTOM)
591 gtk_menu_shell_select_item (GTK_MENU_SHELL (parent), menu_item);
595 if (!priv->active || !priv->button)
597 gboolean initially_active = priv->active;
599 priv->button = event->button;
603 if (_gtk_menu_item_is_selectable (menu_item) &&
604 gtk_widget_get_parent (menu_item) == widget &&
605 menu_item != priv->active_menu_item)
607 _gtk_menu_shell_activate (menu_shell);
608 priv->button = event->button;
610 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
612 priv->activate_time = event->time;
613 gtk_menu_shell_select_item (menu_shell, menu_item);
619 if (!initially_active)
621 gboolean window_drag = FALSE;
623 gtk_widget_style_get (widget,
624 "window-dragging", &window_drag,
629 gtk_menu_shell_deactivate (menu_shell);
630 gtk_window_begin_move_drag (GTK_WINDOW (gtk_widget_get_toplevel (widget)),
641 widget = gtk_get_event_widget ((GdkEvent*) event);
642 if (widget == GTK_WIDGET (menu_shell))
644 gtk_menu_shell_deactivate (menu_shell);
645 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
650 _gtk_menu_item_is_selectable (menu_item) &&
651 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL &&
652 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
654 _gtk_menu_item_popup_submenu (menu_item, FALSE);
655 priv->activated_submenu = TRUE;
662 gtk_menu_shell_grab_broken (GtkWidget *widget,
663 GdkEventGrabBroken *event)
665 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
666 GtkMenuShellPrivate *priv = menu_shell->priv;
668 if (priv->have_xgrab && event->grab_window == NULL)
670 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
671 gtk_menu_shell_deselect (menu_shell);
672 gtk_menu_shell_deactivate (menu_shell);
673 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
680 gtk_menu_shell_button_release (GtkWidget *widget,
681 GdkEventButton *event)
683 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
684 GtkMenuShellPrivate *priv = menu_shell->priv;
688 GtkWidget *menu_item;
689 gboolean deactivate = TRUE;
691 if (priv->button && (event->button != priv->button))
694 if (priv->parent_menu_shell)
695 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
699 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
701 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
703 if (menu_item && (priv->active_menu_item == menu_item) &&
704 _gtk_menu_item_is_selectable (menu_item))
706 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->priv->submenu;
710 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
713 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
714 priv->activated_submenu)
717 GTimeVal *popup_time;
718 gint64 usec_since_popup = 0;
720 g_object_get (gtk_widget_get_settings (widget),
721 "gtk-menu-popdown-delay", &popdown_delay,
724 popup_time = g_object_get_data (G_OBJECT (submenu),
725 "gtk-menu-exact-popup-time");
729 GTimeVal current_time;
731 g_get_current_time (¤t_time);
733 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
734 (gint64) current_time.tv_usec -
735 (gint64) popup_time->tv_sec * 1000 * 1000 -
736 (gint64) popup_time->tv_usec);
738 g_object_set_data (G_OBJECT (submenu),
739 "gtk-menu-exact-popup-time", NULL);
742 /* Only close the submenu on click if we opened the
743 * menu explicitely (usec_since_popup == 0) or
744 * enough time has passed since it was opened by
745 * GtkMenuItem's timeout (usec_since_popup > delay).
747 if (!priv->activated_submenu &&
748 (usec_since_popup == 0 ||
749 usec_since_popup > popdown_delay * 1000))
751 _gtk_menu_item_popdown_submenu (menu_item);
755 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
761 else if (menu_item &&
762 !_gtk_menu_item_is_selectable (menu_item) &&
763 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
767 else if (priv->parent_menu_shell)
770 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
774 /* If we ended up on an item with a submenu, leave the menu up. */
776 (priv->active_menu_item == menu_item) &&
777 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
782 else /* a very fast press-release */
784 /* We only ever want to prevent deactivation on the first
785 * press/release. Setting the time to zero is a bit of a
786 * hack, since we could be being triggered in the first
787 * few fractions of a second after a server time wraparound.
788 * the chances of that happening are ~1/10^6, without
789 * serious harm if we lose.
791 priv->activate_time = 0;
797 gtk_menu_shell_deactivate (menu_shell);
798 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
801 priv->activated_submenu = FALSE;
808 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
809 gboolean keyboard_mode)
811 menu_shell->priv->keyboard_mode = keyboard_mode;
815 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
817 return menu_shell->priv->keyboard_mode;
821 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
823 GtkMenuShell *target;
824 gboolean auto_mnemonics;
826 gboolean mnemonics_visible;
828 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
829 "gtk-auto-mnemonics", &auto_mnemonics,
839 GtkMenuShellPrivate *priv = target->priv;
840 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
842 /* The idea with keyboard mode is that once you start using
843 * the keyboard to navigate the menus, we show mnemonics
844 * until the menu navigation is over. To that end, we spread
845 * the keyboard mode upwards in the menu hierarchy here.
846 * Also see gtk_menu_popup, where we inherit it downwards.
848 if (menu_shell->priv->keyboard_mode)
849 target->priv->keyboard_mode = TRUE;
851 /* While navigating menus, the first parent menu with an active
852 * item is the one where mnemonics are effective, as can be seen
853 * in gtk_menu_shell_key_press below.
854 * We also show mnemonics in context menus. The grab condition is
855 * necessary to ensure we remove underlines from menu bars when
858 mnemonics_visible = target->priv->keyboard_mode &&
859 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
860 (target == menu_shell &&
861 !target->priv->parent_menu_shell &&
862 gtk_widget_has_grab (GTK_WIDGET (target))));
864 /* While menus are up, only show underlines inside the menubar,
865 * not in the entire window.
867 if (GTK_IS_MENU_BAR (target))
869 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
870 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
874 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
876 if (target->priv->active_menu_item || priv->in_unselectable_item)
879 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
884 gtk_menu_shell_key_press (GtkWidget *widget,
887 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
888 GtkMenuShellPrivate *priv = menu_shell->priv;
889 gboolean enable_mnemonics;
891 priv->keyboard_mode = TRUE;
893 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
894 priv->parent_menu_shell)
895 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
897 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
900 g_object_get (gtk_widget_get_settings (widget),
901 "gtk-enable-mnemonics", &enable_mnemonics,
904 if (enable_mnemonics)
905 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
911 gtk_menu_shell_enter_notify (GtkWidget *widget,
912 GdkEventCrossing *event)
914 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
915 GtkMenuShellPrivate *priv = menu_shell->priv;
917 if (event->mode == GDK_CROSSING_GTK_GRAB ||
918 event->mode == GDK_CROSSING_GTK_UNGRAB ||
919 event->mode == GDK_CROSSING_STATE_CHANGED)
924 GtkWidget *menu_item;
927 menu_item = gtk_get_event_widget ((GdkEvent*) event);
932 if (GTK_IS_MENU_ITEM (menu_item) &&
933 !_gtk_menu_item_is_selectable (menu_item))
935 priv->in_unselectable_item = TRUE;
939 parent = gtk_widget_get_parent (menu_item);
940 if (parent == widget &&
941 GTK_IS_MENU_ITEM (menu_item))
943 if (priv->ignore_enter)
946 if (event->detail != GDK_NOTIFY_INFERIOR)
948 if (gtk_widget_get_state (menu_item) != GTK_STATE_PRELIGHT)
949 gtk_menu_shell_select_item (menu_shell, menu_item);
951 /* If any mouse button is down, and there is a submenu
952 * that is not yet visible, activate it. It's sufficient
953 * to check for any button's mask (not only the one
954 * matching menu_shell->button), because there is no
955 * situation a mouse button could be pressed while
956 * entering a menu item where we wouldn't want to show
959 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
960 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL)
962 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
964 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
966 gboolean touchscreen_mode;
968 g_object_get (gtk_widget_get_settings (widget),
969 "gtk-touchscreen-mode", &touchscreen_mode,
972 if (touchscreen_mode)
973 _gtk_menu_item_popup_submenu (menu_item, TRUE);
978 else if (priv->parent_menu_shell)
980 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
988 gtk_menu_shell_leave_notify (GtkWidget *widget,
989 GdkEventCrossing *event)
991 if (event->mode == GDK_CROSSING_GTK_GRAB ||
992 event->mode == GDK_CROSSING_GTK_GRAB ||
993 event->mode == GDK_CROSSING_STATE_CHANGED)
996 if (gtk_widget_get_visible (widget))
998 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
999 GtkMenuShellPrivate *priv = menu_shell->priv;
1000 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
1001 GtkMenuItem *menu_item;
1003 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1006 menu_item = GTK_MENU_ITEM (event_widget);
1008 if (!_gtk_menu_item_is_selectable (event_widget))
1010 priv->in_unselectable_item = TRUE;
1014 if ((priv->active_menu_item == event_widget) &&
1015 (menu_item->priv->submenu == NULL))
1017 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1018 (gtk_widget_get_state (GTK_WIDGET (menu_item)) != GTK_STATE_NORMAL))
1020 gtk_menu_shell_deselect (menu_shell);
1023 else if (priv->parent_menu_shell)
1025 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1033 gtk_menu_shell_screen_changed (GtkWidget *widget,
1034 GdkScreen *previous_screen)
1036 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1040 gtk_menu_shell_add (GtkContainer *container,
1043 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1047 gtk_menu_shell_remove (GtkContainer *container,
1050 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1051 GtkMenuShellPrivate *priv = menu_shell->priv;
1054 was_visible = gtk_widget_get_visible (widget);
1055 priv->children = g_list_remove (priv->children, widget);
1057 if (widget == priv->active_menu_item)
1059 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1060 priv->active_menu_item = NULL;
1063 gtk_widget_unparent (widget);
1065 /* Queue resize regardless of gtk_widget_get_visible (container),
1066 * since that's what is needed by toplevels.
1069 gtk_widget_queue_resize (GTK_WIDGET (container));
1073 gtk_menu_shell_forall (GtkContainer *container,
1074 gboolean include_internals,
1075 GtkCallback callback,
1076 gpointer callback_data)
1078 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1082 children = menu_shell->priv->children;
1085 child = children->data;
1086 children = children->next;
1088 (* callback) (child, callback_data);
1094 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1096 GtkMenuShellPrivate *priv = menu_shell->priv;
1102 priv->active = FALSE;
1103 priv->activate_time = 0;
1105 if (priv->active_menu_item)
1107 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1108 priv->active_menu_item = NULL;
1111 if (priv->have_grab)
1113 priv->have_grab = FALSE;
1114 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1116 if (priv->have_xgrab)
1118 GdkDevice *keyboard;
1120 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1121 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1124 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1126 priv->have_xgrab = FALSE;
1129 priv->keyboard_mode = FALSE;
1130 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1132 _gtk_menu_shell_update_mnemonics (menu_shell);
1137 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1142 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1143 g_return_val_if_fail (child != NULL, FALSE);
1145 parent = gtk_widget_get_parent (child);
1146 while (GTK_IS_MENU_SHELL (parent))
1148 if (parent == (GtkWidget*) menu_shell)
1150 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1157 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1160 GtkWidget *menu_item;
1162 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1164 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1165 menu_item = gtk_widget_get_parent (menu_item);
1167 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1173 /* Handlers for action signals */
1176 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1177 GtkWidget *menu_item)
1179 GtkMenuShellPrivate *priv = menu_shell->priv;
1180 GtkMenuShellClass *class;
1182 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1183 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1185 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1187 if (class->select_item &&
1189 priv->active_menu_item == menu_item))
1190 class->select_item (menu_shell, menu_item);
1193 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1194 GtkSubmenuPlacement placement);
1197 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1198 GtkWidget *menu_item)
1200 GtkMenuShellPrivate *priv = menu_shell->priv;
1201 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1203 if (priv->active_menu_item)
1205 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1206 priv->active_menu_item = NULL;
1209 if (!_gtk_menu_item_is_selectable (menu_item))
1211 priv->in_unselectable_item = TRUE;
1212 _gtk_menu_shell_update_mnemonics (menu_shell);
1216 priv->active_menu_item = menu_item;
1217 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1218 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1221 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1222 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1223 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1225 _gtk_menu_shell_update_mnemonics (menu_shell);
1227 /* This allows the bizarre radio buttons-with-submenus-display-history
1230 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1231 gtk_widget_activate (priv->active_menu_item);
1235 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1237 GtkMenuShellPrivate *priv = menu_shell->priv;
1239 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1241 if (priv->active_menu_item)
1243 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1244 priv->active_menu_item = NULL;
1245 _gtk_menu_shell_update_mnemonics (menu_shell);
1250 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1251 GtkWidget *menu_item,
1252 gboolean force_deactivate)
1254 GSList *slist, *shells = NULL;
1255 gboolean deactivate = force_deactivate;
1257 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1258 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1261 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1263 g_object_ref (menu_shell);
1264 g_object_ref (menu_item);
1268 GtkMenuShell *parent_menu_shell = menu_shell;
1272 g_object_ref (parent_menu_shell);
1273 shells = g_slist_prepend (shells, parent_menu_shell);
1274 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1276 while (parent_menu_shell);
1277 shells = g_slist_reverse (shells);
1279 gtk_menu_shell_deactivate (menu_shell);
1281 /* Flush the x-queue, so any grabs are removed and
1282 * the menu is actually taken down
1284 gdk_display_sync (gtk_widget_get_display (menu_item));
1287 gtk_widget_activate (menu_item);
1289 for (slist = shells; slist; slist = slist->next)
1291 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1292 g_object_unref (slist->data);
1294 g_slist_free (shells);
1296 g_object_unref (menu_shell);
1297 g_object_unref (menu_item);
1300 /* Distance should be +/- 1 */
1302 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1305 GtkMenuShellPrivate *priv = menu_shell->priv;
1307 if (priv->active_menu_item)
1309 GList *node = g_list_find (priv->children, priv->active_menu_item);
1310 GList *start_node = node;
1311 gboolean wrap_around;
1313 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1314 "gtk-keynav-wrap-around", &wrap_around,
1320 while (node != start_node &&
1321 (!node || !_gtk_menu_item_is_selectable (node->data)))
1325 else if (wrap_around)
1326 node = priv->children;
1329 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1337 while (node != start_node &&
1338 (!node || !_gtk_menu_item_is_selectable (node->data)))
1342 else if (wrap_around)
1343 node = g_list_last (priv->children);
1346 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1353 gtk_menu_shell_select_item (menu_shell, node->data);
1359 /* Distance should be +/- 1 */
1361 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1364 gboolean handled = FALSE;
1366 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1367 distance, &handled);
1371 * gtk_menu_shell_select_first:
1372 * @menu_shell: a #GtkMenuShell
1373 * @search_sensitive: if %TRUE, search for the first selectable
1374 * menu item, otherwise select nothing if
1375 * the first item isn't sensitive. This
1376 * should be %FALSE if the menu is being
1377 * popped up initially.
1379 * Select the first visible or selectable child of the menu shell;
1380 * don't select tearoff items unless the only item is a tearoff
1386 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1387 gboolean search_sensitive)
1389 GtkMenuShellPrivate *priv = menu_shell->priv;
1390 GtkWidget *to_select = NULL;
1393 tmp_list = priv->children;
1396 GtkWidget *child = tmp_list->data;
1398 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1399 _gtk_menu_item_is_selectable (child))
1402 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1406 tmp_list = tmp_list->next;
1410 gtk_menu_shell_select_item (menu_shell, to_select);
1414 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1415 gboolean search_sensitive)
1417 GtkMenuShellPrivate *priv = menu_shell->priv;
1418 GtkWidget *to_select = NULL;
1421 tmp_list = g_list_last (priv->children);
1424 GtkWidget *child = tmp_list->data;
1426 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1427 _gtk_menu_item_is_selectable (child))
1430 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1434 tmp_list = tmp_list->prev;
1438 gtk_menu_shell_select_item (menu_shell, to_select);
1442 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1444 GtkMenuShellPrivate *priv = menu_shell->priv;
1445 GtkMenuItem *menu_item;
1447 if (priv->active_menu_item == NULL)
1450 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1452 if (menu_item->priv->submenu)
1454 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1455 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->priv->submenu), TRUE);
1456 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active_menu_item)
1464 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1465 GtkMenuDirectionType direction)
1467 GtkMenuShellPrivate *priv = menu_shell->priv;
1468 GtkMenuShell *parent_menu_shell = NULL;
1469 gboolean had_selection;
1470 gboolean touchscreen_mode;
1472 priv->in_unselectable_item = FALSE;
1474 had_selection = priv->active_menu_item != NULL;
1476 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1477 "gtk-touchscreen-mode", &touchscreen_mode,
1480 if (priv->parent_menu_shell)
1481 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1485 case GTK_MENU_DIR_PARENT:
1486 if (touchscreen_mode &&
1487 priv->active_menu_item &&
1488 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu &&
1489 gtk_widget_get_visible (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu))
1491 /* if we are on a menu item that has an open submenu but the
1492 * focus is not in that submenu (e.g. because it's empty or
1493 * has only insensitive items), close that submenu instead of
1494 * running into the code below which would close *this* menu.
1496 _gtk_menu_item_popdown_submenu (priv->active_menu_item);
1497 _gtk_menu_shell_update_mnemonics (menu_shell);
1499 else if (parent_menu_shell)
1501 if (touchscreen_mode)
1503 /* close menu when returning from submenu. */
1504 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->priv->parent_menu_item);
1505 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1509 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1510 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1511 gtk_menu_shell_deselect (menu_shell);
1514 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1515 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1517 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1518 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1521 /* If there is no parent and the submenu is in the opposite direction
1522 * to the menu, then make the PARENT direction wrap around to
1523 * the bottom of the submenu.
1525 else if (priv->active_menu_item &&
1526 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1527 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1529 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu);
1531 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1532 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1533 _gtk_menu_shell_select_last (submenu, TRUE);
1537 case GTK_MENU_DIR_CHILD:
1538 if (priv->active_menu_item &&
1539 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1540 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1542 if (gtk_menu_shell_select_submenu_first (menu_shell))
1546 /* Try to find a menu running the opposite direction */
1547 while (parent_menu_shell &&
1548 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1549 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1551 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1554 if (parent_menu_shell)
1556 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1557 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1559 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1561 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1565 case GTK_MENU_DIR_PREV:
1566 gtk_menu_shell_move_selected (menu_shell, -1);
1567 if (!had_selection && !priv->active_menu_item && priv->children)
1568 _gtk_menu_shell_select_last (menu_shell, TRUE);
1571 case GTK_MENU_DIR_NEXT:
1572 gtk_menu_shell_move_selected (menu_shell, 1);
1573 if (!had_selection && !priv->active_menu_item && priv->children)
1574 gtk_menu_shell_select_first (menu_shell, TRUE);
1580 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1581 gboolean force_hide)
1583 GtkMenuShellPrivate *priv = menu_shell->priv;
1585 if (priv->active_menu_item &&
1586 _gtk_menu_item_is_selectable (priv->active_menu_item))
1588 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu == NULL)
1589 gtk_menu_shell_activate_item (menu_shell,
1590 priv->active_menu_item,
1593 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1598 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1600 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1601 gtk_menu_shell_deselect (menu_shell);
1602 gtk_menu_shell_deactivate (menu_shell);
1603 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1607 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1608 GtkDirectionType dir)
1610 GtkMenuShellPrivate *priv = menu_shell->priv;
1612 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1614 if (priv->parent_menu_shell)
1615 menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1621 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1625 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1627 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1629 if (klass->get_popup_delay)
1631 return klass->get_popup_delay (menu_shell);
1636 GtkWidget *widget = GTK_WIDGET (menu_shell);
1638 g_object_get (gtk_widget_get_settings (widget),
1639 "gtk-menu-popup-delay", &popup_delay,
1647 * gtk_menu_shell_cancel:
1648 * @menu_shell: a #GtkMenuShell
1650 * Cancels the selection within the menu shell.
1655 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1657 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1659 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1662 static GtkMnemonicHash *
1663 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1666 GtkMenuShellPrivate *priv = menu_shell->priv;
1668 if (!priv->mnemonic_hash && create)
1669 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1671 return priv->mnemonic_hash;
1675 menu_shell_add_mnemonic_foreach (guint keyval,
1679 GtkKeyHash *key_hash = data;
1681 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1685 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1688 GtkMenuShellPrivate *priv = menu_shell->priv;
1689 GtkWidget *widget = GTK_WIDGET (menu_shell);
1691 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1693 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1694 GdkScreen *screen = gtk_widget_get_screen (widget);
1695 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1700 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1702 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1703 menu_shell_add_mnemonic_foreach,
1707 return priv->key_hash;
1711 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1713 GtkMenuShellPrivate *priv = menu_shell->priv;
1717 _gtk_key_hash_free (priv->key_hash);
1718 priv->key_hash = NULL;
1723 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1726 GtkMnemonicHash *mnemonic_hash;
1727 GtkKeyHash *key_hash;
1729 gboolean result = FALSE;
1731 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1735 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1739 entries = _gtk_key_hash_lookup (key_hash,
1740 event->hardware_keycode,
1742 gtk_accelerator_get_default_mod_mask (),
1746 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1747 GPOINTER_TO_UINT (entries->data));
1753 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1757 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1758 g_return_if_fail (GTK_IS_WIDGET (target));
1760 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1762 gtk_menu_shell_reset_key_hash (menu_shell);
1766 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1770 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1771 g_return_if_fail (GTK_IS_WIDGET (target));
1773 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1775 gtk_menu_shell_reset_key_hash (menu_shell);
1779 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1782 GtkMenuShellPrivate *priv = menu_shell->priv;
1784 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1785 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1788 priv->grab_pointer = NULL;
1789 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1790 priv->grab_pointer = gdk_device_get_associated_device (device);
1792 priv->grab_pointer = device;
1796 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1798 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1800 return menu_shell->priv->grab_pointer;
1804 * gtk_menu_shell_get_take_focus:
1805 * @menu_shell: a #GtkMenuShell
1807 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1809 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1814 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1816 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1818 return menu_shell->priv->take_focus;
1822 * gtk_menu_shell_set_take_focus:
1823 * @menu_shell: a #GtkMenuShell
1824 * @take_focus: %TRUE if the menu shell should take the keyboard
1827 * If @take_focus is %TRUE (the default) the menu shell will take
1828 * the keyboard focus so that it will receive all keyboard events
1829 * which is needed to enable keyboard navigation in menus.
1831 * Setting @take_focus to %FALSE is useful only for special applications
1832 * like virtual keyboard implementations which should not take keyboard
1835 * The @take_focus state of a menu or menu bar is automatically
1836 * propagated to submenus whenever a submenu is popped up, so you
1837 * don't have to worry about recursively setting it for your entire
1838 * menu hierarchy. Only when programmatically picking a submenu and
1839 * popping it up manually, the @take_focus property of the submenu
1840 * needs to be set explicitely.
1842 * Note that setting it to %FALSE has side-effects:
1844 * If the focus is in some other app, it keeps the focus and keynav in
1845 * the menu doesn't work. Consequently, keynav on the menu will only
1846 * work if the focus is on some toplevel owned by the onscreen keyboard.
1848 * To avoid confusing the user, menus with @take_focus set to %FALSE
1849 * should not display mnemonics or accelerators, since it cannot be
1850 * guaranteed that they will work.
1852 * See also gdk_keyboard_grab()
1857 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1858 gboolean take_focus)
1860 GtkMenuShellPrivate *priv = menu_shell->priv;
1862 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1864 if (priv->take_focus != take_focus)
1866 priv->take_focus = take_focus;
1867 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1872 * gtk_menu_shell_get_selected_item:
1873 * @menu_shell: a #GtkMenuShell
1875 * Gets the currently selected item.
1877 * Returns: the currently selected item
1882 gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell)
1884 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1886 return menu_shell->priv->active_menu_item;
1890 * gtk_menu_shell_get_parent_shell:
1891 * @menu_shell: a #GtkMenuShell
1893 * Gets the parent menu shell.
1895 * The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
1896 * from which it was opened up.
1898 * Returns: the parent #GtkMenuShell
1903 gtk_menu_shell_get_parent_shell (GtkMenuShell *menu_shell)
1905 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1907 return menu_shell->priv->parent_menu_shell;