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 Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #include "gtkmenuitem.h"
20 #include "gtkmenushell.h"
21 #include "gtksignal.h"
24 #define MENU_SHELL_TIMEOUT 500
25 #define MENU_SHELL_CLASS(w) GTK_MENU_SHELL_CLASS (GTK_OBJECT (w)->klass)
34 static void gtk_menu_shell_class_init (GtkMenuShellClass *klass);
35 static void gtk_menu_shell_init (GtkMenuShell *menu_shell);
36 static void gtk_menu_shell_destroy (GtkObject *object);
37 static void gtk_menu_shell_map (GtkWidget *widget);
38 static void gtk_menu_shell_realize (GtkWidget *widget);
39 static gint gtk_menu_shell_button_press (GtkWidget *widget,
40 GdkEventButton *event);
41 static gint gtk_menu_shell_button_release (GtkWidget *widget,
42 GdkEventButton *event);
43 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
44 GdkEventCrossing *event);
45 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
46 GdkEventCrossing *event);
47 static void gtk_menu_shell_add (GtkContainer *container,
49 static void gtk_menu_shell_remove (GtkContainer *container,
51 static void gtk_menu_shell_foreach (GtkContainer *container,
53 gpointer callback_data);
54 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
55 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
59 static GtkContainerClass *parent_class = NULL;
60 static gint menu_shell_signals[LAST_SIGNAL] = { 0 };
64 gtk_menu_shell_get_type ()
66 static guint menu_shell_type = 0;
70 GtkTypeInfo menu_shell_info =
73 sizeof (GtkMenuShell),
74 sizeof (GtkMenuShellClass),
75 (GtkClassInitFunc) gtk_menu_shell_class_init,
76 (GtkObjectInitFunc) gtk_menu_shell_init,
80 menu_shell_type = gtk_type_unique (gtk_container_get_type (), &menu_shell_info);
83 return menu_shell_type;
87 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
89 GtkObjectClass *object_class;
90 GtkWidgetClass *widget_class;
91 GtkContainerClass *container_class;
93 object_class = (GtkObjectClass*) klass;
94 widget_class = (GtkWidgetClass*) klass;
95 container_class = (GtkContainerClass*) klass;
97 parent_class = gtk_type_class (gtk_container_get_type ());
99 menu_shell_signals[DEACTIVATE] =
100 gtk_signal_new ("deactivate",
103 GTK_SIGNAL_OFFSET (GtkMenuShellClass, deactivate),
104 gtk_signal_default_marshaller,
107 gtk_object_class_add_signals (object_class, menu_shell_signals, LAST_SIGNAL);
109 object_class->destroy = gtk_menu_shell_destroy;
111 widget_class->map = gtk_menu_shell_map;
112 widget_class->realize = gtk_menu_shell_realize;
113 widget_class->button_press_event = gtk_menu_shell_button_press;
114 widget_class->button_release_event = gtk_menu_shell_button_release;
115 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
116 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
118 container_class->add = gtk_menu_shell_add;
119 container_class->remove = gtk_menu_shell_remove;
120 container_class->foreach = gtk_menu_shell_foreach;
122 klass->submenu_placement = GTK_TOP_BOTTOM;
123 klass->deactivate = gtk_real_menu_shell_deactivate;
127 gtk_menu_shell_init (GtkMenuShell *menu_shell)
129 menu_shell->children = NULL;
130 menu_shell->active_menu_item = NULL;
131 menu_shell->parent_menu_shell = NULL;
132 menu_shell->active = FALSE;
133 menu_shell->have_grab = FALSE;
134 menu_shell->have_xgrab = FALSE;
135 menu_shell->ignore_leave = FALSE;
136 menu_shell->button = 0;
137 menu_shell->menu_flag = 0;
138 menu_shell->activate_time = 0;
142 gtk_menu_shell_append (GtkMenuShell *menu_shell,
145 gtk_menu_shell_insert (menu_shell, child, -1);
149 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
152 gtk_menu_shell_insert (menu_shell, child, 0);
156 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
164 g_return_if_fail (menu_shell != NULL);
165 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
166 g_return_if_fail (child != NULL);
167 g_return_if_fail (GTK_IS_MENU_ITEM (child));
169 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
171 if (GTK_WIDGET_VISIBLE (child->parent))
173 if (GTK_WIDGET_REALIZED (child->parent) &&
174 !GTK_WIDGET_REALIZED (child))
175 gtk_widget_realize (child);
177 if (GTK_WIDGET_MAPPED (child->parent) &&
178 !GTK_WIDGET_MAPPED (child))
179 gtk_widget_map (child);
182 nchildren = g_list_length (menu_shell->children);
183 if ((position < 0) || (position > nchildren))
184 position = nchildren;
186 if (position == nchildren)
188 menu_shell->children = g_list_append (menu_shell->children, child);
192 tmp_list = g_list_nth (menu_shell->children, position);
193 new_list = g_list_alloc ();
194 new_list->data = child;
197 tmp_list->prev->next = new_list;
198 new_list->next = tmp_list;
199 new_list->prev = tmp_list->prev;
200 tmp_list->prev = new_list;
202 if (tmp_list == menu_shell->children)
203 menu_shell->children = new_list;
206 if (GTK_WIDGET_VISIBLE (menu_shell))
207 gtk_widget_queue_resize (GTK_WIDGET (menu_shell));
211 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
213 g_return_if_fail (menu_shell != NULL);
214 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
216 gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[DEACTIVATE]);
220 gtk_menu_shell_destroy (GtkObject *object)
222 GtkMenuShell *menu_shell;
226 g_return_if_fail (object != NULL);
227 g_return_if_fail (GTK_IS_MENU_SHELL (object));
229 menu_shell = GTK_MENU_SHELL (object);
231 children = menu_shell->children;
234 child = children->data;
235 children = children->next;
237 child->parent = NULL;
238 gtk_object_unref (GTK_OBJECT (child));
239 gtk_widget_destroy (child);
242 g_list_free (menu_shell->children);
244 if (GTK_OBJECT_CLASS (parent_class)->destroy)
245 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
249 gtk_menu_shell_map (GtkWidget *widget)
251 GtkMenuShell *menu_shell;
255 g_return_if_fail (widget != NULL);
256 g_return_if_fail (GTK_IS_MENU_SHELL (widget));
258 menu_shell = GTK_MENU_SHELL (widget);
259 GTK_WIDGET_SET_FLAGS (menu_shell, GTK_MAPPED);
260 gdk_window_show (widget->window);
262 children = menu_shell->children;
265 child = children->data;
266 children = children->next;
268 if (GTK_WIDGET_VISIBLE (child) && !GTK_WIDGET_MAPPED (child))
269 gtk_widget_map (child);
274 gtk_menu_shell_realize (GtkWidget *widget)
276 GdkWindowAttr attributes;
277 gint attributes_mask;
279 g_return_if_fail (widget != NULL);
280 g_return_if_fail (GTK_IS_MENU_SHELL (widget));
282 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
284 attributes.x = widget->allocation.x;
285 attributes.y = widget->allocation.y;
286 attributes.width = widget->allocation.width;
287 attributes.height = widget->allocation.height;
288 attributes.window_type = GDK_WINDOW_CHILD;
289 attributes.wclass = GDK_INPUT_OUTPUT;
290 attributes.visual = gtk_widget_get_visual (widget);
291 attributes.colormap = gtk_widget_get_colormap (widget);
292 attributes.event_mask = gtk_widget_get_events (widget);
293 attributes.event_mask |= (GDK_EXPOSURE_MASK |
294 GDK_BUTTON_PRESS_MASK |
295 GDK_BUTTON_RELEASE_MASK |
296 GDK_ENTER_NOTIFY_MASK |
297 GDK_LEAVE_NOTIFY_MASK);
299 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
300 widget->window = gdk_window_new (widget->parent->window, &attributes, attributes_mask);
301 gdk_window_set_user_data (widget->window, widget);
303 widget->style = gtk_style_attach (widget->style, widget->window);
304 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
308 gtk_menu_shell_button_press (GtkWidget *widget,
309 GdkEventButton *event)
311 GtkMenuShell *menu_shell;
312 GtkWidget *menu_item;
314 g_return_val_if_fail (widget != NULL, FALSE);
315 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
316 g_return_val_if_fail (event != NULL, FALSE);
318 if (event->type != GDK_BUTTON_PRESS)
321 menu_shell = GTK_MENU_SHELL (widget);
323 if (menu_shell->parent_menu_shell)
325 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
327 else if (!menu_shell->active || !menu_shell->button)
329 if (!menu_shell->active)
331 gtk_grab_add (GTK_WIDGET (widget));
332 menu_shell->have_grab = TRUE;
334 menu_shell->active = TRUE;
336 menu_item = gtk_get_event_widget ((GdkEvent*) event);
337 if (GTK_IS_MENU_ITEM (menu_item) && gtk_menu_shell_is_item (menu_shell, menu_item))
339 if ((menu_item->parent == widget) &&
340 (menu_item != menu_shell->active_menu_item))
342 if (menu_shell->active_menu_item)
343 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
345 menu_shell->active_menu_item = menu_item;
346 gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
347 MENU_SHELL_CLASS (menu_shell)->submenu_placement);
348 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
351 else if (!menu_shell->button)
353 gtk_menu_shell_deactivate (menu_shell);
356 if (menu_shell->active)
357 menu_shell->button = event->button;
361 widget = gtk_get_event_widget ((GdkEvent*) event);
362 if (widget == GTK_WIDGET (menu_shell))
363 gtk_menu_shell_deactivate (menu_shell);
370 gtk_menu_shell_button_release (GtkWidget *widget,
371 GdkEventButton *event)
373 GtkMenuShell *menu_shell;
374 GtkWidget *menu_item;
377 g_return_val_if_fail (widget != NULL, FALSE);
378 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
379 g_return_val_if_fail (event != NULL, FALSE);
381 menu_shell = GTK_MENU_SHELL (widget);
382 if (menu_shell->active)
384 if (menu_shell->button && (event->button != menu_shell->button))
386 menu_shell->button = 0;
387 if (menu_shell->parent_menu_shell)
388 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
392 menu_shell->button = 0;
393 menu_item = gtk_get_event_widget ((GdkEvent*) event);
396 if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
398 if (menu_shell->active_menu_item == menu_item)
400 if (GTK_MENU_ITEM (menu_item)->submenu == NULL)
402 gtk_menu_shell_deactivate (menu_shell);
403 gtk_widget_activate (menu_item);
407 else if (menu_shell->parent_menu_shell)
409 menu_shell->active = TRUE;
410 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
417 if ((!deactivate || (menu_shell->active_menu_item == menu_item)) &&
418 (gdk_pointer_grab (widget->window, TRUE,
419 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
420 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK,
421 NULL, NULL, event->time) == 0))
424 menu_shell->have_xgrab = TRUE;
425 menu_shell->ignore_leave = TRUE;
431 gtk_menu_shell_deactivate (menu_shell);
438 gtk_menu_shell_enter_notify (GtkWidget *widget,
439 GdkEventCrossing *event)
441 GtkMenuShell *menu_shell;
442 GtkWidget *menu_item;
444 g_return_val_if_fail (widget != NULL, FALSE);
445 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
446 g_return_val_if_fail (event != NULL, FALSE);
448 menu_shell = GTK_MENU_SHELL (widget);
449 if (menu_shell->active)
451 menu_item = gtk_get_event_widget ((GdkEvent*) event);
453 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
456 if ((menu_item->parent == widget) &&
457 (menu_shell->active_menu_item != menu_item) &&
458 GTK_IS_MENU_ITEM (menu_item))
460 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
461 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT))
463 if (menu_shell->active_menu_item)
464 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
466 menu_shell->active_menu_item = menu_item;
467 gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
468 MENU_SHELL_CLASS (menu_shell)->submenu_placement);
469 gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));
472 else if (menu_shell->parent_menu_shell)
474 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
482 gtk_menu_shell_leave_notify (GtkWidget *widget,
483 GdkEventCrossing *event)
485 GtkMenuShell *menu_shell;
486 GtkMenuItem *menu_item;
487 GtkWidget *event_widget;
489 g_return_val_if_fail (widget != NULL, FALSE);
490 g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
491 g_return_val_if_fail (event != NULL, FALSE);
493 if (GTK_WIDGET_VISIBLE (widget))
495 menu_shell = GTK_MENU_SHELL (widget);
496 event_widget = gtk_get_event_widget ((GdkEvent*) event);
498 if (!GTK_IS_MENU_ITEM (event_widget))
501 menu_item = GTK_MENU_ITEM (event_widget);
503 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
506 if (menu_shell->ignore_leave)
508 menu_shell->ignore_leave = FALSE;
512 if ((menu_shell->active_menu_item == event_widget) &&
513 (menu_item->submenu == NULL))
515 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
516 (GTK_WIDGET_STATE (menu_item) != GTK_STATE_NORMAL))
518 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
519 menu_shell->active_menu_item = NULL;
522 else if (menu_shell->parent_menu_shell)
524 gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
532 gtk_menu_shell_add (GtkContainer *container,
535 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
539 gtk_menu_shell_remove (GtkContainer *container,
542 GtkMenuShell *menu_shell;
544 g_return_if_fail (container != NULL);
545 g_return_if_fail (GTK_IS_MENU_SHELL (container));
546 g_return_if_fail (widget != NULL);
547 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
549 gtk_widget_unparent (widget);
551 menu_shell = GTK_MENU_SHELL (container);
552 menu_shell->children = g_list_remove (menu_shell->children, widget);
554 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_VISIBLE (container))
555 gtk_widget_queue_resize (GTK_WIDGET (container));
559 gtk_menu_shell_foreach (GtkContainer *container,
560 GtkCallback callback,
561 gpointer callback_data)
563 GtkMenuShell *menu_shell;
567 g_return_if_fail (container != NULL);
568 g_return_if_fail (GTK_IS_MENU_SHELL (container));
569 g_return_if_fail (callback != NULL);
571 menu_shell = GTK_MENU_SHELL (container);
573 children = menu_shell->children;
576 child = children->data;
577 children = children->next;
579 (* callback) (child, callback_data);
585 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
587 g_return_if_fail (menu_shell != NULL);
588 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
590 if (menu_shell->active)
592 menu_shell->button = 0;
593 menu_shell->active = FALSE;
595 if (menu_shell->active_menu_item)
597 gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
598 menu_shell->active_menu_item = NULL;
601 if (menu_shell->have_grab)
603 menu_shell->have_grab = FALSE;
604 gtk_grab_remove (GTK_WIDGET (menu_shell));
606 if (menu_shell->have_xgrab)
608 menu_shell->have_xgrab = FALSE;
609 gdk_pointer_ungrab (GDK_CURRENT_TIME);
615 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
618 GtkMenuShell *parent;
620 g_return_val_if_fail (menu_shell != NULL, FALSE);
621 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
622 g_return_val_if_fail (child != NULL, FALSE);
624 parent = GTK_MENU_SHELL (child->parent);
625 while (parent && GTK_IS_MENU_SHELL (parent))
627 if (parent == menu_shell)
629 parent = GTK_MENU_SHELL (parent->parent_menu_shell);