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"
23 #include "gtkmenubar.h"
24 #include "gtkmenuitem.h"
25 #include "gtksignal.h"
28 #define BORDER_SPACING 3
29 #define SELECT_TIMEOUT 20
31 #define MENU_ITEM_CLASS(w) GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
41 static void gtk_menu_item_class_init (GtkMenuItemClass *klass);
42 static void gtk_menu_item_init (GtkMenuItem *menu_item);
43 static void gtk_menu_item_destroy (GtkObject *object);
44 static void gtk_menu_item_size_request (GtkWidget *widget,
45 GtkRequisition *requisition);
46 static void gtk_menu_item_size_allocate (GtkWidget *widget,
47 GtkAllocation *allocation);
48 static void gtk_menu_item_paint (GtkWidget *widget,
50 static void gtk_menu_item_draw (GtkWidget *widget,
52 static gint gtk_menu_item_expose (GtkWidget *widget,
53 GdkEventExpose *event);
54 static void gtk_real_menu_item_select (GtkItem *item);
55 static void gtk_real_menu_item_deselect (GtkItem *item);
56 static void gtk_real_menu_item_activate_item (GtkMenuItem *item);
57 static gint gtk_menu_item_select_timeout (gpointer data);
58 static void gtk_menu_item_position_menu (GtkMenu *menu,
62 static void gtk_menu_item_show_all (GtkWidget *widget);
63 static void gtk_menu_item_hide_all (GtkWidget *widget);
64 static void gtk_menu_item_forall (GtkContainer *container,
65 gboolean include_internals,
67 gpointer callback_data);
69 static GtkItemClass *parent_class;
70 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
74 gtk_menu_item_get_type (void)
76 static GtkType menu_item_type = 0;
80 GtkTypeInfo menu_item_info =
84 sizeof (GtkMenuItemClass),
85 (GtkClassInitFunc) gtk_menu_item_class_init,
86 (GtkObjectInitFunc) gtk_menu_item_init,
87 /* reserved_1 */ NULL,
88 /* reserved_2 */ NULL,
89 (GtkClassInitFunc) NULL,
92 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
93 gtk_type_set_chunk_alloc (menu_item_type, 16);
96 return menu_item_type;
100 gtk_menu_item_class_init (GtkMenuItemClass *klass)
102 GtkObjectClass *object_class;
103 GtkWidgetClass *widget_class;
104 GtkContainerClass *container_class;
105 GtkItemClass *item_class;
107 object_class = (GtkObjectClass*) klass;
108 widget_class = (GtkWidgetClass*) klass;
109 container_class = (GtkContainerClass*) klass;
110 item_class = (GtkItemClass*) klass;
112 parent_class = gtk_type_class (gtk_item_get_type ());
114 menu_item_signals[ACTIVATE] =
115 gtk_signal_new ("activate",
118 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
119 gtk_marshal_NONE__NONE,
122 menu_item_signals[ACTIVATE_ITEM] =
123 gtk_signal_new ("activate_item",
126 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate_item),
127 gtk_signal_default_marshaller,
130 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
132 object_class->destroy = gtk_menu_item_destroy;
134 widget_class->activate_signal = menu_item_signals[ACTIVATE];
135 widget_class->size_request = gtk_menu_item_size_request;
136 widget_class->size_allocate = gtk_menu_item_size_allocate;
137 widget_class->draw = gtk_menu_item_draw;
138 widget_class->expose_event = gtk_menu_item_expose;
139 widget_class->show_all = gtk_menu_item_show_all;
140 widget_class->hide_all = gtk_menu_item_hide_all;
142 container_class->forall = gtk_menu_item_forall;
144 item_class->select = gtk_real_menu_item_select;
145 item_class->deselect = gtk_real_menu_item_deselect;
147 klass->activate = NULL;
148 klass->activate_item = gtk_real_menu_item_activate_item;
150 klass->toggle_size = 0;
151 klass->hide_on_activate = TRUE;
155 gtk_menu_item_init (GtkMenuItem *menu_item)
157 menu_item->submenu = NULL;
158 menu_item->accelerator_signal = menu_item_signals[ACTIVATE];
159 menu_item->toggle_size = 0;
160 menu_item->accelerator_width = 0;
161 menu_item->show_toggle_indicator = FALSE;
162 menu_item->show_submenu_indicator = FALSE;
163 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
164 menu_item->submenu_placement = GTK_TOP_BOTTOM;
165 menu_item->right_justify = FALSE;
167 menu_item->timer = 0;
171 gtk_menu_item_new (void)
173 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
177 gtk_menu_item_new_with_label (const gchar *label)
179 GtkWidget *menu_item;
180 GtkWidget *accel_label;
182 menu_item = gtk_menu_item_new ();
183 accel_label = gtk_accel_label_new (label);
184 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
186 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
187 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
188 gtk_widget_show (accel_label);
194 gtk_menu_item_destroy (GtkObject *object)
196 GtkMenuItem *menu_item;
198 g_return_if_fail (object != NULL);
199 g_return_if_fail (GTK_IS_MENU_ITEM (object));
201 menu_item = GTK_MENU_ITEM (object);
203 if (menu_item->submenu)
204 gtk_widget_destroy (menu_item->submenu);
206 if (GTK_OBJECT_CLASS (parent_class)->destroy)
207 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
211 gtk_menu_item_detacher (GtkWidget *widget,
214 GtkMenuItem *menu_item;
216 g_return_if_fail (widget != NULL);
217 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
219 menu_item = GTK_MENU_ITEM (widget);
220 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
222 menu_item->submenu = NULL;
226 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
229 g_return_if_fail (menu_item != NULL);
230 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
232 if (menu_item->submenu != submenu)
234 gtk_menu_item_remove_submenu (menu_item);
236 menu_item->submenu = submenu;
237 gtk_menu_attach_to_widget (GTK_MENU (submenu),
238 GTK_WIDGET (menu_item),
239 gtk_menu_item_detacher);
241 if (GTK_WIDGET (menu_item)->parent)
242 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
247 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
249 g_return_if_fail (menu_item != NULL);
250 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
252 if (menu_item->submenu)
253 gtk_menu_detach (GTK_MENU (menu_item->submenu));
257 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
258 GtkSubmenuPlacement placement)
260 g_return_if_fail (menu_item != NULL);
261 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
263 menu_item->submenu_placement = placement;
267 gtk_menu_item_configure (GtkMenuItem *menu_item,
268 gint show_toggle_indicator,
269 gint show_submenu_indicator)
271 g_return_if_fail (menu_item != NULL);
272 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
274 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
275 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
279 gtk_menu_item_select (GtkMenuItem *menu_item)
281 gtk_item_select (GTK_ITEM (menu_item));
285 gtk_menu_item_deselect (GtkMenuItem *menu_item)
287 gtk_item_deselect (GTK_ITEM (menu_item));
291 gtk_menu_item_activate (GtkMenuItem *menu_item)
293 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
297 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
302 if (GTK_IS_ACCEL_LABEL (widget))
306 w = gtk_accel_label_accelerator_width (GTK_ACCEL_LABEL (widget));
307 *width = MAX (*width, w);
309 else if (GTK_IS_CONTAINER (widget))
310 gtk_container_foreach (GTK_CONTAINER (widget),
311 gtk_menu_item_accel_width_foreach,
316 gtk_menu_item_size_request (GtkWidget *widget,
317 GtkRequisition *requisition)
319 GtkMenuItem *menu_item;
323 g_return_if_fail (widget != NULL);
324 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
325 g_return_if_fail (requisition != NULL);
327 bin = GTK_BIN (widget);
328 menu_item = GTK_MENU_ITEM (widget);
330 requisition->width = (GTK_CONTAINER (widget)->border_width +
331 widget->style->klass->xthickness +
333 requisition->height = (GTK_CONTAINER (widget)->border_width +
334 widget->style->klass->ythickness) * 2;
336 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
338 gtk_widget_size_request (bin->child, &bin->child->requisition);
340 requisition->width += bin->child->requisition.width;
341 requisition->height += bin->child->requisition.height;
344 if (menu_item->submenu && menu_item->show_submenu_indicator)
345 requisition->width += 21;
348 gtk_container_foreach (GTK_CONTAINER (menu_item),
349 gtk_menu_item_accel_width_foreach,
351 menu_item->accelerator_width = accel_width;
355 gtk_menu_item_size_allocate (GtkWidget *widget,
356 GtkAllocation *allocation)
358 GtkMenuItem *menu_item;
360 GtkAllocation child_allocation;
362 g_return_if_fail (widget != NULL);
363 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
364 g_return_if_fail (allocation != NULL);
366 menu_item = GTK_MENU_ITEM (widget);
367 bin = GTK_BIN (widget);
369 widget->allocation = *allocation;
373 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
374 widget->style->klass->xthickness +
376 child_allocation.y = (GTK_CONTAINER (widget)->border_width +
377 widget->style->klass->ythickness);
378 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2);
379 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2);
380 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
381 child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
382 if (menu_item->submenu && menu_item->show_submenu_indicator)
383 child_allocation.width -= 21;
385 gtk_widget_size_allocate (bin->child, &child_allocation);
388 if (GTK_WIDGET_REALIZED (widget))
389 gdk_window_move_resize (widget->window,
390 allocation->x, allocation->y,
391 allocation->width, allocation->height);
393 if (menu_item->submenu)
394 gtk_menu_reposition (GTK_MENU (menu_item->submenu));
398 gtk_menu_item_paint (GtkWidget *widget,
401 GtkMenuItem *menu_item;
402 GtkStateType state_type;
403 GtkShadowType shadow_type;
407 g_return_if_fail (widget != NULL);
408 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
410 if (GTK_WIDGET_DRAWABLE (widget))
412 menu_item = GTK_MENU_ITEM (widget);
414 state_type = widget->state;
415 if (!GTK_WIDGET_IS_SENSITIVE (widget))
416 state_type = GTK_STATE_INSENSITIVE;
418 x = GTK_CONTAINER (menu_item)->border_width;
419 y = GTK_CONTAINER (menu_item)->border_width;
420 width = widget->allocation.width - x * 2;
421 height = widget->allocation.height - y * 2;
423 if ((state_type == GTK_STATE_PRELIGHT) &&
424 (GTK_BIN (menu_item)->child))
425 gtk_paint_box (widget->style,
429 area, widget, "menuitem",
430 x, y, width, height);
433 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
434 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
437 if (menu_item->submenu && menu_item->show_submenu_indicator)
439 shadow_type = GTK_SHADOW_OUT;
440 if (state_type == GTK_STATE_PRELIGHT)
441 shadow_type = GTK_SHADOW_IN;
443 gtk_paint_arrow (widget->style, widget->window,
444 state_type, shadow_type,
445 area, widget, "menuitem",
446 GTK_ARROW_RIGHT, TRUE,
447 x + width - 15, y + height / 2 - 5, 10, 10);
449 else if (!GTK_BIN (menu_item)->child)
451 gtk_paint_hline (widget->style, widget->window, GTK_STATE_NORMAL,
452 area, widget, "menuitem",
453 0, widget->allocation.width, 0);
459 gtk_menu_item_draw (GtkWidget *widget,
463 GdkRectangle child_area;
465 g_return_if_fail (widget != NULL);
466 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
467 g_return_if_fail (area != NULL);
469 if (GTK_WIDGET_DRAWABLE (widget))
471 gtk_menu_item_paint (widget, area);
473 bin = GTK_BIN (widget);
477 if (gtk_widget_intersect (bin->child, area, &child_area))
478 gtk_widget_draw (bin->child, &child_area);
484 gtk_menu_item_expose (GtkWidget *widget,
485 GdkEventExpose *event)
488 GdkEventExpose child_event;
490 g_return_val_if_fail (widget != NULL, FALSE);
491 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
492 g_return_val_if_fail (event != NULL, FALSE);
494 if (GTK_WIDGET_DRAWABLE (widget))
496 gtk_menu_item_paint (widget, &event->area);
498 bin = GTK_BIN (widget);
502 child_event = *event;
504 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
505 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
506 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
514 gtk_real_menu_item_select (GtkItem *item)
516 GtkMenuItem *menu_item;
518 g_return_if_fail (item != NULL);
519 g_return_if_fail (GTK_IS_MENU_ITEM (item));
521 menu_item = GTK_MENU_ITEM (item);
523 /* if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))*/
524 if (menu_item->submenu)
526 /* Boy this is a hack! */
527 GdkEvent *current_event = gtk_get_current_event();
528 if (current_event && (current_event->type != GDK_ENTER_NOTIFY))
529 gtk_menu_item_select_timeout (menu_item);
531 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT, gtk_menu_item_select_timeout, menu_item);
534 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
535 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
539 gtk_real_menu_item_deselect (GtkItem *item)
541 GtkMenuItem *menu_item;
543 g_return_if_fail (item != NULL);
544 g_return_if_fail (GTK_IS_MENU_ITEM (item));
546 menu_item = GTK_MENU_ITEM (item);
548 if (menu_item->submenu)
550 if (menu_item->timer)
551 gtk_timeout_remove (menu_item->timer);
553 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
556 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
557 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
561 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
565 g_return_if_fail (menu_item != NULL);
566 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
568 widget = GTK_WIDGET (menu_item);
570 if (widget->parent &&
571 GTK_IS_MENU_SHELL (widget->parent))
573 if (menu_item->submenu == NULL)
574 gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
578 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);
580 if (!menu_shell->active)
582 gtk_grab_add (GTK_WIDGET (menu_shell));
583 menu_shell->have_grab = TRUE;
584 menu_shell->active = TRUE;
587 gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget);
593 gtk_menu_item_select_timeout (gpointer data)
595 GtkMenuItem *menu_item;
597 menu_item = GTK_MENU_ITEM (data);
598 menu_item->timer = 0;
600 gtk_menu_popup (GTK_MENU (menu_item->submenu),
601 GTK_WIDGET (menu_item)->parent,
602 GTK_WIDGET (menu_item),
603 gtk_menu_item_position_menu,
605 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
608 /* This is a bit of a hack - we want to select the first item
609 * of menus hanging of a menu bar, but not for cascading submenus
611 if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
613 GtkMenuShell *submenu = GTK_MENU_SHELL (menu_item->submenu);
614 if (submenu->children)
615 gtk_menu_shell_select_item (submenu, submenu->children->data);
622 gtk_menu_item_position_menu (GtkMenu *menu,
627 GtkMenuItem *menu_item;
628 GtkWidget *parent_menu_item;
631 gint twidth, theight;
634 g_return_if_fail (menu != NULL);
635 g_return_if_fail (x != NULL);
636 g_return_if_fail (y != NULL);
638 menu_item = GTK_MENU_ITEM (user_data);
640 twidth = GTK_WIDGET (menu)->requisition.width;
641 theight = GTK_WIDGET (menu)->requisition.height;
643 screen_width = gdk_screen_width ();
644 screen_height = gdk_screen_height ();
646 if (!gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty))
648 g_warning ("Menu not on screen");
652 switch (menu_item->submenu_placement)
655 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
656 ty += GTK_WIDGET (menu_item)->allocation.height;
657 else if ((ty - theight) >= 0)
660 ty += GTK_WIDGET (menu_item)->allocation.height;
662 if ((tx + twidth) > screen_width)
664 tx -= ((tx + twidth) - screen_width);
671 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
672 parent_menu_item = GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item;
673 if (parent_menu_item)
674 menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
676 switch (menu_item->submenu_direction)
678 case GTK_DIRECTION_LEFT:
679 if ((tx - twidth) >= 0)
683 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
684 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
688 case GTK_DIRECTION_RIGHT:
689 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
690 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
693 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
699 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
700 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
703 ty -= ((ty + theight) - screen_height);
715 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
717 g_return_if_fail (menuitem != NULL);
718 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
720 menuitem->right_justify = 1;
725 gtk_menu_item_show_all (GtkWidget *widget)
727 GtkMenuItem *menu_item;
729 g_return_if_fail (widget != NULL);
730 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
732 menu_item = GTK_MENU_ITEM (widget);
734 /* show children including submenu */
735 if (menu_item->submenu)
736 gtk_widget_show_all (menu_item->submenu);
737 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
739 gtk_widget_show (widget);
743 gtk_menu_item_hide_all (GtkWidget *widget)
745 GtkMenuItem *menu_item;
747 g_return_if_fail (widget != NULL);
748 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
750 gtk_widget_hide (widget);
752 menu_item = GTK_MENU_ITEM (widget);
754 /* hide children including submenu */
755 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
756 if (menu_item->submenu)
757 gtk_widget_hide_all (menu_item->submenu);
761 gtk_menu_item_forall (GtkContainer *container,
762 gboolean include_internals,
763 GtkCallback callback,
764 gpointer callback_data)
767 GtkMenuItem *menu_item;
769 g_return_if_fail (container != NULL);
770 g_return_if_fail (GTK_IS_MENU_ITEM (container));
771 g_return_if_fail (callback != NULL);
773 bin = GTK_BIN (container);
774 menu_item = GTK_MENU_ITEM (container);
777 (* callback) (bin->child, callback_data);
778 if (include_internals && menu_item->submenu)
779 (* callback) (menu_item->submenu, callback_data);