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/.
28 #include "gdk/gdkkeysyms.h"
29 #include "gtkbindings.h"
30 #include "gtkkeyhash.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"
44 #define MENU_SHELL_TIMEOUT 500
46 #define PACK_DIRECTION(m) \
47 (GTK_IS_MENU_BAR (m) \
48 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
49 : GTK_PACK_DIRECTION_LTR)
69 * A menu item can be "selected", this means that it is displayed
70 * in the prelight state, and if it has a submenu, that submenu
73 * A menu is "active" when it is visible onscreen and the user
74 * is selecting from it. A menubar is not active until the user
75 * clicks on one of its menuitems. When a menu is active,
76 * passing the mouse over a submenu will pop it up.
78 * menu_shell->active_menu_item, is however, not an "active"
79 * menu item (there is no such thing) but rather, the selected
80 * menu item in that MenuShell, if there is one.
82 * There is also is a concept of the current menu and a current
83 * menu item. The current menu item is the selected menu item
84 * that is furthest down in the hierarchy. (Every active menu_shell
85 * does not necessarily contain a selected menu item, but if
86 * it does, then menu_shell->parent_menu_shell must also contain
87 * a selected menu item. The current menu is the menu that
88 * contains the current menu_item. It will always have a GTK
89 * grab and receive all key presses.
94 * ::move_current (GtkMenuDirection *dir)
95 * Moves the current menu item in direction 'dir':
97 * GTK_MENU_DIR_PARENT: To the parent menu shell
98 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
100 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
103 * As a a bit of a hack to get movement between menus and
104 * menubars working, if submenu_placement is different for
105 * the menu and its MenuShell then the following apply:
107 * - For 'parent' the current menu is not just moved to
108 * the parent, but moved to the previous entry in the parent
109 * - For 'child', if there is no child, then current is
110 * moved to the next item in the parent.
112 * Note that the above explanation of ::move_current was written
113 * before menus and menubars had support for RTL flipping and
114 * different packing directions, and therefore only applies for
115 * when text direction and packing direction are both left-to-right.
117 * ::activate_current (GBoolean *force_hide)
118 * Activate the current item. If 'force_hide' is true, hide
119 * the current menu item always. Otherwise, only hide
120 * it if menu_item->klass->hide_on_activate is true.
123 * Cancels the current selection
127 static void gtk_menu_shell_set_property (GObject *object,
131 static void gtk_menu_shell_get_property (GObject *object,
135 static void gtk_menu_shell_realize (GtkWidget *widget);
136 static void gtk_menu_shell_finalize (GObject *object);
137 static void gtk_menu_shell_dispose (GObject *object);
138 static gint gtk_menu_shell_button_press (GtkWidget *widget,
139 GdkEventButton *event);
140 static gint gtk_menu_shell_button_release (GtkWidget *widget,
141 GdkEventButton *event);
142 static gint gtk_menu_shell_key_press (GtkWidget *widget,
144 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
145 GdkEventCrossing *event);
146 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
147 GdkEventCrossing *event);
148 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
149 GdkScreen *previous_screen);
150 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
151 GdkEventGrabBroken *event);
152 static void gtk_menu_shell_add (GtkContainer *container,
154 static void gtk_menu_shell_remove (GtkContainer *container,
156 static void gtk_menu_shell_forall (GtkContainer *container,
157 gboolean include_internals,
158 GtkCallback callback,
159 gpointer callback_data);
160 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
163 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
164 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
166 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
168 static GType gtk_menu_shell_child_type (GtkContainer *container);
169 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
170 GtkWidget *menu_item);
171 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
173 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
174 GtkMenuDirectionType direction);
175 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
176 gboolean force_hide);
177 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
178 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
179 GtkDirectionType dir);
181 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
182 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
184 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
187 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
189 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
192 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
194 GObjectClass *object_class;
195 GtkWidgetClass *widget_class;
196 GtkContainerClass *container_class;
198 GtkBindingSet *binding_set;
200 object_class = (GObjectClass*) klass;
201 widget_class = (GtkWidgetClass*) klass;
202 container_class = (GtkContainerClass*) klass;
204 object_class->set_property = gtk_menu_shell_set_property;
205 object_class->get_property = gtk_menu_shell_get_property;
206 object_class->finalize = gtk_menu_shell_finalize;
207 object_class->dispose = gtk_menu_shell_dispose;
209 widget_class->realize = gtk_menu_shell_realize;
210 widget_class->button_press_event = gtk_menu_shell_button_press;
211 widget_class->button_release_event = gtk_menu_shell_button_release;
212 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
213 widget_class->key_press_event = gtk_menu_shell_key_press;
214 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
215 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
216 widget_class->screen_changed = gtk_menu_shell_screen_changed;
218 container_class->add = gtk_menu_shell_add;
219 container_class->remove = gtk_menu_shell_remove;
220 container_class->forall = gtk_menu_shell_forall;
221 container_class->child_type = gtk_menu_shell_child_type;
223 klass->submenu_placement = GTK_TOP_BOTTOM;
224 klass->deactivate = gtk_real_menu_shell_deactivate;
225 klass->selection_done = NULL;
226 klass->move_current = gtk_real_menu_shell_move_current;
227 klass->activate_current = gtk_real_menu_shell_activate_current;
228 klass->cancel = gtk_real_menu_shell_cancel;
229 klass->select_item = gtk_menu_shell_real_select_item;
230 klass->insert = gtk_menu_shell_real_insert;
231 klass->move_selected = gtk_menu_shell_real_move_selected;
233 menu_shell_signals[DEACTIVATE] =
234 g_signal_new (I_("deactivate"),
235 G_OBJECT_CLASS_TYPE (object_class),
237 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
239 _gtk_marshal_VOID__VOID,
242 menu_shell_signals[SELECTION_DONE] =
243 g_signal_new (I_("selection-done"),
244 G_OBJECT_CLASS_TYPE (object_class),
246 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
248 _gtk_marshal_VOID__VOID,
251 menu_shell_signals[MOVE_CURRENT] =
252 g_signal_new (I_("move-current"),
253 G_OBJECT_CLASS_TYPE (object_class),
254 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
255 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
257 _gtk_marshal_VOID__ENUM,
259 GTK_TYPE_MENU_DIRECTION_TYPE);
261 menu_shell_signals[ACTIVATE_CURRENT] =
262 g_signal_new (I_("activate-current"),
263 G_OBJECT_CLASS_TYPE (object_class),
264 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
265 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
267 _gtk_marshal_VOID__BOOLEAN,
271 menu_shell_signals[CANCEL] =
272 g_signal_new (I_("cancel"),
273 G_OBJECT_CLASS_TYPE (object_class),
274 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
275 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
277 _gtk_marshal_VOID__VOID,
280 menu_shell_signals[CYCLE_FOCUS] =
281 g_signal_new_class_handler (I_("cycle-focus"),
282 G_OBJECT_CLASS_TYPE (object_class),
283 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
284 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
286 _gtk_marshal_VOID__ENUM,
288 GTK_TYPE_DIRECTION_TYPE);
291 * GtkMenuShell::move-selected:
292 * @menu_shell: the object on which the signal is emitted
293 * @distance: +1 to move to the next item, -1 to move to the previous
295 * The ::move-selected signal is emitted to move the selection to
298 * Returns: %TRUE to stop the signal emission, %FALSE to continue
302 menu_shell_signals[MOVE_SELECTED] =
303 g_signal_new (I_("move-selected"),
304 G_OBJECT_CLASS_TYPE (object_class),
306 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
307 _gtk_boolean_handled_accumulator, NULL,
308 _gtk_marshal_BOOLEAN__INT,
312 binding_set = gtk_binding_set_by_class (klass);
313 gtk_binding_entry_add_signal (binding_set,
316 gtk_binding_entry_add_signal (binding_set,
318 "activate-current", 1,
321 gtk_binding_entry_add_signal (binding_set,
322 GDK_KEY_ISO_Enter, 0,
323 "activate-current", 1,
326 gtk_binding_entry_add_signal (binding_set,
328 "activate-current", 1,
331 gtk_binding_entry_add_signal (binding_set,
333 "activate-current", 1,
336 gtk_binding_entry_add_signal (binding_set,
338 "activate-current", 1,
341 gtk_binding_entry_add_signal (binding_set,
344 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
345 gtk_binding_entry_add_signal (binding_set,
346 GDK_KEY_F10, GDK_SHIFT_MASK,
348 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
351 * GtkMenuShell:take-focus:
353 * A boolean that determines whether the menu and its submenus grab the
354 * keyboard focus. See gtk_menu_shell_set_take_focus() and
355 * gtk_menu_shell_get_take_focus().
359 g_object_class_install_property (object_class,
361 g_param_spec_boolean ("take-focus",
363 P_("A boolean that determines whether the menu grabs the keyboard focus"),
365 GTK_PARAM_READWRITE));
367 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
371 gtk_menu_shell_child_type (GtkContainer *container)
373 return GTK_TYPE_MENU_ITEM;
377 gtk_menu_shell_init (GtkMenuShell *menu_shell)
379 GtkMenuShellPrivate *priv;
381 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_shell,
383 GtkMenuShellPrivate);
384 menu_shell->priv = priv;
385 priv->take_focus = TRUE;
389 gtk_menu_shell_set_property (GObject *object,
394 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
398 case PROP_TAKE_FOCUS:
399 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
402 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
408 gtk_menu_shell_get_property (GObject *object,
413 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
417 case PROP_TAKE_FOCUS:
418 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
421 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
427 gtk_menu_shell_finalize (GObject *object)
429 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
430 GtkMenuShellPrivate *priv = menu_shell->priv;
432 if (priv->mnemonic_hash)
433 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
435 _gtk_key_hash_free (priv->key_hash);
437 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
442 gtk_menu_shell_dispose (GObject *object)
444 gtk_menu_shell_deactivate (GTK_MENU_SHELL (object));
446 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->dispose (object);
450 gtk_menu_shell_append (GtkMenuShell *menu_shell,
453 gtk_menu_shell_insert (menu_shell, child, -1);
457 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
460 gtk_menu_shell_insert (menu_shell, child, 0);
464 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
468 GtkMenuShellClass *class;
470 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
471 g_return_if_fail (GTK_IS_MENU_ITEM (child));
473 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
476 class->insert (menu_shell, child, position);
480 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
484 GtkMenuShellPrivate *priv = menu_shell->priv;
486 priv->children = g_list_insert (priv->children, child, position);
488 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
492 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
494 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
496 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
500 gtk_menu_shell_realize (GtkWidget *widget)
502 GtkAllocation allocation;
504 GdkWindowAttr attributes;
505 gint attributes_mask;
507 gtk_widget_set_realized (widget, TRUE);
509 gtk_widget_get_allocation (widget, &allocation);
511 attributes.x = allocation.x;
512 attributes.y = allocation.y;
513 attributes.width = allocation.width;
514 attributes.height = allocation.height;
515 attributes.window_type = GDK_WINDOW_CHILD;
516 attributes.wclass = GDK_INPUT_OUTPUT;
517 attributes.visual = gtk_widget_get_visual (widget);
518 attributes.event_mask = gtk_widget_get_events (widget);
519 attributes.event_mask |= (GDK_EXPOSURE_MASK |
520 GDK_BUTTON_PRESS_MASK |
521 GDK_BUTTON_RELEASE_MASK |
523 GDK_ENTER_NOTIFY_MASK |
524 GDK_LEAVE_NOTIFY_MASK);
526 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
528 window = gdk_window_new (gtk_widget_get_parent_window (widget),
529 &attributes, attributes_mask);
530 gtk_widget_set_window (widget, window);
531 gdk_window_set_user_data (window, widget);
533 gtk_widget_style_attach (widget);
534 gtk_style_set_background (gtk_widget_get_style (widget), window, GTK_STATE_NORMAL);
538 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
540 GtkMenuShellPrivate *priv = menu_shell->priv;
546 device = gtk_get_current_event_device ();
548 _gtk_menu_shell_set_grab_device (menu_shell, device);
549 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
551 priv->have_grab = TRUE;
557 gtk_menu_shell_button_press (GtkWidget *widget,
558 GdkEventButton *event)
560 GtkMenuShell *menu_shell;
561 GtkMenuShellPrivate *priv;
562 GtkWidget *menu_item;
565 if (event->type != GDK_BUTTON_PRESS)
568 menu_shell = GTK_MENU_SHELL (widget);
569 priv = menu_shell->priv;
571 if (priv->parent_menu_shell)
572 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
574 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
576 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
578 parent = gtk_widget_get_parent (menu_item);
580 if (menu_item != GTK_MENU_SHELL (parent)->priv->active_menu_item)
582 /* select the menu item *before* activating the shell, so submenus
583 * which might be open are closed the friendly way. If we activate
584 * (and thus grab) this menu shell first, we might get grab_broken
585 * events which will close the entire menu hierarchy. Selecting the
586 * menu item also fixes up the state as if enter_notify() would
587 * have run before (which normally selects the item).
589 if (GTK_MENU_SHELL_GET_CLASS (parent)->submenu_placement != GTK_TOP_BOTTOM)
590 gtk_menu_shell_select_item (GTK_MENU_SHELL (parent), menu_item);
594 if (!priv->active || !priv->button)
596 gboolean initially_active = priv->active;
598 priv->button = event->button;
602 if (_gtk_menu_item_is_selectable (menu_item) &&
603 gtk_widget_get_parent (menu_item) == widget &&
604 menu_item != priv->active_menu_item)
606 _gtk_menu_shell_activate (menu_shell);
607 priv->button = event->button;
609 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
611 priv->activate_time = event->time;
612 gtk_menu_shell_select_item (menu_shell, menu_item);
618 if (!initially_active)
620 gboolean window_drag = FALSE;
622 gtk_widget_style_get (widget,
623 "window-dragging", &window_drag,
628 gtk_menu_shell_deactivate (menu_shell);
629 gtk_window_begin_move_drag (GTK_WINDOW (gtk_widget_get_toplevel (widget)),
640 widget = gtk_get_event_widget ((GdkEvent*) event);
641 if (widget == GTK_WIDGET (menu_shell))
643 gtk_menu_shell_deactivate (menu_shell);
644 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
649 _gtk_menu_item_is_selectable (menu_item) &&
650 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL &&
651 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
653 _gtk_menu_item_popup_submenu (menu_item, FALSE);
654 priv->activated_submenu = TRUE;
661 gtk_menu_shell_grab_broken (GtkWidget *widget,
662 GdkEventGrabBroken *event)
664 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
665 GtkMenuShellPrivate *priv = menu_shell->priv;
667 if (priv->have_xgrab && event->grab_window == NULL)
669 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
670 gtk_menu_shell_deselect (menu_shell);
671 gtk_menu_shell_deactivate (menu_shell);
672 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
679 gtk_menu_shell_button_release (GtkWidget *widget,
680 GdkEventButton *event)
682 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
683 GtkMenuShellPrivate *priv = menu_shell->priv;
687 GtkWidget *menu_item;
688 gboolean deactivate = TRUE;
690 if (priv->button && (event->button != priv->button))
693 if (priv->parent_menu_shell)
694 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
698 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
700 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
702 if (menu_item && (priv->active_menu_item == menu_item) &&
703 _gtk_menu_item_is_selectable (menu_item))
705 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->priv->submenu;
709 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
712 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
713 priv->activated_submenu)
716 GTimeVal *popup_time;
717 gint64 usec_since_popup = 0;
719 g_object_get (gtk_widget_get_settings (widget),
720 "gtk-menu-popdown-delay", &popdown_delay,
723 popup_time = g_object_get_data (G_OBJECT (submenu),
724 "gtk-menu-exact-popup-time");
728 GTimeVal current_time;
730 g_get_current_time (¤t_time);
732 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
733 (gint64) current_time.tv_usec -
734 (gint64) popup_time->tv_sec * 1000 * 1000 -
735 (gint64) popup_time->tv_usec);
737 g_object_set_data (G_OBJECT (submenu),
738 "gtk-menu-exact-popup-time", NULL);
741 /* Only close the submenu on click if we opened the
742 * menu explicitely (usec_since_popup == 0) or
743 * enough time has passed since it was opened by
744 * GtkMenuItem's timeout (usec_since_popup > delay).
746 if (!priv->activated_submenu &&
747 (usec_since_popup == 0 ||
748 usec_since_popup > popdown_delay * 1000))
750 _gtk_menu_item_popdown_submenu (menu_item);
754 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
760 else if (menu_item &&
761 !_gtk_menu_item_is_selectable (menu_item) &&
762 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
766 else if (priv->parent_menu_shell)
769 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
773 /* If we ended up on an item with a submenu, leave the menu up. */
775 (priv->active_menu_item == menu_item) &&
776 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
781 else /* a very fast press-release */
783 /* We only ever want to prevent deactivation on the first
784 * press/release. Setting the time to zero is a bit of a
785 * hack, since we could be being triggered in the first
786 * few fractions of a second after a server time wraparound.
787 * the chances of that happening are ~1/10^6, without
788 * serious harm if we lose.
790 priv->activate_time = 0;
796 gtk_menu_shell_deactivate (menu_shell);
797 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
800 priv->activated_submenu = FALSE;
807 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
808 gboolean keyboard_mode)
810 menu_shell->priv->keyboard_mode = keyboard_mode;
814 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
816 return menu_shell->priv->keyboard_mode;
820 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
822 GtkMenuShell *target;
823 gboolean auto_mnemonics;
825 gboolean mnemonics_visible;
827 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
828 "gtk-auto-mnemonics", &auto_mnemonics,
838 GtkMenuShellPrivate *priv = target->priv;
839 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
841 /* The idea with keyboard mode is that once you start using
842 * the keyboard to navigate the menus, we show mnemonics
843 * until the menu navigation is over. To that end, we spread
844 * the keyboard mode upwards in the menu hierarchy here.
845 * Also see gtk_menu_popup, where we inherit it downwards.
847 if (menu_shell->priv->keyboard_mode)
848 target->priv->keyboard_mode = TRUE;
850 /* While navigating menus, the first parent menu with an active
851 * item is the one where mnemonics are effective, as can be seen
852 * in gtk_menu_shell_key_press below.
853 * We also show mnemonics in context menus. The grab condition is
854 * necessary to ensure we remove underlines from menu bars when
857 mnemonics_visible = target->priv->keyboard_mode &&
858 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
859 (target == menu_shell &&
860 !target->priv->parent_menu_shell &&
861 gtk_widget_has_grab (GTK_WIDGET (target))));
863 /* While menus are up, only show underlines inside the menubar,
864 * not in the entire window.
866 if (GTK_IS_MENU_BAR (target))
868 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
869 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
873 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
875 if (target->priv->active_menu_item || priv->in_unselectable_item)
878 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
883 gtk_menu_shell_key_press (GtkWidget *widget,
886 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
887 GtkMenuShellPrivate *priv = menu_shell->priv;
888 gboolean enable_mnemonics;
890 priv->keyboard_mode = TRUE;
892 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
893 priv->parent_menu_shell)
894 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
896 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
899 g_object_get (gtk_widget_get_settings (widget),
900 "gtk-enable-mnemonics", &enable_mnemonics,
903 if (enable_mnemonics)
904 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
910 gtk_menu_shell_enter_notify (GtkWidget *widget,
911 GdkEventCrossing *event)
913 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
914 GtkMenuShellPrivate *priv = menu_shell->priv;
916 if (event->mode == GDK_CROSSING_GTK_GRAB ||
917 event->mode == GDK_CROSSING_GTK_UNGRAB ||
918 event->mode == GDK_CROSSING_STATE_CHANGED)
923 GtkWidget *menu_item;
926 menu_item = gtk_get_event_widget ((GdkEvent*) event);
931 if (GTK_IS_MENU_ITEM (menu_item) &&
932 !_gtk_menu_item_is_selectable (menu_item))
934 priv->in_unselectable_item = TRUE;
938 parent = gtk_widget_get_parent (menu_item);
939 if (parent == widget &&
940 GTK_IS_MENU_ITEM (menu_item))
942 if (priv->ignore_enter)
945 if (event->detail != GDK_NOTIFY_INFERIOR)
947 if (gtk_widget_get_state (menu_item) != GTK_STATE_PRELIGHT)
948 gtk_menu_shell_select_item (menu_shell, menu_item);
950 /* If any mouse button is down, and there is a submenu
951 * that is not yet visible, activate it. It's sufficient
952 * to check for any button's mask (not only the one
953 * matching menu_shell->button), because there is no
954 * situation a mouse button could be pressed while
955 * entering a menu item where we wouldn't want to show
958 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
959 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL)
961 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
963 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
965 gboolean touchscreen_mode;
967 g_object_get (gtk_widget_get_settings (widget),
968 "gtk-touchscreen-mode", &touchscreen_mode,
971 if (touchscreen_mode)
972 _gtk_menu_item_popup_submenu (menu_item, TRUE);
977 else if (priv->parent_menu_shell)
979 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
987 gtk_menu_shell_leave_notify (GtkWidget *widget,
988 GdkEventCrossing *event)
990 if (event->mode == GDK_CROSSING_GTK_GRAB ||
991 event->mode == GDK_CROSSING_GTK_GRAB ||
992 event->mode == GDK_CROSSING_STATE_CHANGED)
995 if (gtk_widget_get_visible (widget))
997 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
998 GtkMenuShellPrivate *priv = menu_shell->priv;
999 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
1000 GtkMenuItem *menu_item;
1002 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1005 menu_item = GTK_MENU_ITEM (event_widget);
1007 if (!_gtk_menu_item_is_selectable (event_widget))
1009 priv->in_unselectable_item = TRUE;
1013 if ((priv->active_menu_item == event_widget) &&
1014 (menu_item->priv->submenu == NULL))
1016 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1017 (gtk_widget_get_state (GTK_WIDGET (menu_item)) != GTK_STATE_NORMAL))
1019 gtk_menu_shell_deselect (menu_shell);
1022 else if (priv->parent_menu_shell)
1024 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1032 gtk_menu_shell_screen_changed (GtkWidget *widget,
1033 GdkScreen *previous_screen)
1035 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1039 gtk_menu_shell_add (GtkContainer *container,
1042 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1046 gtk_menu_shell_remove (GtkContainer *container,
1049 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1050 GtkMenuShellPrivate *priv = menu_shell->priv;
1053 was_visible = gtk_widget_get_visible (widget);
1054 priv->children = g_list_remove (priv->children, widget);
1056 if (widget == priv->active_menu_item)
1058 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1059 priv->active_menu_item = NULL;
1062 gtk_widget_unparent (widget);
1064 /* Queue resize regardless of gtk_widget_get_visible (container),
1065 * since that's what is needed by toplevels.
1068 gtk_widget_queue_resize (GTK_WIDGET (container));
1072 gtk_menu_shell_forall (GtkContainer *container,
1073 gboolean include_internals,
1074 GtkCallback callback,
1075 gpointer callback_data)
1077 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1081 children = menu_shell->priv->children;
1084 child = children->data;
1085 children = children->next;
1087 (* callback) (child, callback_data);
1093 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1095 GtkMenuShellPrivate *priv = menu_shell->priv;
1101 priv->active = FALSE;
1102 priv->activate_time = 0;
1104 if (priv->active_menu_item)
1106 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1107 priv->active_menu_item = NULL;
1110 if (priv->have_grab)
1112 priv->have_grab = FALSE;
1113 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1115 if (priv->have_xgrab)
1117 GdkDevice *keyboard;
1119 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1120 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1123 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1125 priv->have_xgrab = FALSE;
1128 priv->keyboard_mode = FALSE;
1129 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1131 _gtk_menu_shell_update_mnemonics (menu_shell);
1136 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1141 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1142 g_return_val_if_fail (child != NULL, FALSE);
1144 parent = gtk_widget_get_parent (child);
1145 while (GTK_IS_MENU_SHELL (parent))
1147 if (parent == (GtkWidget*) menu_shell)
1149 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1156 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1159 GtkWidget *menu_item;
1161 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1163 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1164 menu_item = gtk_widget_get_parent (menu_item);
1166 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1172 /* Handlers for action signals */
1175 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1176 GtkWidget *menu_item)
1178 GtkMenuShellPrivate *priv = menu_shell->priv;
1179 GtkMenuShellClass *class;
1181 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1182 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1184 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1186 if (class->select_item &&
1188 priv->active_menu_item == menu_item))
1189 class->select_item (menu_shell, menu_item);
1192 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1193 GtkSubmenuPlacement placement);
1196 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1197 GtkWidget *menu_item)
1199 GtkMenuShellPrivate *priv = menu_shell->priv;
1200 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1202 if (priv->active_menu_item)
1204 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1205 priv->active_menu_item = NULL;
1208 if (!_gtk_menu_item_is_selectable (menu_item))
1210 priv->in_unselectable_item = TRUE;
1211 _gtk_menu_shell_update_mnemonics (menu_shell);
1215 priv->active_menu_item = menu_item;
1216 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1217 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1220 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1221 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1222 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1224 _gtk_menu_shell_update_mnemonics (menu_shell);
1226 /* This allows the bizarre radio buttons-with-submenus-display-history
1229 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1230 gtk_widget_activate (priv->active_menu_item);
1234 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1236 GtkMenuShellPrivate *priv = menu_shell->priv;
1238 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1240 if (priv->active_menu_item)
1242 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1243 priv->active_menu_item = NULL;
1244 _gtk_menu_shell_update_mnemonics (menu_shell);
1249 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1250 GtkWidget *menu_item,
1251 gboolean force_deactivate)
1253 GSList *slist, *shells = NULL;
1254 gboolean deactivate = force_deactivate;
1256 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1257 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1260 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1262 g_object_ref (menu_shell);
1263 g_object_ref (menu_item);
1267 GtkMenuShell *parent_menu_shell = menu_shell;
1271 g_object_ref (parent_menu_shell);
1272 shells = g_slist_prepend (shells, parent_menu_shell);
1273 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1275 while (parent_menu_shell);
1276 shells = g_slist_reverse (shells);
1278 gtk_menu_shell_deactivate (menu_shell);
1280 /* Flush the x-queue, so any grabs are removed and
1281 * the menu is actually taken down
1283 gdk_display_sync (gtk_widget_get_display (menu_item));
1286 gtk_widget_activate (menu_item);
1288 for (slist = shells; slist; slist = slist->next)
1290 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1291 g_object_unref (slist->data);
1293 g_slist_free (shells);
1295 g_object_unref (menu_shell);
1296 g_object_unref (menu_item);
1299 /* Distance should be +/- 1 */
1301 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1304 GtkMenuShellPrivate *priv = menu_shell->priv;
1306 if (priv->active_menu_item)
1308 GList *node = g_list_find (priv->children, priv->active_menu_item);
1309 GList *start_node = node;
1310 gboolean wrap_around;
1312 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1313 "gtk-keynav-wrap-around", &wrap_around,
1319 while (node != start_node &&
1320 (!node || !_gtk_menu_item_is_selectable (node->data)))
1324 else if (wrap_around)
1325 node = priv->children;
1328 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1336 while (node != start_node &&
1337 (!node || !_gtk_menu_item_is_selectable (node->data)))
1341 else if (wrap_around)
1342 node = g_list_last (priv->children);
1345 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1352 gtk_menu_shell_select_item (menu_shell, node->data);
1358 /* Distance should be +/- 1 */
1360 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1363 gboolean handled = FALSE;
1365 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1366 distance, &handled);
1370 * gtk_menu_shell_select_first:
1371 * @menu_shell: a #GtkMenuShell
1372 * @search_sensitive: if %TRUE, search for the first selectable
1373 * menu item, otherwise select nothing if
1374 * the first item isn't sensitive. This
1375 * should be %FALSE if the menu is being
1376 * popped up initially.
1378 * Select the first visible or selectable child of the menu shell;
1379 * don't select tearoff items unless the only item is a tearoff
1385 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1386 gboolean search_sensitive)
1388 GtkMenuShellPrivate *priv = menu_shell->priv;
1389 GtkWidget *to_select = NULL;
1392 tmp_list = priv->children;
1395 GtkWidget *child = tmp_list->data;
1397 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1398 _gtk_menu_item_is_selectable (child))
1401 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1405 tmp_list = tmp_list->next;
1409 gtk_menu_shell_select_item (menu_shell, to_select);
1413 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1414 gboolean search_sensitive)
1416 GtkMenuShellPrivate *priv = menu_shell->priv;
1417 GtkWidget *to_select = NULL;
1420 tmp_list = g_list_last (priv->children);
1423 GtkWidget *child = tmp_list->data;
1425 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1426 _gtk_menu_item_is_selectable (child))
1429 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1433 tmp_list = tmp_list->prev;
1437 gtk_menu_shell_select_item (menu_shell, to_select);
1441 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1443 GtkMenuShellPrivate *priv = menu_shell->priv;
1444 GtkMenuItem *menu_item;
1446 if (priv->active_menu_item == NULL)
1449 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1451 if (menu_item->priv->submenu)
1453 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1454 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->priv->submenu), TRUE);
1455 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active_menu_item)
1463 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1464 GtkMenuDirectionType direction)
1466 GtkMenuShellPrivate *priv = menu_shell->priv;
1467 GtkMenuShell *parent_menu_shell = NULL;
1468 gboolean had_selection;
1469 gboolean touchscreen_mode;
1471 priv->in_unselectable_item = FALSE;
1473 had_selection = priv->active_menu_item != NULL;
1475 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1476 "gtk-touchscreen-mode", &touchscreen_mode,
1479 if (priv->parent_menu_shell)
1480 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1484 case GTK_MENU_DIR_PARENT:
1485 if (touchscreen_mode &&
1486 priv->active_menu_item &&
1487 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu &&
1488 gtk_widget_get_visible (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu))
1490 /* if we are on a menu item that has an open submenu but the
1491 * focus is not in that submenu (e.g. because it's empty or
1492 * has only insensitive items), close that submenu instead of
1493 * running into the code below which would close *this* menu.
1495 _gtk_menu_item_popdown_submenu (priv->active_menu_item);
1496 _gtk_menu_shell_update_mnemonics (menu_shell);
1498 else if (parent_menu_shell)
1500 if (touchscreen_mode)
1502 /* close menu when returning from submenu. */
1503 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->priv->parent_menu_item);
1504 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1508 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1509 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1510 gtk_menu_shell_deselect (menu_shell);
1513 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1514 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1516 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1517 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1520 /* If there is no parent and the submenu is in the opposite direction
1521 * to the menu, then make the PARENT direction wrap around to
1522 * the bottom of the submenu.
1524 else if (priv->active_menu_item &&
1525 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1526 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1528 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu);
1530 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1531 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1532 _gtk_menu_shell_select_last (submenu, TRUE);
1536 case GTK_MENU_DIR_CHILD:
1537 if (priv->active_menu_item &&
1538 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1539 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1541 if (gtk_menu_shell_select_submenu_first (menu_shell))
1545 /* Try to find a menu running the opposite direction */
1546 while (parent_menu_shell &&
1547 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1548 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1550 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1553 if (parent_menu_shell)
1555 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1556 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1558 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1560 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1564 case GTK_MENU_DIR_PREV:
1565 gtk_menu_shell_move_selected (menu_shell, -1);
1566 if (!had_selection && !priv->active_menu_item && priv->children)
1567 _gtk_menu_shell_select_last (menu_shell, TRUE);
1570 case GTK_MENU_DIR_NEXT:
1571 gtk_menu_shell_move_selected (menu_shell, 1);
1572 if (!had_selection && !priv->active_menu_item && priv->children)
1573 gtk_menu_shell_select_first (menu_shell, TRUE);
1579 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1580 gboolean force_hide)
1582 GtkMenuShellPrivate *priv = menu_shell->priv;
1584 if (priv->active_menu_item &&
1585 _gtk_menu_item_is_selectable (priv->active_menu_item))
1587 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu == NULL)
1588 gtk_menu_shell_activate_item (menu_shell,
1589 priv->active_menu_item,
1592 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1597 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1599 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1600 gtk_menu_shell_deselect (menu_shell);
1601 gtk_menu_shell_deactivate (menu_shell);
1602 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1606 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1607 GtkDirectionType dir)
1609 GtkMenuShellPrivate *priv = menu_shell->priv;
1611 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1613 if (priv->parent_menu_shell)
1614 menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1620 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1624 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1626 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1628 if (klass->get_popup_delay)
1630 return klass->get_popup_delay (menu_shell);
1635 GtkWidget *widget = GTK_WIDGET (menu_shell);
1637 g_object_get (gtk_widget_get_settings (widget),
1638 "gtk-menu-popup-delay", &popup_delay,
1646 * gtk_menu_shell_cancel:
1647 * @menu_shell: a #GtkMenuShell
1649 * Cancels the selection within the menu shell.
1654 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1656 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1658 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1661 static GtkMnemonicHash *
1662 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1665 GtkMenuShellPrivate *priv = menu_shell->priv;
1667 if (!priv->mnemonic_hash && create)
1668 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1670 return priv->mnemonic_hash;
1674 menu_shell_add_mnemonic_foreach (guint keyval,
1678 GtkKeyHash *key_hash = data;
1680 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1684 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1687 GtkMenuShellPrivate *priv = menu_shell->priv;
1688 GtkWidget *widget = GTK_WIDGET (menu_shell);
1690 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1692 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1693 GdkScreen *screen = gtk_widget_get_screen (widget);
1694 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1699 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1701 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1702 menu_shell_add_mnemonic_foreach,
1706 return priv->key_hash;
1710 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1712 GtkMenuShellPrivate *priv = menu_shell->priv;
1716 _gtk_key_hash_free (priv->key_hash);
1717 priv->key_hash = NULL;
1722 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1725 GtkMnemonicHash *mnemonic_hash;
1726 GtkKeyHash *key_hash;
1728 gboolean result = FALSE;
1730 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1734 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1738 entries = _gtk_key_hash_lookup (key_hash,
1739 event->hardware_keycode,
1741 gtk_accelerator_get_default_mod_mask (),
1745 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1746 GPOINTER_TO_UINT (entries->data));
1752 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1756 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1757 g_return_if_fail (GTK_IS_WIDGET (target));
1759 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1761 gtk_menu_shell_reset_key_hash (menu_shell);
1765 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1769 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1770 g_return_if_fail (GTK_IS_WIDGET (target));
1772 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1774 gtk_menu_shell_reset_key_hash (menu_shell);
1778 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1781 GtkMenuShellPrivate *priv = menu_shell->priv;
1783 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1784 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1787 priv->grab_pointer = NULL;
1788 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1789 priv->grab_pointer = gdk_device_get_associated_device (device);
1791 priv->grab_pointer = device;
1795 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1797 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1799 return menu_shell->priv->grab_pointer;
1803 * gtk_menu_shell_get_take_focus:
1804 * @menu_shell: a #GtkMenuShell
1806 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1808 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1813 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1815 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1817 return menu_shell->priv->take_focus;
1821 * gtk_menu_shell_set_take_focus:
1822 * @menu_shell: a #GtkMenuShell
1823 * @take_focus: %TRUE if the menu shell should take the keyboard
1826 * If @take_focus is %TRUE (the default) the menu shell will take
1827 * the keyboard focus so that it will receive all keyboard events
1828 * which is needed to enable keyboard navigation in menus.
1830 * Setting @take_focus to %FALSE is useful only for special applications
1831 * like virtual keyboard implementations which should not take keyboard
1834 * The @take_focus state of a menu or menu bar is automatically
1835 * propagated to submenus whenever a submenu is popped up, so you
1836 * don't have to worry about recursively setting it for your entire
1837 * menu hierarchy. Only when programmatically picking a submenu and
1838 * popping it up manually, the @take_focus property of the submenu
1839 * needs to be set explicitely.
1841 * Note that setting it to %FALSE has side-effects:
1843 * If the focus is in some other app, it keeps the focus and keynav in
1844 * the menu doesn't work. Consequently, keynav on the menu will only
1845 * work if the focus is on some toplevel owned by the onscreen keyboard.
1847 * To avoid confusing the user, menus with @take_focus set to %FALSE
1848 * should not display mnemonics or accelerators, since it cannot be
1849 * guaranteed that they will work.
1851 * See also gdk_keyboard_grab()
1856 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1857 gboolean take_focus)
1859 GtkMenuShellPrivate *priv = menu_shell->priv;
1861 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1863 if (priv->take_focus != take_focus)
1865 priv->take_focus = take_focus;
1866 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1871 * gtk_menu_shell_get_selected_item:
1872 * @menu_shell: a #GtkMenuShell
1874 * Gets the currently selected item.
1876 * Returns: the currently selected item
1881 gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell)
1883 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1885 return menu_shell->priv->active_menu_item;
1889 * gtk_menu_shell_get_parent_shell:
1890 * @menu_shell: a #GtkMenuShell
1892 * Gets the parent menu shell.
1894 * The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
1895 * from which it was opened up.
1897 * Returns: the parent #GtkMenuShell
1902 gtk_menu_shell_get_parent_shell (GtkMenuShell *menu_shell)
1904 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1906 return menu_shell->priv->parent_menu_shell;