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 "gtkmenuitem.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);
648 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
649 GTK_MENU_ITEM (menu_item)->submenu != NULL &&
650 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
652 _gtk_menu_item_popup_submenu (menu_item, FALSE);
653 priv->activated_submenu = TRUE;
660 gtk_menu_shell_grab_broken (GtkWidget *widget,
661 GdkEventGrabBroken *event)
663 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
664 GtkMenuShellPrivate *priv = menu_shell->priv;
666 if (priv->have_xgrab && event->grab_window == NULL)
668 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
669 gtk_menu_shell_deselect (menu_shell);
670 gtk_menu_shell_deactivate (menu_shell);
671 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
678 gtk_menu_shell_button_release (GtkWidget *widget,
679 GdkEventButton *event)
681 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
682 GtkMenuShellPrivate *priv = menu_shell->priv;
686 GtkWidget *menu_item;
687 gboolean deactivate = TRUE;
689 if (priv->button && (event->button != priv->button))
692 if (priv->parent_menu_shell)
693 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
697 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
699 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
701 if (menu_item && (priv->active_menu_item == menu_item) &&
702 _gtk_menu_item_is_selectable (menu_item))
704 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->submenu;
708 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
711 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
712 priv->activated_submenu)
715 GTimeVal *popup_time;
716 gint64 usec_since_popup = 0;
718 g_object_get (gtk_widget_get_settings (widget),
719 "gtk-menu-popdown-delay", &popdown_delay,
722 popup_time = g_object_get_data (G_OBJECT (submenu),
723 "gtk-menu-exact-popup-time");
727 GTimeVal current_time;
729 g_get_current_time (¤t_time);
731 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
732 (gint64) current_time.tv_usec -
733 (gint64) popup_time->tv_sec * 1000 * 1000 -
734 (gint64) popup_time->tv_usec);
736 g_object_set_data (G_OBJECT (submenu),
737 "gtk-menu-exact-popup-time", NULL);
740 /* Only close the submenu on click if we opened the
741 * menu explicitely (usec_since_popup == 0) or
742 * enough time has passed since it was opened by
743 * GtkMenuItem's timeout (usec_since_popup > delay).
745 if (!priv->activated_submenu &&
746 (usec_since_popup == 0 ||
747 usec_since_popup > popdown_delay * 1000))
749 _gtk_menu_item_popdown_submenu (menu_item);
753 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
759 else if (menu_item &&
760 !_gtk_menu_item_is_selectable (menu_item) &&
761 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
765 else if (priv->parent_menu_shell)
768 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
772 /* If we ended up on an item with a submenu, leave the menu up. */
774 (priv->active_menu_item == menu_item) &&
775 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
780 else /* a very fast press-release */
782 /* We only ever want to prevent deactivation on the first
783 * press/release. Setting the time to zero is a bit of a
784 * hack, since we could be being triggered in the first
785 * few fractions of a second after a server time wraparound.
786 * the chances of that happening are ~1/10^6, without
787 * serious harm if we lose.
789 priv->activate_time = 0;
795 gtk_menu_shell_deactivate (menu_shell);
796 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
799 priv->activated_submenu = FALSE;
806 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
807 gboolean keyboard_mode)
809 menu_shell->priv->keyboard_mode = keyboard_mode;
813 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
815 return menu_shell->priv->keyboard_mode;
819 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
821 GtkMenuShell *target;
822 gboolean auto_mnemonics;
824 gboolean mnemonics_visible;
826 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
827 "gtk-auto-mnemonics", &auto_mnemonics,
837 GtkMenuShellPrivate *priv = target->priv;
838 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
840 /* The idea with keyboard mode is that once you start using
841 * the keyboard to navigate the menus, we show mnemonics
842 * until the menu navigation is over. To that end, we spread
843 * the keyboard mode upwards in the menu hierarchy here.
844 * Also see gtk_menu_popup, where we inherit it downwards.
846 if (menu_shell->priv->keyboard_mode)
847 target->priv->keyboard_mode = TRUE;
849 /* While navigating menus, the first parent menu with an active
850 * item is the one where mnemonics are effective, as can be seen
851 * in gtk_menu_shell_key_press below.
852 * We also show mnemonics in context menus. The grab condition is
853 * necessary to ensure we remove underlines from menu bars when
856 mnemonics_visible = target->priv->keyboard_mode &&
857 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
858 (target == menu_shell &&
859 !target->priv->parent_menu_shell &&
860 gtk_widget_has_grab (GTK_WIDGET (target))));
862 /* While menus are up, only show underlines inside the menubar,
863 * not in the entire window.
865 if (GTK_IS_MENU_BAR (target))
867 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
868 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
872 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
874 if (target->priv->active_menu_item || priv->in_unselectable_item)
877 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
882 gtk_menu_shell_key_press (GtkWidget *widget,
885 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
886 GtkMenuShellPrivate *priv = menu_shell->priv;
887 gboolean enable_mnemonics;
889 priv->keyboard_mode = TRUE;
891 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
892 priv->parent_menu_shell)
893 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
895 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
898 g_object_get (gtk_widget_get_settings (widget),
899 "gtk-enable-mnemonics", &enable_mnemonics,
902 if (enable_mnemonics)
903 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
909 gtk_menu_shell_enter_notify (GtkWidget *widget,
910 GdkEventCrossing *event)
912 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
913 GtkMenuShellPrivate *priv = menu_shell->priv;
915 if (event->mode == GDK_CROSSING_GTK_GRAB ||
916 event->mode == GDK_CROSSING_GTK_UNGRAB ||
917 event->mode == GDK_CROSSING_STATE_CHANGED)
922 GtkWidget *menu_item;
925 menu_item = gtk_get_event_widget ((GdkEvent*) event);
930 if (GTK_IS_MENU_ITEM (menu_item) &&
931 !_gtk_menu_item_is_selectable (menu_item))
933 priv->in_unselectable_item = TRUE;
937 parent = gtk_widget_get_parent (menu_item);
938 if (parent == widget &&
939 GTK_IS_MENU_ITEM (menu_item))
941 if (priv->ignore_enter)
944 if (event->detail != GDK_NOTIFY_INFERIOR)
946 if (gtk_widget_get_state (menu_item) != GTK_STATE_PRELIGHT)
947 gtk_menu_shell_select_item (menu_shell, menu_item);
949 /* If any mouse button is down, and there is a submenu
950 * that is not yet visible, activate it. It's sufficient
951 * to check for any button's mask (not only the one
952 * matching menu_shell->button), because there is no
953 * situation a mouse button could be pressed while
954 * entering a menu item where we wouldn't want to show
957 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
958 GTK_MENU_ITEM (menu_item)->submenu != NULL)
960 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
962 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
964 gboolean touchscreen_mode;
966 g_object_get (gtk_widget_get_settings (widget),
967 "gtk-touchscreen-mode", &touchscreen_mode,
970 if (touchscreen_mode)
971 _gtk_menu_item_popup_submenu (menu_item, TRUE);
976 else if (priv->parent_menu_shell)
978 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
986 gtk_menu_shell_leave_notify (GtkWidget *widget,
987 GdkEventCrossing *event)
989 if (event->mode == GDK_CROSSING_GTK_GRAB ||
990 event->mode == GDK_CROSSING_GTK_GRAB ||
991 event->mode == GDK_CROSSING_STATE_CHANGED)
994 if (gtk_widget_get_visible (widget))
996 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
997 GtkMenuShellPrivate *priv = menu_shell->priv;
998 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
999 GtkMenuItem *menu_item;
1001 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1004 menu_item = GTK_MENU_ITEM (event_widget);
1006 if (!_gtk_menu_item_is_selectable (event_widget))
1008 priv->in_unselectable_item = TRUE;
1012 if ((priv->active_menu_item == event_widget) &&
1013 (menu_item->submenu == NULL))
1015 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1016 (gtk_widget_get_state (GTK_WIDGET (menu_item)) != GTK_STATE_NORMAL))
1018 gtk_menu_shell_deselect (menu_shell);
1021 else if (priv->parent_menu_shell)
1023 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1031 gtk_menu_shell_screen_changed (GtkWidget *widget,
1032 GdkScreen *previous_screen)
1034 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1038 gtk_menu_shell_add (GtkContainer *container,
1041 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1045 gtk_menu_shell_remove (GtkContainer *container,
1048 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1049 GtkMenuShellPrivate *priv = menu_shell->priv;
1052 was_visible = gtk_widget_get_visible (widget);
1053 priv->children = g_list_remove (priv->children, widget);
1055 if (widget == priv->active_menu_item)
1057 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1058 priv->active_menu_item = NULL;
1061 gtk_widget_unparent (widget);
1063 /* Queue resize regardless of gtk_widget_get_visible (container),
1064 * since that's what is needed by toplevels.
1067 gtk_widget_queue_resize (GTK_WIDGET (container));
1071 gtk_menu_shell_forall (GtkContainer *container,
1072 gboolean include_internals,
1073 GtkCallback callback,
1074 gpointer callback_data)
1076 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1080 children = menu_shell->priv->children;
1083 child = children->data;
1084 children = children->next;
1086 (* callback) (child, callback_data);
1092 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1094 GtkMenuShellPrivate *priv = menu_shell->priv;
1100 priv->active = FALSE;
1101 priv->activate_time = 0;
1103 if (priv->active_menu_item)
1105 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1106 priv->active_menu_item = NULL;
1109 if (priv->have_grab)
1111 priv->have_grab = FALSE;
1112 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1114 if (priv->have_xgrab)
1116 GdkDevice *keyboard;
1118 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1119 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1122 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1124 priv->have_xgrab = FALSE;
1127 priv->keyboard_mode = FALSE;
1128 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1130 _gtk_menu_shell_update_mnemonics (menu_shell);
1135 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1140 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1141 g_return_val_if_fail (child != NULL, FALSE);
1143 parent = gtk_widget_get_parent (child);
1144 while (GTK_IS_MENU_SHELL (parent))
1146 if (parent == (GtkWidget*) menu_shell)
1148 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1155 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1158 GtkWidget *menu_item;
1160 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1162 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1163 menu_item = gtk_widget_get_parent (menu_item);
1165 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1171 /* Handlers for action signals */
1174 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1175 GtkWidget *menu_item)
1177 GtkMenuShellPrivate *priv = menu_shell->priv;
1178 GtkMenuShellClass *class;
1180 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1181 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1183 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1185 if (class->select_item &&
1187 priv->active_menu_item == menu_item))
1188 class->select_item (menu_shell, menu_item);
1191 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1192 GtkSubmenuPlacement placement);
1195 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1196 GtkWidget *menu_item)
1198 GtkMenuShellPrivate *priv = menu_shell->priv;
1199 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1201 if (priv->active_menu_item)
1203 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1204 priv->active_menu_item = NULL;
1207 if (!_gtk_menu_item_is_selectable (menu_item))
1209 priv->in_unselectable_item = TRUE;
1210 _gtk_menu_shell_update_mnemonics (menu_shell);
1214 priv->active_menu_item = menu_item;
1215 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1216 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1219 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1220 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1221 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1223 _gtk_menu_shell_update_mnemonics (menu_shell);
1225 /* This allows the bizarre radio buttons-with-submenus-display-history
1228 if (GTK_MENU_ITEM (priv->active_menu_item)->submenu)
1229 gtk_widget_activate (priv->active_menu_item);
1233 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1235 GtkMenuShellPrivate *priv = menu_shell->priv;
1237 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1239 if (priv->active_menu_item)
1241 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1242 priv->active_menu_item = NULL;
1243 _gtk_menu_shell_update_mnemonics (menu_shell);
1248 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1249 GtkWidget *menu_item,
1250 gboolean force_deactivate)
1252 GSList *slist, *shells = NULL;
1253 gboolean deactivate = force_deactivate;
1255 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1256 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1259 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1261 g_object_ref (menu_shell);
1262 g_object_ref (menu_item);
1266 GtkMenuShell *parent_menu_shell = menu_shell;
1270 g_object_ref (parent_menu_shell);
1271 shells = g_slist_prepend (shells, parent_menu_shell);
1272 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1274 while (parent_menu_shell);
1275 shells = g_slist_reverse (shells);
1277 gtk_menu_shell_deactivate (menu_shell);
1279 /* Flush the x-queue, so any grabs are removed and
1280 * the menu is actually taken down
1282 gdk_display_sync (gtk_widget_get_display (menu_item));
1285 gtk_widget_activate (menu_item);
1287 for (slist = shells; slist; slist = slist->next)
1289 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1290 g_object_unref (slist->data);
1292 g_slist_free (shells);
1294 g_object_unref (menu_shell);
1295 g_object_unref (menu_item);
1298 /* Distance should be +/- 1 */
1300 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1303 GtkMenuShellPrivate *priv = menu_shell->priv;
1305 if (priv->active_menu_item)
1307 GList *node = g_list_find (priv->children, priv->active_menu_item);
1308 GList *start_node = node;
1309 gboolean wrap_around;
1311 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1312 "gtk-keynav-wrap-around", &wrap_around,
1318 while (node != start_node &&
1319 (!node || !_gtk_menu_item_is_selectable (node->data)))
1323 else if (wrap_around)
1324 node = priv->children;
1327 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1335 while (node != start_node &&
1336 (!node || !_gtk_menu_item_is_selectable (node->data)))
1340 else if (wrap_around)
1341 node = g_list_last (priv->children);
1344 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1351 gtk_menu_shell_select_item (menu_shell, node->data);
1357 /* Distance should be +/- 1 */
1359 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1362 gboolean handled = FALSE;
1364 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1365 distance, &handled);
1369 * gtk_menu_shell_select_first:
1370 * @menu_shell: a #GtkMenuShell
1371 * @search_sensitive: if %TRUE, search for the first selectable
1372 * menu item, otherwise select nothing if
1373 * the first item isn't sensitive. This
1374 * should be %FALSE if the menu is being
1375 * popped up initially.
1377 * Select the first visible or selectable child of the menu shell;
1378 * don't select tearoff items unless the only item is a tearoff
1384 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1385 gboolean search_sensitive)
1387 GtkMenuShellPrivate *priv = menu_shell->priv;
1388 GtkWidget *to_select = NULL;
1391 tmp_list = priv->children;
1394 GtkWidget *child = tmp_list->data;
1396 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1397 _gtk_menu_item_is_selectable (child))
1400 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1404 tmp_list = tmp_list->next;
1408 gtk_menu_shell_select_item (menu_shell, to_select);
1412 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1413 gboolean search_sensitive)
1415 GtkMenuShellPrivate *priv = menu_shell->priv;
1416 GtkWidget *to_select = NULL;
1419 tmp_list = g_list_last (priv->children);
1422 GtkWidget *child = tmp_list->data;
1424 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1425 _gtk_menu_item_is_selectable (child))
1428 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1432 tmp_list = tmp_list->prev;
1436 gtk_menu_shell_select_item (menu_shell, to_select);
1440 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1442 GtkMenuShellPrivate *priv = menu_shell->priv;
1443 GtkMenuItem *menu_item;
1445 if (priv->active_menu_item == NULL)
1448 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1450 if (menu_item->submenu)
1452 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1453 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1454 if (GTK_MENU_SHELL (menu_item->submenu)->priv->active_menu_item)
1462 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1463 GtkMenuDirectionType direction)
1465 GtkMenuShellPrivate *priv = menu_shell->priv;
1466 GtkMenuShell *parent_menu_shell = NULL;
1467 gboolean had_selection;
1468 gboolean touchscreen_mode;
1470 priv->in_unselectable_item = FALSE;
1472 had_selection = priv->active_menu_item != NULL;
1474 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1475 "gtk-touchscreen-mode", &touchscreen_mode,
1478 if (priv->parent_menu_shell)
1479 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1483 case GTK_MENU_DIR_PARENT:
1484 if (touchscreen_mode &&
1485 priv->active_menu_item &&
1486 GTK_MENU_ITEM (priv->active_menu_item)->submenu &&
1487 gtk_widget_get_visible (GTK_MENU_ITEM (priv->active_menu_item)->submenu))
1489 /* if we are on a menu item that has an open submenu but the
1490 * focus is not in that submenu (e.g. because it's empty or
1491 * has only insensitive items), close that submenu instead of
1492 * running into the code below which would close *this* menu.
1494 _gtk_menu_item_popdown_submenu (priv->active_menu_item);
1495 _gtk_menu_shell_update_mnemonics (menu_shell);
1497 else if (parent_menu_shell)
1499 if (touchscreen_mode)
1501 /* close menu when returning from submenu. */
1502 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->priv->parent_menu_item);
1503 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1507 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1508 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1509 gtk_menu_shell_deselect (menu_shell);
1512 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1513 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1515 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1516 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1519 /* If there is no parent and the submenu is in the opposite direction
1520 * to the menu, then make the PARENT direction wrap around to
1521 * the bottom of the submenu.
1523 else if (priv->active_menu_item &&
1524 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1525 GTK_MENU_ITEM (priv->active_menu_item)->submenu)
1527 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->submenu);
1529 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1530 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1531 _gtk_menu_shell_select_last (submenu, TRUE);
1535 case GTK_MENU_DIR_CHILD:
1536 if (priv->active_menu_item &&
1537 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1538 GTK_MENU_ITEM (priv->active_menu_item)->submenu)
1540 if (gtk_menu_shell_select_submenu_first (menu_shell))
1544 /* Try to find a menu running the opposite direction */
1545 while (parent_menu_shell &&
1546 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1547 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1549 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1552 if (parent_menu_shell)
1554 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1555 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1557 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1559 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1563 case GTK_MENU_DIR_PREV:
1564 gtk_menu_shell_move_selected (menu_shell, -1);
1565 if (!had_selection &&
1566 !priv->active_menu_item &&
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 &&
1574 !priv->active_menu_item &&
1576 gtk_menu_shell_select_first (menu_shell, TRUE);
1582 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1583 gboolean force_hide)
1585 GtkMenuShellPrivate *priv = menu_shell->priv;
1587 if (priv->active_menu_item &&
1588 _gtk_menu_item_is_selectable (priv->active_menu_item))
1590 if (GTK_MENU_ITEM (priv->active_menu_item)->submenu == NULL)
1591 gtk_menu_shell_activate_item (menu_shell,
1592 priv->active_menu_item,
1595 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1600 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1602 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1603 gtk_menu_shell_deselect (menu_shell);
1604 gtk_menu_shell_deactivate (menu_shell);
1605 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1609 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1610 GtkDirectionType dir)
1612 GtkMenuShellPrivate *priv = menu_shell->priv;
1614 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1616 if (priv->parent_menu_shell)
1617 menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1623 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1627 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1629 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1631 if (klass->get_popup_delay)
1633 return klass->get_popup_delay (menu_shell);
1638 GtkWidget *widget = GTK_WIDGET (menu_shell);
1640 g_object_get (gtk_widget_get_settings (widget),
1641 "gtk-menu-popup-delay", &popup_delay,
1649 * gtk_menu_shell_cancel:
1650 * @menu_shell: a #GtkMenuShell
1652 * Cancels the selection within the menu shell.
1657 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1659 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1661 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1664 static GtkMnemonicHash *
1665 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1668 GtkMenuShellPrivate *priv = menu_shell->priv;
1670 if (!priv->mnemonic_hash && create)
1671 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1673 return priv->mnemonic_hash;
1677 menu_shell_add_mnemonic_foreach (guint keyval,
1681 GtkKeyHash *key_hash = data;
1683 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1687 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1690 GtkMenuShellPrivate *priv = menu_shell->priv;
1691 GtkWidget *widget = GTK_WIDGET (menu_shell);
1693 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1695 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1696 GdkScreen *screen = gtk_widget_get_screen (widget);
1697 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1702 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1704 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1705 menu_shell_add_mnemonic_foreach,
1709 return priv->key_hash;
1713 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1715 GtkMenuShellPrivate *priv = menu_shell->priv;
1719 _gtk_key_hash_free (priv->key_hash);
1720 priv->key_hash = NULL;
1725 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1728 GtkMnemonicHash *mnemonic_hash;
1729 GtkKeyHash *key_hash;
1731 gboolean result = FALSE;
1733 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1737 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1741 entries = _gtk_key_hash_lookup (key_hash,
1742 event->hardware_keycode,
1744 gtk_accelerator_get_default_mod_mask (),
1748 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1749 GPOINTER_TO_UINT (entries->data));
1755 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1759 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1760 g_return_if_fail (GTK_IS_WIDGET (target));
1762 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1764 gtk_menu_shell_reset_key_hash (menu_shell);
1768 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1772 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1773 g_return_if_fail (GTK_IS_WIDGET (target));
1775 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1777 gtk_menu_shell_reset_key_hash (menu_shell);
1781 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1784 GtkMenuShellPrivate *priv = menu_shell->priv;
1786 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1787 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1790 priv->grab_pointer = NULL;
1791 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1792 priv->grab_pointer = gdk_device_get_associated_device (device);
1794 priv->grab_pointer = device;
1798 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1800 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1802 return menu_shell->priv->grab_pointer;
1806 * gtk_menu_shell_get_take_focus:
1807 * @menu_shell: a #GtkMenuShell
1809 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1811 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1816 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1818 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1820 return menu_shell->priv->take_focus;
1824 * gtk_menu_shell_set_take_focus:
1825 * @menu_shell: a #GtkMenuShell
1826 * @take_focus: %TRUE if the menu shell should take the keyboard
1829 * If @take_focus is %TRUE (the default) the menu shell will take
1830 * the keyboard focus so that it will receive all keyboard events
1831 * which is needed to enable keyboard navigation in menus.
1833 * Setting @take_focus to %FALSE is useful only for special applications
1834 * like virtual keyboard implementations which should not take keyboard
1837 * The @take_focus state of a menu or menu bar is automatically
1838 * propagated to submenus whenever a submenu is popped up, so you
1839 * don't have to worry about recursively setting it for your entire
1840 * menu hierarchy. Only when programmatically picking a submenu and
1841 * popping it up manually, the @take_focus property of the submenu
1842 * needs to be set explicitely.
1844 * Note that setting it to %FALSE has side-effects:
1846 * If the focus is in some other app, it keeps the focus and keynav in
1847 * the menu doesn't work. Consequently, keynav on the menu will only
1848 * work if the focus is on some toplevel owned by the onscreen keyboard.
1850 * To avoid confusing the user, menus with @take_focus set to %FALSE
1851 * should not display mnemonics or accelerators, since it cannot be
1852 * guaranteed that they will work.
1854 * See also gdk_keyboard_grab()
1859 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1860 gboolean take_focus)
1862 GtkMenuShellPrivate *priv = menu_shell->priv;
1864 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1866 if (priv->take_focus != take_focus)
1868 priv->take_focus = take_focus;
1869 g_object_notify (G_OBJECT (menu_shell), "take-focus");