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"
32 #include "gtkbindings.h"
33 #include "gtkkeyhash.h"
35 #include "gtkmarshalers.h"
36 #include "gtkmenubar.h"
37 #include "gtkmenuitem.h"
38 #include "gtkmenushell.h"
39 #include "gtkmnemonichash.h"
40 #include "gtktearoffmenuitem.h"
41 #include "gtkwindow.h"
43 #define MENU_SHELL_TIMEOUT 500
55 typedef void (*GtkMenuShellSignal1) (GtkObject *object,
56 GtkMenuDirectionType arg1,
58 typedef void (*GtkMenuShellSignal2) (GtkObject *object,
64 * A menu item can be "selected", this means that it is displayed
65 * in the prelight state, and if it has a submenu, that submenu
68 * A menu is "active" when it is visible onscreen and the user
69 * is selecting from it. A menubar is not active until the user
70 * clicks on one of its menuitems. When a menu is active,
71 * passing the mouse over a submenu will pop it up.
73 * menu_shell->active_menu_item, is however, not an "active"
74 * menu item (there is no such thing) but rather, the selected
75 * menu item in that MenuShell, if there is one.
77 * There is also is a concept of the current menu and a current
78 * menu item. The current menu item is the selected menu item
79 * that is furthest down in the heirarchy. (Every active menu_shell
80 * does not necessarily contain a selected menu item, but if
81 * it does, then menu_shell->parent_menu_shell must also contain
82 * a selected menu item. The current menu is the menu that
83 * contains the current menu_item. It will always have a GTK
84 * grab and receive all key presses.
89 * ::move_current (GtkMenuDirection *dir)
90 * Moves the current menu item in direction 'dir':
92 * GTK_MENU_DIR_PARENT: To the parent menu shell
93 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
95 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
98 * As a a bit of a hack to get movement between menus and
99 * menubars working, if submenu_placement is different for
100 * the menu and its MenuShell then the following apply:
102 * - For 'parent' the current menu is not just moved to
103 * the parent, but moved to the previous entry in the parent
104 * - For 'child', if there is no child, then current is
105 * moved to the next item in the parent.
108 * ::activate_current (GBoolean *force_hide)
109 * Activate the current item. If 'force_hide' is true, hide
110 * the current menu item always. Otherwise, only hide
111 * it if menu_item->klass->hide_on_activate is true.
114 * Cancels the current selection
117 #define GTK_MENU_SHELL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShellPrivate))
119 typedef struct _GtkMenuShellPrivate GtkMenuShellPrivate;
121 struct _GtkMenuShellPrivate
123 GtkMnemonicHash *mnemonic_hash;
124 GtkKeyHash *key_hash;
127 static void gtk_menu_shell_class_init (GtkMenuShellClass *klass);
128 static void gtk_menu_shell_init (GtkMenuShell *menu_shell);
129 static void gtk_menu_shell_realize (GtkWidget *widget);
130 static void gtk_menu_shell_finalize (GObject *object);
131 static gint gtk_menu_shell_button_press (GtkWidget *widget,
132 GdkEventButton *event);
133 static gint gtk_menu_shell_button_release (GtkWidget *widget,
134 GdkEventButton *event);
135 static gint gtk_menu_shell_key_press (GtkWidget *widget,
137 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
138 GdkEventCrossing *event);
139 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
140 GdkEventCrossing *event);
141 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
142 GdkScreen *previous_screen);
143 static void gtk_menu_shell_add (GtkContainer *container,
145 static void gtk_menu_shell_remove (GtkContainer *container,
147 static void gtk_menu_shell_forall (GtkContainer *container,
148 gboolean include_internals,
149 GtkCallback callback,
150 gpointer callback_data);
151 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
154 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
155 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
157 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
159 static GType gtk_menu_shell_child_type (GtkContainer *container);
160 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
161 GtkWidget *menu_item);
162 static void gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
164 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
165 GtkMenuDirectionType direction);
166 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
167 gboolean force_hide);
168 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
169 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
170 GtkDirectionType dir);
172 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
173 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
176 static GtkContainerClass *parent_class = NULL;
177 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
181 gtk_menu_shell_get_type (void)
183 static GType menu_shell_type = 0;
185 if (!menu_shell_type)
187 static const GTypeInfo menu_shell_info =
189 sizeof (GtkMenuShellClass),
190 NULL, /* base_init */
191 NULL, /* base_finalize */
192 (GClassInitFunc) gtk_menu_shell_class_init,
193 NULL, /* class_finalize */
194 NULL, /* class_data */
195 sizeof (GtkMenuShell),
197 (GInstanceInitFunc) gtk_menu_shell_init,
198 NULL, /* value_table */
202 g_type_register_static (GTK_TYPE_CONTAINER, "GtkMenuShell",
203 &menu_shell_info, G_TYPE_FLAG_ABSTRACT);
206 return menu_shell_type;
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 parent_class = g_type_class_peek_parent (klass);
224 object_class->finalize = gtk_menu_shell_finalize;
226 widget_class->realize = gtk_menu_shell_realize;
227 widget_class->button_press_event = gtk_menu_shell_button_press;
228 widget_class->button_release_event = gtk_menu_shell_button_release;
229 widget_class->key_press_event = gtk_menu_shell_key_press;
230 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
231 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
232 widget_class->screen_changed = gtk_menu_shell_screen_changed;
234 container_class->add = gtk_menu_shell_add;
235 container_class->remove = gtk_menu_shell_remove;
236 container_class->forall = gtk_menu_shell_forall;
237 container_class->child_type = gtk_menu_shell_child_type;
239 klass->submenu_placement = GTK_TOP_BOTTOM;
240 klass->deactivate = gtk_real_menu_shell_deactivate;
241 klass->selection_done = NULL;
242 klass->move_current = gtk_real_menu_shell_move_current;
243 klass->activate_current = gtk_real_menu_shell_activate_current;
244 klass->cancel = gtk_real_menu_shell_cancel;
245 klass->select_item = gtk_menu_shell_real_select_item;
246 klass->insert = gtk_menu_shell_real_insert;
248 menu_shell_signals[DEACTIVATE] =
249 g_signal_new ("deactivate",
250 G_OBJECT_CLASS_TYPE (object_class),
252 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
254 _gtk_marshal_VOID__VOID,
256 menu_shell_signals[SELECTION_DONE] =
257 g_signal_new ("selection-done",
258 G_OBJECT_CLASS_TYPE (object_class),
260 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
262 _gtk_marshal_VOID__VOID,
264 menu_shell_signals[MOVE_CURRENT] =
265 g_signal_new ("move_current",
266 G_OBJECT_CLASS_TYPE (object_class),
267 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
268 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
270 _gtk_marshal_VOID__ENUM,
272 GTK_TYPE_MENU_DIRECTION_TYPE);
273 menu_shell_signals[ACTIVATE_CURRENT] =
274 g_signal_new ("activate_current",
275 G_OBJECT_CLASS_TYPE (object_class),
276 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
277 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
279 _gtk_marshal_VOID__BOOLEAN,
282 menu_shell_signals[CANCEL] =
283 g_signal_new ("cancel",
284 G_OBJECT_CLASS_TYPE (object_class),
285 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
286 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
288 _gtk_marshal_VOID__VOID,
290 menu_shell_signals[CYCLE_FOCUS] =
291 _gtk_binding_signal_new ("cycle_focus",
292 G_OBJECT_CLASS_TYPE (object_class),
293 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
294 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
296 _gtk_marshal_VOID__ENUM,
298 GTK_TYPE_DIRECTION_TYPE);
301 binding_set = gtk_binding_set_by_class (klass);
302 gtk_binding_entry_add_signal (binding_set,
305 gtk_binding_entry_add_signal (binding_set,
307 "activate_current", 1,
310 gtk_binding_entry_add_signal (binding_set,
312 "activate_current", 1,
315 gtk_binding_entry_add_signal (binding_set,
317 "activate_current", 1,
320 gtk_binding_entry_add_signal (binding_set,
322 "activate_current", 1,
325 gtk_binding_entry_add_signal (binding_set,
328 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
329 gtk_binding_entry_add_signal (binding_set,
330 GDK_F10, GDK_SHIFT_MASK,
332 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
334 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
338 gtk_menu_shell_child_type (GtkContainer *container)
340 return GTK_TYPE_MENU_ITEM;
344 gtk_menu_shell_init (GtkMenuShell *menu_shell)
346 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
348 menu_shell->children = NULL;
349 menu_shell->active_menu_item = NULL;
350 menu_shell->parent_menu_shell = NULL;
351 menu_shell->active = FALSE;
352 menu_shell->have_grab = FALSE;
353 menu_shell->have_xgrab = FALSE;
354 menu_shell->button = 0;
355 menu_shell->activate_time = 0;
357 priv->mnemonic_hash = NULL;
358 priv->key_hash = NULL;
362 gtk_menu_shell_finalize (GObject *object)
364 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
365 GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
367 if (priv->mnemonic_hash)
368 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
370 _gtk_key_hash_free (priv->key_hash);
372 G_OBJECT_CLASS (parent_class)->finalize (object);
377 gtk_menu_shell_append (GtkMenuShell *menu_shell,
380 gtk_menu_shell_insert (menu_shell, child, -1);
384 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
387 gtk_menu_shell_insert (menu_shell, child, 0);
391 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
395 GtkMenuShellClass *class;
397 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
398 g_return_if_fail (GTK_IS_MENU_ITEM (child));
400 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
403 class->insert (menu_shell, child, position);
407 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
411 menu_shell->children = g_list_insert (menu_shell->children, child, position);
413 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
417 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
419 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
421 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
425 gtk_menu_shell_realize (GtkWidget *widget)
427 GdkWindowAttr attributes;
428 gint attributes_mask;
430 g_return_if_fail (GTK_IS_MENU_SHELL (widget));
432 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
434 attributes.x = widget->allocation.x;
435 attributes.y = widget->allocation.y;
436 attributes.width = widget->allocation.width;
437 attributes.height = widget->allocation.height;
438 attributes.window_type = GDK_WINDOW_CHILD;
439 attributes.wclass = GDK_INPUT_OUTPUT;
440 attributes.visual = gtk_widget_get_visual (widget);
441 attributes.colormap = gtk_widget_get_colormap (widget);
442 attributes.event_mask = gtk_widget_get_events (widget);
443 attributes.event_mask |= (GDK_EXPOSURE_MASK |
444 GDK_BUTTON_PRESS_MASK |
445 GDK_BUTTON_RELEASE_MASK |
447 GDK_ENTER_NOTIFY_MASK |
448 GDK_LEAVE_NOTIFY_MASK);
450 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
451 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
452 gdk_window_set_user_data (widget->window, widget);
454 widget->style = gtk_style_attach (widget->style, widget->window);
455 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
459 _gtk_menu_shell_activate (GtkMenuShell *menu_shell)
461 if (!menu_shell->active)
463 gtk_grab_add (GTK_WIDGET (menu_shell));
464 menu_shell->have_grab = TRUE;
465 menu_shell->active = TRUE;
470 gtk_menu_shell_button_press (GtkWidget *widget,
471 GdkEventButton *event)
473 GtkMenuShell *menu_shell;
474 GtkWidget *menu_item;
476 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
477 g_return_val_if_fail (event != NULL, FALSE);
479 if (event->type != GDK_BUTTON_PRESS)
482 menu_shell = GTK_MENU_SHELL (widget);
484 if (menu_shell->parent_menu_shell)
486 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
488 else if (!menu_shell->active || !menu_shell->button)
490 _gtk_menu_shell_activate (menu_shell);
492 menu_shell->button = event->button;
494 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
496 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
498 if ((menu_item->parent == widget) &&
499 (menu_item != menu_shell->active_menu_item))
501 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
503 menu_shell->activate_time = event->time;
506 gtk_menu_shell_select_item (menu_shell, menu_item);
512 widget = gtk_get_event_widget ((GdkEvent*) event);
513 if (widget == GTK_WIDGET (menu_shell))
515 gtk_menu_shell_deactivate (menu_shell);
516 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
524 gtk_menu_shell_button_release (GtkWidget *widget,
525 GdkEventButton *event)
527 GtkMenuShell *menu_shell;
528 GtkWidget *menu_item;
531 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
532 g_return_val_if_fail (event != NULL, FALSE);
534 menu_shell = GTK_MENU_SHELL (widget);
535 if (menu_shell->active)
537 if (menu_shell->button && (event->button != menu_shell->button))
539 menu_shell->button = 0;
540 if (menu_shell->parent_menu_shell)
541 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
544 menu_shell->button = 0;
545 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
549 if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
551 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
552 _gtk_menu_item_is_selectable (menu_item))
554 if (GTK_MENU_ITEM (menu_item)->submenu == NULL)
556 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
559 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
561 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
565 else if (menu_item &&
566 !_gtk_menu_item_is_selectable (menu_item) &&
567 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
571 else if (menu_shell->parent_menu_shell)
573 menu_shell->active = TRUE;
574 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
578 /* If we ended up on an item with a submenu, leave the menu up.
580 if (menu_item && (menu_shell->active_menu_item == menu_item) &&
581 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
586 else /* a very fast press-release */
588 /* We only ever want to prevent deactivation on the first
589 * press/release. Setting the time to zero is a bit of a
590 * hack, since we could be being triggered in the first
591 * few fractions of a second after a server time wraparound.
592 * the chances of that happening are ~1/10^6, without
593 * serious harm if we lose.
595 menu_shell->activate_time = 0;
601 gtk_menu_shell_deactivate (menu_shell);
602 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
610 gtk_menu_shell_key_press (GtkWidget *widget,
613 GtkMenuShell *menu_shell;
615 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
616 g_return_val_if_fail (event != NULL, FALSE);
618 menu_shell = GTK_MENU_SHELL (widget);
620 if (!menu_shell->active_menu_item && menu_shell->parent_menu_shell)
621 return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent *)event);
623 if (gtk_bindings_activate_event (GTK_OBJECT (widget), event))
626 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
630 gtk_menu_shell_enter_notify (GtkWidget *widget,
631 GdkEventCrossing *event)
633 GtkMenuShell *menu_shell;
634 GtkWidget *menu_item;
636 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
637 g_return_val_if_fail (event != NULL, FALSE);
639 menu_shell = GTK_MENU_SHELL (widget);
641 if (menu_shell->active)
643 menu_item = gtk_get_event_widget ((GdkEvent*) event);
646 (GTK_IS_MENU_ITEM (menu_item) &&
647 !_gtk_menu_item_is_selectable (menu_item)))
650 if ((menu_item->parent == widget) &&
651 (menu_shell->active_menu_item != menu_item) &&
652 GTK_IS_MENU_ITEM (menu_item))
654 if (menu_shell->ignore_enter)
657 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
658 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT))
660 gtk_menu_shell_select_item (menu_shell, menu_item);
663 else if (menu_shell->parent_menu_shell)
665 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
673 gtk_menu_shell_leave_notify (GtkWidget *widget,
674 GdkEventCrossing *event)
676 GtkMenuShell *menu_shell;
677 GtkMenuItem *menu_item;
678 GtkWidget *event_widget;
680 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
681 g_return_val_if_fail (event != NULL, FALSE);
683 if (GTK_WIDGET_VISIBLE (widget))
685 menu_shell = GTK_MENU_SHELL (widget);
686 event_widget = gtk_get_event_widget ((GdkEvent*) event);
688 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
691 menu_item = GTK_MENU_ITEM (event_widget);
693 if (!_gtk_menu_item_is_selectable (event_widget))
696 if ((menu_shell->active_menu_item == event_widget) &&
697 (menu_item->submenu == NULL))
699 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
700 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_NORMAL))
702 gtk_menu_shell_deselect (menu_shell);
705 else if (menu_shell->parent_menu_shell)
707 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
715 gtk_menu_shell_screen_changed (GtkWidget *widget,
716 GdkScreen *previous_screen)
718 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
722 gtk_menu_shell_add (GtkContainer *container,
725 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
729 gtk_menu_shell_remove (GtkContainer *container,
732 GtkMenuShell *menu_shell;
735 g_return_if_fail (GTK_IS_MENU_SHELL (container));
736 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
738 was_visible = GTK_WIDGET_VISIBLE (widget);
739 menu_shell = GTK_MENU_SHELL (container);
740 menu_shell->children = g_list_remove (menu_shell->children, widget);
742 if (widget == menu_shell->active_menu_item)
744 gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
745 menu_shell->active_menu_item = NULL;
748 gtk_widget_unparent (widget);
750 /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
751 * since that's what is needed by toplevels.
754 gtk_widget_queue_resize (GTK_WIDGET (container));
758 gtk_menu_shell_forall (GtkContainer *container,
759 gboolean include_internals,
760 GtkCallback callback,
761 gpointer callback_data)
763 GtkMenuShell *menu_shell;
767 g_return_if_fail (GTK_IS_MENU_SHELL (container));
768 g_return_if_fail (callback != NULL);
770 menu_shell = GTK_MENU_SHELL (container);
772 children = menu_shell->children;
775 child = children->data;
776 children = children->next;
778 (* callback) (child, callback_data);
784 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
786 if (menu_shell->active)
788 menu_shell->button = 0;
789 menu_shell->active = FALSE;
790 menu_shell->activate_time = 0;
792 if (menu_shell->active_menu_item)
794 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
795 menu_shell->active_menu_item = NULL;
798 if (menu_shell->have_grab)
800 menu_shell->have_grab = FALSE;
801 gtk_grab_remove (GTK_WIDGET (menu_shell));
803 if (menu_shell->have_xgrab)
805 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET (menu_shell));
807 menu_shell->have_xgrab = FALSE;
808 gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
809 gdk_display_keyboard_ungrab (display, GDK_CURRENT_TIME);
815 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
820 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
821 g_return_val_if_fail (child != NULL, FALSE);
823 parent = child->parent;
824 while (parent && GTK_IS_MENU_SHELL (parent))
826 if (parent == (GtkWidget*) menu_shell)
828 parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
835 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
838 GtkWidget *menu_item;
840 menu_item = gtk_get_event_widget ((GdkEvent*) event);
842 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
843 menu_item = menu_item->parent;
845 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
851 /* Handlers for action signals */
854 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
855 GtkWidget *menu_item)
857 GtkMenuShellClass *class;
859 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
860 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
862 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
864 if (class->select_item &&
865 !(menu_shell->active &&
866 menu_shell->active_menu_item == menu_item))
867 class->select_item (menu_shell, menu_item);
870 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
871 GtkSubmenuPlacement placement);
874 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
875 GtkWidget *menu_item)
877 gtk_menu_shell_deselect (menu_shell);
879 if (!_gtk_menu_item_is_selectable (menu_item))
882 menu_shell->active_menu_item = menu_item;
883 _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
884 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
885 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
887 /* This allows the bizarre radio buttons-with-submenus-display-history
890 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
891 gtk_widget_activate (menu_shell->active_menu_item);
895 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
897 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
899 if (menu_shell->active_menu_item)
901 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
902 menu_shell->active_menu_item = NULL;
907 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
908 GtkWidget *menu_item,
909 gboolean force_deactivate)
911 GSList *slist, *shells = NULL;
912 gboolean deactivate = force_deactivate;
914 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
915 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
918 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
920 g_object_ref (menu_shell);
924 GtkMenuShell *parent_menu_shell = menu_shell;
928 g_object_ref (parent_menu_shell);
929 shells = g_slist_prepend (shells, parent_menu_shell);
930 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->parent_menu_shell;
932 while (parent_menu_shell);
933 shells = g_slist_reverse (shells);
935 gtk_menu_shell_deactivate (menu_shell);
937 /* flush the x-queue, so any grabs are removed and
938 * the menu is actually taken down
940 gdk_display_sync (gtk_widget_get_display (menu_item));
943 gtk_widget_activate (menu_item);
945 for (slist = shells; slist; slist = slist->next)
947 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
948 g_object_unref (slist->data);
950 g_slist_free (shells);
952 g_object_unref (menu_shell);
955 /* Distance should be +/- 1 */
957 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
960 if (menu_shell->active_menu_item)
962 GList *node = g_list_find (menu_shell->children,
963 menu_shell->active_menu_item);
964 GList *start_node = node;
969 while (node != start_node &&
970 (!node || !_gtk_menu_item_is_selectable (node->data)))
973 node = menu_shell->children;
981 while (node != start_node &&
982 (!node || !_gtk_menu_item_is_selectable (node->data)))
985 node = g_list_last (menu_shell->children);
992 gtk_menu_shell_select_item (menu_shell, node->data);
997 * gtk_menu_shell_select_first:
998 * @menu_shell: a #GtkMenuShell
999 * @search_sensitive: if %TRUE, search for the first selectable
1000 * menu item, otherwise select nothing if
1001 * the first item isn't sensitive. This
1002 * should be %FALSE if the menu is being
1003 * popped up initially.
1005 * Select the first visible or selectable child of the menu shell;
1006 * don't select tearoff items unless the only item is a tearoff
1012 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1013 gboolean search_sensitive)
1015 GtkWidget *to_select = NULL;
1018 tmp_list = menu_shell->children;
1021 GtkWidget *child = tmp_list->data;
1023 if ((!search_sensitive && GTK_WIDGET_VISIBLE (child)) ||
1024 _gtk_menu_item_is_selectable (child))
1027 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1031 tmp_list = tmp_list->next;
1035 gtk_menu_shell_select_item (menu_shell, to_select);
1039 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1040 gboolean search_sensitive)
1042 GtkWidget *to_select = NULL;
1045 tmp_list = g_list_last (menu_shell->children);
1048 GtkWidget *child = tmp_list->data;
1050 if ((!search_sensitive && GTK_WIDGET_VISIBLE (child)) ||
1051 _gtk_menu_item_is_selectable (child))
1054 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1058 tmp_list = tmp_list->prev;
1062 gtk_menu_shell_select_item (menu_shell, to_select);
1066 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1068 GtkMenuItem *menu_item;
1070 menu_item = GTK_MENU_ITEM (menu_shell->active_menu_item);
1072 if (menu_item->submenu)
1074 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item));
1075 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1080 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1081 GtkMenuDirectionType direction)
1083 GtkMenuShell *parent_menu_shell = NULL;
1084 gboolean had_selection;
1086 had_selection = menu_shell->active_menu_item != NULL;
1088 if (menu_shell->parent_menu_shell)
1089 parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1091 if (gtk_widget_get_direction (GTK_WIDGET (menu_shell)) == GTK_TEXT_DIR_RTL)
1095 case GTK_MENU_DIR_PARENT:
1096 direction = GTK_MENU_DIR_CHILD;
1098 case GTK_MENU_DIR_CHILD:
1099 direction = GTK_MENU_DIR_PARENT;
1101 case GTK_MENU_DIR_PREV:
1102 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
1103 direction = GTK_MENU_DIR_NEXT;
1105 case GTK_MENU_DIR_NEXT:
1106 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
1107 direction = GTK_MENU_DIR_PREV;
1115 case GTK_MENU_DIR_PARENT:
1116 if (parent_menu_shell)
1118 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1119 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1120 gtk_menu_shell_deselect (menu_shell);
1123 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1124 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1127 /* If there is no parent and the submenu is in the opposite direction
1128 * to the menu, then make the PARENT direction wrap around to
1129 * the bottom of the submenu.
1131 else if (menu_shell->active_menu_item &&
1132 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1133 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1135 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu);
1137 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1138 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1139 _gtk_menu_shell_select_last (submenu, TRUE);
1143 case GTK_MENU_DIR_CHILD:
1144 if (menu_shell->active_menu_item &&
1145 _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1146 GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
1148 gtk_menu_shell_select_submenu_first (menu_shell);
1152 /* Try to find a menu running the opposite direction */
1153 while (parent_menu_shell &&
1154 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1155 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1157 GtkWidget *tmp_widget = parent_menu_shell->parent_menu_shell;
1160 parent_menu_shell = GTK_MENU_SHELL (tmp_widget);
1162 parent_menu_shell = NULL;
1165 if (parent_menu_shell)
1167 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1168 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1173 case GTK_MENU_DIR_PREV:
1174 gtk_menu_shell_move_selected (menu_shell, -1);
1175 if (!had_selection &&
1176 !menu_shell->active_menu_item &&
1177 menu_shell->children)
1178 _gtk_menu_shell_select_last (menu_shell, TRUE);
1180 case GTK_MENU_DIR_NEXT:
1181 gtk_menu_shell_move_selected (menu_shell, 1);
1182 if (!had_selection &&
1183 !menu_shell->active_menu_item &&
1184 menu_shell->children)
1185 gtk_menu_shell_select_first (menu_shell, TRUE);
1192 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1193 gboolean force_hide)
1195 if (menu_shell->active_menu_item &&
1196 _gtk_menu_item_is_selectable (menu_shell->active_menu_item))
1199 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu == NULL)
1200 gtk_menu_shell_activate_item (menu_shell,
1201 menu_shell->active_menu_item,
1204 _gtk_menu_item_popup_submenu (menu_shell->active_menu_item);
1209 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1211 /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
1213 gtk_menu_shell_deselect (menu_shell);
1215 gtk_menu_shell_deactivate (menu_shell);
1216 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1220 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1221 GtkDirectionType dir)
1223 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1225 if (menu_shell->parent_menu_shell)
1226 menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1232 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1236 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1238 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1240 if (klass->get_popup_delay)
1242 return klass->get_popup_delay (menu_shell);
1247 GtkWidget *widget = GTK_WIDGET (menu_shell);
1249 g_object_get (gtk_widget_get_settings (widget),
1250 "gtk-menu-popup-delay", &popup_delay,
1258 * gtk_menu_shell_cancel:
1259 * @menu_shell: a #GtkMenuShell
1261 * Cancels the selection within the menu shell.
1266 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1268 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1270 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1273 static GtkMnemonicHash *
1274 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1277 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1279 if (!private->mnemonic_hash && create)
1280 private->mnemonic_hash = _gtk_mnemonic_hash_new ();
1282 return private->mnemonic_hash;
1286 menu_shell_add_mnemonic_foreach (guint keyval,
1290 GtkKeyHash *key_hash = data;
1292 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1296 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1299 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1300 GtkWidget *widget = GTK_WIDGET (menu_shell);
1302 if (!private->key_hash && create && gtk_widget_has_screen (widget))
1304 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1305 GdkScreen *screen = gtk_widget_get_screen (widget);
1306 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1311 private->key_hash = _gtk_key_hash_new (keymap, NULL);
1313 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1314 menu_shell_add_mnemonic_foreach,
1318 return private->key_hash;
1322 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1324 GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
1326 if (private->key_hash)
1328 _gtk_key_hash_free (private->key_hash);
1329 private->key_hash = NULL;
1334 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1337 GtkMnemonicHash *mnemonic_hash;
1338 GtkKeyHash *key_hash;
1340 gboolean result = FALSE;
1342 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1346 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1350 entries = _gtk_key_hash_lookup (key_hash,
1351 event->hardware_keycode,
1353 gtk_accelerator_get_default_mod_mask (),
1357 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1358 GPOINTER_TO_UINT (entries->data));
1364 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1368 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1369 g_return_if_fail (GTK_IS_WIDGET (target));
1371 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1373 gtk_menu_shell_reset_key_hash (menu_shell);
1377 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1381 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1382 g_return_if_fail (GTK_IS_WIDGET (target));
1384 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1386 gtk_menu_shell_reset_key_hash (menu_shell);