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.
22 #include "gtkmenuitem.h"
23 #include "gtksignal.h"
26 #define BORDER_SPACING 3
27 #define SELECT_TIMEOUT 20
29 #define MENU_ITEM_CLASS(w) GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
38 static void gtk_menu_item_class_init (GtkMenuItemClass *klass);
39 static void gtk_menu_item_init (GtkMenuItem *menu_item);
40 static void gtk_menu_item_destroy (GtkObject *object);
41 static void gtk_menu_item_size_request (GtkWidget *widget,
42 GtkRequisition *requisition);
43 static void gtk_menu_item_size_allocate (GtkWidget *widget,
44 GtkAllocation *allocation);
45 static gint gtk_menu_item_install_accel (GtkWidget *widget,
46 const gchar *signal_name,
49 static void gtk_menu_item_remove_accel (GtkWidget *widget,
50 const gchar *signal_name);
51 static void gtk_menu_item_paint (GtkWidget *widget,
53 static void gtk_menu_item_draw (GtkWidget *widget,
55 static gint gtk_menu_item_expose (GtkWidget *widget,
56 GdkEventExpose *event);
57 static gint gtk_menu_item_enter (GtkWidget *widget,
58 GdkEventCrossing *event);
59 static gint gtk_menu_item_leave (GtkWidget *widget,
60 GdkEventCrossing *event);
61 static void gtk_real_menu_item_select (GtkItem *item);
62 static void gtk_real_menu_item_deselect (GtkItem *item);
63 static gint gtk_menu_item_select_timeout (gpointer data);
64 static void gtk_menu_item_position_menu (GtkMenu *menu,
68 static void gtk_menu_item_show_all (GtkWidget *widget);
69 static void gtk_menu_item_hide_all (GtkWidget *widget);
71 static GtkItemClass *parent_class;
72 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
76 gtk_menu_item_get_type ()
78 static guint menu_item_type = 0;
82 GtkTypeInfo menu_item_info =
86 sizeof (GtkMenuItemClass),
87 (GtkClassInitFunc) gtk_menu_item_class_init,
88 (GtkObjectInitFunc) gtk_menu_item_init,
93 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
96 return menu_item_type;
100 gtk_menu_item_class_init (GtkMenuItemClass *klass)
102 GtkObjectClass *object_class;
103 GtkWidgetClass *widget_class;
104 GtkItemClass *item_class;
106 object_class = (GtkObjectClass*) klass;
107 widget_class = (GtkWidgetClass*) klass;
108 item_class = (GtkItemClass*) klass;
110 parent_class = gtk_type_class (gtk_item_get_type ());
112 menu_item_signals[ACTIVATE] =
113 gtk_signal_new ("activate",
116 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
117 gtk_signal_default_marshaller,
120 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
122 object_class->destroy = gtk_menu_item_destroy;
124 widget_class->activate_signal = menu_item_signals[ACTIVATE];
125 widget_class->size_request = gtk_menu_item_size_request;
126 widget_class->size_allocate = gtk_menu_item_size_allocate;
127 widget_class->install_accelerator = gtk_menu_item_install_accel;
128 widget_class->remove_accelerator = gtk_menu_item_remove_accel;
129 widget_class->draw = gtk_menu_item_draw;
130 widget_class->expose_event = gtk_menu_item_expose;
131 widget_class->enter_notify_event = gtk_menu_item_enter;
132 widget_class->leave_notify_event = gtk_menu_item_leave;
133 widget_class->show_all = gtk_menu_item_show_all;
134 widget_class->hide_all = gtk_menu_item_hide_all;
136 item_class->select = gtk_real_menu_item_select;
137 item_class->deselect = gtk_real_menu_item_deselect;
139 klass->activate = NULL;
141 klass->toggle_size = 0;
142 klass->shift_text = "Shft";
143 klass->control_text = "Ctl";
144 klass->alt_text = "Alt";
145 klass->separator_text = "+";
149 gtk_menu_item_init (GtkMenuItem *menu_item)
151 menu_item->submenu = NULL;
152 menu_item->accelerator_key = 0;
153 menu_item->accelerator_mods = 0;
154 menu_item->accelerator_size = 0;
155 menu_item->accelerator_signal = 0;
156 menu_item->toggle_size = 0;
157 menu_item->show_toggle_indicator = FALSE;
158 menu_item->show_submenu_indicator = FALSE;
159 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
160 menu_item->submenu_placement = GTK_TOP_BOTTOM;
161 menu_item->right_justify = FALSE;
163 menu_item->timer = 0;
169 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
173 gtk_menu_item_new_with_label (const gchar *label)
175 GtkWidget *menu_item;
176 GtkWidget *label_widget;
178 menu_item = gtk_menu_item_new ();
179 label_widget = gtk_label_new (label);
180 gtk_misc_set_alignment (GTK_MISC (label_widget), 0.0, 0.5);
182 gtk_container_add (GTK_CONTAINER (menu_item), label_widget);
183 gtk_widget_show (label_widget);
189 gtk_menu_item_destroy (GtkObject *object)
191 GtkMenuItem *menu_item;
193 g_return_if_fail (object != NULL);
194 g_return_if_fail (GTK_IS_MENU_ITEM (object));
196 menu_item = GTK_MENU_ITEM (object);
198 if (menu_item->submenu)
199 gtk_widget_destroy (menu_item->submenu);
201 if (GTK_OBJECT_CLASS (parent_class)->destroy)
202 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
206 gtk_menu_item_detacher (GtkWidget *widget,
209 GtkMenuItem *menu_item;
211 g_return_if_fail (widget != NULL);
212 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
214 menu_item = GTK_MENU_ITEM (widget);
215 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
217 menu_item->submenu = NULL;
221 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
224 g_return_if_fail (menu_item != NULL);
225 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
227 if (menu_item->submenu != submenu)
229 gtk_menu_item_remove_submenu (menu_item);
231 menu_item->submenu = submenu;
232 gtk_menu_attach_to_widget (GTK_MENU (submenu),
233 GTK_WIDGET (menu_item),
234 gtk_menu_item_detacher);
236 if (GTK_WIDGET (menu_item)->parent)
237 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
242 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
244 g_return_if_fail (menu_item != NULL);
245 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
247 if (menu_item->submenu)
248 gtk_menu_detach (GTK_MENU (menu_item->submenu));
252 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
253 GtkSubmenuPlacement placement)
255 g_return_if_fail (menu_item != NULL);
256 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
258 menu_item->submenu_placement = placement;
262 gtk_menu_item_accelerator_size (GtkMenuItem *menu_item)
266 g_return_if_fail (menu_item != NULL);
267 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
269 if (menu_item->accelerator_key)
271 gtk_menu_item_accelerator_text (menu_item, buf);
272 menu_item->accelerator_size = gdk_string_width (GTK_WIDGET (menu_item)->style->font, buf) + 13;
274 else if (menu_item->submenu && menu_item->show_submenu_indicator)
276 menu_item->accelerator_size = 21;
280 menu_item->accelerator_size = 0;
285 gtk_menu_item_accelerator_text (GtkMenuItem *menu_item,
288 g_return_if_fail (menu_item != NULL);
289 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
291 if (menu_item->accelerator_key)
294 if (menu_item->accelerator_mods & GDK_SHIFT_MASK)
296 strcat (buffer, MENU_ITEM_CLASS (menu_item)->shift_text);
297 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
299 if (menu_item->accelerator_mods & GDK_CONTROL_MASK)
301 strcat (buffer, MENU_ITEM_CLASS (menu_item)->control_text);
302 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
304 if (menu_item->accelerator_mods & GDK_MOD1_MASK)
306 strcat (buffer, MENU_ITEM_CLASS (menu_item)->alt_text);
307 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
309 strncat (buffer, &menu_item->accelerator_key, 1);
314 gtk_menu_item_configure (GtkMenuItem *menu_item,
315 gint show_toggle_indicator,
316 gint show_submenu_indicator)
318 g_return_if_fail (menu_item != NULL);
319 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
321 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
322 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
326 gtk_menu_item_select (GtkMenuItem *menu_item)
328 gtk_item_select (GTK_ITEM (menu_item));
332 gtk_menu_item_deselect (GtkMenuItem *menu_item)
334 gtk_item_deselect (GTK_ITEM (menu_item));
338 gtk_menu_item_activate (GtkMenuItem *menu_item)
340 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
345 gtk_menu_item_size_request (GtkWidget *widget,
346 GtkRequisition *requisition)
350 g_return_if_fail (widget != NULL);
351 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
352 g_return_if_fail (requisition != NULL);
354 bin = GTK_BIN (widget);
356 gtk_menu_item_accelerator_size (GTK_MENU_ITEM (widget));
358 requisition->width = (GTK_CONTAINER (widget)->border_width +
359 widget->style->klass->xthickness +
361 requisition->height = (GTK_CONTAINER (widget)->border_width +
362 widget->style->klass->ythickness) * 2;
364 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
366 gtk_widget_size_request (bin->child, &bin->child->requisition);
368 requisition->width += bin->child->requisition.width;
369 requisition->height += bin->child->requisition.height;
374 gtk_menu_item_size_allocate (GtkWidget *widget,
375 GtkAllocation *allocation)
378 GtkAllocation child_allocation;
380 g_return_if_fail (widget != NULL);
381 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
382 g_return_if_fail (allocation != NULL);
384 widget->allocation = *allocation;
385 if (GTK_WIDGET_REALIZED (widget))
386 gdk_window_move_resize (widget->window,
387 allocation->x, allocation->y,
388 allocation->width, allocation->height);
390 bin = GTK_BIN (widget);
394 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
395 widget->style->klass->xthickness +
397 child_allocation.y = GTK_CONTAINER (widget)->border_width;
398 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2);
399 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2);
400 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
401 child_allocation.width -= (GTK_MENU_ITEM (widget)->toggle_size +
402 GTK_MENU_ITEM (widget)->accelerator_size);
404 gtk_widget_size_allocate (bin->child, &child_allocation);
409 gtk_menu_item_install_accel (GtkWidget *widget,
410 const gchar *signal_name,
414 GtkMenuItem *menu_item;
416 g_return_val_if_fail (widget != NULL, FALSE);
417 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
418 g_return_val_if_fail (signal_name != NULL, FALSE);
420 menu_item = GTK_MENU_ITEM (widget);
422 menu_item->accelerator_signal = gtk_signal_lookup (signal_name, GTK_OBJECT_TYPE (widget));
423 if (menu_item->accelerator_signal > 0)
425 menu_item->accelerator_key = key;
426 menu_item->accelerator_mods = modifiers;
429 gtk_widget_queue_resize (widget);
438 gtk_menu_item_remove_accel (GtkWidget *widget,
439 const gchar *signal_name)
441 GtkMenuItem *menu_item;
444 g_return_if_fail (widget != NULL);
445 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
446 g_return_if_fail (signal_name != NULL);
448 menu_item = GTK_MENU_ITEM (widget);
450 signal_num = gtk_signal_lookup (signal_name, GTK_OBJECT_TYPE (widget));
451 if (menu_item->accelerator_signal == signal_num)
453 menu_item->accelerator_key = 0;
454 menu_item->accelerator_mods = 0;
455 menu_item->accelerator_signal = 0;
457 if (GTK_WIDGET_VISIBLE (widget))
459 gtk_widget_queue_draw (widget);
460 GTK_MENU_SHELL (widget->parent)->menu_flag = TRUE;
463 gtk_container_need_resize (GTK_CONTAINER (widget->parent));
468 gtk_menu_item_paint (GtkWidget *widget,
471 GtkMenuItem *menu_item;
472 GtkStateType state_type;
473 GtkShadowType shadow_type;
479 g_return_if_fail (widget != NULL);
480 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
482 if (GTK_WIDGET_DRAWABLE (widget))
484 menu_item = GTK_MENU_ITEM (widget);
486 state_type = widget->state;
487 if (!GTK_WIDGET_IS_SENSITIVE (widget))
488 state_type = GTK_STATE_INSENSITIVE;
490 gtk_style_set_background (widget->style, widget->window, state_type);
491 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
493 x = GTK_CONTAINER (menu_item)->border_width;
494 y = GTK_CONTAINER (menu_item)->border_width;
495 width = widget->allocation.width - x * 2;
496 height = widget->allocation.height - y * 2;
498 if ((state_type == GTK_STATE_PRELIGHT) &&
499 (GTK_BIN (menu_item)->child))
500 gtk_draw_shadow (widget->style,
504 x, y, width, height);
506 if (menu_item->accelerator_key)
508 gtk_menu_item_accelerator_text (menu_item, buf);
510 font = widget->style->font;
511 x = x + width - menu_item->accelerator_size + 13 - 4;
512 y = y + ((height - (font->ascent + font->descent)) / 2) + font->ascent;
514 if (state_type == GTK_STATE_INSENSITIVE)
515 gdk_draw_string (widget->window, widget->style->font,
516 widget->style->white_gc,
519 gdk_draw_string (widget->window, widget->style->font,
520 widget->style->fg_gc[state_type],
523 else if (menu_item->submenu && menu_item->show_submenu_indicator)
525 shadow_type = GTK_SHADOW_OUT;
526 if (state_type == GTK_STATE_PRELIGHT)
527 shadow_type = GTK_SHADOW_IN;
529 gtk_draw_arrow (widget->style, widget->window,
530 state_type, shadow_type, GTK_ARROW_RIGHT, FALSE,
531 x + width - 15, y + height / 2 - 5, 10, 10);
533 else if (!GTK_BIN (menu_item)->child)
535 gtk_draw_hline (widget->style, widget->window, GTK_STATE_NORMAL,
536 0, widget->allocation.width, 0);
542 gtk_menu_item_draw (GtkWidget *widget,
546 GdkRectangle child_area;
548 g_return_if_fail (widget != NULL);
549 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
550 g_return_if_fail (area != NULL);
552 if (GTK_WIDGET_DRAWABLE (widget))
554 gtk_menu_item_paint (widget, area);
556 bin = GTK_BIN (widget);
560 if (gtk_widget_intersect (bin->child, area, &child_area))
561 gtk_widget_draw (bin->child, &child_area);
567 gtk_menu_item_expose (GtkWidget *widget,
568 GdkEventExpose *event)
571 GdkEventExpose child_event;
573 g_return_val_if_fail (widget != NULL, FALSE);
574 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
575 g_return_val_if_fail (event != NULL, FALSE);
577 if (GTK_WIDGET_DRAWABLE (widget))
579 gtk_menu_item_paint (widget, &event->area);
581 bin = GTK_BIN (widget);
585 child_event = *event;
587 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
588 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
589 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
597 gtk_menu_item_enter (GtkWidget *widget,
598 GdkEventCrossing *event)
600 g_return_val_if_fail (widget != NULL, FALSE);
601 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
602 g_return_val_if_fail (event != NULL, FALSE);
604 return gtk_widget_event (widget->parent, (GdkEvent*) event);
608 gtk_menu_item_leave (GtkWidget *widget,
609 GdkEventCrossing *event)
611 g_return_val_if_fail (widget != NULL, FALSE);
612 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
613 g_return_val_if_fail (event != NULL, FALSE);
615 return gtk_widget_event (widget->parent, (GdkEvent*) event);
619 gtk_real_menu_item_select (GtkItem *item)
621 GtkMenuItem *menu_item;
623 g_return_if_fail (item != NULL);
624 g_return_if_fail (GTK_IS_MENU_ITEM (item));
626 menu_item = GTK_MENU_ITEM (item);
628 if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))
629 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT, gtk_menu_item_select_timeout, menu_item);
631 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
632 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
636 gtk_real_menu_item_deselect (GtkItem *item)
638 GtkMenuItem *menu_item;
640 g_return_if_fail (item != NULL);
641 g_return_if_fail (GTK_IS_MENU_ITEM (item));
643 menu_item = GTK_MENU_ITEM (item);
645 if (menu_item->submenu)
647 if (menu_item->timer)
648 gtk_timeout_remove (menu_item->timer);
650 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
653 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
654 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
658 gtk_menu_item_select_timeout (gpointer data)
660 GtkMenuItem *menu_item;
662 menu_item = GTK_MENU_ITEM (data);
663 menu_item->timer = 0;
665 gtk_menu_popup (GTK_MENU (menu_item->submenu),
666 GTK_WIDGET (menu_item)->parent,
667 GTK_WIDGET (menu_item),
668 gtk_menu_item_position_menu,
670 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
677 gtk_menu_item_position_menu (GtkMenu *menu,
682 GtkMenuItem *menu_item;
683 GtkWidget *parent_menu_item;
686 gint twidth, theight;
689 g_return_if_fail (menu != NULL);
690 g_return_if_fail (x != NULL);
691 g_return_if_fail (y != NULL);
693 menu_item = GTK_MENU_ITEM (user_data);
695 twidth = GTK_WIDGET (menu)->requisition.width;
696 theight = GTK_WIDGET (menu)->requisition.height;
698 screen_width = gdk_screen_width ();
699 screen_height = gdk_screen_height ();
701 if (!gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty))
703 g_warning ("Menu not on screen");
707 switch (menu_item->submenu_placement)
710 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
711 ty += GTK_WIDGET (menu_item)->allocation.height;
712 else if ((ty - theight) >= 0)
715 ty += GTK_WIDGET (menu_item)->allocation.height;
717 if ((tx + twidth) > screen_width)
719 tx -= ((tx + twidth) - screen_width);
726 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
727 parent_menu_item = GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item;
728 if (parent_menu_item)
729 menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
731 switch (menu_item->submenu_direction)
733 case GTK_DIRECTION_LEFT:
734 if ((tx - twidth) >= 0)
738 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
739 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
743 case GTK_DIRECTION_RIGHT:
744 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
745 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
748 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
754 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
755 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
758 ty -= ((ty + theight) - screen_height);
770 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
772 g_return_if_fail (menuitem != NULL);
773 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
775 menuitem->right_justify = 1;
779 gtk_menu_item_show_all (GtkWidget *widget)
781 GtkContainer *container;
782 GtkMenuItem *menu_item;
784 g_return_if_fail (widget != NULL);
785 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
786 container = GTK_CONTAINER (widget);
787 menu_item = GTK_MENU_ITEM (widget);
789 /* Show children, traverse to submenu, show self. */
790 gtk_container_foreach (container, (GtkCallback) gtk_widget_show_all, NULL);
791 if (menu_item->submenu)
792 gtk_widget_show_all (menu_item->submenu);
793 gtk_widget_show (widget);
798 gtk_menu_item_hide_all (GtkWidget *widget)
800 GtkContainer *container;
801 GtkMenuItem *menu_item;
803 g_return_if_fail (widget != NULL);
804 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
805 container = GTK_CONTAINER (widget);
806 menu_item = GTK_MENU_ITEM (widget);
808 /* Reverse order of gtk_menu_item_show_all */
809 gtk_widget_hide (widget);
810 if (menu_item->submenu)
811 gtk_widget_hide_all (menu_item->submenu);
812 gtk_container_foreach (container, (GtkCallback) gtk_widget_hide_all, NULL);