1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #define GTK_MENU_INTERNALS
30 #include "gdk/gdkkeysyms.h"
31 #include "gtkbindings.h"
32 #include "gtkkeyhash.h"
35 #include "gtkmarshalers.h"
37 #include "gtkmenubar.h"
38 #include "gtkmenuitem.h"
39 #include "gtkmenushell.h"
40 #include "gtkmnemonichash.h"
41 #include "gtktearoffmenuitem.h"
42 #include "gtkwindow.h"
43 #include "gtkprivate.h"
47 #define MENU_SHELL_TIMEOUT 500
49 #define PACK_DIRECTION(m) \
50 (GTK_IS_MENU_BAR (m) \
51 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
52 : GTK_PACK_DIRECTION_LTR)
72 * A menu item can be "selected", this means that it is displayed
73 * in the prelight state, and if it has a submenu, that submenu
76 * A menu is "active" when it is visible onscreen and the user
77 * is selecting from it. A menubar is not active until the user
78 * clicks on one of its menuitems. When a menu is active,
79 * passing the mouse over a submenu will pop it up.
81 * menu_shell->active_menu_item, is however, not an "active"
82 * menu item (there is no such thing) but rather, the selected
83 * menu item in that MenuShell, if there is one.
85 * There is also is a concept of the current menu and a current
86 * menu item. The current menu item is the selected menu item
87 * that is furthest down in the hierarchy. (Every active menu_shell
88 * does not necessarily contain a selected menu item, but if
89 * it does, then menu_shell->parent_menu_shell must also contain
90 * a selected menu item. The current menu is the menu that
91 * contains the current menu_item. It will always have a GTK
92 * grab and receive all key presses.
97 * ::move_current (GtkMenuDirection *dir)
98 * Moves the current menu item in direction 'dir':
100 * GTK_MENU_DIR_PARENT: To the parent menu shell
101 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
103 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
106 * As a a bit of a hack to get movement between menus and
107 * menubars working, if submenu_placement is different for
108 * the menu and its MenuShell then the following apply:
110 * - For 'parent' the current menu is not just moved to
111 * the parent, but moved to the previous entry in the parent
112 * - For 'child', if there is no child, then current is
113 * moved to the next item in the parent.
115 * Note that the above explanation of ::move_current was written
116 * before menus and menubars had support for RTL flipping and
117 * different packing directions, and therefore only applies for
118 * when text direction and packing direction are both left-to-right.
120 * ::activate_current (GBoolean *force_hide)
121 * Activate the current item. If 'force_hide' is true, hide
122 * the current menu item always. Otherwise, only hide
123 * it if menu_item->klass->hide_on_activate is true.
126 * Cancels the current selection
129 #define GTK_MENU_SHELL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShellPrivate))
131 typedef struct _GtkMenuShellPrivate GtkMenuShellPrivate;
133 struct _GtkMenuShellPrivate
135 GtkMnemonicHash *mnemonic_hash;
136 GtkKeyHash *key_hash;
138 GdkDevice *grab_keyboard;
139 GdkDevice *grab_pointer;
141 guint take_focus : 1;
142 guint activated_submenu : 1;
143 /* This flag is a crutch to keep mnemonics in the same menu
144 * if the user moves the mouse over an unselectable menuitem.
146 guint in_unselectable_item : 1;
149 static void gtk_menu_shell_set_property (GObject *object,
153 static void gtk_menu_shell_get_property (GObject *object,
157 static void gtk_menu_shell_realize (GtkWidget *widget);
158 static void gtk_menu_shell_finalize (GObject *object);
159 static gint gtk_menu_shell_button_press (GtkWidget *widget,
160 GdkEventButton *event);
161 static gint gtk_menu_shell_button_release (GtkWidget *widget,
162 GdkEventButton *event);
163 static gint gtk_menu_shell_key_press (GtkWidget *widget,
165 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
166 GdkEventCrossing *event);
167 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
168 GdkEventCrossing *event);
169 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
170 GdkScreen *previous_screen);
171 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
172 GdkEventGrabBroken *event);
173 static void gtk_menu_shell_add (GtkContainer *container,
175 static void gtk_menu_shell_remove (GtkContainer *container,
177 static void gtk_menu_shell_forall (GtkContainer *container,
178 gboolean include_internals,
179 GtkCallback callback,
180 gpointer callback_data);
181 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
184 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
185 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
187 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
189 static GType gtk_menu_shell_child_type (GtkContainer *container);
190 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
191 GtkWidget *menu_item);
192 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
194 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
195 GtkMenuDirectionType direction);
196 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
197 gboolean force_hide);
198 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
199 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
200 GtkDirectionType dir);
202 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
203 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
205 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
208 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
210 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
213 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
215 GObjectClass *object_class;
216 GtkWidgetClass *widget_class;
217 GtkContainerClass *container_class;
219 GtkBindingSet *binding_set;
221 object_class = (GObjectClass*) klass;
222 widget_class = (GtkWidgetClass*) klass;
223 container_class = (GtkContainerClass*) klass;
225 object_class->set_property = gtk_menu_shell_set_property;
226 object_class->get_property = gtk_menu_shell_get_property;
227 object_class->finalize = gtk_menu_shell_finalize;
229 widget_class->realize = gtk_menu_shell_realize;
230 widget_class->button_press_event = gtk_menu_shell_button_press;
231 widget_class->button_release_event = gtk_menu_shell_button_release;
232 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
233 widget_class->key_press_event = gtk_menu_shell_key_press;
234 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
235 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
236 widget_class->screen_changed = gtk_menu_shell_screen_changed;
238 container_class->add = gtk_menu_shell_add;
239 container_class->remove = gtk_menu_shell_remove;
240 container_class->forall = gtk_menu_shell_forall;
241 container_class->child_type = gtk_menu_shell_child_type;
243 klass->submenu_placement = GTK_TOP_BOTTOM;
244 klass->deactivate = gtk_real_menu_shell_deactivate;
245 klass->selection_done = NULL;
246 klass->move_current = gtk_real_menu_shell_move_current;
247 klass->activate_current = gtk_real_menu_shell_activate_current;
248 klass->cancel = gtk_real_menu_shell_cancel;
249 klass->select_item = gtk_menu_shell_real_select_item;
250 klass->insert = gtk_menu_shell_real_insert;
251 klass->move_selected = gtk_menu_shell_real_move_selected;
253 menu_shell_signals[DEACTIVATE] =
254 g_signal_new (I_("deactivate"),
255 G_OBJECT_CLASS_TYPE (object_class),
257 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
259 _gtk_marshal_VOID__VOID,
262 menu_shell_signals[SELECTION_DONE] =
263 g_signal_new (I_("selection-done"),
264 G_OBJECT_CLASS_TYPE (object_class),
266 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
268 _gtk_marshal_VOID__VOID,
271 menu_shell_signals[MOVE_CURRENT] =
272 g_signal_new (I_("move-current"),
273 G_OBJECT_CLASS_TYPE (object_class),
274 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
275 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
277 _gtk_marshal_VOID__ENUM,
279 GTK_TYPE_MENU_DIRECTION_TYPE);
281 menu_shell_signals[ACTIVATE_CURRENT] =
282 g_signal_new (I_("activate-current"),
283 G_OBJECT_CLASS_TYPE (object_class),
284 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
285 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
287 _gtk_marshal_VOID__BOOLEAN,
291 menu_shell_signals[CANCEL] =
292 g_signal_new (I_("cancel"),
293 G_OBJECT_CLASS_TYPE (object_class),
294 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
295 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
297 _gtk_marshal_VOID__VOID,
300 menu_shell_signals[CYCLE_FOCUS] =
301 g_signal_new_class_handler (I_("cycle-focus"),
302 G_OBJECT_CLASS_TYPE (object_class),
303 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
304 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
306 _gtk_marshal_VOID__ENUM,
308 GTK_TYPE_DIRECTION_TYPE);
311 * GtkMenuShell::move-selected:
312 * @menu_shell: the object on which the signal is emitted
313 * @distance: +1 to move to the next item, -1 to move to the previous
315 * The ::move-selected signal is emitted to move the selection to
318 * Returns: %TRUE to stop the signal emission, %FALSE to continue
322 menu_shell_signals[MOVE_SELECTED] =
323 g_signal_new (I_("move-selected"),
324 G_OBJECT_CLASS_TYPE (object_class),
326 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
327 _gtk_boolean_handled_accumulator, NULL,
328 _gtk_marshal_BOOLEAN__INT,
332 binding_set = gtk_binding_set_by_class (klass);
333 gtk_binding_entry_add_signal (binding_set,
336 gtk_binding_entry_add_signal (binding_set,
338 "activate-current", 1,
341 gtk_binding_entry_add_signal (binding_set,
343 "activate-current", 1,
346 gtk_binding_entry_add_signal (binding_set,
348 "activate-current", 1,
351 gtk_binding_entry_add_signal (binding_set,
353 "activate-current", 1,
356 gtk_binding_entry_add_signal (binding_set,
358 "activate-current", 1,
361 gtk_binding_entry_add_signal (binding_set,
364 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
365 gtk_binding_entry_add_signal (binding_set,
366 GDK_F10, GDK_SHIFT_MASK,
368 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
371 * GtkMenuShell:take-focus:
373 * A boolean that determines whether the menu and its submenus grab the
374 * keyboard focus. See gtk_menu_shell_set_take_focus() and
375 * gtk_menu_shell_get_take_focus().
379 g_object_class_install_property (object_class,
381 g_param_spec_boolean ("take-focus",
383 P_("A boolean that determines whether the menu grabs the keyboard focus"),
385 GTK_PARAM_READWRITE));
387 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
391 gtk_menu_shell_child_type (GtkContainer *container)
393 return GTK_TYPE_MENU_ITEM;
397 gtk_menu_shell_init (GtkMenuShell *menu_shell)
399 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
401 menu_shell->children = NULL;
402 menu_shell->active_menu_item = NULL;
403 menu_shell->parent_menu_shell = NULL;
404 menu_shell->active = FALSE;
405 menu_shell->have_grab = FALSE;
406 menu_shell->have_xgrab = FALSE;
407 menu_shell->button = 0;
408 menu_shell->activate_time = 0;
410 priv->mnemonic_hash = NULL;
411 priv->key_hash = NULL;
412 priv->take_focus = TRUE;
413 priv->activated_submenu = FALSE;
417 gtk_menu_shell_set_property (GObject *object,
422 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
426 case PROP_TAKE_FOCUS:
427 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
430 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
436 gtk_menu_shell_get_property (GObject *object,
441 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
445 case PROP_TAKE_FOCUS:
446 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
449 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
455 gtk_menu_shell_finalize (GObject *object)
457 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
458 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
460 if (priv->mnemonic_hash)
461 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
463 _gtk_key_hash_free (priv->key_hash);
465 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
470 gtk_menu_shell_append (GtkMenuShell *menu_shell,
473 gtk_menu_shell_insert (menu_shell, child, -1);
477 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
480 gtk_menu_shell_insert (menu_shell, child, 0);
484 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
488 GtkMenuShellClass *class;
490 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
491 g_return_if_fail (GTK_IS_MENU_ITEM (child));
493 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
496 class->insert (menu_shell, child, position);
500 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
504 menu_shell->children = g_list_insert (menu_shell->children, child, position);
506 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
510 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
512 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
514 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
518 gtk_menu_shell_realize (GtkWidget *widget)
520 GdkWindowAttr attributes;
521 gint attributes_mask;
523 gtk_widget_set_realized (widget, TRUE);
525 attributes.x = widget->allocation.x;
526 attributes.y = widget->allocation.y;
527 attributes.width = widget->allocation.width;
528 attributes.height = widget->allocation.height;
529 attributes.window_type = GDK_WINDOW_CHILD;
530 attributes.wclass = GDK_INPUT_OUTPUT;
531 attributes.visual = gtk_widget_get_visual (widget);
532 attributes.colormap = gtk_widget_get_colormap (widget);
533 attributes.event_mask = gtk_widget_get_events (widget);
534 attributes.event_mask |= (GDK_EXPOSURE_MASK |
535 GDK_BUTTON_PRESS_MASK |
536 GDK_BUTTON_RELEASE_MASK |
538 GDK_ENTER_NOTIFY_MASK |
539 GDK_LEAVE_NOTIFY_MASK);
541 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
542 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
543 gdk_window_set_user_data (widget->window, widget);
545 widget->style = gtk_style_attach (widget->style, widget->window);
546 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
550 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
552 if (!menu_shell->active)
554 gtk_device_grab_add (GTK_WIDGET (menu_shell),
555 gtk_get_current_event_device (),
557 menu_shell->have_grab = TRUE;
558 menu_shell->active = TRUE;
563 gtk_menu_shell_button_press (GtkWidget *widget,
564 GdkEventButton *event)
566 GtkMenuShell *menu_shell;
567 GtkWidget *menu_item;
569 if (event->type != GDK_BUTTON_PRESS)
572 menu_shell = GTK_MENU_SHELL (widget);
574 if (menu_shell->parent_menu_shell)
575 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
577 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
579 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
580 menu_item != GTK_MENU_SHELL (menu_item->parent)->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 (menu_item->parent)->submenu_placement != GTK_TOP_BOTTOM)
591 gtk_menu_shell_select_item (GTK_MENU_SHELL (menu_item->parent), menu_item);
595 if (!menu_shell->active || !menu_shell->button)
597 _gtk_menu_shell_activate (menu_shell);
599 menu_shell->button = event->button;
601 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
602 menu_item->parent == widget &&
603 menu_item != menu_shell->active_menu_item)
605 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
607 menu_shell->activate_time = event->time;
608 gtk_menu_shell_select_item (menu_shell, menu_item);
614 widget = gtk_get_event_widget ((GdkEvent*) event);
615 if (widget == GTK_WIDGET (menu_shell))
617 gtk_menu_shell_deactivate (menu_shell);
618 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
622 if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
623 GTK_MENU_ITEM (menu_item)->submenu != NULL &&
624 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
626 GtkMenuShellPrivate *priv;
628 _gtk_menu_item_popup_submenu (menu_item, FALSE);
630 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
631 priv->activated_submenu = TRUE;
638 gtk_menu_shell_grab_broken (GtkWidget *widget,
639 GdkEventGrabBroken *event)
641 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
643 if (menu_shell->have_xgrab && event->grab_window == NULL)
645 /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
648 gtk_menu_shell_deselect (menu_shell);
650 gtk_menu_shell_deactivate (menu_shell);
651 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
658 gtk_menu_shell_button_release (GtkWidget *widget,
659 GdkEventButton *event)
661 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
662 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (widget);
664 if (menu_shell->active)
666 GtkWidget *menu_item;
667 gboolean deactivate = TRUE;
669 if (menu_shell->button && (event->button != menu_shell->button))
671 menu_shell->button = 0;
672 if (menu_shell->parent_menu_shell)
673 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
676 menu_shell->button = 0;
677 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
679 if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
681 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
682 _gtk_menu_item_is_selectable (menu_item))
684 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->submenu;
688 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
692 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
693 priv->activated_submenu)
696 GTimeVal *popup_time;
697 gint64 usec_since_popup = 0;
699 g_object_get (gtk_widget_get_settings (widget),
700 "gtk-menu-popdown-delay", &popdown_delay,
703 popup_time = g_object_get_data (G_OBJECT (submenu),
704 "gtk-menu-exact-popup-time");
708 GTimeVal current_time;
710 g_get_current_time (¤t_time);
712 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
713 (gint64) current_time.tv_usec -
714 (gint64) popup_time->tv_sec * 1000 * 1000 -
715 (gint64) popup_time->tv_usec);
717 g_object_set_data (G_OBJECT (submenu),
718 "gtk-menu-exact-popup-time", NULL);
721 /* only close the submenu on click if we opened the
722 * menu explicitely (usec_since_popup == 0) or
723 * enough time has passed since it was opened by
724 * GtkMenuItem's timeout (usec_since_popup > delay).
726 if (!priv->activated_submenu &&
727 (usec_since_popup == 0 ||
728 usec_since_popup > popdown_delay * 1000))
730 _gtk_menu_item_popdown_submenu (menu_item);
734 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
740 else if (menu_item &&
741 !_gtk_menu_item_is_selectable (menu_item) &&
742 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
746 else if (menu_shell->parent_menu_shell)
748 menu_shell->active = TRUE;
749 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
753 /* If we ended up on an item with a submenu, leave the menu up.
755 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
756 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
761 else /* a very fast press-release */
763 /* We only ever want to prevent deactivation on the first
764 * press/release. Setting the time to zero is a bit of a
765 * hack, since we could be being triggered in the first
766 * few fractions of a second after a server time wraparound.
767 * the chances of that happening are ~1/10^6, without
768 * serious harm if we lose.
770 menu_shell->activate_time = 0;
776 gtk_menu_shell_deactivate (menu_shell);
777 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
780 priv->activated_submenu = FALSE;
787 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
788 gboolean keyboard_mode)
790 menu_shell->keyboard_mode = keyboard_mode;
794 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
796 return menu_shell->keyboard_mode;
800 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
802 GtkMenuShell *target;
803 gboolean auto_mnemonics;
805 gboolean mnemonics_visible;
807 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
808 "gtk-auto-mnemonics", &auto_mnemonics, NULL);
817 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (target);
818 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
820 /* The idea with keyboard mode is that once you start using
821 * the keyboard to navigate the menus, we show mnemonics
822 * until the menu navigation is over. To that end, we spread
823 * the keyboard mode upwards in the menu hierarchy here.
824 * Also see gtk_menu_popup, where we inherit it downwards.
826 if (menu_shell->keyboard_mode)
827 target->keyboard_mode = TRUE;
829 /* While navigating menus, the first parent menu with an active
830 * item is the one where mnemonics are effective, as can be seen
831 * in gtk_menu_shell_key_press below.
832 * We also show mnemonics in context menus. The grab condition is
833 * necessary to ensure we remove underlines from menu bars when
836 mnemonics_visible = target->keyboard_mode &&
837 (((target->active_menu_item || priv->in_unselectable_item) && !found) ||
838 (target == menu_shell &&
839 !target->parent_menu_shell &&
840 gtk_widget_has_grab (GTK_WIDGET (target))));
842 /* While menus are up, only show underlines inside the menubar,
843 * not in the entire window.
845 if (GTK_IS_MENU_BAR (target))
847 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
848 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
852 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
854 if (target->active_menu_item || priv->in_unselectable_item)
857 target = GTK_MENU_SHELL (target->parent_menu_shell);
862 gtk_menu_shell_key_press (GtkWidget *widget,
865 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
866 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
867 gboolean enable_mnemonics;
869 menu_shell->keyboard_mode = TRUE;
871 if (!(menu_shell->active_menu_item || priv->in_unselectable_item) && menu_shell->parent_menu_shell)
872 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent *)event);
874 if (gtk_bindings_activate_event (GTK_OBJECT (widget), event))
877 g_object_get (gtk_widget_get_settings (widget),
878 "gtk-enable-mnemonics", &enable_mnemonics,
881 if (enable_mnemonics)
882 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
888 gtk_menu_shell_enter_notify (GtkWidget *widget,
889 GdkEventCrossing *event)
891 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
893 if (event->mode == GDK_CROSSING_GTK_GRAB ||
894 event->mode == GDK_CROSSING_GTK_UNGRAB ||
895 event->mode == GDK_CROSSING_STATE_CHANGED)
898 if (menu_shell->active)
900 GtkWidget *menu_item;
902 menu_item = gtk_get_event_widget ((GdkEvent*) event);
907 if (GTK_IS_MENU_ITEM (menu_item) &&
908 !_gtk_menu_item_is_selectable (menu_item))
910 GtkMenuShellPrivate *priv;
912 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
913 priv->in_unselectable_item = TRUE;
918 if (menu_item->parent == widget &&
919 GTK_IS_MENU_ITEM (menu_item))
921 if (menu_shell->ignore_enter)
924 if (event->detail != GDK_NOTIFY_INFERIOR)
926 if (gtk_widget_get_state (menu_item) != GTK_STATE_PRELIGHT)
927 gtk_menu_shell_select_item (menu_shell, menu_item);
929 /* If any mouse button is down, and there is a submenu
930 * that is not yet visible, activate it. It's sufficient
931 * to check for any button's mask (not only the one
932 * matching menu_shell->button), because there is no
933 * situation a mouse button could be pressed while
934 * entering a menu item where we wouldn't want to show
937 if ((event->state & (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)) &&
938 GTK_MENU_ITEM (menu_item)->submenu != NULL)
940 GtkMenuShellPrivate *priv;
942 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
943 priv->activated_submenu = TRUE;
945 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->submenu))
947 gboolean touchscreen_mode;
949 g_object_get (gtk_widget_get_settings (widget),
950 "gtk-touchscreen-mode", &touchscreen_mode,
953 if (touchscreen_mode)
954 _gtk_menu_item_popup_submenu (menu_item, TRUE);
959 else if (menu_shell->parent_menu_shell)
961 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
969 gtk_menu_shell_leave_notify (GtkWidget *widget,
970 GdkEventCrossing *event)
972 if (event->mode == GDK_CROSSING_GTK_GRAB ||
973 event->mode == GDK_CROSSING_GTK_GRAB ||
974 event->mode == GDK_CROSSING_STATE_CHANGED)
977 if (gtk_widget_get_visible (widget))
979 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
980 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
981 GtkMenuItem *menu_item;
983 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
986 menu_item = GTK_MENU_ITEM (event_widget);
988 if (!_gtk_menu_item_is_selectable (event_widget))
990 GtkMenuShellPrivate *priv;
992 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
993 priv->in_unselectable_item = TRUE;
998 if ((menu_shell->active_menu_item == event_widget) &&
999 (menu_item->submenu == NULL))
1001 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1002 (gtk_widget_get_state (GTK_WIDGET (menu_item)) != GTK_STATE_NORMAL))
1004 gtk_menu_shell_deselect (menu_shell);
1007 else if (menu_shell->parent_menu_shell)
1009 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
1017 gtk_menu_shell_screen_changed (GtkWidget *widget,
1018 GdkScreen *previous_screen)
1020 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1024 gtk_menu_shell_add (GtkContainer *container,
1027 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1031 gtk_menu_shell_remove (GtkContainer *container,
1034 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1037 was_visible = gtk_widget_get_visible (widget);
1038 menu_shell->children = g_list_remove (menu_shell->children, widget);
1040 if (widget == menu_shell->active_menu_item)
1042 gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
1043 menu_shell->active_menu_item = NULL;
1046 gtk_widget_unparent (widget);
1048 /* queue resize regardless of gtk_widget_get_visible (container),
1049 * since that's what is needed by toplevels.
1052 gtk_widget_queue_resize (GTK_WIDGET (container));
1056 gtk_menu_shell_forall (GtkContainer *container,
1057 gboolean include_internals,
1058 GtkCallback callback,
1059 gpointer callback_data)
1061 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1065 children = menu_shell->children;
1068 child = children->data;
1069 children = children->next;
1071 (* callback) (child, callback_data);
1077 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1079 if (menu_shell->active)
1081 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1083 menu_shell->button = 0;
1084 menu_shell->active = FALSE;
1085 menu_shell->activate_time = 0;
1087 if (menu_shell->active_menu_item)
1089 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1090 menu_shell->active_menu_item = NULL;
1093 if (menu_shell->have_grab)
1095 menu_shell->have_grab = FALSE;
1096 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1098 if (menu_shell->have_xgrab)
1100 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1101 gdk_device_ungrab (priv->grab_keyboard, GDK_CURRENT_TIME);
1103 menu_shell->have_xgrab = FALSE;
1104 priv->grab_pointer = NULL;
1105 priv->grab_keyboard = NULL;
1108 menu_shell->keyboard_mode = FALSE;
1110 _gtk_menu_shell_update_mnemonics (menu_shell);
1115 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1120 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1121 g_return_val_if_fail (child != NULL, FALSE);
1123 parent = child->parent;
1124 while (GTK_IS_MENU_SHELL (parent))
1126 if (parent == (GtkWidget*) menu_shell)
1128 parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
1135 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1138 GtkWidget *menu_item;
1140 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1142 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1143 menu_item = menu_item->parent;
1145 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1151 /* Handlers for action signals */
1154 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1155 GtkWidget *menu_item)
1157 GtkMenuShellClass *class;
1159 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1160 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1162 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1164 if (class->select_item &&
1165 !(menu_shell->active &&
1166 menu_shell->active_menu_item == menu_item))
1167 class->select_item (menu_shell, menu_item);
1170 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1171 GtkSubmenuPlacement placement);
1174 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1175 GtkWidget *menu_item)
1177 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1179 if (menu_shell->active_menu_item)
1181 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1182 menu_shell->active_menu_item = NULL;
1185 if (!_gtk_menu_item_is_selectable (menu_item))
1187 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1189 priv->in_unselectable_item = TRUE;
1190 _gtk_menu_shell_update_mnemonics (menu_shell);
1195 menu_shell->active_menu_item = menu_item;
1196 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1197 _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
1200 _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
1201 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1202 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
1204 _gtk_menu_shell_update_mnemonics (menu_shell);
1206 /* This allows the bizarre radio buttons-with-submenus-display-history
1209 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1210 gtk_widget_activate (menu_shell->active_menu_item);
1214 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1216 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1218 if (menu_shell->active_menu_item)
1220 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
1221 menu_shell->active_menu_item = NULL;
1222 _gtk_menu_shell_update_mnemonics (menu_shell);
1227 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1228 GtkWidget *menu_item,
1229 gboolean force_deactivate)
1231 GSList *slist, *shells = NULL;
1232 gboolean deactivate = force_deactivate;
1234 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1235 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1238 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1240 g_object_ref (menu_shell);
1241 g_object_ref (menu_item);
1245 GtkMenuShell *parent_menu_shell = menu_shell;
1249 g_object_ref (parent_menu_shell);
1250 shells = g_slist_prepend (shells, parent_menu_shell);
1251 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->parent_menu_shell;
1253 while (parent_menu_shell);
1254 shells = g_slist_reverse (shells);
1256 gtk_menu_shell_deactivate (menu_shell);
1258 /* flush the x-queue, so any grabs are removed and
1259 * the menu is actually taken down
1261 gdk_display_sync (gtk_widget_get_display (menu_item));
1264 gtk_widget_activate (menu_item);
1266 for (slist = shells; slist; slist = slist->next)
1268 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1269 g_object_unref (slist->data);
1271 g_slist_free (shells);
1273 g_object_unref (menu_shell);
1274 g_object_unref (menu_item);
1277 /* Distance should be +/- 1 */
1279 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1282 if (menu_shell->active_menu_item)
1284 GList *node = g_list_find (menu_shell->children,
1285 menu_shell->active_menu_item);
1286 GList *start_node = node;
1287 gboolean wrap_around;
1289 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1290 "gtk-keynav-wrap-around", &wrap_around,
1296 while (node != start_node &&
1297 (!node || !_gtk_menu_item_is_selectable (node->data)))
1301 else if (wrap_around)
1302 node = menu_shell->children;
1305 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1313 while (node != start_node &&
1314 (!node || !_gtk_menu_item_is_selectable (node->data)))
1318 else if (wrap_around)
1319 node = g_list_last (menu_shell->children);
1322 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1329 gtk_menu_shell_select_item (menu_shell, node->data);
1335 /* Distance should be +/- 1 */
1337 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1340 gboolean handled = FALSE;
1342 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1343 distance, &handled);
1347 * gtk_menu_shell_select_first:
1348 * @menu_shell: a #GtkMenuShell
1349 * @search_sensitive: if %TRUE, search for the first selectable
1350 * menu item, otherwise select nothing if
1351 * the first item isn't sensitive. This
1352 * should be %FALSE if the menu is being
1353 * popped up initially.
1355 * Select the first visible or selectable child of the menu shell;
1356 * don't select tearoff items unless the only item is a tearoff
1362 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1363 gboolean search_sensitive)
1365 GtkWidget *to_select = NULL;
1368 tmp_list = menu_shell->children;
1371 GtkWidget *child = tmp_list->data;
1373 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1374 _gtk_menu_item_is_selectable (child))
1377 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1381 tmp_list = tmp_list->next;
1385 gtk_menu_shell_select_item (menu_shell, to_select);
1389 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1390 gboolean search_sensitive)
1392 GtkWidget *to_select = NULL;
1395 tmp_list = g_list_last (menu_shell->children);
1398 GtkWidget *child = tmp_list->data;
1400 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1401 _gtk_menu_item_is_selectable (child))
1404 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1408 tmp_list = tmp_list->prev;
1412 gtk_menu_shell_select_item (menu_shell, to_select);
1416 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1418 GtkMenuItem *menu_item;
1420 if (menu_shell->active_menu_item == NULL)
1423 menu_item = GTK_MENU_ITEM (menu_shell->active_menu_item);
1425 if (menu_item->submenu)
1427 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1428 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1429 if (GTK_MENU_SHELL (menu_item->submenu)->active_menu_item)
1437 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1438 GtkMenuDirectionType direction)
1440 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1441 GtkMenuShell *parent_menu_shell = NULL;
1442 gboolean had_selection;
1443 gboolean touchscreen_mode;
1445 priv->in_unselectable_item = FALSE;
1447 had_selection = menu_shell->active_menu_item != NULL;
1449 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1450 "gtk-touchscreen-mode", &touchscreen_mode,
1453 if (menu_shell->parent_menu_shell)
1454 parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1458 case GTK_MENU_DIR_PARENT:
1459 if (touchscreen_mode &&
1460 menu_shell->active_menu_item &&
1461 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu &&
1462 gtk_widget_get_visible (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu))
1464 /* if we are on a menu item that has an open submenu but the
1465 * focus is not in that submenu (e.g. because it's empty or
1466 * has only insensitive items), close that submenu instead
1467 * of running into the code below which would close *this*
1470 _gtk_menu_item_popdown_submenu (menu_shell->active_menu_item);
1471 _gtk_menu_shell_update_mnemonics (menu_shell);
1473 else if (parent_menu_shell)
1475 if (touchscreen_mode)
1477 /* close menu when returning from submenu. */
1478 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->parent_menu_item);
1479 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1483 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1484 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1485 gtk_menu_shell_deselect (menu_shell);
1488 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1489 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1491 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1492 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1495 /* If there is no parent and the submenu is in the opposite direction
1496 * to the menu, then make the PARENT direction wrap around to
1497 * the bottom of the submenu.
1499 else if (menu_shell->active_menu_item &&
1500 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1501 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1503 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu);
1505 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1506 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1507 _gtk_menu_shell_select_last (submenu, TRUE);
1511 case GTK_MENU_DIR_CHILD:
1512 if (menu_shell->active_menu_item &&
1513 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1514 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1516 if (gtk_menu_shell_select_submenu_first (menu_shell))
1520 /* Try to find a menu running the opposite direction */
1521 while (parent_menu_shell &&
1522 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1523 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1525 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->parent_menu_shell);
1528 if (parent_menu_shell)
1530 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1531 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1533 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1535 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1539 case GTK_MENU_DIR_PREV:
1540 gtk_menu_shell_move_selected (menu_shell, -1);
1541 if (!had_selection &&
1542 !menu_shell->active_menu_item &&
1543 menu_shell->children)
1544 _gtk_menu_shell_select_last (menu_shell, TRUE);
1547 case GTK_MENU_DIR_NEXT:
1548 gtk_menu_shell_move_selected (menu_shell, 1);
1549 if (!had_selection &&
1550 !menu_shell->active_menu_item &&
1551 menu_shell->children)
1552 gtk_menu_shell_select_first (menu_shell, TRUE);
1558 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1559 gboolean force_hide)
1561 if (menu_shell->active_menu_item &&
1562 _gtk_menu_item_is_selectable (menu_shell->active_menu_item))
1564 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu == NULL)
1565 gtk_menu_shell_activate_item (menu_shell,
1566 menu_shell->active_menu_item,
1569 _gtk_menu_item_popup_submenu (menu_shell->active_menu_item, FALSE);
1574 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1576 /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
1578 gtk_menu_shell_deselect (menu_shell);
1580 gtk_menu_shell_deactivate (menu_shell);
1581 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1585 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1586 GtkDirectionType dir)
1588 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1590 if (menu_shell->parent_menu_shell)
1591 menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1597 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1601 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1603 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1605 if (klass->get_popup_delay)
1607 return klass->get_popup_delay (menu_shell);
1612 GtkWidget *widget = GTK_WIDGET (menu_shell);
1614 g_object_get (gtk_widget_get_settings (widget),
1615 "gtk-menu-popup-delay", &popup_delay,
1623 * gtk_menu_shell_cancel:
1624 * @menu_shell: a #GtkMenuShell
1626 * Cancels the selection within the menu shell.
1631 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1633 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1635 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1638 static GtkMnemonicHash *
1639 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1642 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1644 if (!private->mnemonic_hash && create)
1645 private->mnemonic_hash = _gtk_mnemonic_hash_new ();
1647 return private->mnemonic_hash;
1651 menu_shell_add_mnemonic_foreach (guint keyval,
1655 GtkKeyHash *key_hash = data;
1657 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1661 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1664 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1665 GtkWidget *widget = GTK_WIDGET (menu_shell);
1667 if (!private->key_hash && create && gtk_widget_has_screen (widget))
1669 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1670 GdkScreen *screen = gtk_widget_get_screen (widget);
1671 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1676 private->key_hash = _gtk_key_hash_new (keymap, NULL);
1678 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1679 menu_shell_add_mnemonic_foreach,
1683 return private->key_hash;
1687 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1689 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1691 if (private->key_hash)
1693 _gtk_key_hash_free (private->key_hash);
1694 private->key_hash = NULL;
1699 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1702 GtkMnemonicHash *mnemonic_hash;
1703 GtkKeyHash *key_hash;
1705 gboolean result = FALSE;
1707 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1711 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1715 entries = _gtk_key_hash_lookup (key_hash,
1716 event->hardware_keycode,
1718 gtk_accelerator_get_default_mod_mask (),
1722 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1723 GPOINTER_TO_UINT (entries->data));
1729 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1733 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1734 g_return_if_fail (GTK_IS_WIDGET (target));
1736 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1738 gtk_menu_shell_reset_key_hash (menu_shell);
1742 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1746 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1747 g_return_if_fail (GTK_IS_WIDGET (target));
1749 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1751 gtk_menu_shell_reset_key_hash (menu_shell);
1755 _gtk_menu_shell_set_grab_devices (GtkMenuShell *menu_shell,
1756 GdkDevice *keyboard,
1759 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1761 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1762 g_return_if_fail (!keyboard || GDK_IS_DEVICE (keyboard));
1763 g_return_if_fail (!pointer || GDK_IS_DEVICE (pointer));
1765 priv->grab_keyboard = keyboard;
1766 priv->grab_pointer = pointer;
1770 _gtk_menu_shell_get_grab_devices (GtkMenuShell *menu_shell,
1771 GdkDevice **keyboard,
1772 GdkDevice **pointer)
1774 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1776 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1779 *keyboard = priv->grab_keyboard;
1782 *pointer = priv->grab_pointer;
1788 * gtk_menu_shell_get_take_focus:
1789 * @menu_shell: a #GtkMenuShell
1791 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1793 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1798 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1800 GtkMenuShellPrivate *priv;
1802 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1804 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1806 return priv->take_focus;
1810 * gtk_menu_shell_set_take_focus:
1811 * @menu_shell: a #GtkMenuShell
1812 * @take_focus: %TRUE if the menu shell should take the keyboard focus on popup.
1814 * If @take_focus is %TRUE (the default) the menu shell will take the keyboard
1815 * focus so that it will receive all keyboard events which is needed to enable
1816 * keyboard navigation in menus.
1818 * Setting @take_focus to %FALSE is useful only for special applications
1819 * like virtual keyboard implementations which should not take keyboard
1822 * The @take_focus state of a menu or menu bar is automatically propagated
1823 * to submenus whenever a submenu is popped up, so you don't have to worry
1824 * about recursively setting it for your entire menu hierarchy. Only when
1825 * programmatically picking a submenu and popping it up manually, the
1826 * @take_focus property of the submenu needs to be set explicitely.
1828 * Note that setting it to %FALSE has side-effects:
1830 * If the focus is in some other app, it keeps the focus and keynav in
1831 * the menu doesn't work. Consequently, keynav on the menu will only
1832 * work if the focus is on some toplevel owned by the onscreen keyboard.
1834 * To avoid confusing the user, menus with @take_focus set to %FALSE
1835 * should not display mnemonics or accelerators, since it cannot be
1836 * guaranteed that they will work.
1838 * See also gdk_keyboard_grab()
1843 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1844 gboolean take_focus)
1846 GtkMenuShellPrivate *priv;
1848 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1850 priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1852 if (priv->take_focus != take_focus)
1854 priv->take_focus = take_focus;
1855 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1859 #define __GTK_MENU_SHELL_C__
1860 #include "gtkaliasdef.c"