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,
69 static GtkItemClass *parent_class;
70 static gint menu_item_signals[LAST_SIGNAL] = { 0 };
74 gtk_menu_item_get_type ()
76 static guint 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,
90 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
93 return menu_item_type;
97 gtk_menu_item_class_init (GtkMenuItemClass *klass)
99 GtkObjectClass *object_class;
100 GtkWidgetClass *widget_class;
101 GtkItemClass *item_class;
103 object_class = (GtkObjectClass*) klass;
104 widget_class = (GtkWidgetClass*) klass;
105 item_class = (GtkItemClass*) klass;
107 parent_class = gtk_type_class (gtk_item_get_type ());
109 menu_item_signals[ACTIVATE] =
110 gtk_signal_new ("activate",
113 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
114 gtk_signal_default_marshaller,
117 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
119 object_class->destroy = gtk_menu_item_destroy;
121 widget_class->activate_signal = menu_item_signals[ACTIVATE];
122 widget_class->size_request = gtk_menu_item_size_request;
123 widget_class->size_allocate = gtk_menu_item_size_allocate;
124 widget_class->install_accelerator = gtk_menu_item_install_accel;
125 widget_class->remove_accelerator = gtk_menu_item_remove_accel;
126 widget_class->draw = gtk_menu_item_draw;
127 widget_class->expose_event = gtk_menu_item_expose;
128 widget_class->enter_notify_event = gtk_menu_item_enter;
129 widget_class->leave_notify_event = gtk_menu_item_leave;
131 item_class->select = gtk_real_menu_item_select;
132 item_class->deselect = gtk_real_menu_item_deselect;
134 klass->activate = NULL;
136 klass->toggle_size = 0;
137 klass->shift_text = "Shft";
138 klass->control_text = "Ctl";
139 klass->alt_text = "Alt";
140 klass->separator_text = "+";
144 gtk_menu_item_init (GtkMenuItem *menu_item)
146 menu_item->submenu = NULL;
147 menu_item->accelerator_key = 0;
148 menu_item->accelerator_mods = 0;
149 menu_item->accelerator_size = 0;
150 menu_item->accelerator_signal = 0;
151 menu_item->toggle_size = 0;
152 menu_item->show_toggle_indicator = FALSE;
153 menu_item->show_submenu_indicator = FALSE;
154 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
155 menu_item->submenu_placement = GTK_TOP_BOTTOM;
156 menu_item->right_justify = FALSE;
158 menu_item->timer = 0;
164 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
168 gtk_menu_item_new_with_label (const gchar *label)
170 GtkWidget *menu_item;
171 GtkWidget *label_widget;
173 menu_item = gtk_menu_item_new ();
174 label_widget = gtk_label_new (label);
175 gtk_misc_set_alignment (GTK_MISC (label_widget), 0.0, 0.5);
177 gtk_container_add (GTK_CONTAINER (menu_item), label_widget);
178 gtk_widget_show (label_widget);
184 gtk_menu_item_destroy (GtkObject *object)
186 GtkMenuItem *menu_item;
188 g_return_if_fail (object != NULL);
189 g_return_if_fail (GTK_IS_MENU_ITEM (object));
191 menu_item = GTK_MENU_ITEM (object);
193 if (menu_item->submenu)
195 gtk_object_unref (GTK_OBJECT (menu_item->submenu));
196 /* gtk_widget_destroy (menu_item->submenu); */
199 if (GTK_OBJECT_CLASS (parent_class)->destroy)
200 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
204 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
207 g_return_if_fail (menu_item != NULL);
208 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
210 if (menu_item->submenu)
212 g_return_if_fail (!GTK_WIDGET_VISIBLE (menu_item->submenu));
213 gtk_object_unref (GTK_OBJECT (menu_item->submenu));
216 menu_item->submenu = submenu;
218 if (menu_item->submenu)
219 gtk_object_ref (GTK_OBJECT (menu_item->submenu));
221 if (GTK_WIDGET (menu_item)->parent)
222 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
226 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
227 GtkSubmenuPlacement placement)
229 g_return_if_fail (menu_item != NULL);
230 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
232 menu_item->submenu_placement = placement;
236 gtk_menu_item_accelerator_size (GtkMenuItem *menu_item)
240 g_return_if_fail (menu_item != NULL);
241 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
243 if (menu_item->accelerator_key)
245 gtk_menu_item_accelerator_text (menu_item, buf);
246 menu_item->accelerator_size = gdk_string_width (GTK_WIDGET (menu_item)->style->font, buf) + 13;
248 else if (menu_item->submenu && menu_item->show_submenu_indicator)
250 menu_item->accelerator_size = 21;
254 menu_item->accelerator_size = 0;
259 gtk_menu_item_accelerator_text (GtkMenuItem *menu_item,
262 g_return_if_fail (menu_item != NULL);
263 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
265 if (menu_item->accelerator_key)
268 if (menu_item->accelerator_mods & GDK_SHIFT_MASK)
270 strcat (buffer, MENU_ITEM_CLASS (menu_item)->shift_text);
271 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
273 if (menu_item->accelerator_mods & GDK_CONTROL_MASK)
275 strcat (buffer, MENU_ITEM_CLASS (menu_item)->control_text);
276 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
278 if (menu_item->accelerator_mods & GDK_MOD1_MASK)
280 strcat (buffer, MENU_ITEM_CLASS (menu_item)->alt_text);
281 strcat (buffer, MENU_ITEM_CLASS (menu_item)->separator_text);
283 strncat (buffer, &menu_item->accelerator_key, 1);
288 gtk_menu_item_configure (GtkMenuItem *menu_item,
289 gint show_toggle_indicator,
290 gint show_submenu_indicator)
292 g_return_if_fail (menu_item != NULL);
293 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
295 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
296 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
300 gtk_menu_item_select (GtkMenuItem *menu_item)
302 gtk_item_select (GTK_ITEM (menu_item));
306 gtk_menu_item_deselect (GtkMenuItem *menu_item)
308 gtk_item_deselect (GTK_ITEM (menu_item));
312 gtk_menu_item_activate (GtkMenuItem *menu_item)
314 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
319 gtk_menu_item_size_request (GtkWidget *widget,
320 GtkRequisition *requisition)
324 g_return_if_fail (widget != NULL);
325 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
326 g_return_if_fail (requisition != NULL);
328 bin = GTK_BIN (widget);
330 gtk_menu_item_accelerator_size (GTK_MENU_ITEM (widget));
332 requisition->width = (GTK_CONTAINER (widget)->border_width +
333 widget->style->klass->xthickness +
335 requisition->height = (GTK_CONTAINER (widget)->border_width +
336 widget->style->klass->ythickness) * 2;
338 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
340 gtk_widget_size_request (bin->child, &bin->child->requisition);
342 requisition->width += bin->child->requisition.width;
343 requisition->height += bin->child->requisition.height;
348 gtk_menu_item_size_allocate (GtkWidget *widget,
349 GtkAllocation *allocation)
352 GtkAllocation child_allocation;
354 g_return_if_fail (widget != NULL);
355 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
356 g_return_if_fail (allocation != NULL);
358 widget->allocation = *allocation;
359 if (GTK_WIDGET_REALIZED (widget))
360 gdk_window_move_resize (widget->window,
361 allocation->x, allocation->y,
362 allocation->width, allocation->height);
364 bin = GTK_BIN (widget);
368 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
369 widget->style->klass->xthickness +
371 child_allocation.y = GTK_CONTAINER (widget)->border_width;
372 child_allocation.width = allocation->width - child_allocation.x * 2;
373 child_allocation.height = allocation->height - child_allocation.y * 2;
374 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
375 child_allocation.width -= (GTK_MENU_ITEM (widget)->toggle_size +
376 GTK_MENU_ITEM (widget)->accelerator_size);
378 gtk_widget_size_allocate (bin->child, &child_allocation);
383 gtk_menu_item_install_accel (GtkWidget *widget,
384 const gchar *signal_name,
388 GtkMenuItem *menu_item;
390 g_return_val_if_fail (widget != NULL, FALSE);
391 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
392 g_return_val_if_fail (signal_name != NULL, FALSE);
394 menu_item = GTK_MENU_ITEM (widget);
396 menu_item->accelerator_signal = gtk_signal_lookup (signal_name, GTK_OBJECT_TYPE (widget));
397 if (menu_item->accelerator_signal > 0)
399 menu_item->accelerator_key = key;
400 menu_item->accelerator_mods = modifiers;
403 gtk_widget_queue_resize (widget);
412 gtk_menu_item_remove_accel (GtkWidget *widget,
413 const gchar *signal_name)
415 GtkMenuItem *menu_item;
418 g_return_if_fail (widget != NULL);
419 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
420 g_return_if_fail (signal_name != NULL);
422 menu_item = GTK_MENU_ITEM (widget);
424 signal_num = gtk_signal_lookup (signal_name, GTK_OBJECT_TYPE (widget));
425 if (menu_item->accelerator_signal == signal_num)
427 menu_item->accelerator_key = 0;
428 menu_item->accelerator_mods = 0;
429 menu_item->accelerator_signal = 0;
431 if (GTK_WIDGET_VISIBLE (widget))
433 gtk_widget_queue_draw (widget);
434 GTK_MENU_SHELL (widget->parent)->menu_flag = TRUE;
437 gtk_container_need_resize (GTK_CONTAINER (widget->parent));
442 gtk_menu_item_paint (GtkWidget *widget,
445 GtkMenuItem *menu_item;
446 GtkStateType state_type;
447 GtkShadowType shadow_type;
453 g_return_if_fail (widget != NULL);
454 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
456 if (GTK_WIDGET_DRAWABLE (widget))
458 menu_item = GTK_MENU_ITEM (widget);
460 state_type = widget->state;
461 if (!GTK_WIDGET_IS_SENSITIVE (widget))
462 state_type = GTK_STATE_INSENSITIVE;
464 gtk_style_set_background (widget->style, widget->window, state_type);
465 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
467 x = GTK_CONTAINER (menu_item)->border_width;
468 y = GTK_CONTAINER (menu_item)->border_width;
469 width = widget->allocation.width - x * 2;
470 height = widget->allocation.height - y * 2;
472 if ((state_type == GTK_STATE_PRELIGHT) &&
473 (GTK_BIN (menu_item)->child))
474 gtk_draw_shadow (widget->style,
478 x, y, width, height);
480 if (menu_item->accelerator_key)
482 gtk_menu_item_accelerator_text (menu_item, buf);
484 font = widget->style->font;
485 x = x + width - menu_item->accelerator_size + 13 - 4;
486 y = y + ((height - (font->ascent + font->descent)) / 2) + font->ascent;
488 if (state_type == GTK_STATE_INSENSITIVE)
489 gdk_draw_string (widget->window, widget->style->font,
490 widget->style->white_gc,
493 gdk_draw_string (widget->window, widget->style->font,
494 widget->style->fg_gc[state_type],
497 else if (menu_item->submenu && menu_item->show_submenu_indicator)
499 shadow_type = GTK_SHADOW_OUT;
500 if (state_type == GTK_STATE_PRELIGHT)
501 shadow_type = GTK_SHADOW_IN;
503 gtk_draw_arrow (widget->style, widget->window,
504 state_type, shadow_type, GTK_ARROW_RIGHT, FALSE,
505 x + width - 15, y + height / 2 - 5, 10, 10);
507 else if (!GTK_BIN (menu_item)->child)
509 gtk_draw_hline (widget->style, widget->window, GTK_STATE_NORMAL,
510 0, widget->allocation.width, 0);
516 gtk_menu_item_draw (GtkWidget *widget,
520 GdkRectangle child_area;
522 g_return_if_fail (widget != NULL);
523 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
524 g_return_if_fail (area != NULL);
526 if (GTK_WIDGET_DRAWABLE (widget))
528 gtk_menu_item_paint (widget, area);
530 bin = GTK_BIN (widget);
534 if (gtk_widget_intersect (bin->child, area, &child_area))
535 gtk_widget_draw (bin->child, &child_area);
541 gtk_menu_item_expose (GtkWidget *widget,
542 GdkEventExpose *event)
545 GdkEventExpose child_event;
547 g_return_val_if_fail (widget != NULL, FALSE);
548 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
549 g_return_val_if_fail (event != NULL, FALSE);
551 if (GTK_WIDGET_DRAWABLE (widget))
553 gtk_menu_item_paint (widget, &event->area);
555 bin = GTK_BIN (widget);
559 child_event = *event;
561 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
562 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
563 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
571 gtk_menu_item_enter (GtkWidget *widget,
572 GdkEventCrossing *event)
574 g_return_val_if_fail (widget != NULL, FALSE);
575 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
576 g_return_val_if_fail (event != NULL, FALSE);
578 return gtk_widget_event (widget->parent, (GdkEvent*) event);
582 gtk_menu_item_leave (GtkWidget *widget,
583 GdkEventCrossing *event)
585 g_return_val_if_fail (widget != NULL, FALSE);
586 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
587 g_return_val_if_fail (event != NULL, FALSE);
589 return gtk_widget_event (widget->parent, (GdkEvent*) event);
593 gtk_real_menu_item_select (GtkItem *item)
595 GtkMenuItem *menu_item;
597 g_return_if_fail (item != NULL);
598 g_return_if_fail (GTK_IS_MENU_ITEM (item));
600 menu_item = GTK_MENU_ITEM (item);
602 if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))
603 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT, gtk_menu_item_select_timeout, menu_item);
605 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
606 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
610 gtk_real_menu_item_deselect (GtkItem *item)
612 GtkMenuItem *menu_item;
614 g_return_if_fail (item != NULL);
615 g_return_if_fail (GTK_IS_MENU_ITEM (item));
617 menu_item = GTK_MENU_ITEM (item);
619 if (menu_item->submenu)
621 if (menu_item->timer)
622 gtk_timeout_remove (menu_item->timer);
624 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
627 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
628 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
632 gtk_menu_item_select_timeout (gpointer data)
634 GtkMenuItem *menu_item;
636 menu_item = GTK_MENU_ITEM (data);
637 menu_item->timer = 0;
639 gtk_menu_popup (GTK_MENU (menu_item->submenu),
640 GTK_WIDGET (menu_item)->parent,
641 GTK_WIDGET (menu_item),
642 gtk_menu_item_position_menu,
644 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
651 gtk_menu_item_position_menu (GtkMenu *menu,
656 GtkMenuItem *menu_item;
657 GtkMenuItem *parent_menu_item;
660 gint twidth, theight;
663 g_return_if_fail (menu != NULL);
664 g_return_if_fail (x != NULL);
665 g_return_if_fail (y != NULL);
667 menu_item = GTK_MENU_ITEM (user_data);
669 twidth = GTK_WIDGET (menu)->requisition.width;
670 theight = GTK_WIDGET (menu)->requisition.height;
672 screen_width = gdk_screen_width ();
673 screen_height = gdk_screen_height ();
675 g_return_if_fail (gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty));
677 switch (menu_item->submenu_placement)
680 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
681 ty += GTK_WIDGET (menu_item)->allocation.height;
682 else if ((ty - theight) >= 0)
685 ty += GTK_WIDGET (menu_item)->allocation.height;
687 if ((tx + twidth) > screen_width)
689 tx -= ((tx + twidth) - screen_width);
696 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
697 parent_menu_item = GTK_MENU_ITEM (GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item);
698 if (parent_menu_item)
699 menu_item->submenu_direction = parent_menu_item->submenu_direction;
701 switch (menu_item->submenu_direction)
703 case GTK_DIRECTION_LEFT:
704 if ((tx - twidth) >= 0)
708 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
709 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
713 case GTK_DIRECTION_RIGHT:
714 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
715 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
718 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
724 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
725 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
728 ty -= ((ty + theight) - screen_height);
740 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
742 g_return_if_fail (menuitem != NULL);
743 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
745 menuitem->right_justify = 1;