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 "gtkmenuitem.h"
24 #include "gtksignal.h"
27 #define BORDER_SPACING 3
28 #define SELECT_TIMEOUT 20
30 #define MENU_ITEM_CLASS(w) GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
39 static void gtk_menu_item_class_init (GtkMenuItemClass *klass);
40 static void gtk_menu_item_init (GtkMenuItem *menu_item);
41 static void gtk_menu_item_destroy (GtkObject *object);
42 static void gtk_menu_item_size_request (GtkWidget *widget,
43 GtkRequisition *requisition);
44 static void gtk_menu_item_size_allocate (GtkWidget *widget,
45 GtkAllocation *allocation);
46 static void gtk_menu_item_paint (GtkWidget *widget,
48 static void gtk_menu_item_draw (GtkWidget *widget,
50 static gint gtk_menu_item_expose (GtkWidget *widget,
51 GdkEventExpose *event);
52 static void gtk_real_menu_item_select (GtkItem *item);
53 static void gtk_real_menu_item_deselect (GtkItem *item);
54 static gint gtk_menu_item_select_timeout (gpointer data);
55 static void gtk_menu_item_position_menu (GtkMenu *menu,
59 static void gtk_menu_item_show_all (GtkWidget *widget);
60 static void gtk_menu_item_hide_all (GtkWidget *widget);
62 static GtkItemClass *parent_class;
63 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
67 gtk_menu_item_get_type (void)
69 static GtkType menu_item_type = 0;
73 GtkTypeInfo menu_item_info =
77 sizeof (GtkMenuItemClass),
78 (GtkClassInitFunc) gtk_menu_item_class_init,
79 (GtkObjectInitFunc) gtk_menu_item_init,
80 /* reserved_1 */ NULL,
81 /* reserved_2 */ NULL,
82 (GtkClassInitFunc) NULL,
85 menu_item_type = gtk_type_unique (gtk_item_get_type (), &menu_item_info);
86 gtk_type_set_chunk_alloc (menu_item_type, 16);
89 return menu_item_type;
93 gtk_menu_item_class_init (GtkMenuItemClass *klass)
95 GtkObjectClass *object_class;
96 GtkWidgetClass *widget_class;
97 GtkItemClass *item_class;
99 object_class = (GtkObjectClass*) klass;
100 widget_class = (GtkWidgetClass*) klass;
101 item_class = (GtkItemClass*) klass;
103 parent_class = gtk_type_class (gtk_item_get_type ());
105 menu_item_signals[ACTIVATE] =
106 gtk_signal_new ("activate",
109 GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
110 gtk_marshal_NONE__NONE,
113 gtk_object_class_add_signals (object_class, menu_item_signals, LAST_SIGNAL);
115 object_class->destroy = gtk_menu_item_destroy;
117 widget_class->activate_signal = menu_item_signals[ACTIVATE];
118 widget_class->size_request = gtk_menu_item_size_request;
119 widget_class->size_allocate = gtk_menu_item_size_allocate;
120 widget_class->draw = gtk_menu_item_draw;
121 widget_class->expose_event = gtk_menu_item_expose;
122 widget_class->show_all = gtk_menu_item_show_all;
123 widget_class->hide_all = gtk_menu_item_hide_all;
125 item_class->select = gtk_real_menu_item_select;
126 item_class->deselect = gtk_real_menu_item_deselect;
128 klass->activate = NULL;
130 klass->toggle_size = 0;
134 gtk_menu_item_init (GtkMenuItem *menu_item)
136 menu_item->submenu = NULL;
137 menu_item->accelerator_signal = menu_item_signals[ACTIVATE];
138 menu_item->toggle_size = 0;
139 menu_item->accelerator_width = 0;
140 menu_item->show_toggle_indicator = FALSE;
141 menu_item->show_submenu_indicator = FALSE;
142 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
143 menu_item->submenu_placement = GTK_TOP_BOTTOM;
144 menu_item->right_justify = FALSE;
146 menu_item->timer = 0;
150 gtk_menu_item_new (void)
152 return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
156 gtk_menu_item_new_with_label (const gchar *label)
158 GtkWidget *menu_item;
159 GtkWidget *accel_label;
161 menu_item = gtk_menu_item_new ();
162 accel_label = gtk_accel_label_new (label);
163 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
165 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
166 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
167 gtk_widget_show (accel_label);
173 gtk_menu_item_destroy (GtkObject *object)
175 GtkMenuItem *menu_item;
177 g_return_if_fail (object != NULL);
178 g_return_if_fail (GTK_IS_MENU_ITEM (object));
180 menu_item = GTK_MENU_ITEM (object);
182 if (menu_item->submenu)
183 gtk_widget_destroy (menu_item->submenu);
185 if (GTK_OBJECT_CLASS (parent_class)->destroy)
186 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
190 gtk_menu_item_detacher (GtkWidget *widget,
193 GtkMenuItem *menu_item;
195 g_return_if_fail (widget != NULL);
196 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
198 menu_item = GTK_MENU_ITEM (widget);
199 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
201 menu_item->submenu = NULL;
205 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
208 g_return_if_fail (menu_item != NULL);
209 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
211 if (menu_item->submenu != submenu)
213 gtk_menu_item_remove_submenu (menu_item);
215 menu_item->submenu = submenu;
216 gtk_menu_attach_to_widget (GTK_MENU (submenu),
217 GTK_WIDGET (menu_item),
218 gtk_menu_item_detacher);
220 if (GTK_WIDGET (menu_item)->parent)
221 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
226 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
228 g_return_if_fail (menu_item != NULL);
229 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
231 if (menu_item->submenu)
232 gtk_menu_detach (GTK_MENU (menu_item->submenu));
236 gtk_menu_item_set_placement (GtkMenuItem *menu_item,
237 GtkSubmenuPlacement placement)
239 g_return_if_fail (menu_item != NULL);
240 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
242 menu_item->submenu_placement = placement;
246 gtk_menu_item_configure (GtkMenuItem *menu_item,
247 gint show_toggle_indicator,
248 gint show_submenu_indicator)
250 g_return_if_fail (menu_item != NULL);
251 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
253 menu_item->show_toggle_indicator = (show_toggle_indicator == TRUE);
254 menu_item->show_submenu_indicator = (show_submenu_indicator == TRUE);
258 gtk_menu_item_select (GtkMenuItem *menu_item)
260 gtk_item_select (GTK_ITEM (menu_item));
264 gtk_menu_item_deselect (GtkMenuItem *menu_item)
266 gtk_item_deselect (GTK_ITEM (menu_item));
270 gtk_menu_item_activate (GtkMenuItem *menu_item)
272 gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
276 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
281 if (GTK_IS_ACCEL_LABEL (widget))
285 w = gtk_accel_label_accelerator_width (GTK_ACCEL_LABEL (widget));
286 *width = MAX (*width, w);
288 else if (GTK_IS_CONTAINER (widget))
289 gtk_container_foreach (GTK_CONTAINER (widget),
290 gtk_menu_item_accel_width_foreach,
295 gtk_menu_item_size_request (GtkWidget *widget,
296 GtkRequisition *requisition)
298 GtkMenuItem *menu_item;
302 g_return_if_fail (widget != NULL);
303 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
304 g_return_if_fail (requisition != NULL);
306 bin = GTK_BIN (widget);
307 menu_item = GTK_MENU_ITEM (widget);
309 requisition->width = (GTK_CONTAINER (widget)->border_width +
310 widget->style->klass->xthickness +
312 requisition->height = (GTK_CONTAINER (widget)->border_width +
313 widget->style->klass->ythickness) * 2;
315 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
317 gtk_widget_size_request (bin->child, &bin->child->requisition);
319 requisition->width += bin->child->requisition.width;
320 requisition->height += bin->child->requisition.height;
323 if (menu_item->submenu && menu_item->show_submenu_indicator)
324 requisition->width += 21;
327 gtk_container_foreach (GTK_CONTAINER (menu_item),
328 gtk_menu_item_accel_width_foreach,
330 menu_item->accelerator_width = accel_width;
334 gtk_menu_item_size_allocate (GtkWidget *widget,
335 GtkAllocation *allocation)
337 GtkMenuItem *menu_item;
339 GtkAllocation child_allocation;
341 g_return_if_fail (widget != NULL);
342 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
343 g_return_if_fail (allocation != NULL);
345 menu_item = GTK_MENU_ITEM (widget);
346 bin = GTK_BIN (widget);
348 widget->allocation = *allocation;
352 child_allocation.x = (GTK_CONTAINER (widget)->border_width +
353 widget->style->klass->xthickness +
355 child_allocation.y = (GTK_CONTAINER (widget)->border_width +
356 widget->style->klass->ythickness);
357 child_allocation.width = MAX (1, allocation->width - child_allocation.x * 2);
358 child_allocation.height = MAX (1, allocation->height - child_allocation.y * 2);
359 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
360 child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
361 if (menu_item->submenu && menu_item->show_submenu_indicator)
362 child_allocation.width -= 21;
364 gtk_widget_size_allocate (bin->child, &child_allocation);
367 if (GTK_WIDGET_REALIZED (widget))
368 gdk_window_move_resize (widget->window,
369 allocation->x, allocation->y,
370 allocation->width, allocation->height);
372 if (menu_item->submenu)
373 gtk_menu_reposition (GTK_MENU (menu_item->submenu));
377 gtk_menu_item_paint (GtkWidget *widget,
380 GtkMenuItem *menu_item;
381 GtkStateType state_type;
382 GtkShadowType shadow_type;
386 g_return_if_fail (widget != NULL);
387 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
389 if (GTK_WIDGET_DRAWABLE (widget))
391 menu_item = GTK_MENU_ITEM (widget);
393 state_type = widget->state;
394 if (!GTK_WIDGET_IS_SENSITIVE (widget))
395 state_type = GTK_STATE_INSENSITIVE;
397 gtk_style_set_background (widget->style, widget->window, state_type);
398 gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);
400 x = GTK_CONTAINER (menu_item)->border_width;
401 y = GTK_CONTAINER (menu_item)->border_width;
402 width = widget->allocation.width - x * 2;
403 height = widget->allocation.height - y * 2;
405 if ((state_type == GTK_STATE_PRELIGHT) &&
406 (GTK_BIN (menu_item)->child))
407 gtk_draw_shadow (widget->style,
411 x, y, width, height);
413 if (menu_item->submenu && menu_item->show_submenu_indicator)
415 shadow_type = GTK_SHADOW_OUT;
416 if (state_type == GTK_STATE_PRELIGHT)
417 shadow_type = GTK_SHADOW_IN;
419 gtk_draw_arrow (widget->style, widget->window,
420 state_type, shadow_type, GTK_ARROW_RIGHT, FALSE,
421 x + width - 15, y + height / 2 - 5, 10, 10);
423 else if (!GTK_BIN (menu_item)->child)
425 gtk_draw_hline (widget->style, widget->window, GTK_STATE_NORMAL,
426 0, widget->allocation.width, 0);
432 gtk_menu_item_draw (GtkWidget *widget,
436 GdkRectangle child_area;
438 g_return_if_fail (widget != NULL);
439 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
440 g_return_if_fail (area != NULL);
442 if (GTK_WIDGET_DRAWABLE (widget))
444 gtk_menu_item_paint (widget, area);
446 bin = GTK_BIN (widget);
450 if (gtk_widget_intersect (bin->child, area, &child_area))
451 gtk_widget_draw (bin->child, &child_area);
457 gtk_menu_item_expose (GtkWidget *widget,
458 GdkEventExpose *event)
461 GdkEventExpose child_event;
463 g_return_val_if_fail (widget != NULL, FALSE);
464 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
465 g_return_val_if_fail (event != NULL, FALSE);
467 if (GTK_WIDGET_DRAWABLE (widget))
469 gtk_menu_item_paint (widget, &event->area);
471 bin = GTK_BIN (widget);
475 child_event = *event;
477 if (GTK_WIDGET_NO_WINDOW (bin->child) &&
478 gtk_widget_intersect (bin->child, &event->area, &child_event.area))
479 gtk_widget_event (bin->child, (GdkEvent*) &child_event);
487 gtk_real_menu_item_select (GtkItem *item)
489 GtkMenuItem *menu_item;
491 g_return_if_fail (item != NULL);
492 g_return_if_fail (GTK_IS_MENU_ITEM (item));
494 menu_item = GTK_MENU_ITEM (item);
496 if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))
497 menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT, gtk_menu_item_select_timeout, menu_item);
499 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
500 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
504 gtk_real_menu_item_deselect (GtkItem *item)
506 GtkMenuItem *menu_item;
508 g_return_if_fail (item != NULL);
509 g_return_if_fail (GTK_IS_MENU_ITEM (item));
511 menu_item = GTK_MENU_ITEM (item);
513 if (menu_item->submenu)
515 if (menu_item->timer)
516 gtk_timeout_remove (menu_item->timer);
518 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
521 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
522 gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
526 gtk_menu_item_select_timeout (gpointer data)
528 GtkMenuItem *menu_item;
530 menu_item = GTK_MENU_ITEM (data);
531 menu_item->timer = 0;
533 gtk_menu_popup (GTK_MENU (menu_item->submenu),
534 GTK_WIDGET (menu_item)->parent,
535 GTK_WIDGET (menu_item),
536 gtk_menu_item_position_menu,
538 GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
545 gtk_menu_item_position_menu (GtkMenu *menu,
550 GtkMenuItem *menu_item;
551 GtkWidget *parent_menu_item;
554 gint twidth, theight;
557 g_return_if_fail (menu != NULL);
558 g_return_if_fail (x != NULL);
559 g_return_if_fail (y != NULL);
561 menu_item = GTK_MENU_ITEM (user_data);
563 twidth = GTK_WIDGET (menu)->requisition.width;
564 theight = GTK_WIDGET (menu)->requisition.height;
566 screen_width = gdk_screen_width ();
567 screen_height = gdk_screen_height ();
569 if (!gdk_window_get_origin (GTK_WIDGET (menu_item)->window, &tx, &ty))
571 g_warning ("Menu not on screen");
575 switch (menu_item->submenu_placement)
578 if ((ty + GTK_WIDGET (menu_item)->allocation.height + theight) <= screen_height)
579 ty += GTK_WIDGET (menu_item)->allocation.height;
580 else if ((ty - theight) >= 0)
583 ty += GTK_WIDGET (menu_item)->allocation.height;
585 if ((tx + twidth) > screen_width)
587 tx -= ((tx + twidth) - screen_width);
594 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
595 parent_menu_item = GTK_MENU (GTK_WIDGET (menu_item)->parent)->parent_menu_item;
596 if (parent_menu_item)
597 menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
599 switch (menu_item->submenu_direction)
601 case GTK_DIRECTION_LEFT:
602 if ((tx - twidth) >= 0)
606 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
607 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
611 case GTK_DIRECTION_RIGHT:
612 if ((tx + GTK_WIDGET (menu_item)->allocation.width + twidth - 5) <= screen_width)
613 tx += GTK_WIDGET (menu_item)->allocation.width - 5;
616 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
622 if ((ty + GTK_WIDGET (menu_item)->allocation.height / 4 + theight) <= screen_height)
623 ty += GTK_WIDGET (menu_item)->allocation.height / 4;
626 ty -= ((ty + theight) - screen_height);
638 gtk_menu_item_right_justify(GtkMenuItem *menuitem)
640 g_return_if_fail (menuitem != NULL);
641 g_return_if_fail (GTK_IS_MENU_ITEM (menuitem));
643 menuitem->right_justify = 1;
647 gtk_menu_item_show_all (GtkWidget *widget)
649 GtkContainer *container;
650 GtkMenuItem *menu_item;
652 g_return_if_fail (widget != NULL);
653 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
654 container = GTK_CONTAINER (widget);
655 menu_item = GTK_MENU_ITEM (widget);
657 /* Show children, traverse to submenu, show self. */
658 gtk_container_foreach (container, (GtkCallback) gtk_widget_show_all, NULL);
659 if (menu_item->submenu)
660 gtk_widget_show_all (menu_item->submenu);
661 gtk_widget_show (widget);
666 gtk_menu_item_hide_all (GtkWidget *widget)
668 GtkContainer *container;
669 GtkMenuItem *menu_item;
671 g_return_if_fail (widget != NULL);
672 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
673 container = GTK_CONTAINER (widget);
674 menu_item = GTK_MENU_ITEM (widget);
676 /* Reverse order of gtk_menu_item_show_all */
677 gtk_widget_hide (widget);
678 if (menu_item->submenu)
679 gtk_widget_hide_all (menu_item->submenu);
680 gtk_container_foreach (container, (GtkCallback) gtk_widget_hide_all, NULL);