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 Library 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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
20 #include "gtkmenuitem.h"
21 #include "gtkmenushell.h"
22 #include "gtksignal.h"
25 #define MENU_SHELL_TIMEOUT 500
26 #define MENU_SHELL_CLASS(w) GTK_MENU_SHELL_CLASS (GTK_OBJECT (w)->klass)
36 static void gtk_menu_shell_class_init (GtkMenuShellClass *klass);
37 static void gtk_menu_shell_init (GtkMenuShell *menu_shell);
38 static void gtk_menu_shell_map (GtkWidget *widget);
39 static void gtk_menu_shell_realize (GtkWidget *widget);
40 static gint gtk_menu_shell_button_press (GtkWidget *widget,
41 GdkEventButton *event);
42 static gint gtk_menu_shell_button_release (GtkWidget *widget,
43 GdkEventButton *event);
44 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
45 GdkEventCrossing *event);
46 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
47 GdkEventCrossing *event);
48 static void gtk_menu_shell_add (GtkContainer *container,
50 static void gtk_menu_shell_remove (GtkContainer *container,
52 static void gtk_menu_shell_foreach (GtkContainer *container,
54 gpointer callback_data);
55 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
56 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
58 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
60 static GtkType gtk_menu_shell_child_type (GtkContainer *container);
63 static GtkContainerClass *parent_class = NULL;
64 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
68 gtk_menu_shell_get_type (void)
70 static GtkType menu_shell_type = 0;
74 GtkTypeInfo menu_shell_info =
77 sizeof (GtkMenuShell),
78 sizeof (GtkMenuShellClass),
79 (GtkClassInitFunc) gtk_menu_shell_class_init,
80 (GtkObjectInitFunc) gtk_menu_shell_init,
81 /* reserved_1 */ NULL,
82 /* reserved_2 */ NULL,
83 (GtkClassInitFunc) NULL,
86 menu_shell_type = gtk_type_unique (gtk_container_get_type (), &menu_shell_info);
89 return menu_shell_type;
93 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
95 GtkObjectClass *object_class;
96 GtkWidgetClass *widget_class;
97 GtkContainerClass *container_class;
99 object_class = (GtkObjectClass*) klass;
100 widget_class = (GtkWidgetClass*) klass;
101 container_class = (GtkContainerClass*) klass;
103 parent_class = gtk_type_class (gtk_container_get_type ());
105 menu_shell_signals[DEACTIVATE] =
106 gtk_signal_new ("deactivate",
109 GTK_SIGNAL_OFFSET (GtkMenuShellClass, deactivate),
110 gtk_signal_default_marshaller,
112 menu_shell_signals[SELECTION_DONE] =
113 gtk_signal_new ("selection-done",
116 GTK_SIGNAL_OFFSET (GtkMenuShellClass, selection_done),
117 gtk_signal_default_marshaller,
119 gtk_object_class_add_signals (object_class, menu_shell_signals, LAST_SIGNAL);
121 widget_class->map = gtk_menu_shell_map;
122 widget_class->realize = gtk_menu_shell_realize;
123 widget_class->button_press_event = gtk_menu_shell_button_press;
124 widget_class->button_release_event = gtk_menu_shell_button_release;
125 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
126 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
128 container_class->add = gtk_menu_shell_add;
129 container_class->remove = gtk_menu_shell_remove;
130 container_class->foreach = gtk_menu_shell_foreach;
131 container_class->child_type = gtk_menu_shell_child_type;
133 klass->submenu_placement = GTK_TOP_BOTTOM;
134 klass->deactivate = gtk_real_menu_shell_deactivate;
135 klass->selection_done = NULL;
139 gtk_menu_shell_child_type (GtkContainer *container)
141 return GTK_TYPE_MENU_ITEM;
145 gtk_menu_shell_init (GtkMenuShell *menu_shell)
147 menu_shell->children = NULL;
148 menu_shell->active_menu_item = NULL;
149 menu_shell->parent_menu_shell = NULL;
150 menu_shell->active = FALSE;
151 menu_shell->have_grab = FALSE;
152 menu_shell->have_xgrab = FALSE;
153 menu_shell->ignore_leave = FALSE;
154 menu_shell->button = 0;
155 menu_shell->menu_flag = 0;
156 menu_shell->activate_time = 0;
160 gtk_menu_shell_append (GtkMenuShell *menu_shell,
163 gtk_menu_shell_insert (menu_shell, child, -1);
167 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
170 gtk_menu_shell_insert (menu_shell, child, 0);
174 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
182 g_return_if_fail (menu_shell != NULL);
183 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
184 g_return_if_fail (child != NULL);
185 g_return_if_fail (GTK_IS_MENU_ITEM (child));
187 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
189 if (GTK_WIDGET_VISIBLE (child->parent))
191 if (GTK_WIDGET_REALIZED (child->parent) &&
192 !GTK_WIDGET_REALIZED (child))
193 gtk_widget_realize (child);
195 if (GTK_WIDGET_MAPPED (child->parent) &&
196 !GTK_WIDGET_MAPPED (child))
197 gtk_widget_map (child);
200 nchildren = g_list_length (menu_shell->children);
201 if ((position < 0) || (position > nchildren))
202 position = nchildren;
204 if (position == nchildren)
206 menu_shell->children = g_list_append (menu_shell->children, child);
210 tmp_list = g_list_nth (menu_shell->children, position);
211 new_list = g_list_alloc ();
212 new_list->data = child;
215 tmp_list->prev->next = new_list;
216 new_list->next = tmp_list;
217 new_list->prev = tmp_list->prev;
218 tmp_list->prev = new_list;
220 if (tmp_list == menu_shell->children)
221 menu_shell->children = new_list;
224 if (GTK_WIDGET_VISIBLE (menu_shell))
225 gtk_widget_queue_resize (GTK_WIDGET (menu_shell));
229 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
231 g_return_if_fail (menu_shell != NULL);
232 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
234 gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[DEACTIVATE]);
238 gtk_menu_shell_map (GtkWidget *widget)
240 GtkMenuShell *menu_shell;
244 g_return_if_fail (widget != NULL);
245 g_return_if_fail (GTK_IS_MENU_SHELL (widget));
247 menu_shell = GTK_MENU_SHELL (widget);
248 GTK_WIDGET_SET_FLAGS (menu_shell, GTK_MAPPED);
249 gdk_window_show (widget->window);
251 children = menu_shell->children;
254 child = children->data;
255 children = children->next;
257 if (GTK_WIDGET_VISIBLE (child) && !GTK_WIDGET_MAPPED (child))
258 gtk_widget_map (child);
263 gtk_menu_shell_realize (GtkWidget *widget)
265 GdkWindowAttr attributes;
266 gint attributes_mask;
268 g_return_if_fail (widget != NULL);
269 g_return_if_fail (GTK_IS_MENU_SHELL (widget));
271 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
273 attributes.x = widget->allocation.x;
274 attributes.y = widget->allocation.y;
275 attributes.width = widget->allocation.width;
276 attributes.height = widget->allocation.height;
277 attributes.window_type = GDK_WINDOW_CHILD;
278 attributes.wclass = GDK_INPUT_OUTPUT;
279 attributes.visual = gtk_widget_get_visual (widget);
280 attributes.colormap = gtk_widget_get_colormap (widget);
281 attributes.event_mask = gtk_widget_get_events (widget);
282 attributes.event_mask |= (GDK_EXPOSURE_MASK |
283 GDK_BUTTON_PRESS_MASK |
284 GDK_BUTTON_RELEASE_MASK |
285 GDK_ENTER_NOTIFY_MASK |
286 GDK_LEAVE_NOTIFY_MASK);
288 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
289 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
290 gdk_window_set_user_data (widget->window, widget);
292 widget->style = gtk_style_attach (widget->style, widget->window);
293 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
297 gtk_menu_shell_button_press (GtkWidget *widget,
298 GdkEventButton *event)
300 GtkMenuShell *menu_shell;
301 GtkWidget *menu_item;
303 g_return_val_if_fail (widget != NULL, FALSE);
304 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
305 g_return_val_if_fail (event != NULL, FALSE);
307 if (event->type != GDK_BUTTON_PRESS)
310 menu_shell = GTK_MENU_SHELL (widget);
312 if (menu_shell->parent_menu_shell)
314 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
316 else if (!menu_shell->active || !menu_shell->button)
318 if (!menu_shell->active)
320 gtk_grab_add (GTK_WIDGET (widget));
321 menu_shell->have_grab = TRUE;
322 menu_shell->active = TRUE;
324 menu_shell->button = event->button;
326 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
329 GTK_WIDGET_IS_SENSITIVE (menu_item))
331 if ((menu_item->parent == widget) &&
332 (menu_item != menu_shell->active_menu_item))
334 if (menu_shell->active_menu_item)
335 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
337 menu_shell->active_menu_item = menu_item;
338 gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
339 MENU_SHELL_CLASS (menu_shell)->submenu_placement);
340 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
346 widget = gtk_get_event_widget ((GdkEvent*) event);
347 if (widget == GTK_WIDGET (menu_shell))
349 gtk_menu_shell_deactivate (menu_shell);
350 gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
358 gtk_menu_shell_button_release (GtkWidget *widget,
359 GdkEventButton *event)
361 GtkMenuShell *menu_shell;
362 GtkWidget *menu_item;
365 g_return_val_if_fail (widget != NULL, FALSE);
366 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
367 g_return_val_if_fail (event != NULL, FALSE);
369 menu_shell = GTK_MENU_SHELL (widget);
370 if (menu_shell->active)
372 if (menu_shell->button && (event->button != menu_shell->button))
374 menu_shell->button = 0;
375 if (menu_shell->parent_menu_shell)
376 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
380 menu_shell->button = 0;
381 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
385 if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
387 if (menu_item && (menu_shell->active_menu_item == menu_item))
389 if (GTK_MENU_ITEM (menu_item)->submenu == NULL)
391 gtk_menu_shell_deactivate (menu_shell);
393 /* flush the x-queue, so any grabs are removed and
394 * the menu is actually taken down
397 gtk_widget_activate (menu_item);
399 gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
404 else if (menu_shell->parent_menu_shell)
406 menu_shell->active = TRUE;
407 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
414 /* If the button click was very fast, or we ended up on a submenu,
418 (menu_item && (menu_shell->active_menu_item == menu_item)))
421 menu_shell->ignore_leave = TRUE;
428 gtk_menu_shell_deactivate (menu_shell);
429 gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
437 gtk_menu_shell_enter_notify (GtkWidget *widget,
438 GdkEventCrossing *event)
440 GtkMenuShell *menu_shell;
441 GtkWidget *menu_item;
443 g_return_val_if_fail (widget != NULL, FALSE);
444 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
445 g_return_val_if_fail (event != NULL, FALSE);
447 menu_shell = GTK_MENU_SHELL (widget);
448 if (menu_shell->active)
450 menu_item = gtk_get_event_widget ((GdkEvent*) event);
452 if (!menu_item || !GTK_WIDGET_IS_SENSITIVE (menu_item))
455 if ((menu_item->parent == widget) &&
456 (menu_shell->active_menu_item != menu_item) &&
457 GTK_IS_MENU_ITEM (menu_item))
459 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
460 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT))
462 if (menu_shell->active_menu_item)
463 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
465 menu_shell->active_menu_item = menu_item;
466 gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
467 MENU_SHELL_CLASS (menu_shell)->submenu_placement);
468 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
469 if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
470 gtk_widget_activate (menu_shell->active_menu_item);
473 else if (menu_shell->parent_menu_shell)
475 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
483 gtk_menu_shell_leave_notify (GtkWidget *widget,
484 GdkEventCrossing *event)
486 GtkMenuShell *menu_shell;
487 GtkMenuItem *menu_item;
488 GtkWidget *event_widget;
490 g_return_val_if_fail (widget != NULL, FALSE);
491 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
492 g_return_val_if_fail (event != NULL, FALSE);
494 if (GTK_WIDGET_VISIBLE (widget))
496 menu_shell = GTK_MENU_SHELL (widget);
497 event_widget = gtk_get_event_widget ((GdkEvent*) event);
499 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
502 menu_item = GTK_MENU_ITEM (event_widget);
504 if (menu_shell->ignore_leave)
506 menu_shell->ignore_leave = FALSE;
510 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
513 if ((menu_shell->active_menu_item == event_widget) &&
514 (menu_item->submenu == NULL))
516 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
517 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_NORMAL))
519 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
520 menu_shell->active_menu_item = NULL;
523 else if (menu_shell->parent_menu_shell)
525 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
533 gtk_menu_shell_add (GtkContainer *container,
536 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
540 gtk_menu_shell_remove (GtkContainer *container,
543 GtkMenuShell *menu_shell;
546 g_return_if_fail (container != NULL);
547 g_return_if_fail (GTK_IS_MENU_SHELL (container));
548 g_return_if_fail (widget != NULL);
549 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
551 was_visible = GTK_WIDGET_VISIBLE (widget);
552 menu_shell = GTK_MENU_SHELL (container);
553 menu_shell->children = g_list_remove (menu_shell->children, widget);
555 gtk_widget_unparent (widget);
557 /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
558 * since that's what is needed by toplevels.
561 gtk_widget_queue_resize (GTK_WIDGET (container));
565 gtk_menu_shell_foreach (GtkContainer *container,
566 GtkCallback callback,
567 gpointer callback_data)
569 GtkMenuShell *menu_shell;
573 g_return_if_fail (container != NULL);
574 g_return_if_fail (GTK_IS_MENU_SHELL (container));
575 g_return_if_fail (callback != NULL);
577 menu_shell = GTK_MENU_SHELL (container);
579 children = menu_shell->children;
582 child = children->data;
583 children = children->next;
585 (* callback) (child, callback_data);
591 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
593 g_return_if_fail (menu_shell != NULL);
594 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
596 if (menu_shell->active)
598 menu_shell->button = 0;
599 menu_shell->active = FALSE;
601 if (menu_shell->active_menu_item)
603 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
604 menu_shell->active_menu_item = NULL;
607 if (menu_shell->have_grab)
609 menu_shell->have_grab = FALSE;
610 gtk_grab_remove (GTK_WIDGET (menu_shell));
612 if (menu_shell->have_xgrab)
614 menu_shell->have_xgrab = FALSE;
615 gdk_pointer_ungrab (GDK_CURRENT_TIME);
621 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
626 g_return_val_if_fail (menu_shell != NULL, FALSE);
627 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
628 g_return_val_if_fail (child != NULL, FALSE);
630 parent = child->parent;
631 while (parent && GTK_IS_MENU_SHELL (parent))
633 if (parent == (GtkWidget*) menu_shell)
635 parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
642 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
645 GtkWidget *menu_item;
647 menu_item = gtk_get_event_widget ((GdkEvent*) event);
649 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
650 menu_item = menu_item->parent;
652 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))