]> Pileus Git - ~andy/gtk/blob - gtk/gtkmenuitem.c
include gdkkeysysms.h if compiling gdk_keyval_convert_case.
[~andy/gtk] / gtk / gtkmenuitem.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser 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.
8  *
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  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser 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.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #define GTK_MENU_INTERNALS
28
29 #include <string.h>
30 #include "gtkaccellabel.h"
31 #include "gtkmain.h"
32 #include "gtkmarshalers.h"
33 #include "gtkmenu.h"
34 #include "gtkmenubar.h"
35 #include "gtkmenuitem.h"
36 #include "gtkseparatormenuitem.h"
37 #include "gtksignal.h"
38
39
40 #define BORDER_SPACING  3
41 #define SELECT_TIMEOUT  75
42
43 #define MENU_ITEM_CLASS(w)  GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
44
45
46 enum {
47   ACTIVATE,
48   ACTIVATE_ITEM,
49   TOGGLE_SIZE_REQUEST,
50   TOGGLE_SIZE_ALLOCATE,
51   LAST_SIGNAL
52 };
53
54
55 static void gtk_menu_item_class_init     (GtkMenuItemClass *klass);
56 static void gtk_menu_item_init           (GtkMenuItem      *menu_item);
57 static void gtk_menu_item_destroy        (GtkObject        *object);
58 static void gtk_menu_item_finalize       (GObject          *object);
59 static void gtk_menu_item_size_request   (GtkWidget        *widget,
60                                           GtkRequisition   *requisition);
61 static void gtk_menu_item_size_allocate  (GtkWidget        *widget,
62                                           GtkAllocation    *allocation);
63 static void gtk_menu_item_realize        (GtkWidget        *widget);
64 static void gtk_menu_item_unrealize      (GtkWidget        *widget);
65 static void gtk_menu_item_map            (GtkWidget        *widget);
66 static void gtk_menu_item_unmap          (GtkWidget        *widget);
67 static void gtk_menu_item_paint          (GtkWidget        *widget,
68                                           GdkRectangle     *area);
69 static gint gtk_menu_item_expose         (GtkWidget        *widget,
70                                           GdkEventExpose   *event);
71 static void gtk_menu_item_parent_set     (GtkWidget        *widget,
72                                           GtkWidget        *previous_parent);
73
74
75 static void gtk_real_menu_item_select               (GtkItem     *item);
76 static void gtk_real_menu_item_deselect             (GtkItem     *item);
77 static void gtk_real_menu_item_activate_item        (GtkMenuItem *item);
78 static void gtk_real_menu_item_toggle_size_request  (GtkMenuItem *menu_item,
79                                                      gint        *requisition);
80 static void gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
81                                                      gint         allocation);
82 static gboolean gtk_menu_item_mnemonic_activate     (GtkWidget   *widget,
83                                                      gboolean     group_cycling);
84
85 static gint gtk_menu_item_select_timeout (gpointer          data);
86 static void gtk_menu_item_popup_submenu  (gpointer     data);
87 static void gtk_menu_item_position_menu  (GtkMenu          *menu,
88                                           gint             *x,
89                                           gint             *y,
90                                           gboolean         *push_in,
91                                           gpointer          user_data);
92 static void gtk_menu_item_show_all       (GtkWidget        *widget);
93 static void gtk_menu_item_hide_all       (GtkWidget        *widget);
94 static void gtk_menu_item_forall         (GtkContainer    *container,
95                                           gboolean         include_internals,
96                                           GtkCallback      callback,
97                                           gpointer         callback_data);
98
99
100 static GtkItemClass *parent_class;
101 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
102 static guint32  last_submenu_deselect_time = 0;
103
104
105
106 GtkType
107 gtk_menu_item_get_type (void)
108 {
109   static GtkType menu_item_type = 0;
110
111   if (!menu_item_type)
112     {
113       static const GTypeInfo menu_item_info =
114       {
115         sizeof (GtkMenuItemClass),
116         NULL,           /* base_init */
117         NULL,           /* base_finalize */
118         (GClassInitFunc) gtk_menu_item_class_init,
119         NULL,           /* class_finalize */
120         NULL,           /* class_data */
121         sizeof (GtkMenuItem),
122         16,             /* n_preallocs */
123         (GInstanceInitFunc) gtk_menu_item_init,
124       };
125
126       menu_item_type = g_type_register_static (GTK_TYPE_ITEM, "GtkMenuItem", &menu_item_info, 0);
127     }
128
129   return menu_item_type;
130 }
131
132 static void
133 gtk_menu_item_class_init (GtkMenuItemClass *klass)
134 {
135   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
136   GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
137   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
138   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
139   GtkItemClass *item_class = GTK_ITEM_CLASS (klass);
140
141   parent_class = g_type_class_peek_parent (klass);
142
143   gobject_class->finalize = gtk_menu_item_finalize;
144
145   object_class->destroy = gtk_menu_item_destroy;
146
147   widget_class->size_request = gtk_menu_item_size_request;
148   widget_class->size_allocate = gtk_menu_item_size_allocate;
149   widget_class->expose_event = gtk_menu_item_expose;
150   widget_class->realize = gtk_menu_item_realize;
151   widget_class->unrealize = gtk_menu_item_unrealize;
152   widget_class->map = gtk_menu_item_map;
153   widget_class->unmap = gtk_menu_item_unmap;
154   widget_class->show_all = gtk_menu_item_show_all;
155   widget_class->hide_all = gtk_menu_item_hide_all;
156   widget_class->mnemonic_activate = gtk_menu_item_mnemonic_activate;
157   widget_class->parent_set = gtk_menu_item_parent_set;
158   
159   container_class->forall = gtk_menu_item_forall;
160
161   item_class->select = gtk_real_menu_item_select;
162   item_class->deselect = gtk_real_menu_item_deselect;
163
164   klass->activate = NULL;
165   klass->activate_item = gtk_real_menu_item_activate_item;
166   klass->toggle_size_request = gtk_real_menu_item_toggle_size_request;
167   klass->toggle_size_allocate = gtk_real_menu_item_toggle_size_allocate;
168
169   klass->hide_on_activate = TRUE;
170
171   menu_item_signals[ACTIVATE] =
172     gtk_signal_new ("activate",
173                     GTK_RUN_FIRST | GTK_RUN_ACTION,
174                     GTK_CLASS_TYPE (object_class),
175                     GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
176                     _gtk_marshal_VOID__VOID,
177                     GTK_TYPE_NONE, 0);
178   widget_class->activate_signal = menu_item_signals[ACTIVATE];
179
180   menu_item_signals[ACTIVATE_ITEM] =
181     gtk_signal_new ("activate_item",
182                     GTK_RUN_FIRST,
183                     GTK_CLASS_TYPE (object_class),
184                     GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate_item),
185                     gtk_signal_default_marshaller,
186                     GTK_TYPE_NONE, 0);
187
188   menu_item_signals[TOGGLE_SIZE_REQUEST] =
189     gtk_signal_new ("toggle_size_request",
190                     GTK_RUN_FIRST,
191                     GTK_CLASS_TYPE (object_class),
192                     GTK_SIGNAL_OFFSET (GtkMenuItemClass, toggle_size_request),
193                     _gtk_marshal_VOID__POINTER,
194                     GTK_TYPE_NONE, 1,
195                     GTK_TYPE_POINTER);
196
197   menu_item_signals[TOGGLE_SIZE_ALLOCATE] =
198     gtk_signal_new ("toggle_size_allocate",
199                     GTK_RUN_FIRST,
200                     GTK_CLASS_TYPE (object_class),
201                     GTK_SIGNAL_OFFSET (GtkMenuItemClass, toggle_size_allocate),
202                     _gtk_marshal_NONE__INT,
203                     GTK_TYPE_NONE, 1,
204                     GTK_TYPE_INT);
205 }
206
207 static void
208 gtk_menu_item_init (GtkMenuItem *menu_item)
209 {
210   GTK_WIDGET_SET_FLAGS (menu_item, GTK_NO_WINDOW);
211   
212   menu_item->submenu = NULL;
213   menu_item->toggle_size = 0;
214   menu_item->accelerator_width = 0;
215   menu_item->show_submenu_indicator = FALSE;
216   menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
217   menu_item->submenu_placement = GTK_TOP_BOTTOM;
218   menu_item->right_justify = FALSE;
219
220   menu_item->timer = 0;
221 }
222
223 GtkWidget*
224 gtk_menu_item_new (void)
225 {
226   return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
227 }
228
229 GtkWidget*
230 gtk_menu_item_new_with_label (const gchar *label)
231 {
232   GtkWidget *menu_item;
233   GtkWidget *accel_label;
234
235   menu_item = gtk_menu_item_new ();
236   accel_label = gtk_accel_label_new (label);
237   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
238
239   gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
240   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
241   gtk_widget_show (accel_label);
242
243   return menu_item;
244 }
245
246
247 /**
248  * gtk_menu_item_new_with_mnemonic:
249  * @label: The text of the button, with an underscore in front of the
250  *         mnemonic character
251  * @returns: a new #GtkMenuItem
252  *
253  * Creates a new #GtkMenuItem containing a label. The label
254  * will be created using gtk_label_new_with_mnemonic(), so underscores
255  * in @label indicate the mnemonic for the menu item.
256  **/
257 GtkWidget*
258 gtk_menu_item_new_with_mnemonic (const gchar *label)
259 {
260   GtkWidget *menu_item;
261   GtkWidget *accel_label;
262
263   menu_item = gtk_menu_item_new ();
264   accel_label = gtk_type_new (GTK_TYPE_ACCEL_LABEL);
265   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
266   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
267
268   gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
269   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
270   gtk_widget_show (accel_label);
271
272   return menu_item;
273 }
274
275 static void
276 gtk_menu_item_destroy (GtkObject *object)
277 {
278   GtkMenuItem *menu_item;
279
280   g_return_if_fail (GTK_IS_MENU_ITEM (object));
281
282   menu_item = GTK_MENU_ITEM (object);
283
284   if (menu_item->submenu)
285     gtk_widget_destroy (menu_item->submenu);
286
287   GTK_OBJECT_CLASS (parent_class)->destroy (object);
288 }
289
290 static void
291 gtk_menu_item_finalize (GObject *object)
292 {
293   GtkMenuItem *menu_item = GTK_MENU_ITEM (object);
294
295   g_free (menu_item->accel_path);
296
297   G_OBJECT_CLASS (parent_class)->finalize (object);
298 }
299
300 static void
301 gtk_menu_item_detacher (GtkWidget     *widget,
302                         GtkMenu       *menu)
303 {
304   GtkMenuItem *menu_item;
305
306   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
307
308   menu_item = GTK_MENU_ITEM (widget);
309   g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
310
311   menu_item->submenu = NULL;
312 }
313
314 void
315 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
316                            GtkWidget   *submenu)
317 {
318   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
319   
320   if (menu_item->submenu != submenu)
321     {
322       gtk_menu_item_remove_submenu (menu_item);
323       
324       menu_item->submenu = submenu;
325       gtk_menu_attach_to_widget (GTK_MENU (submenu),
326                                  GTK_WIDGET (menu_item),
327                                  gtk_menu_item_detacher);
328       
329       if (GTK_WIDGET (menu_item)->parent)
330         gtk_widget_queue_resize (GTK_WIDGET (menu_item));
331     }
332 }
333
334 /**
335  * gtk_menu_item_get_submenu:
336  * @menu_item: a #GtkMenuItem
337  *
338  * Gets the submenu underneath this menu item, if any. See
339  * gtk_menu_item_set_submenu().
340  *
341  * Return value: submenu for this menu item, or %NULL if none.
342  **/
343 GtkWidget *
344 gtk_menu_item_get_submenu (GtkMenuItem *menu_item)
345 {
346   g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), NULL);
347
348   return menu_item->submenu;
349 }
350
351 void
352 gtk_menu_item_remove_submenu (GtkMenuItem         *menu_item)
353 {
354   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
355       
356   if (menu_item->submenu)
357     gtk_menu_detach (GTK_MENU (menu_item->submenu));
358 }
359
360 void _gtk_menu_item_set_placement (GtkMenuItem         *menu_item,
361                                    GtkSubmenuPlacement  placement);
362
363 void
364 _gtk_menu_item_set_placement (GtkMenuItem         *menu_item,
365                              GtkSubmenuPlacement  placement)
366 {
367   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
368
369   menu_item->submenu_placement = placement;
370 }
371
372 void
373 gtk_menu_item_select (GtkMenuItem *menu_item)
374 {
375   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
376   
377   gtk_item_select (GTK_ITEM (menu_item));
378 }
379
380 void
381 gtk_menu_item_deselect (GtkMenuItem *menu_item)
382 {
383   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
384   
385   gtk_item_deselect (GTK_ITEM (menu_item));
386 }
387
388 void
389 gtk_menu_item_activate (GtkMenuItem *menu_item)
390 {
391   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
392   
393   gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
394 }
395
396 void
397 gtk_menu_item_toggle_size_request (GtkMenuItem *menu_item,
398                                    gint        *requisition)
399 {
400   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
401
402   gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[TOGGLE_SIZE_REQUEST], requisition);
403 }
404
405 void
406 gtk_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
407                                     gint         allocation)
408 {
409   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
410
411   gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[TOGGLE_SIZE_ALLOCATE], allocation);
412 }
413
414 static void
415 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
416                                    gpointer data)
417 {
418   guint *width = data;
419
420   if (GTK_IS_ACCEL_LABEL (widget))
421     {
422       guint w;
423
424       w = gtk_accel_label_get_accel_width (GTK_ACCEL_LABEL (widget));
425       *width = MAX (*width, w);
426     }
427   else if (GTK_IS_CONTAINER (widget))
428     gtk_container_foreach (GTK_CONTAINER (widget),
429                            gtk_menu_item_accel_width_foreach,
430                            data);
431 }
432
433 static void
434 gtk_menu_item_size_request (GtkWidget      *widget,
435                             GtkRequisition *requisition)
436 {
437   GtkMenuItem *menu_item;
438   GtkBin *bin;
439   guint accel_width;
440
441   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
442   g_return_if_fail (requisition != NULL);
443
444   bin = GTK_BIN (widget);
445   menu_item = GTK_MENU_ITEM (widget);
446
447   requisition->width = (GTK_CONTAINER (widget)->border_width +
448                         widget->style->xthickness +
449                         BORDER_SPACING) * 2;
450   requisition->height = (GTK_CONTAINER (widget)->border_width +
451                          widget->style->ythickness) * 2;
452
453   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
454     {
455       GtkRequisition child_requisition;
456       
457       gtk_widget_size_request (bin->child, &child_requisition);
458
459       requisition->width += child_requisition.width;
460       requisition->height += child_requisition.height;
461
462       if (menu_item->submenu && menu_item->show_submenu_indicator)
463         requisition->width += child_requisition.height;
464     }
465
466   accel_width = 0;
467   gtk_container_foreach (GTK_CONTAINER (menu_item),
468                          gtk_menu_item_accel_width_foreach,
469                          &accel_width);
470   menu_item->accelerator_width = accel_width;
471 }
472
473 static void
474 gtk_menu_item_size_allocate (GtkWidget     *widget,
475                              GtkAllocation *allocation)
476 {
477   GtkMenuItem *menu_item;
478   GtkBin *bin;
479   GtkAllocation child_allocation;
480
481   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
482   g_return_if_fail (allocation != NULL);
483
484   menu_item = GTK_MENU_ITEM (widget);
485   bin = GTK_BIN (widget);
486   
487   widget->allocation = *allocation;
488
489   if (bin->child)
490     {
491       child_allocation.x = (GTK_CONTAINER (widget)->border_width +
492                             widget->style->xthickness +
493                             BORDER_SPACING);
494       child_allocation.y = (GTK_CONTAINER (widget)->border_width +
495                             widget->style->ythickness);
496       child_allocation.width = MAX (1, (gint)allocation->width - child_allocation.x * 2);
497       child_allocation.height = MAX (1, (gint)allocation->height - child_allocation.y * 2);
498       child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
499       child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
500       child_allocation.x += widget->allocation.x;
501       child_allocation.y += widget->allocation.y;
502       
503       if (menu_item->submenu && menu_item->show_submenu_indicator)
504         child_allocation.width -= child_allocation.height;
505
506       gtk_widget_size_allocate (bin->child, &child_allocation);
507     }
508
509   if (GTK_WIDGET_REALIZED (widget))
510     gdk_window_move_resize (menu_item->event_window,
511                             allocation->x, allocation->y,
512                             allocation->width, allocation->height);
513
514   if (menu_item->submenu)
515     gtk_menu_reposition (GTK_MENU (menu_item->submenu));
516 }
517
518 static void
519 gtk_menu_item_realize (GtkWidget *widget)
520 {
521   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
522   GdkWindowAttr attributes;
523   gint attributes_mask;
524
525   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
526
527   widget->window = gtk_widget_get_parent_window (widget);
528   gdk_window_ref (widget->window);
529   
530   attributes.x = widget->allocation.x;
531   attributes.y = widget->allocation.y;
532   attributes.width = widget->allocation.width;
533   attributes.height = widget->allocation.height;
534   attributes.window_type = GDK_WINDOW_CHILD;
535   attributes.wclass = GDK_INPUT_ONLY;
536   attributes.event_mask = (gtk_widget_get_events (widget) |
537                            GDK_EXPOSURE_MASK |
538                            GDK_BUTTON_PRESS_MASK |
539                            GDK_BUTTON_RELEASE_MASK |
540                            GDK_ENTER_NOTIFY_MASK |
541                            GDK_LEAVE_NOTIFY_MASK |
542                            GDK_POINTER_MOTION_MASK);
543
544   attributes_mask = GDK_WA_X | GDK_WA_Y;
545   menu_item->event_window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
546   gdk_window_set_user_data (menu_item->event_window, widget);
547
548   widget->style = gtk_style_attach (widget->style, widget->window);
549 }
550
551 static void
552 gtk_menu_item_unrealize (GtkWidget *widget)
553 {
554   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
555
556   gdk_window_set_user_data (menu_item->event_window, NULL);
557   gdk_window_destroy (menu_item->event_window);
558   menu_item->event_window = NULL;
559   
560   if (GTK_WIDGET_CLASS (parent_class)->unrealize)
561     (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
562 }
563
564 static void
565 gtk_menu_item_map (GtkWidget *widget)
566 {
567   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
568   
569   GTK_WIDGET_CLASS (parent_class)->map (widget);
570
571   gdk_window_show (menu_item->event_window);
572 }
573
574 static void
575 gtk_menu_item_unmap (GtkWidget *widget)
576 {
577   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
578     
579   gdk_window_hide (menu_item->event_window);
580
581   GTK_WIDGET_CLASS (parent_class)->unmap (widget);
582 }
583
584 static void
585 gtk_menu_item_paint (GtkWidget    *widget,
586                      GdkRectangle *area)
587 {
588   GtkMenuItem *menu_item;
589   GtkStateType state_type;
590   GtkShadowType shadow_type;
591   gint width, height;
592   gint x, y;
593   gint border_width = GTK_CONTAINER (widget)->border_width;
594
595   if (GTK_WIDGET_DRAWABLE (widget))
596     {
597       menu_item = GTK_MENU_ITEM (widget);
598
599       state_type = widget->state;
600
601       x = widget->allocation.x + border_width;
602       y = widget->allocation.y + border_width;
603       width = widget->allocation.width - border_width * 2;
604       height = widget->allocation.height - border_width * 2;
605       
606       if ((state_type == GTK_STATE_PRELIGHT) &&
607           (GTK_BIN (menu_item)->child))
608         gtk_paint_box (widget->style,
609                        widget->window,
610                        GTK_STATE_PRELIGHT,
611                        GTK_SHADOW_OUT,
612                        area, widget, "menuitem",
613                        x, y, width, height);
614
615       if (menu_item->submenu && menu_item->show_submenu_indicator)
616         {
617           gint arrow_x, arrow_y;
618           gint arrow_size = height - 2 * widget->style->ythickness;
619           gint arrow_extent = arrow_size / 2;
620           
621           shadow_type = GTK_SHADOW_OUT;
622           if (state_type == GTK_STATE_PRELIGHT)
623             shadow_type = GTK_SHADOW_IN;
624
625           arrow_x = x + width - 1 - arrow_size + (arrow_size - arrow_extent) / 2;
626           arrow_y = y + (height - arrow_extent) / 2;
627
628           gtk_paint_arrow (widget->style, widget->window,
629                            state_type, shadow_type, 
630                            area, widget, "menuitem", 
631                            GTK_ARROW_RIGHT, TRUE,
632                            arrow_x, arrow_y,
633                            arrow_extent, arrow_extent);
634         }
635       else if (!GTK_BIN (menu_item)->child)
636         {
637           gtk_paint_hline (widget->style, widget->window, GTK_STATE_NORMAL,
638                            area, widget, "menuitem",
639                            widget->allocation.x, widget->allocation.width,
640                            widget->allocation.y);
641         }
642     }
643 }
644
645 static gint
646 gtk_menu_item_expose (GtkWidget      *widget,
647                       GdkEventExpose *event)
648 {
649   g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
650   g_return_val_if_fail (event != NULL, FALSE);
651
652   if (GTK_WIDGET_DRAWABLE (widget))
653     {
654       gtk_menu_item_paint (widget, &event->area);
655
656       (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
657     }
658
659   return FALSE;
660 }
661
662 static void
663 gtk_real_menu_item_select (GtkItem *item)
664 {
665   GtkMenuItem *menu_item;
666
667   g_return_if_fail (GTK_IS_MENU_ITEM (item));
668
669   menu_item = GTK_MENU_ITEM (item);
670
671   /*  if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))*/
672   if (menu_item->submenu)
673     {
674       guint32 etime;
675       GdkEvent *event = gtk_get_current_event ();
676
677       etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
678       if (event &&
679           etime >= last_submenu_deselect_time &&
680           last_submenu_deselect_time + SELECT_TIMEOUT > etime)
681         {
682           if (!menu_item->timer)
683             menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT - (etime - last_submenu_deselect_time),
684                                                 gtk_menu_item_select_timeout,
685                                                 menu_item);
686           if (event &&
687               event->type != GDK_BUTTON_PRESS &&
688               event->type != GDK_ENTER_NOTIFY)
689             menu_item->timer_from_keypress = TRUE;
690           else
691             menu_item->timer_from_keypress = FALSE;
692         }
693       else
694         gtk_menu_item_popup_submenu (menu_item);
695       if (event)
696         gdk_event_free(event);
697     }
698   
699   gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
700   gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
701 }
702
703 static void
704 gtk_real_menu_item_deselect (GtkItem *item)
705 {
706   GtkMenuItem *menu_item;
707
708   g_return_if_fail (GTK_IS_MENU_ITEM (item));
709
710   menu_item = GTK_MENU_ITEM (item);
711
712   if (menu_item->submenu)
713     {
714       guint32 etime;
715       GdkEvent *event = gtk_get_current_event ();
716
717       if (menu_item->timer)
718         {
719           gtk_timeout_remove (menu_item->timer);
720           menu_item->timer = 0;
721         }
722       else
723         gtk_menu_popdown (GTK_MENU (menu_item->submenu));
724
725       etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
726       if (etime > last_submenu_deselect_time)
727         last_submenu_deselect_time = etime;
728       if (event)
729         gdk_event_free(event);
730     }
731
732   gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
733   gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
734 }
735
736 static gboolean
737 gtk_menu_item_mnemonic_activate (GtkWidget *widget,
738                                  gboolean   group_cycling)
739 {
740   if (group_cycling)
741     {
742       if (widget->parent &&
743           GTK_IS_MENU_SHELL (widget->parent))
744         gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent),
745                                     widget);
746
747     }
748   else
749     gtk_signal_emit (GTK_OBJECT (widget), menu_item_signals[ACTIVATE_ITEM]);
750   
751   return TRUE;
752 }
753
754
755 static void
756 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
757 {
758   GtkWidget *widget;
759   GtkMenuShell *submenu; 
760
761   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
762
763   widget = GTK_WIDGET (menu_item);
764   
765   if (widget->parent &&
766       GTK_IS_MENU_SHELL (widget->parent))
767     {
768       if (menu_item->submenu == NULL)
769         gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
770                                       widget, TRUE);
771       else
772         {
773           GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);
774
775           if (!menu_shell->active)
776             {
777               gtk_grab_add (GTK_WIDGET (menu_shell));
778               menu_shell->have_grab = TRUE;
779               menu_shell->active = TRUE;
780             }
781
782           gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget); 
783           gtk_menu_item_popup_submenu (widget); 
784
785           _gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu));
786           submenu = GTK_MENU_SHELL (menu_item->submenu);
787         }
788     }
789 }
790 static void
791 gtk_real_menu_item_toggle_size_request (GtkMenuItem *menu_item,
792                                         gint        *requisition)
793 {
794   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
795
796   *requisition = 0;
797 }
798
799 static void
800 gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
801                                          gint         allocation)
802 {
803   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
804
805   menu_item->toggle_size = allocation;
806 }
807
808 static gint
809 gtk_menu_item_select_timeout (gpointer data)
810 {
811   GtkMenuItem *menu_item;
812   GtkWidget *parent;
813   
814   GDK_THREADS_ENTER ();
815
816   menu_item = GTK_MENU_ITEM (data);
817
818   parent = GTK_WIDGET (menu_item)->parent;
819
820   if (parent && GTK_IS_MENU_SHELL (parent) && GTK_MENU_SHELL (parent)->active)
821     {
822       gtk_menu_item_popup_submenu (data);
823       if (menu_item->timer_from_keypress && menu_item->submenu)
824         GTK_MENU_SHELL (menu_item->submenu)->ignore_enter = TRUE;
825     }
826
827   GDK_THREADS_LEAVE ();
828
829   return FALSE;  
830 }
831
832 static void
833 gtk_menu_item_popup_submenu (gpointer data)
834 {
835   GtkMenuItem *menu_item;
836
837   menu_item = GTK_MENU_ITEM (data);
838   menu_item->timer = 0;
839
840   if (GTK_WIDGET_IS_SENSITIVE (menu_item->submenu))
841     {
842       gtk_menu_popup (GTK_MENU (menu_item->submenu),
843                       GTK_WIDGET (menu_item)->parent,
844                       GTK_WIDGET (menu_item),
845                       gtk_menu_item_position_menu,
846                       menu_item,
847                       GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
848                       0);
849     }
850 }
851
852 static void
853 gtk_menu_item_position_menu (GtkMenu  *menu,
854                              gint     *x,
855                              gint     *y,
856                              gboolean *push_in,
857                              gpointer  user_data)
858 {
859   GtkMenuItem *menu_item;
860   GtkWidget *widget;
861   GtkWidget *parent_menu_item;
862   gint screen_width;
863   gint screen_height;
864   gint twidth, theight;
865   gint tx, ty;
866
867   g_return_if_fail (menu != NULL);
868   g_return_if_fail (x != NULL);
869   g_return_if_fail (y != NULL);
870
871   menu_item = GTK_MENU_ITEM (user_data);
872   widget = GTK_WIDGET (user_data);
873
874   twidth = GTK_WIDGET (menu)->requisition.width;
875   theight = GTK_WIDGET (menu)->requisition.height;
876
877   screen_width = gdk_screen_width ();
878   screen_height = gdk_screen_height ();
879
880   if (!gdk_window_get_origin (widget->window, &tx, &ty))
881     {
882       g_warning ("Menu not on screen");
883       return;
884     }
885
886   tx += widget->allocation.x;
887   ty += widget->allocation.y;
888
889   switch (menu_item->submenu_placement)
890     {
891     case GTK_TOP_BOTTOM:
892       if ((ty + widget->allocation.height + theight) <= screen_height)
893         ty += widget->allocation.height;
894       else if ((ty - theight) >= 0)
895         ty -= theight;
896       else if (screen_height - (ty + widget->allocation.height) > ty)
897         ty += widget->allocation.height;
898       else
899         ty -= theight;
900       break;
901
902     case GTK_LEFT_RIGHT:
903       menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
904       parent_menu_item = GTK_MENU (widget->parent)->parent_menu_item;
905       if (parent_menu_item)
906         menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
907
908       switch (menu_item->submenu_direction)
909         {
910         case GTK_DIRECTION_LEFT:
911           if ((tx - twidth) >= 0)
912             tx -= twidth;
913           else
914             {
915               menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
916               tx += widget->allocation.width - 5;
917             }
918           break;
919
920         case GTK_DIRECTION_RIGHT:
921           if ((tx + widget->allocation.width + twidth - 5) <= screen_width)
922             tx += widget->allocation.width - 5;
923           else
924             {
925               menu_item->submenu_direction = GTK_DIRECTION_LEFT;
926               tx -= twidth;
927             }
928           break;
929         }
930
931       ty += widget->allocation.height / 4;
932
933       /* If the height of the menu doesn't fit we move it upward. */
934       ty = CLAMP (ty, 0, MAX (0, screen_height - theight));
935       break;
936     }
937
938   /* If we have negative, tx, here it is because we can't get
939    * the menu all the way on screen. Favor the left portion.
940    */
941   *x = CLAMP (tx, 0, MAX (0, screen_width - twidth));
942   *y = ty;
943 }
944
945 /**
946  * gtk_menu_item_set_right_justified:
947  * @menu_item: a #GtkMenuItem.
948  * @right_justified: if %TRUE the menu item will appear at the 
949  *   far right if added to a menu bar.
950  * 
951  * Sets whether the menu item appears justified at the right
952  * side of a menu bar. This was traditionally done for "Help" menu
953  * items, but is now considered a bad idea. (If the widget
954  * layout is reversed for a right-to-left language like Hebrew
955  * or Arabic, right-justified-menu-items appear at the left.)
956  **/
957 void
958 gtk_menu_item_set_right_justified (GtkMenuItem *menu_item,
959                                    gboolean     right_justified)
960 {
961   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
962
963   right_justified = right_justified != FALSE;
964
965   if (right_justified != menu_item->right_justify)
966     {
967       menu_item->right_justify = right_justified;
968       gtk_widget_queue_resize (GTK_WIDGET (menu_item));
969     }
970 }
971
972 /**
973  * gtk_menu_item_get_right_justified:
974  * @menu_item: a #GtkMenuItem
975  * 
976  * Gets whether the menu item appears justified at the right
977  * side of the menu bar.
978  * 
979  * Return value: %TRUE if the menu item will appear at the
980  *   far right if added to a menu bar.
981  **/
982 gboolean
983 gtk_menu_item_get_right_justified (GtkMenuItem *menu_item)
984 {
985   g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), FALSE);
986   
987   return menu_item->right_justify;
988 }
989
990
991 static void
992 gtk_menu_item_show_all (GtkWidget *widget)
993 {
994   GtkMenuItem *menu_item;
995
996   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
997
998   menu_item = GTK_MENU_ITEM (widget);
999
1000   /* show children including submenu */
1001   if (menu_item->submenu)
1002     gtk_widget_show_all (menu_item->submenu);
1003   gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
1004
1005   gtk_widget_show (widget);
1006 }
1007
1008 static void
1009 gtk_menu_item_hide_all (GtkWidget *widget)
1010 {
1011   GtkMenuItem *menu_item;
1012
1013   g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1014
1015   gtk_widget_hide (widget);
1016
1017   menu_item = GTK_MENU_ITEM (widget);
1018
1019   /* hide children including submenu */
1020   gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
1021   if (menu_item->submenu)
1022     gtk_widget_hide_all (menu_item->submenu);
1023 }
1024
1025 static void
1026 gtk_menu_item_accel_name_foreach (GtkWidget *widget,
1027                                   gpointer data)
1028 {
1029   const gchar **path_p = data;
1030
1031   if (!*path_p)
1032     {
1033       if (GTK_IS_LABEL (widget))
1034         {
1035           *path_p = gtk_label_get_text (GTK_LABEL (widget));
1036           if (*path_p && (*path_p)[0] == 0)
1037             *path_p = NULL;
1038         }
1039       else if (GTK_IS_CONTAINER (widget))
1040         gtk_container_foreach (GTK_CONTAINER (widget),
1041                                gtk_menu_item_accel_name_foreach,
1042                                data);
1043     }
1044 }
1045
1046 static void
1047 gtk_menu_item_parent_set (GtkWidget *widget,
1048                           GtkWidget *previous_parent)
1049 {
1050   GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
1051   GtkMenu *menu = GTK_IS_MENU (widget->parent) ? GTK_MENU (widget->parent) : NULL;
1052
1053   if (menu)
1054     _gtk_menu_item_refresh_accel_path (menu_item,
1055                                        menu->accel_path,
1056                                        menu->accel_group,
1057                                        TRUE);
1058
1059   if (GTK_WIDGET_CLASS (parent_class)->parent_set)
1060     GTK_WIDGET_CLASS (parent_class)->parent_set (widget, previous_parent);
1061 }
1062
1063 void
1064 _gtk_menu_item_refresh_accel_path (GtkMenuItem   *menu_item,
1065                                    const gchar   *prefix,
1066                                    GtkAccelGroup *accel_group,
1067                                    gboolean       group_changed)
1068 {
1069   const gchar *path;
1070   GtkWidget *widget;
1071
1072   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1073   g_return_if_fail (!accel_group || GTK_IS_ACCEL_GROUP (accel_group));
1074
1075   widget = GTK_WIDGET (menu_item);
1076
1077   if (!accel_group)
1078     {
1079       gtk_widget_set_accel_path (widget, NULL, NULL);
1080       return;
1081     }
1082
1083   path = _gtk_widget_get_accel_path (widget);
1084   if (!path)                                    /* no active accel_path yet */
1085     {
1086       path = menu_item->accel_path;
1087       if (!path && prefix)
1088         {
1089           gchar *postfix = NULL;
1090
1091           /* try to construct one from label text */
1092           gtk_container_foreach (GTK_CONTAINER (menu_item),
1093                                  gtk_menu_item_accel_name_foreach,
1094                                  &postfix);
1095           menu_item->accel_path = postfix ? g_strconcat (prefix, "/", postfix, NULL) : NULL;
1096           path = menu_item->accel_path;
1097         }
1098       if (path)
1099         gtk_widget_set_accel_path (widget, path, accel_group);
1100     }
1101   else if (group_changed)                       /* reinstall accelerators */
1102     gtk_widget_set_accel_path (widget, path, accel_group);
1103 }
1104
1105 /**
1106  * gtk_menu_item_set_accel_path
1107  * @menu_item:  a valid #GtkMenuItem
1108  * @accel_path: accelerator path, corresponding to this menu item's functionality
1109  *
1110  * Set the accelerator path on @menu_item, through which runtime changes of the
1111  * menu item's accelerator caused by the user can be identified and saved to
1112  * persistant storage (see gtk_accel_map_save() on this).
1113  * To setup a default accelerator for this menu item, call
1114  * gtk_accel_map_add_entry() with the same @accel_path.
1115  * See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
1116  * and gtk_menu_set_accel_path() for a more convenient variant of this function.
1117  *
1118  * This function is basically a convenience wrapper that handles calling
1119  * gtk_widget_set_accel_path() with the appropriate accelerator group for
1120  * the menu item.
1121  */
1122 void
1123 gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,
1124                               const gchar *accel_path)
1125 {
1126   GtkWidget *widget;
1127
1128   g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1129   g_return_if_fail (accel_path && accel_path[0] == '<' && strchr (accel_path, '/'));
1130
1131   widget = GTK_WIDGET (menu_item);
1132
1133   /* store new path */
1134   g_free (menu_item->accel_path);
1135   menu_item->accel_path = g_strdup (accel_path);
1136
1137   /* forget accelerators associated with old path */
1138   gtk_widget_set_accel_path (widget, NULL, NULL);
1139
1140   /* install accelerators associated with new path */
1141   if (widget->parent && GTK_IS_MENU (widget->parent))
1142     {
1143       GtkMenu *menu = GTK_MENU (widget->parent);
1144
1145       if (menu->accel_group)
1146         _gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
1147                                            NULL,
1148                                            menu->accel_group,
1149                                            FALSE);
1150     }
1151 }
1152
1153 static void
1154 gtk_menu_item_forall (GtkContainer *container,
1155                       gboolean      include_internals,
1156                       GtkCallback   callback,
1157                       gpointer      callback_data)
1158 {
1159   GtkBin *bin;
1160   GtkMenuItem *menu_item;
1161
1162   g_return_if_fail (GTK_IS_MENU_ITEM (container));
1163   g_return_if_fail (callback != NULL);
1164
1165   bin = GTK_BIN (container);
1166   menu_item = GTK_MENU_ITEM (container);
1167
1168   if (bin->child)
1169     callback (bin->child, callback_data);
1170 }
1171
1172 gboolean
1173 _gtk_menu_item_is_selectable (GtkWidget *menu_item)
1174 {
1175   if ((!GTK_BIN (menu_item)->child &&
1176        G_OBJECT_TYPE (menu_item) == GTK_TYPE_MENU_ITEM) ||
1177       GTK_IS_SEPARATOR_MENU_ITEM (menu_item) ||
1178       !GTK_WIDGET_IS_SENSITIVE (menu_item) ||
1179       !GTK_WIDGET_VISIBLE (menu_item))
1180     return FALSE;
1181
1182   return TRUE;
1183 }