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 75
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 };
71 static guint32 last_submenu_deselect_time = 0;
76 gtk_menu_item_get_type (void)
78 static GtkType menu_item_type = 0;
82 static const GtkTypeInfo menu_item_info =
86 sizeof (GtkMenuItemClass),
87 (GtkClassInitFunc) gtk_menu_item_class_init,
88 (GtkObjectInitFunc) gtk_menu_item_init,
89 /* reserved_1 */ NULL,
90 /* reserved_2 */ NULL,
91 (GtkClassInitFunc) NULL,
94 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
95 gtk_type_set_chunk_alloc (menu_item_type, 16);
98 return menu_item_type;
102 gtk_menu_item_class_init (GtkMenuItemClass *klass)
104 GtkObjectClass *object_class;
105 GtkWidgetClass *widget_class;
106 GtkContainerClass *container_class;
107 GtkItemClass *item_class;
109 object_class = (GtkObjectClass*) klass;
110 widget_class = (GtkWidgetClass*) klass;
111 container_class = (GtkContainerClass*) klass;
112 item_class = (GtkItemClass*) klass;
114 parent_class = gtk_type_class (gtk_item_get_type ());
116 menu_item_signals[ACTIVATE] =
117 gtk_signal_new ("activate",
118 GTK_RUN_FIRST | GTK_RUN_ACTION,
120 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
121 gtk_marshal_NONE__NONE,
124 menu_item_signals[ACTIVATE_ITEM] =
125 gtk_signal_new ("activate_item",
128 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate_item),
129 gtk_signal_default_marshaller,
132 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
134 object_class->destroy = gtk_menu_item_destroy;
136 widget_class->activate_signal = menu_item_signals[ACTIVATE];
137 widget_class->size_request = gtk_menu_item_size_request;
138 widget_class->size_allocate = gtk_menu_item_size_allocate;
139 widget_class->draw = gtk_menu_item_draw;
140 widget_class->expose_event = gtk_menu_item_expose;
141 widget_class->show_all = gtk_menu_item_show_all;
142 widget_class->hide_all = gtk_menu_item_hide_all;
144 container_class->forall = gtk_menu_item_forall;
146 item_class->select = gtk_real_menu_item_select;
147 item_class->deselect = gtk_real_menu_item_deselect;
149 klass->activate = NULL;
150 klass->activate_item = gtk_real_menu_item_activate_item;
152 klass->toggle_size = 0;
153 klass->hide_on_activate = TRUE;
157 gtk_menu_item_init (GtkMenuItem *menu_item)
159 menu_item->submenu = NULL;
160 menu_item->accelerator_signal = menu_item_signals[ACTIVATE];
161 menu_item->toggle_size = 0;
162 menu_item->accelerator_width = 0;
163 menu_item->show_toggle_indicator = FALSE;
164 menu_item->show_submenu_indicator = FALSE;
165 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
166 menu_item->submenu_placement = GTK_TOP_BOTTOM;
167 menu_item->right_justify = FALSE;
169 menu_item->timer = 0;
173 gtk_menu_item_new (void)
175 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
179 gtk_menu_item_new_with_label (const gchar *label)
181 GtkWidget *menu_item;
182 GtkWidget *accel_label;
184 menu_item = gtk_menu_item_new ();
185 accel_label = gtk_accel_label_new (label);
186 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
188 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
189 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
190 gtk_widget_show (accel_label);
196 gtk_menu_item_destroy (GtkObject *object)
198 GtkMenuItem *menu_item;
200 g_return_if_fail (object != NULL);
201 g_return_if_fail (GTK_IS_MENU_ITEM (object));
203 menu_item = GTK_MENU_ITEM (object);
205 if (menu_item->submenu)
206 gtk_widget_destroy (menu_item->submenu);
208 if (GTK_OBJECT_CLASS (parent_class)->destroy)
209 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
213 gtk_menu_item_detacher (GtkWidget *widget,
216 GtkMenuItem *menu_item;
218 g_return_if_fail (widget != NULL);
219 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
221 menu_item = GTK_MENU_ITEM (widget);
222 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
224 menu_item->submenu = NULL;
228 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
231 g_return_if_fail (menu_item != NULL);
232 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
234 if (menu_item->submenu != submenu)
236 gtk_menu_item_remove_submenu (menu_item);
238 menu_item->submenu = submenu;
239 gtk_menu_attach_to_widget (GTK_MENU (submenu),
240 GTK_WIDGET (menu_item),
241 gtk_menu_item_detacher);
243 if (GTK_WIDGET (menu_item)->parent)
244 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
249 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
251 g_return_if_fail (menu_item != NULL);
252 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
254 if (menu_item->submenu)
255 gtk_menu_detach (GTK_MENU (menu_item->submenu));
259 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
260 GtkSubmenuPlacement placement)
262 g_return_if_fail (menu_item != NULL);
263 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
265 menu_item->submenu_placement = placement;
269 gtk_menu_item_configure (GtkMenuItem *menu_item,
270 gint show_toggle_indicator,
271 gint show_submenu_indicator)
273 g_return_if_fail (menu_item != NULL);
274 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
276 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
277 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
281 gtk_menu_item_select (GtkMenuItem *menu_item)
283 g_return_if_fail (menu_item != NULL);
284 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
286 gtk_item_select (GTK_ITEM (menu_item));
290 gtk_menu_item_deselect (GtkMenuItem *menu_item)
292 g_return_if_fail (menu_item != NULL);
293 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
295 gtk_item_deselect (GTK_ITEM (menu_item));
299 gtk_menu_item_activate (GtkMenuItem *menu_item)
301 g_return_if_fail (menu_item != NULL);
302 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
304 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
308 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
313 if (GTK_IS_ACCEL_LABEL (widget))
317 w = gtk_accel_label_get_accel_width (GTK_ACCEL_LABEL (widget));
318 *width = MAX (*width, w);
320 else if (GTK_IS_CONTAINER (widget))
321 gtk_container_foreach (GTK_CONTAINER (widget),
322 gtk_menu_item_accel_width_foreach,
327 gtk_menu_item_size_request (GtkWidget *widget,
328 GtkRequisition *requisition)
330 GtkMenuItem *menu_item;
334 g_return_if_fail (widget != NULL);
335 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
336 g_return_if_fail (requisition != NULL);
338 bin = GTK_BIN (widget);
339 menu_item = GTK_MENU_ITEM (widget);
341 requisition->width = (GTK_CONTAINER (widget)->border_width +
342 widget->style->klass->xthickness +
344 requisition->height = (GTK_CONTAINER (widget)->border_width +
345 widget->style->klass->ythickness) * 2;
347 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
349 gtk_widget_size_request (bin->child, &bin->child->requisition);
351 requisition->width += bin->child->requisition.width;
352 requisition->height += bin->child->requisition.height;
355 if (menu_item->submenu && menu_item->show_submenu_indicator)
356 requisition->width += 21;
359 gtk_container_foreach (GTK_CONTAINER (menu_item),
360 gtk_menu_item_accel_width_foreach,
362 menu_item->accelerator_width = accel_width;
366 gtk_menu_item_size_allocate (GtkWidget *widget,
367 GtkAllocation *allocation)
369 GtkMenuItem *menu_item;
371 GtkAllocation child_allocation;
373 g_return_if_fail (widget != NULL);
374 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
375 g_return_if_fail (allocation != NULL);
377 menu_item = GTK_MENU_ITEM (widget);
378 bin = GTK_BIN (widget);
380 widget->allocation = *allocation;
384 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
385 widget->style->klass->xthickness +
387 child_allocation.y = (GTK_CONTAINER (widget)->border_width +
388 widget->style->klass->ythickness);
389 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2);
390 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2);
391 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
392 child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
393 if (menu_item->submenu && menu_item->show_submenu_indicator)
394 child_allocation.width -= 21;
396 gtk_widget_size_allocate (bin->child, &child_allocation);
399 if (GTK_WIDGET_REALIZED (widget))
400 gdk_window_move_resize (widget->window,
401 allocation->x, allocation->y,
402 allocation->width, allocation->height);
404 if (menu_item->submenu)
405 gtk_menu_reposition (GTK_MENU (menu_item->submenu));
409 gtk_menu_item_paint (GtkWidget *widget,
412 GtkMenuItem *menu_item;
413 GtkStateType state_type;
414 GtkShadowType shadow_type;
418 g_return_if_fail (widget != NULL);
419 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
421 if (GTK_WIDGET_DRAWABLE (widget))
423 menu_item = GTK_MENU_ITEM (widget);
425 state_type = widget->state;
426 if (!GTK_WIDGET_IS_SENSITIVE (widget))
427 state_type = GTK_STATE_INSENSITIVE;
429 x = GTK_CONTAINER (menu_item)->border_width;
430 y = GTK_CONTAINER (menu_item)->border_width;
431 width = widget->allocation.width - x * 2;
432 height = widget->allocation.height - y * 2;
434 if ((state_type == GTK_STATE_PRELIGHT) &&
435 (GTK_BIN (menu_item)->child))
436 gtk_paint_box (widget->style,
440 area, widget, "menuitem",
441 x, y, width, height);
444 gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
445 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
448 if (menu_item->submenu && menu_item->show_submenu_indicator)
450 shadow_type = GTK_SHADOW_OUT;
451 if (state_type == GTK_STATE_PRELIGHT)
452 shadow_type = GTK_SHADOW_IN;
454 gtk_paint_arrow (widget->style, widget->window,
455 state_type, shadow_type,
456 area, widget, "menuitem",
457 GTK_ARROW_RIGHT, TRUE,
458 x + width - 15, y + height / 2 - 5, 10, 10);
460 else if (!GTK_BIN (menu_item)->child)
462 gtk_paint_hline (widget->style, widget->window, GTK_STATE_NORMAL,
463 area, widget, "menuitem",
464 0, widget->allocation.width, 0);
470 gtk_menu_item_draw (GtkWidget *widget,
474 GdkRectangle child_area;
476 g_return_if_fail (widget != NULL);
477 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
478 g_return_if_fail (area != NULL);
480 if (GTK_WIDGET_DRAWABLE (widget))
482 gtk_menu_item_paint (widget, area);
484 bin = GTK_BIN (widget);
488 if (gtk_widget_intersect (bin->child, area, &child_area))
489 gtk_widget_draw (bin->child, &child_area);
495 gtk_menu_item_expose (GtkWidget *widget,
496 GdkEventExpose *event)
499 GdkEventExpose child_event;
501 g_return_val_if_fail (widget != NULL, FALSE);
502 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
503 g_return_val_if_fail (event != NULL, FALSE);
505 if (GTK_WIDGET_DRAWABLE (widget))
507 gtk_menu_item_paint (widget, &event->area);
509 bin = GTK_BIN (widget);
513 child_event = *event;
515 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
516 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
517 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
525 gtk_real_menu_item_select (GtkItem *item)
527 GtkMenuItem *menu_item;
529 g_return_if_fail (item != NULL);
530 g_return_if_fail (GTK_IS_MENU_ITEM (item));
532 menu_item = GTK_MENU_ITEM (item);
534 /* if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))*/
535 if (menu_item->submenu)
538 GdkEvent *event = gtk_get_current_event ();
540 etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
541 if (etime >= last_submenu_deselect_time &&
542 last_submenu_deselect_time + SELECT_TIMEOUT > etime)
543 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT - (etime - last_submenu_deselect_time),
544 gtk_menu_item_select_timeout,
547 gtk_menu_item_select_timeout (menu_item);
548 if(event) gdk_event_free(event);
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;
581 if(event) gdk_event_free(event);
584 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
585 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
589 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
593 g_return_if_fail (menu_item != NULL);
594 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
596 widget = GTK_WIDGET (menu_item);
598 if (widget->parent &&
599 GTK_IS_MENU_SHELL (widget->parent))
601 if (menu_item->submenu == NULL)
602 gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
606 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);
608 if (!menu_shell->active)
610 gtk_grab_add (GTK_WIDGET (menu_shell));
611 menu_shell->have_grab = TRUE;
612 menu_shell->active = TRUE;
615 gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget);
621 gtk_menu_item_select_timeout (gpointer data)
623 GtkMenuItem *menu_item;
625 GDK_THREADS_ENTER ();
627 menu_item = GTK_MENU_ITEM (data);
628 menu_item->timer = 0;
630 gtk_menu_popup (GTK_MENU (menu_item->submenu),
631 GTK_WIDGET (menu_item)->parent,
632 GTK_WIDGET (menu_item),
633 gtk_menu_item_position_menu,
635 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
638 /* This is a bit of a hack - we want to select the first item
639 * of menus hanging of a menu bar, but not for cascading submenus
641 if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
643 GtkMenuShell *submenu = GTK_MENU_SHELL (menu_item->submenu);
644 if (submenu->children)
645 gtk_menu_shell_select_item (submenu, submenu->children->data);
648 GDK_THREADS_LEAVE ();
654 gtk_menu_item_position_menu (GtkMenu *menu,
659 GtkMenuItem *menu_item;
660 GtkWidget *parent_menu_item;
663 gint twidth, theight;
666 g_return_if_fail (menu != NULL);
667 g_return_if_fail (x != NULL);
668 g_return_if_fail (y != NULL);
670 menu_item = GTK_MENU_ITEM (user_data);
672 twidth = GTK_WIDGET (menu)->requisition.width;
673 theight = GTK_WIDGET (menu)->requisition.height;
675 screen_width = gdk_screen_width ();
676 screen_height = gdk_screen_height ();
678 if (!gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty))
680 g_warning ("Menu not on screen");
684 switch (menu_item->submenu_placement)
687 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
688 ty += GTK_WIDGET (menu_item)->allocation.height;
689 else if ((ty - theight) >= 0)
692 ty += GTK_WIDGET (menu_item)->allocation.height;
694 if ((tx + twidth) > screen_width)
696 tx -= ((tx + twidth) - screen_width);
703 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
704 parent_menu_item = GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item;
705 if (parent_menu_item)
706 menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
708 switch (menu_item->submenu_direction)
710 case GTK_DIRECTION_LEFT:
711 if ((tx - twidth) >= 0)
715 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
716 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
720 case GTK_DIRECTION_RIGHT:
721 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
722 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
725 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
731 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
732 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
735 ty -= ((ty + theight) - screen_height);
747 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
749 g_return_if_fail (menuitem != NULL);
750 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
752 menuitem->right_justify = 1;
757 gtk_menu_item_show_all (GtkWidget *widget)
759 GtkMenuItem *menu_item;
761 g_return_if_fail (widget != NULL);
762 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
764 menu_item = GTK_MENU_ITEM (widget);
766 /* show children including submenu */
767 if (menu_item->submenu)
768 gtk_widget_show_all (menu_item->submenu);
769 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
771 gtk_widget_show (widget);
775 gtk_menu_item_hide_all (GtkWidget *widget)
777 GtkMenuItem *menu_item;
779 g_return_if_fail (widget != NULL);
780 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
782 gtk_widget_hide (widget);
784 menu_item = GTK_MENU_ITEM (widget);
786 /* hide children including submenu */
787 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
788 if (menu_item->submenu)
789 gtk_widget_hide_all (menu_item->submenu);
793 gtk_menu_item_forall (GtkContainer *container,
794 gboolean include_internals,
795 GtkCallback callback,
796 gpointer callback_data)
799 GtkMenuItem *menu_item;
801 g_return_if_fail (container != NULL);
802 g_return_if_fail (GTK_IS_MENU_ITEM (container));
803 g_return_if_fail (callback != NULL);
805 bin = GTK_BIN (container);
806 menu_item = GTK_MENU_ITEM (container);
809 (* callback) (bin->child, callback_data);
810 if (include_internals && menu_item->submenu)
811 (* callback) (menu_item->submenu, callback_data);