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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26 * SECTION:gtkmenushell
27 * @Title: GtkMenuShell
28 * @Short_description: A base class for menu objects
30 * A #GtkMenuShell is the abstract base class used to derive the
31 * #GtkMenu and #GtkMenuBar subclasses.
33 * A #GtkMenuShell is a container of #GtkMenuItem objects arranged
34 * in a list which can be navigated, selected, and activated by the
35 * user to perform application functions. A #GtkMenuItem can have a
36 * submenu associated with it, allowing for nested hierarchical menus.
40 #include "gtkbindings.h"
41 #include "gtkkeyhash.h"
44 #include "gtkmarshalers.h"
45 #include "gtkmenubar.h"
46 #include "gtkmenuitemprivate.h"
47 #include "gtkmenushellprivate.h"
48 #include "gtkmenuprivate.h"
49 #include "gtkmnemonichash.h"
50 #include "gtkwindow.h"
51 #include "gtkprivate.h"
54 #include "gtktypebuiltins.h"
56 #include "deprecated/gtktearoffmenuitem.h"
58 #include "a11y/gtkmenushellaccessible.h"
61 #define MENU_SHELL_TIMEOUT 500
63 #define PACK_DIRECTION(m) \
64 (GTK_IS_MENU_BAR (m) \
65 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
66 : GTK_PACK_DIRECTION_LTR)
87 * A menu item can be "selected", this means that it is displayed
88 * in the prelight state, and if it has a submenu, that submenu
91 * A menu is "active" when it is visible onscreen and the user
92 * is selecting from it. A menubar is not active until the user
93 * clicks on one of its menuitems. When a menu is active,
94 * passing the mouse over a submenu will pop it up.
96 * menu_shell->active_menu_item, is however, not an "active"
97 * menu item (there is no such thing) but rather, the selected
98 * menu item in that MenuShell, if there is one.
100 * There is also is a concept of the current menu and a current
101 * menu item. The current menu item is the selected menu item
102 * that is furthest down in the hierarchy. (Every active menu_shell
103 * does not necessarily contain a selected menu item, but if
104 * it does, then menu_shell->parent_menu_shell must also contain
105 * a selected menu item. The current menu is the menu that
106 * contains the current menu_item. It will always have a GTK
107 * grab and receive all key presses.
112 * ::move_current (GtkMenuDirection *dir)
113 * Moves the current menu item in direction 'dir':
115 * GTK_MENU_DIR_PARENT: To the parent menu shell
116 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
118 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
121 * As a a bit of a hack to get movement between menus and
122 * menubars working, if submenu_placement is different for
123 * the menu and its MenuShell then the following apply:
125 * - For 'parent' the current menu is not just moved to
126 * the parent, but moved to the previous entry in the parent
127 * - For 'child', if there is no child, then current is
128 * moved to the next item in the parent.
130 * Note that the above explanation of ::move_current was written
131 * before menus and menubars had support for RTL flipping and
132 * different packing directions, and therefore only applies for
133 * when text direction and packing direction are both left-to-right.
135 * ::activate_current (GBoolean *force_hide)
136 * Activate the current item. If 'force_hide' is true, hide
137 * the current menu item always. Otherwise, only hide
138 * it if menu_item->klass->hide_on_activate is true.
141 * Cancels the current selection
145 static void gtk_menu_shell_set_property (GObject *object,
149 static void gtk_menu_shell_get_property (GObject *object,
153 static void gtk_menu_shell_realize (GtkWidget *widget);
154 static void gtk_menu_shell_finalize (GObject *object);
155 static void gtk_menu_shell_dispose (GObject *object);
156 static gint gtk_menu_shell_button_press (GtkWidget *widget,
157 GdkEventButton *event);
158 static gint gtk_menu_shell_button_release (GtkWidget *widget,
159 GdkEventButton *event);
160 static gint gtk_menu_shell_key_press (GtkWidget *widget,
162 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
163 GdkEventCrossing *event);
164 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
165 GdkEventCrossing *event);
166 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
167 GdkScreen *previous_screen);
168 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
169 GdkEventGrabBroken *event);
170 static void gtk_menu_shell_add (GtkContainer *container,
172 static void gtk_menu_shell_remove (GtkContainer *container,
174 static void gtk_menu_shell_forall (GtkContainer *container,
175 gboolean include_internals,
176 GtkCallback callback,
177 gpointer callback_data);
178 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
181 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
182 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
184 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
186 static GType gtk_menu_shell_child_type (GtkContainer *container);
187 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
188 GtkWidget *menu_item);
189 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
191 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
192 GtkMenuDirectionType direction);
193 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
194 gboolean force_hide);
195 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
196 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
197 GtkDirectionType dir);
199 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
200 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
202 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
205 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
207 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
210 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
212 GObjectClass *object_class;
213 GtkWidgetClass *widget_class;
214 GtkContainerClass *container_class;
216 GtkBindingSet *binding_set;
218 object_class = (GObjectClass*) klass;
219 widget_class = (GtkWidgetClass*) klass;
220 container_class = (GtkContainerClass*) klass;
222 object_class->set_property = gtk_menu_shell_set_property;
223 object_class->get_property = gtk_menu_shell_get_property;
224 object_class->finalize = gtk_menu_shell_finalize;
225 object_class->dispose = gtk_menu_shell_dispose;
227 widget_class->realize = gtk_menu_shell_realize;
228 widget_class->button_press_event = gtk_menu_shell_button_press;
229 widget_class->button_release_event = gtk_menu_shell_button_release;
230 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
231 widget_class->key_press_event = gtk_menu_shell_key_press;
232 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
233 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
234 widget_class->screen_changed = gtk_menu_shell_screen_changed;
236 container_class->add = gtk_menu_shell_add;
237 container_class->remove = gtk_menu_shell_remove;
238 container_class->forall = gtk_menu_shell_forall;
239 container_class->child_type = gtk_menu_shell_child_type;
241 klass->submenu_placement = GTK_TOP_BOTTOM;
242 klass->deactivate = gtk_real_menu_shell_deactivate;
243 klass->selection_done = NULL;
244 klass->move_current = gtk_real_menu_shell_move_current;
245 klass->activate_current = gtk_real_menu_shell_activate_current;
246 klass->cancel = gtk_real_menu_shell_cancel;
247 klass->select_item = gtk_menu_shell_real_select_item;
248 klass->insert = gtk_menu_shell_real_insert;
249 klass->move_selected = gtk_menu_shell_real_move_selected;
252 * GtkMenuShell::deactivate:
253 * @menushell: the object which received the signal
255 * This signal is emitted when a menu shell is deactivated.
257 menu_shell_signals[DEACTIVATE] =
258 g_signal_new (I_("deactivate"),
259 G_OBJECT_CLASS_TYPE (object_class),
261 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
263 _gtk_marshal_VOID__VOID,
267 * GtkMenuShell::selection-done:
268 * @menushell: the object which received the signal
270 * This signal is emitted when a selection has been
271 * completed within a menu shell.
273 menu_shell_signals[SELECTION_DONE] =
274 g_signal_new (I_("selection-done"),
275 G_OBJECT_CLASS_TYPE (object_class),
277 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
279 _gtk_marshal_VOID__VOID,
283 * GtkMenuShell::move-current:
284 * @menushell: the object which received the signal
285 * @direction: the direction to move
287 * An keybinding signal which moves the current menu item
288 * in the direction specified by @direction.
290 menu_shell_signals[MOVE_CURRENT] =
291 g_signal_new (I_("move-current"),
292 G_OBJECT_CLASS_TYPE (object_class),
293 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
294 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
296 _gtk_marshal_VOID__ENUM,
298 GTK_TYPE_MENU_DIRECTION_TYPE);
301 * GtkMenuShell::activate-current:
302 * @menushell: the object which received the signal
303 * @force_hide: if %TRUE, hide the menu after activating the menu item
305 * An action signal that activates the current menu item within
308 menu_shell_signals[ACTIVATE_CURRENT] =
309 g_signal_new (I_("activate-current"),
310 G_OBJECT_CLASS_TYPE (object_class),
311 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
312 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
314 _gtk_marshal_VOID__BOOLEAN,
319 * GtkMenuShell::cancel:
320 * @menushell: the object which received the signal
322 * An action signal which cancels the selection within the menu shell.
323 * Causes the #GtkMenuShell::selection-done signal to be emitted.
325 menu_shell_signals[CANCEL] =
326 g_signal_new (I_("cancel"),
327 G_OBJECT_CLASS_TYPE (object_class),
328 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
329 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
331 _gtk_marshal_VOID__VOID,
335 * GtkMenuShell::cycle-focus:
336 * @menushell: the object which received the signal
337 * @direction: the direction to cycle in
339 * A keybinding signal which moves the focus in the
342 menu_shell_signals[CYCLE_FOCUS] =
343 g_signal_new_class_handler (I_("cycle-focus"),
344 G_OBJECT_CLASS_TYPE (object_class),
345 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
346 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
348 _gtk_marshal_VOID__ENUM,
350 GTK_TYPE_DIRECTION_TYPE);
353 * GtkMenuShell::move-selected:
354 * @menu_shell: the object on which the signal is emitted
355 * @distance: +1 to move to the next item, -1 to move to the previous
357 * The ::move-selected signal is emitted to move the selection to
360 * Returns: %TRUE to stop the signal emission, %FALSE to continue
364 menu_shell_signals[MOVE_SELECTED] =
365 g_signal_new (I_("move-selected"),
366 G_OBJECT_CLASS_TYPE (object_class),
368 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
369 _gtk_boolean_handled_accumulator, NULL,
370 _gtk_marshal_BOOLEAN__INT,
375 * GtkMenuShell::insert:
376 * @menu_shell: the object on which the signal is emitted
377 * @child: the #GtkMenuItem that is being inserted
378 * @position: the position at which the insert occurs
380 * The ::insert signal is emitted when a new #GtkMenuItem is added to
381 * a #GtkMenuShell. A separate signal is used instead of
382 * GtkContainer::add because of the need for an additional position
385 * The inverse of this signal is the GtkContainer::removed signal.
389 menu_shell_signals[INSERT] =
390 g_signal_new (I_("insert"),
391 G_OBJECT_CLASS_TYPE (object_class),
393 G_STRUCT_OFFSET (GtkMenuShellClass, insert),
395 _gtk_marshal_VOID__OBJECT_INT,
396 G_TYPE_NONE, 2, GTK_TYPE_WIDGET, G_TYPE_INT);
399 binding_set = gtk_binding_set_by_class (klass);
400 gtk_binding_entry_add_signal (binding_set,
403 gtk_binding_entry_add_signal (binding_set,
405 "activate-current", 1,
408 gtk_binding_entry_add_signal (binding_set,
409 GDK_KEY_ISO_Enter, 0,
410 "activate-current", 1,
413 gtk_binding_entry_add_signal (binding_set,
415 "activate-current", 1,
418 gtk_binding_entry_add_signal (binding_set,
420 "activate-current", 1,
423 gtk_binding_entry_add_signal (binding_set,
425 "activate-current", 1,
428 gtk_binding_entry_add_signal (binding_set,
431 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
432 gtk_binding_entry_add_signal (binding_set,
433 GDK_KEY_F10, GDK_SHIFT_MASK,
435 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
438 * GtkMenuShell:take-focus:
440 * A boolean that determines whether the menu and its submenus grab the
441 * keyboard focus. See gtk_menu_shell_set_take_focus() and
442 * gtk_menu_shell_get_take_focus().
446 g_object_class_install_property (object_class,
448 g_param_spec_boolean ("take-focus",
450 P_("A boolean that determines whether the menu grabs the keyboard focus"),
452 GTK_PARAM_READWRITE));
454 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_MENU_SHELL_ACCESSIBLE);
456 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
460 gtk_menu_shell_child_type (GtkContainer *container)
462 return GTK_TYPE_MENU_ITEM;
466 gtk_menu_shell_init (GtkMenuShell *menu_shell)
468 GtkMenuShellPrivate *priv;
470 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_shell,
472 GtkMenuShellPrivate);
473 menu_shell->priv = priv;
474 priv->take_focus = TRUE;
478 gtk_menu_shell_set_property (GObject *object,
483 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
487 case PROP_TAKE_FOCUS:
488 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
491 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
497 gtk_menu_shell_get_property (GObject *object,
502 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
506 case PROP_TAKE_FOCUS:
507 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
510 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
516 gtk_menu_shell_finalize (GObject *object)
518 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
519 GtkMenuShellPrivate *priv = menu_shell->priv;
521 if (priv->mnemonic_hash)
522 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
524 _gtk_key_hash_free (priv->key_hash);
526 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
531 gtk_menu_shell_dispose (GObject *object)
533 gtk_menu_shell_deactivate (GTK_MENU_SHELL (object));
535 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->dispose (object);
539 * gtk_menu_shell_append:
540 * @menu_shell: a #GtkMenuShell
541 * @child: The #GtkMenuItem to add
543 * Adds a new #GtkMenuItem to the end of the menu shell's
547 gtk_menu_shell_append (GtkMenuShell *menu_shell,
550 gtk_menu_shell_insert (menu_shell, child, -1);
554 * gtk_menu_shell_prepend:
555 * @menu_shell: a #GtkMenuShell
556 * @child: The #GtkMenuItem to add
558 * Adds a new #GtkMenuItem to the beginning of the menu shell's
562 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
565 gtk_menu_shell_insert (menu_shell, child, 0);
569 * gtk_menu_shell_insert:
570 * @menu_shell: a #GtkMenuShell
571 * @child: The #GtkMenuItem to add
572 * @position: The position in the item list where @child
573 * is added. Positions are numbered from 0 to n-1
575 * Adds a new #GtkMenuItem to the menu shell's item list
576 * at the position indicated by @position.
579 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
583 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
584 g_return_if_fail (GTK_IS_MENU_ITEM (child));
586 g_signal_emit (menu_shell, menu_shell_signals[INSERT], 0, child, position);
590 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
594 GtkMenuShellPrivate *priv = menu_shell->priv;
596 priv->children = g_list_insert (priv->children, child, position);
598 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
602 * gtk_menu_shell_deactivate:
603 * @menu_shell: a #GtkMenuShell
605 * Deactivates the menu shell.
607 * Typically this results in the menu shell being erased
611 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
613 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
615 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
619 gtk_menu_shell_realize (GtkWidget *widget)
621 GtkAllocation allocation;
623 GdkWindowAttr attributes;
624 gint attributes_mask;
625 GtkStyleContext *context;
627 gtk_widget_set_realized (widget, TRUE);
629 gtk_widget_get_allocation (widget, &allocation);
631 attributes.x = allocation.x;
632 attributes.y = allocation.y;
633 attributes.width = allocation.width;
634 attributes.height = allocation.height;
635 attributes.window_type = GDK_WINDOW_CHILD;
636 attributes.wclass = GDK_INPUT_OUTPUT;
637 attributes.visual = gtk_widget_get_visual (widget);
638 attributes.event_mask = gtk_widget_get_events (widget);
639 attributes.event_mask |= (GDK_EXPOSURE_MASK |
640 GDK_BUTTON_PRESS_MASK |
641 GDK_BUTTON_RELEASE_MASK |
643 GDK_ENTER_NOTIFY_MASK |
644 GDK_LEAVE_NOTIFY_MASK);
646 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
648 window = gdk_window_new (gtk_widget_get_parent_window (widget),
649 &attributes, attributes_mask);
650 gtk_widget_set_window (widget, window);
651 gdk_window_set_user_data (window, widget);
653 context = gtk_widget_get_style_context (widget);
654 gtk_style_context_set_background (context, window);
658 gtk_menu_shell_activate (GtkMenuShell *menu_shell)
660 GtkMenuShellPrivate *priv = menu_shell->priv;
666 device = gtk_get_current_event_device ();
668 _gtk_menu_shell_set_grab_device (menu_shell, device);
669 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
671 priv->have_grab = TRUE;
677 gtk_menu_shell_button_press (GtkWidget *widget,
678 GdkEventButton *event)
680 GtkMenuShell *menu_shell;
681 GtkMenuShellPrivate *priv;
682 GtkWidget *menu_item;
685 if (event->type != GDK_BUTTON_PRESS)
688 menu_shell = GTK_MENU_SHELL (widget);
689 priv = menu_shell->priv;
691 if (priv->parent_menu_shell)
692 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
694 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
696 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
698 parent = gtk_widget_get_parent (menu_item);
700 if (menu_item != GTK_MENU_SHELL (parent)->priv->active_menu_item)
702 /* select the menu item *before* activating the shell, so submenus
703 * which might be open are closed the friendly way. If we activate
704 * (and thus grab) this menu shell first, we might get grab_broken
705 * events which will close the entire menu hierarchy. Selecting the
706 * menu item also fixes up the state as if enter_notify() would
707 * have run before (which normally selects the item).
709 if (GTK_MENU_SHELL_GET_CLASS (parent)->submenu_placement != GTK_TOP_BOTTOM)
710 gtk_menu_shell_select_item (GTK_MENU_SHELL (parent), menu_item);
714 if (!priv->active || !priv->button)
716 gboolean initially_active = priv->active;
718 priv->button = event->button;
722 if (_gtk_menu_item_is_selectable (menu_item) &&
723 gtk_widget_get_parent (menu_item) == widget &&
724 menu_item != priv->active_menu_item)
726 gtk_menu_shell_activate (menu_shell);
727 priv->button = event->button;
729 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
731 priv->activate_time = event->time;
732 gtk_menu_shell_select_item (menu_shell, menu_item);
738 if (!initially_active)
740 gboolean window_drag = FALSE;
742 gtk_widget_style_get (widget,
743 "window-dragging", &window_drag,
748 gtk_menu_shell_deactivate (menu_shell);
749 gtk_window_begin_move_drag (GTK_WINDOW (gtk_widget_get_toplevel (widget)),
760 widget = gtk_get_event_widget ((GdkEvent*) event);
761 if (widget == GTK_WIDGET (menu_shell))
763 gtk_menu_shell_deactivate (menu_shell);
764 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
769 _gtk_menu_item_is_selectable (menu_item) &&
770 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL &&
771 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
773 _gtk_menu_item_popup_submenu (menu_item, FALSE);
774 priv->activated_submenu = TRUE;
781 gtk_menu_shell_grab_broken (GtkWidget *widget,
782 GdkEventGrabBroken *event)
784 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
785 GtkMenuShellPrivate *priv = menu_shell->priv;
787 if (priv->have_xgrab && event->grab_window == NULL)
789 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
790 gtk_menu_shell_deselect (menu_shell);
791 gtk_menu_shell_deactivate (menu_shell);
792 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
799 gtk_menu_shell_button_release (GtkWidget *widget,
800 GdkEventButton *event)
802 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
803 GtkMenuShellPrivate *priv = menu_shell->priv;
807 GtkWidget *menu_item;
808 gboolean deactivate = TRUE;
810 if (priv->button && (event->button != priv->button))
813 if (priv->parent_menu_shell)
814 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
818 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
820 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
822 if (menu_item && (priv->active_menu_item == menu_item) &&
823 _gtk_menu_item_is_selectable (menu_item))
825 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->priv->submenu;
829 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
832 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
833 priv->activated_submenu)
836 GTimeVal *popup_time;
837 gint64 usec_since_popup = 0;
839 g_object_get (gtk_widget_get_settings (widget),
840 "gtk-menu-popdown-delay", &popdown_delay,
843 popup_time = g_object_get_data (G_OBJECT (submenu),
844 "gtk-menu-exact-popup-time");
848 GTimeVal current_time;
850 g_get_current_time (¤t_time);
852 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
853 (gint64) current_time.tv_usec -
854 (gint64) popup_time->tv_sec * 1000 * 1000 -
855 (gint64) popup_time->tv_usec);
857 g_object_set_data (G_OBJECT (submenu),
858 "gtk-menu-exact-popup-time", NULL);
861 /* Only close the submenu on click if we opened the
862 * menu explicitely (usec_since_popup == 0) or
863 * enough time has passed since it was opened by
864 * GtkMenuItem's timeout (usec_since_popup > delay).
866 if (!priv->activated_submenu &&
867 (usec_since_popup == 0 ||
868 usec_since_popup > popdown_delay * 1000))
870 _gtk_menu_item_popdown_submenu (menu_item);
874 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
880 else if (menu_item &&
881 !_gtk_menu_item_is_selectable (menu_item) &&
882 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
886 else if (priv->parent_menu_shell)
889 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
893 /* If we ended up on an item with a submenu, leave the menu up. */
895 (priv->active_menu_item == menu_item) &&
896 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
901 else /* a very fast press-release */
903 /* We only ever want to prevent deactivation on the first
904 * press/release. Setting the time to zero is a bit of a
905 * hack, since we could be being triggered in the first
906 * few fractions of a second after a server time wraparound.
907 * the chances of that happening are ~1/10^6, without
908 * serious harm if we lose.
910 priv->activate_time = 0;
916 gtk_menu_shell_deactivate (menu_shell);
917 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
920 priv->activated_submenu = FALSE;
927 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
928 gboolean keyboard_mode)
930 menu_shell->priv->keyboard_mode = keyboard_mode;
934 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
936 return menu_shell->priv->keyboard_mode;
940 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
942 GtkMenuShell *target;
943 gboolean auto_mnemonics;
945 gboolean mnemonics_visible;
947 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
948 "gtk-auto-mnemonics", &auto_mnemonics,
958 GtkMenuShellPrivate *priv = target->priv;
959 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
961 /* The idea with keyboard mode is that once you start using
962 * the keyboard to navigate the menus, we show mnemonics
963 * until the menu navigation is over. To that end, we spread
964 * the keyboard mode upwards in the menu hierarchy here.
965 * Also see gtk_menu_popup, where we inherit it downwards.
967 if (menu_shell->priv->keyboard_mode)
968 target->priv->keyboard_mode = TRUE;
970 /* While navigating menus, the first parent menu with an active
971 * item is the one where mnemonics are effective, as can be seen
972 * in gtk_menu_shell_key_press below.
973 * We also show mnemonics in context menus. The grab condition is
974 * necessary to ensure we remove underlines from menu bars when
977 mnemonics_visible = target->priv->keyboard_mode &&
978 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
979 (target == menu_shell &&
980 !target->priv->parent_menu_shell &&
981 gtk_widget_has_grab (GTK_WIDGET (target))));
983 /* While menus are up, only show underlines inside the menubar,
984 * not in the entire window.
986 if (GTK_IS_MENU_BAR (target))
988 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
989 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
993 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
995 if (target->priv->active_menu_item || priv->in_unselectable_item)
998 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
1003 gtk_menu_shell_key_press (GtkWidget *widget,
1006 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1007 GtkMenuShellPrivate *priv = menu_shell->priv;
1008 gboolean enable_mnemonics;
1010 priv->keyboard_mode = TRUE;
1012 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
1013 priv->parent_menu_shell)
1014 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
1016 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
1019 g_object_get (gtk_widget_get_settings (widget),
1020 "gtk-enable-mnemonics", &enable_mnemonics,
1023 if (enable_mnemonics)
1024 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
1030 gtk_menu_shell_enter_notify (GtkWidget *widget,
1031 GdkEventCrossing *event)
1033 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1034 GtkMenuShellPrivate *priv = menu_shell->priv;
1036 if (event->mode == GDK_CROSSING_GTK_GRAB ||
1037 event->mode == GDK_CROSSING_GTK_UNGRAB ||
1038 event->mode == GDK_CROSSING_STATE_CHANGED)
1043 GtkWidget *menu_item;
1046 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1051 if (GTK_IS_MENU_ITEM (menu_item) &&
1052 !_gtk_menu_item_is_selectable (menu_item))
1054 priv->in_unselectable_item = TRUE;
1058 parent = gtk_widget_get_parent (menu_item);
1059 if (parent == widget &&
1060 GTK_IS_MENU_ITEM (menu_item))
1062 if (priv->ignore_enter)
1065 if (event->detail != GDK_NOTIFY_INFERIOR)
1067 if ((gtk_widget_get_state_flags (menu_item) & GTK_STATE_FLAG_PRELIGHT) == 0)
1068 gtk_menu_shell_select_item (menu_shell, menu_item);
1070 /* If any mouse button is down, and there is a submenu
1071 * that is not yet visible, activate it. It's sufficient
1072 * to check for any button's mask (not only the one
1073 * matching menu_shell->button), because there is no
1074 * situation a mouse button could be pressed while
1075 * entering a menu item where we wouldn't want to show
1078 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
1079 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL)
1081 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
1083 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
1085 gboolean touchscreen_mode;
1087 g_object_get (gtk_widget_get_settings (widget),
1088 "gtk-touchscreen-mode", &touchscreen_mode,
1091 if (touchscreen_mode)
1092 _gtk_menu_item_popup_submenu (menu_item, TRUE);
1097 else if (priv->parent_menu_shell)
1099 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1107 gtk_menu_shell_leave_notify (GtkWidget *widget,
1108 GdkEventCrossing *event)
1110 if (event->mode == GDK_CROSSING_GTK_GRAB ||
1111 event->mode == GDK_CROSSING_GTK_GRAB ||
1112 event->mode == GDK_CROSSING_STATE_CHANGED)
1115 if (gtk_widget_get_visible (widget))
1117 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1118 GtkMenuShellPrivate *priv = menu_shell->priv;
1119 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
1120 GtkMenuItem *menu_item;
1122 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1125 menu_item = GTK_MENU_ITEM (event_widget);
1127 if (!_gtk_menu_item_is_selectable (event_widget))
1129 priv->in_unselectable_item = TRUE;
1133 if ((priv->active_menu_item == event_widget) &&
1134 (menu_item->priv->submenu == NULL))
1136 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1137 (gtk_widget_get_state_flags (GTK_WIDGET (menu_item)) & GTK_STATE_FLAG_PRELIGHT) != 0)
1139 gtk_menu_shell_deselect (menu_shell);
1142 else if (priv->parent_menu_shell)
1144 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1152 gtk_menu_shell_screen_changed (GtkWidget *widget,
1153 GdkScreen *previous_screen)
1155 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1159 gtk_menu_shell_add (GtkContainer *container,
1162 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1166 gtk_menu_shell_remove (GtkContainer *container,
1169 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1170 GtkMenuShellPrivate *priv = menu_shell->priv;
1173 was_visible = gtk_widget_get_visible (widget);
1174 priv->children = g_list_remove (priv->children, widget);
1176 if (widget == priv->active_menu_item)
1178 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1179 priv->active_menu_item = NULL;
1182 gtk_widget_unparent (widget);
1184 /* Queue resize regardless of gtk_widget_get_visible (container),
1185 * since that's what is needed by toplevels.
1188 gtk_widget_queue_resize (GTK_WIDGET (container));
1192 gtk_menu_shell_forall (GtkContainer *container,
1193 gboolean include_internals,
1194 GtkCallback callback,
1195 gpointer callback_data)
1197 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1201 children = menu_shell->priv->children;
1204 child = children->data;
1205 children = children->next;
1207 (* callback) (child, callback_data);
1213 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1215 GtkMenuShellPrivate *priv = menu_shell->priv;
1220 priv->active = FALSE;
1221 priv->activate_time = 0;
1223 if (priv->active_menu_item)
1225 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1226 priv->active_menu_item = NULL;
1229 if (priv->have_grab)
1231 priv->have_grab = FALSE;
1232 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1234 if (priv->have_xgrab)
1236 GdkDevice *keyboard;
1238 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1239 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1242 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1244 priv->have_xgrab = FALSE;
1247 priv->keyboard_mode = FALSE;
1248 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1250 _gtk_menu_shell_update_mnemonics (menu_shell);
1255 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1260 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1261 g_return_val_if_fail (child != NULL, FALSE);
1263 parent = gtk_widget_get_parent (child);
1264 while (GTK_IS_MENU_SHELL (parent))
1266 if (parent == (GtkWidget*) menu_shell)
1268 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1275 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1278 GtkWidget *menu_item;
1280 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1282 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1283 menu_item = gtk_widget_get_parent (menu_item);
1285 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1291 /* Handlers for action signals */
1294 * gtk_menu_shell_select_item:
1295 * @menu_shell: a #GtkMenuShell
1296 * @menu_item: The #GtkMenuItem to select
1298 * Selects the menu item from the menu shell.
1301 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1302 GtkWidget *menu_item)
1304 GtkMenuShellPrivate *priv = menu_shell->priv;
1305 GtkMenuShellClass *class;
1307 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1308 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1310 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1312 if (class->select_item &&
1314 priv->active_menu_item == menu_item))
1315 class->select_item (menu_shell, menu_item);
1318 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1319 GtkSubmenuPlacement placement);
1322 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1323 GtkWidget *menu_item)
1325 GtkMenuShellPrivate *priv = menu_shell->priv;
1326 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1328 if (priv->active_menu_item)
1330 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1331 priv->active_menu_item = NULL;
1334 if (!_gtk_menu_item_is_selectable (menu_item))
1336 priv->in_unselectable_item = TRUE;
1337 _gtk_menu_shell_update_mnemonics (menu_shell);
1341 gtk_menu_shell_activate (menu_shell);
1343 priv->active_menu_item = menu_item;
1344 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1345 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1348 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1349 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1350 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1352 _gtk_menu_shell_update_mnemonics (menu_shell);
1354 /* This allows the bizarre radio buttons-with-submenus-display-history
1357 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1358 gtk_widget_activate (priv->active_menu_item);
1362 * gtk_menu_shell_deselect:
1363 * @menu_shell: a #GtkMenuShell
1365 * Deselects the currently selected item from the menu shell,
1369 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1371 GtkMenuShellPrivate *priv = menu_shell->priv;
1373 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1375 if (priv->active_menu_item)
1377 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1378 priv->active_menu_item = NULL;
1379 _gtk_menu_shell_update_mnemonics (menu_shell);
1384 * gtk_menu_shell_activate_item:
1385 * @menu_shell: a #GtkMenuShell
1386 * @menu_item: the #GtkMenuItem to activate
1387 * @force_deactivate: if %TRUE, force the deactivation of the
1388 * menu shell after the menu item is activated
1390 * Activates the menu item within the menu shell.
1393 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1394 GtkWidget *menu_item,
1395 gboolean force_deactivate)
1397 GSList *slist, *shells = NULL;
1398 gboolean deactivate = force_deactivate;
1400 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1401 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1404 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1406 g_object_ref (menu_shell);
1407 g_object_ref (menu_item);
1411 GtkMenuShell *parent_menu_shell = menu_shell;
1415 g_object_ref (parent_menu_shell);
1416 shells = g_slist_prepend (shells, parent_menu_shell);
1417 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1419 while (parent_menu_shell);
1420 shells = g_slist_reverse (shells);
1422 gtk_menu_shell_deactivate (menu_shell);
1424 /* Flush the x-queue, so any grabs are removed and
1425 * the menu is actually taken down
1427 gdk_display_sync (gtk_widget_get_display (menu_item));
1430 gtk_widget_activate (menu_item);
1432 for (slist = shells; slist; slist = slist->next)
1434 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1435 g_object_unref (slist->data);
1437 g_slist_free (shells);
1439 g_object_unref (menu_shell);
1440 g_object_unref (menu_item);
1443 /* Distance should be +/- 1 */
1445 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1448 GtkMenuShellPrivate *priv = menu_shell->priv;
1450 if (priv->active_menu_item)
1452 GList *node = g_list_find (priv->children, priv->active_menu_item);
1453 GList *start_node = node;
1454 gboolean wrap_around;
1456 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1457 "gtk-keynav-wrap-around", &wrap_around,
1463 while (node != start_node &&
1464 (!node || !_gtk_menu_item_is_selectable (node->data)))
1468 else if (wrap_around)
1469 node = priv->children;
1472 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1480 while (node != start_node &&
1481 (!node || !_gtk_menu_item_is_selectable (node->data)))
1485 else if (wrap_around)
1486 node = g_list_last (priv->children);
1489 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1496 gtk_menu_shell_select_item (menu_shell, node->data);
1502 /* Distance should be +/- 1 */
1504 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1507 gboolean handled = FALSE;
1509 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1510 distance, &handled);
1514 * gtk_menu_shell_select_first:
1515 * @menu_shell: a #GtkMenuShell
1516 * @search_sensitive: if %TRUE, search for the first selectable
1517 * menu item, otherwise select nothing if
1518 * the first item isn't sensitive. This
1519 * should be %FALSE if the menu is being
1520 * popped up initially.
1522 * Select the first visible or selectable child of the menu shell;
1523 * don't select tearoff items unless the only item is a tearoff
1529 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1530 gboolean search_sensitive)
1532 GtkMenuShellPrivate *priv = menu_shell->priv;
1533 GtkWidget *to_select = NULL;
1536 tmp_list = priv->children;
1539 GtkWidget *child = tmp_list->data;
1541 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1542 _gtk_menu_item_is_selectable (child))
1545 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1549 tmp_list = tmp_list->next;
1553 gtk_menu_shell_select_item (menu_shell, to_select);
1557 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1558 gboolean search_sensitive)
1560 GtkMenuShellPrivate *priv = menu_shell->priv;
1561 GtkWidget *to_select = NULL;
1564 tmp_list = g_list_last (priv->children);
1567 GtkWidget *child = tmp_list->data;
1569 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1570 _gtk_menu_item_is_selectable (child))
1573 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1577 tmp_list = tmp_list->prev;
1581 gtk_menu_shell_select_item (menu_shell, to_select);
1585 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1587 GtkMenuShellPrivate *priv = menu_shell->priv;
1588 GtkMenuItem *menu_item;
1590 if (priv->active_menu_item == NULL)
1593 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1595 if (menu_item->priv->submenu)
1597 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1598 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->priv->submenu), TRUE);
1599 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active_menu_item)
1607 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1608 GtkMenuDirectionType direction)
1610 GtkMenuShellPrivate *priv = menu_shell->priv;
1611 GtkMenuShell *parent_menu_shell = NULL;
1612 gboolean had_selection;
1613 gboolean touchscreen_mode;
1615 priv->in_unselectable_item = FALSE;
1617 had_selection = priv->active_menu_item != NULL;
1619 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1620 "gtk-touchscreen-mode", &touchscreen_mode,
1623 if (priv->parent_menu_shell)
1624 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1628 case GTK_MENU_DIR_PARENT:
1629 if (touchscreen_mode &&
1630 priv->active_menu_item &&
1631 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu &&
1632 gtk_widget_get_visible (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu))
1634 /* if we are on a menu item that has an open submenu but the
1635 * focus is not in that submenu (e.g. because it's empty or
1636 * has only insensitive items), close that submenu instead of
1637 * running into the code below which would close *this* menu.
1639 _gtk_menu_item_popdown_submenu (priv->active_menu_item);
1640 _gtk_menu_shell_update_mnemonics (menu_shell);
1642 else if (parent_menu_shell)
1644 if (touchscreen_mode)
1646 /* close menu when returning from submenu. */
1647 _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->priv->parent_menu_item);
1648 _gtk_menu_shell_update_mnemonics (parent_menu_shell);
1652 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1653 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1654 gtk_menu_shell_deselect (menu_shell);
1657 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1658 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1660 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1661 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1664 /* If there is no parent and the submenu is in the opposite direction
1665 * to the menu, then make the PARENT direction wrap around to
1666 * the bottom of the submenu.
1668 else if (priv->active_menu_item &&
1669 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1670 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1672 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu);
1674 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1675 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1676 _gtk_menu_shell_select_last (submenu, TRUE);
1680 case GTK_MENU_DIR_CHILD:
1681 if (priv->active_menu_item &&
1682 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1683 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1685 if (gtk_menu_shell_select_submenu_first (menu_shell))
1689 /* Try to find a menu running the opposite direction */
1690 while (parent_menu_shell &&
1691 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1692 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1694 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1697 if (parent_menu_shell)
1699 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1700 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1702 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1704 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1708 case GTK_MENU_DIR_PREV:
1709 gtk_menu_shell_move_selected (menu_shell, -1);
1710 if (!had_selection && !priv->active_menu_item && priv->children)
1711 _gtk_menu_shell_select_last (menu_shell, TRUE);
1714 case GTK_MENU_DIR_NEXT:
1715 gtk_menu_shell_move_selected (menu_shell, 1);
1716 if (!had_selection && !priv->active_menu_item && priv->children)
1717 gtk_menu_shell_select_first (menu_shell, TRUE);
1723 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1724 gboolean force_hide)
1726 GtkMenuShellPrivate *priv = menu_shell->priv;
1728 if (priv->active_menu_item &&
1729 _gtk_menu_item_is_selectable (priv->active_menu_item))
1731 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu == NULL)
1732 gtk_menu_shell_activate_item (menu_shell,
1733 priv->active_menu_item,
1736 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1741 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1743 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1744 gtk_menu_shell_deselect (menu_shell);
1745 gtk_menu_shell_deactivate (menu_shell);
1746 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1750 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1751 GtkDirectionType dir)
1753 GtkMenuShellPrivate *priv = menu_shell->priv;
1755 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1757 if (priv->parent_menu_shell)
1758 menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1764 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1768 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1770 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1772 if (klass->get_popup_delay)
1774 return klass->get_popup_delay (menu_shell);
1779 GtkWidget *widget = GTK_WIDGET (menu_shell);
1781 g_object_get (gtk_widget_get_settings (widget),
1782 "gtk-menu-popup-delay", &popup_delay,
1790 * gtk_menu_shell_cancel:
1791 * @menu_shell: a #GtkMenuShell
1793 * Cancels the selection within the menu shell.
1798 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1800 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1802 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1805 static GtkMnemonicHash *
1806 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1809 GtkMenuShellPrivate *priv = menu_shell->priv;
1811 if (!priv->mnemonic_hash && create)
1812 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1814 return priv->mnemonic_hash;
1818 menu_shell_add_mnemonic_foreach (guint keyval,
1822 GtkKeyHash *key_hash = data;
1824 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1828 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1831 GtkMenuShellPrivate *priv = menu_shell->priv;
1832 GtkWidget *widget = GTK_WIDGET (menu_shell);
1834 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1836 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1837 GdkScreen *screen = gtk_widget_get_screen (widget);
1838 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1843 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1845 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1846 menu_shell_add_mnemonic_foreach,
1850 return priv->key_hash;
1854 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1856 GtkMenuShellPrivate *priv = menu_shell->priv;
1860 _gtk_key_hash_free (priv->key_hash);
1861 priv->key_hash = NULL;
1866 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1869 GtkMnemonicHash *mnemonic_hash;
1870 GtkKeyHash *key_hash;
1872 gboolean result = FALSE;
1874 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1878 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1882 entries = _gtk_key_hash_lookup (key_hash,
1883 event->hardware_keycode,
1885 gtk_accelerator_get_default_mod_mask (),
1890 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1891 GPOINTER_TO_UINT (entries->data));
1892 g_slist_free (entries);
1899 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1903 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1904 g_return_if_fail (GTK_IS_WIDGET (target));
1906 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1908 gtk_menu_shell_reset_key_hash (menu_shell);
1912 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1916 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1917 g_return_if_fail (GTK_IS_WIDGET (target));
1919 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1921 gtk_menu_shell_reset_key_hash (menu_shell);
1925 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1928 GtkMenuShellPrivate *priv = menu_shell->priv;
1930 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1931 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1934 priv->grab_pointer = NULL;
1935 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1936 priv->grab_pointer = gdk_device_get_associated_device (device);
1938 priv->grab_pointer = device;
1942 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1944 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1946 return menu_shell->priv->grab_pointer;
1950 * gtk_menu_shell_get_take_focus:
1951 * @menu_shell: a #GtkMenuShell
1953 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1955 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1960 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1962 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1964 return menu_shell->priv->take_focus;
1968 * gtk_menu_shell_set_take_focus:
1969 * @menu_shell: a #GtkMenuShell
1970 * @take_focus: %TRUE if the menu shell should take the keyboard
1973 * If @take_focus is %TRUE (the default) the menu shell will take
1974 * the keyboard focus so that it will receive all keyboard events
1975 * which is needed to enable keyboard navigation in menus.
1977 * Setting @take_focus to %FALSE is useful only for special applications
1978 * like virtual keyboard implementations which should not take keyboard
1981 * The @take_focus state of a menu or menu bar is automatically
1982 * propagated to submenus whenever a submenu is popped up, so you
1983 * don't have to worry about recursively setting it for your entire
1984 * menu hierarchy. Only when programmatically picking a submenu and
1985 * popping it up manually, the @take_focus property of the submenu
1986 * needs to be set explicitely.
1988 * Note that setting it to %FALSE has side-effects:
1990 * If the focus is in some other app, it keeps the focus and keynav in
1991 * the menu doesn't work. Consequently, keynav on the menu will only
1992 * work if the focus is on some toplevel owned by the onscreen keyboard.
1994 * To avoid confusing the user, menus with @take_focus set to %FALSE
1995 * should not display mnemonics or accelerators, since it cannot be
1996 * guaranteed that they will work.
1998 * See also gdk_keyboard_grab()
2003 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
2004 gboolean take_focus)
2006 GtkMenuShellPrivate *priv = menu_shell->priv;
2008 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
2010 if (priv->take_focus != take_focus)
2012 priv->take_focus = take_focus;
2013 g_object_notify (G_OBJECT (menu_shell), "take-focus");
2018 * gtk_menu_shell_get_selected_item:
2019 * @menu_shell: a #GtkMenuShell
2021 * Gets the currently selected item.
2023 * Returns: (transfer none): the currently selected item
2028 gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell)
2030 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
2032 return menu_shell->priv->active_menu_item;
2036 * gtk_menu_shell_get_parent_shell:
2037 * @menu_shell: a #GtkMenuShell
2039 * Gets the parent menu shell.
2041 * The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
2042 * from which it was opened up.
2044 * Returns: (transfer none): the parent #GtkMenuShell
2049 gtk_menu_shell_get_parent_shell (GtkMenuShell *menu_shell)
2051 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
2053 return menu_shell->priv->parent_menu_shell;