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 "gtkaccellabel.h"
22 #include "gtkprivate.h"
24 #include "gtkmenubar.h"
25 #include "gtkmenuitem.h"
26 #include "gtksignal.h"
29 #define BORDER_SPACING 3
30 #define SELECT_TIMEOUT 75
32 #define MENU_ITEM_CLASS(w) GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
42 static void gtk_menu_item_class_init (GtkMenuItemClass *klass);
43 static void gtk_menu_item_init (GtkMenuItem *menu_item);
44 static void gtk_menu_item_destroy (GtkObject *object);
45 static void gtk_menu_item_size_request (GtkWidget *widget,
46 GtkRequisition *requisition);
47 static void gtk_menu_item_size_allocate (GtkWidget *widget,
48 GtkAllocation *allocation);
49 static void gtk_menu_item_paint (GtkWidget *widget,
51 static void gtk_menu_item_draw (GtkWidget *widget,
53 static gint gtk_menu_item_expose (GtkWidget *widget,
54 GdkEventExpose *event);
55 static void gtk_real_menu_item_select (GtkItem *item);
56 static void gtk_real_menu_item_deselect (GtkItem *item);
57 static void gtk_real_menu_item_activate_item (GtkMenuItem *item);
58 static gint gtk_menu_item_select_timeout (gpointer data);
59 static void gtk_menu_item_position_menu (GtkMenu *menu,
63 static void gtk_menu_item_show_all (GtkWidget *widget);
64 static void gtk_menu_item_hide_all (GtkWidget *widget);
65 static void gtk_menu_item_forall (GtkContainer *container,
66 gboolean include_internals,
68 gpointer callback_data);
70 static GtkItemClass *parent_class;
71 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
72 static guint32 last_submenu_deselect_time = 0;
77 gtk_menu_item_get_type (void)
79 static GtkType menu_item_type = 0;
83 static const GtkTypeInfo menu_item_info =
87 sizeof (GtkMenuItemClass),
88 (GtkClassInitFunc) gtk_menu_item_class_init,
89 (GtkObjectInitFunc) gtk_menu_item_init,
90 /* reserved_1 */ NULL,
91 /* reserved_2 */ NULL,
92 (GtkClassInitFunc) NULL,
95 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
96 gtk_type_set_chunk_alloc (menu_item_type, 16);
99 return menu_item_type;
103 gtk_menu_item_class_init (GtkMenuItemClass *klass)
105 GtkObjectClass *object_class;
106 GtkWidgetClass *widget_class;
107 GtkContainerClass *container_class;
108 GtkItemClass *item_class;
110 object_class = (GtkObjectClass*) klass;
111 widget_class = (GtkWidgetClass*) klass;
112 container_class = (GtkContainerClass*) klass;
113 item_class = (GtkItemClass*) klass;
115 parent_class = gtk_type_class (gtk_item_get_type ());
117 menu_item_signals[ACTIVATE] =
118 gtk_signal_new ("activate",
119 GTK_RUN_FIRST | GTK_RUN_ACTION,
121 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
122 gtk_marshal_NONE__NONE,
125 menu_item_signals[ACTIVATE_ITEM] =
126 gtk_signal_new ("activate_item",
129 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate_item),
130 gtk_signal_default_marshaller,
133 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
135 object_class->destroy = gtk_menu_item_destroy;
137 widget_class->activate_signal = menu_item_signals[ACTIVATE];
138 widget_class->size_request = gtk_menu_item_size_request;
139 widget_class->size_allocate = gtk_menu_item_size_allocate;
140 widget_class->draw = gtk_menu_item_draw;
141 widget_class->expose_event = gtk_menu_item_expose;
142 widget_class->show_all = gtk_menu_item_show_all;
143 widget_class->hide_all = gtk_menu_item_hide_all;
145 container_class->forall = gtk_menu_item_forall;
147 item_class->select = gtk_real_menu_item_select;
148 item_class->deselect = gtk_real_menu_item_deselect;
150 klass->activate = NULL;
151 klass->activate_item = gtk_real_menu_item_activate_item;
153 klass->toggle_size = 0;
154 klass->hide_on_activate = TRUE;
158 gtk_menu_item_init (GtkMenuItem *menu_item)
160 menu_item->submenu = NULL;
161 menu_item->accelerator_signal = menu_item_signals[ACTIVATE];
162 menu_item->toggle_size = 0;
163 menu_item->accelerator_width = 0;
164 menu_item->show_toggle_indicator = FALSE;
165 menu_item->show_submenu_indicator = FALSE;
166 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
167 menu_item->submenu_placement = GTK_TOP_BOTTOM;
168 menu_item->right_justify = FALSE;
170 menu_item->timer = 0;
174 gtk_menu_item_new (void)
176 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
180 gtk_menu_item_new_with_label (const gchar *label)
182 GtkWidget *menu_item;
183 GtkWidget *accel_label;
185 menu_item = gtk_menu_item_new ();
186 accel_label = gtk_accel_label_new (label);
187 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
189 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
190 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
191 gtk_widget_show (accel_label);
197 gtk_menu_item_destroy (GtkObject *object)
199 GtkMenuItem *menu_item;
201 g_return_if_fail (object != NULL);
202 g_return_if_fail (GTK_IS_MENU_ITEM (object));
204 menu_item = GTK_MENU_ITEM (object);
206 if (menu_item->submenu)
207 gtk_widget_destroy (menu_item->submenu);
209 if (GTK_OBJECT_CLASS (parent_class)->destroy)
210 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
214 gtk_menu_item_detacher (GtkWidget *widget,
217 GtkMenuItem *menu_item;
219 g_return_if_fail (widget != NULL);
220 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
222 menu_item = GTK_MENU_ITEM (widget);
223 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
225 menu_item->submenu = NULL;
229 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
232 g_return_if_fail (menu_item != NULL);
233 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
235 if (menu_item->submenu != submenu)
237 gtk_menu_item_remove_submenu (menu_item);
239 menu_item->submenu = submenu;
240 gtk_menu_attach_to_widget (GTK_MENU (submenu),
241 GTK_WIDGET (menu_item),
242 gtk_menu_item_detacher);
244 if (GTK_WIDGET (menu_item)->parent)
245 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
250 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
252 g_return_if_fail (menu_item != NULL);
253 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
255 if (menu_item->submenu)
256 gtk_menu_detach (GTK_MENU (menu_item->submenu));
260 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
261 GtkSubmenuPlacement placement)
263 g_return_if_fail (menu_item != NULL);
264 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
266 menu_item->submenu_placement = placement;
270 gtk_menu_item_configure (GtkMenuItem *menu_item,
271 gint show_toggle_indicator,
272 gint show_submenu_indicator)
274 g_return_if_fail (menu_item != NULL);
275 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
277 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
278 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
282 gtk_menu_item_select (GtkMenuItem *menu_item)
284 g_return_if_fail (menu_item != NULL);
285 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
287 gtk_item_select (GTK_ITEM (menu_item));
291 gtk_menu_item_deselect (GtkMenuItem *menu_item)
293 g_return_if_fail (menu_item != NULL);
294 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
296 gtk_item_deselect (GTK_ITEM (menu_item));
300 gtk_menu_item_activate (GtkMenuItem *menu_item)
302 g_return_if_fail (menu_item != NULL);
303 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
305 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
309 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
314 if (GTK_IS_ACCEL_LABEL (widget))
318 w = gtk_accel_label_get_accel_width (GTK_ACCEL_LABEL (widget));
319 *width = MAX (*width, w);
321 else if (GTK_IS_CONTAINER (widget))
322 gtk_container_foreach (GTK_CONTAINER (widget),
323 gtk_menu_item_accel_width_foreach,
328 gtk_menu_item_size_request (GtkWidget *widget,
329 GtkRequisition *requisition)
331 GtkMenuItem *menu_item;
335 g_return_if_fail (widget != NULL);
336 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
337 g_return_if_fail (requisition != NULL);
339 bin = GTK_BIN (widget);
340 menu_item = GTK_MENU_ITEM (widget);
342 requisition->width = (GTK_CONTAINER (widget)->border_width +
343 widget->style->klass->xthickness +
345 requisition->height = (GTK_CONTAINER (widget)->border_width +
346 widget->style->klass->ythickness) * 2;
348 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
350 gtk_widget_size_request (bin->child, &bin->child->requisition);
352 requisition->width += bin->child->requisition.width;
353 requisition->height += bin->child->requisition.height;
356 if (menu_item->submenu && menu_item->show_submenu_indicator)
357 requisition->width += 21;
360 gtk_container_foreach (GTK_CONTAINER (menu_item),
361 gtk_menu_item_accel_width_foreach,
363 menu_item->accelerator_width = accel_width;
367 gtk_menu_item_size_allocate (GtkWidget *widget,
368 GtkAllocation *allocation)
370 GtkMenuItem *menu_item;
372 GtkAllocation child_allocation;
374 g_return_if_fail (widget != NULL);
375 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
376 g_return_if_fail (allocation != NULL);
378 menu_item = GTK_MENU_ITEM (widget);
379 bin = GTK_BIN (widget);
381 widget->allocation = *allocation;
385 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
386 widget->style->klass->xthickness +
388 child_allocation.y = (GTK_CONTAINER (widget)->border_width +
389 widget->style->klass->ythickness);
390 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2);
391 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2);
392 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
393 child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
394 if (menu_item->submenu && menu_item->show_submenu_indicator)
395 child_allocation.width -= 21;
397 gtk_widget_size_allocate (bin->child, &child_allocation);
400 if (GTK_WIDGET_REALIZED (widget))
401 gdk_window_move_resize (widget->window,
402 allocation->x, allocation->y,
403 allocation->width, allocation->height);
405 if (menu_item->submenu)
406 gtk_menu_reposition (GTK_MENU (menu_item->submenu));
410 gtk_menu_item_paint (GtkWidget *widget,
413 GtkMenuItem *menu_item;
414 GtkStateType state_type;
415 GtkShadowType shadow_type;
419 g_return_if_fail (widget != NULL);
420 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
422 if (GTK_WIDGET_DRAWABLE (widget))
424 menu_item = GTK_MENU_ITEM (widget);
426 state_type = widget->state;
427 if (!GTK_WIDGET_IS_SENSITIVE (widget))
428 state_type = GTK_STATE_INSENSITIVE;
430 x = GTK_CONTAINER (menu_item)->border_width;
431 y = GTK_CONTAINER (menu_item)->border_width;
432 width = widget->allocation.width - x * 2;
433 height = widget->allocation.height - y * 2;
435 if ((state_type == GTK_STATE_PRELIGHT) &&
436 (GTK_BIN (menu_item)->child))
437 gtk_paint_box (widget->style,
441 area, widget, "menuitem",
442 x, y, width, height);
445 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
446 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
449 if (menu_item->submenu && menu_item->show_submenu_indicator)
451 shadow_type = GTK_SHADOW_OUT;
452 if (state_type == GTK_STATE_PRELIGHT)
453 shadow_type = GTK_SHADOW_IN;
455 gtk_paint_arrow (widget->style, widget->window,
456 state_type, shadow_type,
457 area, widget, "menuitem",
458 GTK_ARROW_RIGHT, TRUE,
459 x + width - 15, y + height / 2 - 5, 10, 10);
461 else if (!GTK_BIN (menu_item)->child)
463 gtk_paint_hline (widget->style, widget->window, GTK_STATE_NORMAL,
464 area, widget, "menuitem",
465 0, widget->allocation.width, 0);
471 gtk_menu_item_draw (GtkWidget *widget,
475 GdkRectangle child_area;
477 g_return_if_fail (widget != NULL);
478 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
479 g_return_if_fail (area != NULL);
481 if (GTK_WIDGET_DRAWABLE (widget))
483 gtk_menu_item_paint (widget, area);
485 bin = GTK_BIN (widget);
489 if (gtk_widget_intersect (bin->child, area, &child_area))
490 gtk_widget_draw (bin->child, &child_area);
496 gtk_menu_item_expose (GtkWidget *widget,
497 GdkEventExpose *event)
500 GdkEventExpose child_event;
502 g_return_val_if_fail (widget != NULL, FALSE);
503 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
504 g_return_val_if_fail (event != NULL, FALSE);
506 if (GTK_WIDGET_DRAWABLE (widget))
508 gtk_menu_item_paint (widget, &event->area);
510 bin = GTK_BIN (widget);
514 child_event = *event;
516 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
517 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
518 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
526 gtk_real_menu_item_select (GtkItem *item)
528 GtkMenuItem *menu_item;
530 g_return_if_fail (item != NULL);
531 g_return_if_fail (GTK_IS_MENU_ITEM (item));
533 menu_item = GTK_MENU_ITEM (item);
535 /* if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))*/
536 if (menu_item->submenu)
539 GdkEvent *event = gtk_get_current_event ();
541 etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
542 if (etime >= last_submenu_deselect_time &&
543 last_submenu_deselect_time + SELECT_TIMEOUT > etime)
544 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT - (etime - last_submenu_deselect_time),
545 gtk_menu_item_select_timeout,
548 gtk_menu_item_select_timeout (menu_item);
551 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
552 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
556 gtk_real_menu_item_deselect (GtkItem *item)
558 GtkMenuItem *menu_item;
560 g_return_if_fail (item != NULL);
561 g_return_if_fail (GTK_IS_MENU_ITEM (item));
563 menu_item = GTK_MENU_ITEM (item);
565 if (menu_item->submenu)
568 GdkEvent *event = gtk_get_current_event ();
570 if (menu_item->timer)
572 gtk_timeout_remove (menu_item->timer);
573 menu_item->timer = 0;
576 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
578 etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
579 if (etime > last_submenu_deselect_time)
580 last_submenu_deselect_time = etime;
583 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
584 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
588 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
592 g_return_if_fail (menu_item != NULL);
593 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
595 widget = GTK_WIDGET (menu_item);
597 if (widget->parent &&
598 GTK_IS_MENU_SHELL (widget->parent))
600 if (menu_item->submenu == NULL)
601 gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
605 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);
607 if (!menu_shell->active)
609 gtk_grab_add (GTK_WIDGET (menu_shell));
610 menu_shell->have_grab = TRUE;
611 menu_shell->active = TRUE;
614 gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget);
620 gtk_menu_item_select_timeout (gpointer data)
622 GtkMenuItem *menu_item;
624 GTK_THREADS_ENTER ();
626 menu_item = GTK_MENU_ITEM (data);
627 menu_item->timer = 0;
629 gtk_menu_popup (GTK_MENU (menu_item->submenu),
630 GTK_WIDGET (menu_item)->parent,
631 GTK_WIDGET (menu_item),
632 gtk_menu_item_position_menu,
634 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
637 /* This is a bit of a hack - we want to select the first item
638 * of menus hanging of a menu bar, but not for cascading submenus
640 if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
642 GtkMenuShell *submenu = GTK_MENU_SHELL (menu_item->submenu);
643 if (submenu->children)
644 gtk_menu_shell_select_item (submenu, submenu->children->data);
647 GTK_THREADS_LEAVE ();
653 gtk_menu_item_position_menu (GtkMenu *menu,
658 GtkMenuItem *menu_item;
659 GtkWidget *parent_menu_item;
662 gint twidth, theight;
665 g_return_if_fail (menu != NULL);
666 g_return_if_fail (x != NULL);
667 g_return_if_fail (y != NULL);
669 menu_item = GTK_MENU_ITEM (user_data);
671 twidth = GTK_WIDGET (menu)->requisition.width;
672 theight = GTK_WIDGET (menu)->requisition.height;
674 screen_width = gdk_screen_width ();
675 screen_height = gdk_screen_height ();
677 if (!gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty))
679 g_warning ("Menu not on screen");
683 switch (menu_item->submenu_placement)
686 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
687 ty += GTK_WIDGET (menu_item)->allocation.height;
688 else if ((ty - theight) >= 0)
691 ty += GTK_WIDGET (menu_item)->allocation.height;
693 if ((tx + twidth) > screen_width)
695 tx -= ((tx + twidth) - screen_width);
702 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
703 parent_menu_item = GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item;
704 if (parent_menu_item)
705 menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
707 switch (menu_item->submenu_direction)
709 case GTK_DIRECTION_LEFT:
710 if ((tx - twidth) >= 0)
714 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
715 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
719 case GTK_DIRECTION_RIGHT:
720 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
721 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
724 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
730 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
731 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
734 ty -= ((ty + theight) - screen_height);
746 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
748 g_return_if_fail (menuitem != NULL);
749 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
751 menuitem->right_justify = 1;
756 gtk_menu_item_show_all (GtkWidget *widget)
758 GtkMenuItem *menu_item;
760 g_return_if_fail (widget != NULL);
761 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
763 menu_item = GTK_MENU_ITEM (widget);
765 /* show children including submenu */
766 if (menu_item->submenu)
767 gtk_widget_show_all (menu_item->submenu);
768 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
770 gtk_widget_show (widget);
774 gtk_menu_item_hide_all (GtkWidget *widget)
776 GtkMenuItem *menu_item;
778 g_return_if_fail (widget != NULL);
779 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
781 gtk_widget_hide (widget);
783 menu_item = GTK_MENU_ITEM (widget);
785 /* hide children including submenu */
786 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
787 if (menu_item->submenu)
788 gtk_widget_hide_all (menu_item->submenu);
792 gtk_menu_item_forall (GtkContainer *container,
793 gboolean include_internals,
794 GtkCallback callback,
795 gpointer callback_data)
798 GtkMenuItem *menu_item;
800 g_return_if_fail (container != NULL);
801 g_return_if_fail (GTK_IS_MENU_ITEM (container));
802 g_return_if_fail (callback != NULL);
804 bin = GTK_BIN (container);
805 menu_item = GTK_MENU_ITEM (container);
808 (* callback) (bin->child, callback_data);
809 if (include_internals && menu_item->submenu)
810 (* callback) (menu_item->submenu, callback_data);