gtkmenuitem.c 30.2 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27
#include <string.h>
Tim Janik's avatar
Tim Janik committed
28
#include "gtkaccellabel.h"
Elliot Lee's avatar
Elliot Lee committed
29
#include "gtkmain.h"
30
#include "gtkmarshalers.h"
Elliot Lee's avatar
Elliot Lee committed
31
#include "gtkmenu.h"
32
#include "gtkmenubar.h"
Elliot Lee's avatar
Elliot Lee committed
33 34 35 36 37
#include "gtkmenuitem.h"
#include "gtksignal.h"


#define BORDER_SPACING  3
38
#define SELECT_TIMEOUT  75
Elliot Lee's avatar
Elliot Lee committed
39 40 41 42 43 44

#define MENU_ITEM_CLASS(w)  GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)


enum {
  ACTIVATE,
45
  ACTIVATE_ITEM,
46 47
  TOGGLE_SIZE_REQUEST,
  TOGGLE_SIZE_ALLOCATE,
Elliot Lee's avatar
Elliot Lee committed
48 49 50 51 52 53 54
  LAST_SIGNAL
};


static void gtk_menu_item_class_init     (GtkMenuItemClass *klass);
static void gtk_menu_item_init           (GtkMenuItem      *menu_item);
static void gtk_menu_item_destroy        (GtkObject        *object);
55
static void gtk_menu_item_finalize       (GObject          *object);
Elliot Lee's avatar
Elliot Lee committed
56 57 58 59
static void gtk_menu_item_size_request   (GtkWidget        *widget,
					  GtkRequisition   *requisition);
static void gtk_menu_item_size_allocate  (GtkWidget        *widget,
					  GtkAllocation    *allocation);
60 61 62 63
static void gtk_menu_item_realize        (GtkWidget        *widget);
static void gtk_menu_item_unrealize      (GtkWidget        *widget);
static void gtk_menu_item_map            (GtkWidget        *widget);
static void gtk_menu_item_unmap          (GtkWidget        *widget);
Elliot Lee's avatar
Elliot Lee committed
64 65 66 67
static void gtk_menu_item_paint          (GtkWidget        *widget,
					  GdkRectangle     *area);
static gint gtk_menu_item_expose         (GtkWidget        *widget,
					  GdkEventExpose   *event);
68

69

70 71 72 73
static void gtk_real_menu_item_select               (GtkItem     *item);
static void gtk_real_menu_item_deselect             (GtkItem     *item);
static void gtk_real_menu_item_activate_item        (GtkMenuItem *item);
static void gtk_real_menu_item_toggle_size_request  (GtkMenuItem *menu_item,
74
						     gint        *requisition);
75
static void gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
76
						     gint         allocation);
77
static gboolean gtk_menu_item_mnemonic_activate     (GtkWidget   *widget,
78
						     gboolean     group_cycling);
79

Elliot Lee's avatar
Elliot Lee committed
80
static gint gtk_menu_item_select_timeout (gpointer          data);
81
static void gtk_menu_item_popup_submenu  (gpointer     data);
Elliot Lee's avatar
Elliot Lee committed
82 83 84
static void gtk_menu_item_position_menu  (GtkMenu          *menu,
					  gint             *x,
					  gint             *y,
85
					  gboolean         *push_in,
Elliot Lee's avatar
Elliot Lee committed
86
					  gpointer          user_data);
87 88
static void gtk_menu_item_show_all       (GtkWidget        *widget);
static void gtk_menu_item_hide_all       (GtkWidget        *widget);
89 90 91 92
static void gtk_menu_item_forall         (GtkContainer    *container,
					  gboolean         include_internals,
					  GtkCallback      callback,
					  gpointer         callback_data);
Elliot Lee's avatar
Elliot Lee committed
93

94

Elliot Lee's avatar
Elliot Lee committed
95
static GtkItemClass *parent_class;
96
static guint menu_item_signals[LAST_SIGNAL] = { 0 };
97 98
static guint32	last_submenu_deselect_time = 0;

Elliot Lee's avatar
Elliot Lee committed
99 100


Tim Janik's avatar
Tim Janik committed
101
GtkType
102
gtk_menu_item_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
103
{
Tim Janik's avatar
Tim Janik committed
104
  static GtkType menu_item_type = 0;
Elliot Lee's avatar
Elliot Lee committed
105 106 107

  if (!menu_item_type)
    {
108
      static const GTypeInfo menu_item_info =
Elliot Lee's avatar
Elliot Lee committed
109 110
      {
	sizeof (GtkMenuItemClass),
111 112 113 114 115 116 117 118
	NULL,           /* base_init */
	NULL,           /* base_finalize */
	(GClassInitFunc) gtk_menu_item_class_init,
	NULL,           /* class_finalize */
	NULL,           /* class_data */
	sizeof (GtkMenuItem),
	16,             /* n_preallocs */
	(GInstanceInitFunc) gtk_menu_item_init,
Elliot Lee's avatar
Elliot Lee committed
119 120
      };

121
      menu_item_type = g_type_register_static (GTK_TYPE_ITEM, "GtkMenuItem", &menu_item_info, 0);
Elliot Lee's avatar
Elliot Lee committed
122 123 124 125 126 127 128 129
    }

  return menu_item_type;
}

static void
gtk_menu_item_class_init (GtkMenuItemClass *klass)
{
130 131 132 133 134
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
  GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
  GtkItemClass *item_class = GTK_ITEM_CLASS (klass);
Elliot Lee's avatar
Elliot Lee committed
135

136
  parent_class = g_type_class_peek_parent (klass);
Elliot Lee's avatar
Elliot Lee committed
137

138
  gobject_class->finalize = gtk_menu_item_finalize;
139 140 141 142 143 144

  object_class->destroy = gtk_menu_item_destroy;

  widget_class->size_request = gtk_menu_item_size_request;
  widget_class->size_allocate = gtk_menu_item_size_allocate;
  widget_class->expose_event = gtk_menu_item_expose;
145 146 147 148
  widget_class->realize = gtk_menu_item_realize;
  widget_class->unrealize = gtk_menu_item_unrealize;
  widget_class->map = gtk_menu_item_map;
  widget_class->unmap = gtk_menu_item_unmap;
149 150
  widget_class->show_all = gtk_menu_item_show_all;
  widget_class->hide_all = gtk_menu_item_hide_all;
151
  widget_class->mnemonic_activate = gtk_menu_item_mnemonic_activate;
152
  
153 154 155 156 157 158 159 160 161 162 163 164
  container_class->forall = gtk_menu_item_forall;

  item_class->select = gtk_real_menu_item_select;
  item_class->deselect = gtk_real_menu_item_deselect;

  klass->activate = NULL;
  klass->activate_item = gtk_real_menu_item_activate_item;
  klass->toggle_size_request = gtk_real_menu_item_toggle_size_request;
  klass->toggle_size_allocate = gtk_real_menu_item_toggle_size_allocate;

  klass->hide_on_activate = TRUE;

Elliot Lee's avatar
Elliot Lee committed
165 166
  menu_item_signals[ACTIVATE] =
    gtk_signal_new ("activate",
167
                    GTK_RUN_FIRST | GTK_RUN_ACTION,
168
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
169
                    GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate),
170
                    _gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
171
		    GTK_TYPE_NONE, 0);
172
  widget_class->activate_signal = menu_item_signals[ACTIVATE];
Elliot Lee's avatar
Elliot Lee committed
173

174 175 176
  menu_item_signals[ACTIVATE_ITEM] =
    gtk_signal_new ("activate_item",
                    GTK_RUN_FIRST,
177
                    GTK_CLASS_TYPE (object_class),
178 179 180 181
                    GTK_SIGNAL_OFFSET (GtkMenuItemClass, activate_item),
                    gtk_signal_default_marshaller,
		    GTK_TYPE_NONE, 0);

182 183 184 185 186
  menu_item_signals[TOGGLE_SIZE_REQUEST] =
    gtk_signal_new ("toggle_size_request",
                    GTK_RUN_FIRST,
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkMenuItemClass, toggle_size_request),
187
                    _gtk_marshal_NONE__POINTER,
188 189 190 191 192 193 194 195
		    GTK_TYPE_NONE, 1,
		    GTK_TYPE_POINTER);

  menu_item_signals[TOGGLE_SIZE_ALLOCATE] =
    gtk_signal_new ("toggle_size_allocate",
                    GTK_RUN_FIRST,
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkMenuItemClass, toggle_size_allocate),
196
                    _gtk_marshal_NONE__INT,
197
		    GTK_TYPE_NONE, 1,
198
		    GTK_TYPE_INT);
Elliot Lee's avatar
Elliot Lee committed
199 200 201 202 203
}

static void
gtk_menu_item_init (GtkMenuItem *menu_item)
{
204 205
  GTK_WIDGET_SET_FLAGS (menu_item, GTK_NO_WINDOW);
  
Elliot Lee's avatar
Elliot Lee committed
206 207
  menu_item->submenu = NULL;
  menu_item->toggle_size = 0;
208
  menu_item->accelerator_width = 0;
Elliot Lee's avatar
Elliot Lee committed
209 210 211 212 213 214 215 216 217
  menu_item->show_submenu_indicator = FALSE;
  menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
  menu_item->submenu_placement = GTK_TOP_BOTTOM;
  menu_item->right_justify = FALSE;

  menu_item->timer = 0;
}

GtkWidget*
218
gtk_menu_item_new (void)
Elliot Lee's avatar
Elliot Lee committed
219 220 221 222 223 224 225 226
{
  return GTK_WIDGET (gtk_type_new (gtk_menu_item_get_type ()));
}

GtkWidget*
gtk_menu_item_new_with_label (const gchar *label)
{
  GtkWidget *menu_item;
Tim Janik's avatar
Tim Janik committed
227
  GtkWidget *accel_label;
Elliot Lee's avatar
Elliot Lee committed
228 229

  menu_item = gtk_menu_item_new ();
Tim Janik's avatar
Tim Janik committed
230 231
  accel_label = gtk_accel_label_new (label);
  gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
Elliot Lee's avatar
Elliot Lee committed
232

Tim Janik's avatar
Tim Janik committed
233 234 235
  gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
  gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
  gtk_widget_show (accel_label);
Elliot Lee's avatar
Elliot Lee committed
236 237 238 239

  return menu_item;
}

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

/**
 * gtk_menu_item_new_with_mnemonic:
 * @label: The text of the button, with an underscore in front of the
 *         mnemonic character
 * @returns: a new #GtkMenuItem
 *
 * Creates a new #GtkMenuItem containing a label. The label
 * will be created using gtk_label_new_with_mnemonic(), so underscores
 * in @label indicate the mnemonic for the menu item.
 **/
GtkWidget*
gtk_menu_item_new_with_mnemonic (const gchar *label)
{
  GtkWidget *menu_item;
  GtkWidget *accel_label;

  menu_item = gtk_menu_item_new ();
  accel_label = gtk_type_new (GTK_TYPE_ACCEL_LABEL);
  gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
  gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);

  gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
  gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
  gtk_widget_show (accel_label);

  return menu_item;
}

Elliot Lee's avatar
Elliot Lee committed
269 270 271 272 273 274 275 276 277 278
static void
gtk_menu_item_destroy (GtkObject *object)
{
  GtkMenuItem *menu_item;

  g_return_if_fail (GTK_IS_MENU_ITEM (object));

  menu_item = GTK_MENU_ITEM (object);

  if (menu_item->submenu)
279
    gtk_widget_destroy (menu_item->submenu);
Elliot Lee's avatar
Elliot Lee committed
280

281 282 283 284 285 286 287 288 289 290 291
  GTK_OBJECT_CLASS (parent_class)->destroy (object);
}

static void
gtk_menu_item_finalize (GObject *object)
{
  GtkMenuItem *menu_item = GTK_MENU_ITEM (object);

  g_free (menu_item->accel_path);

  G_OBJECT_CLASS (parent_class)->finalize (object);
Elliot Lee's avatar
Elliot Lee committed
292 293
}

294 295 296 297 298 299 300 301 302 303 304 305 306 307
static void
gtk_menu_item_detacher (GtkWidget     *widget,
			GtkMenu       *menu)
{
  GtkMenuItem *menu_item;

  g_return_if_fail (GTK_IS_MENU_ITEM (widget));

  menu_item = GTK_MENU_ITEM (widget);
  g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);

  menu_item->submenu = NULL;
}

Elliot Lee's avatar
Elliot Lee committed
308 309 310 311 312
void
gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
			   GtkWidget   *submenu)
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
313
  
314
  if (menu_item->submenu != submenu)
Elliot Lee's avatar
Elliot Lee committed
315
    {
316 317
      gtk_menu_item_remove_submenu (menu_item);
      
318
      menu_item->submenu = submenu;
319 320 321 322
      gtk_menu_attach_to_widget (GTK_MENU (submenu),
				 GTK_WIDGET (menu_item),
				 gtk_menu_item_detacher);
      
323 324
      if (GTK_WIDGET (menu_item)->parent)
	gtk_widget_queue_resize (GTK_WIDGET (menu_item));
Elliot Lee's avatar
Elliot Lee committed
325 326 327
    }
}

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
/**
 * gtk_menu_item_get_submenu:
 * @menu_item: a #GtkMenuItem
 *
 * Gets the submenu underneath this menu item, if any. See
 * gtk_menu_item_set_submenu().
 *
 * Return value: submenu for this menu item, or %NULL if none.
 **/
GtkWidget *
gtk_menu_item_get_submenu (GtkMenuItem *menu_item)
{
  g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), NULL);

  return menu_item->submenu;
}

345 346 347 348 349 350 351 352 353
void
gtk_menu_item_remove_submenu (GtkMenuItem         *menu_item)
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
      
  if (menu_item->submenu)
    gtk_menu_detach (GTK_MENU (menu_item->submenu));
}

Elliot Lee's avatar
Elliot Lee committed
354
void
Owen Taylor's avatar
Owen Taylor committed
355
_gtk_menu_item_set_placement (GtkMenuItem         *menu_item,
Elliot Lee's avatar
Elliot Lee committed
356 357 358 359 360 361 362 363 364 365
			     GtkSubmenuPlacement  placement)
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  menu_item->submenu_placement = placement;
}

void
gtk_menu_item_select (GtkMenuItem *menu_item)
{
366 367
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
  
Elliot Lee's avatar
Elliot Lee committed
368 369 370 371 372 373
  gtk_item_select (GTK_ITEM (menu_item));
}

void
gtk_menu_item_deselect (GtkMenuItem *menu_item)
{
374 375
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
  
Elliot Lee's avatar
Elliot Lee committed
376 377 378 379 380 381
  gtk_item_deselect (GTK_ITEM (menu_item));
}

void
gtk_menu_item_activate (GtkMenuItem *menu_item)
{
382 383
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
  
Elliot Lee's avatar
Elliot Lee committed
384 385 386
  gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[ACTIVATE]);
}

387 388
void
gtk_menu_item_toggle_size_request (GtkMenuItem *menu_item,
389
				   gint        *requisition)
390 391 392 393 394 395 396 397
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[TOGGLE_SIZE_REQUEST], requisition);
}

void
gtk_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
398
				    gint         allocation)
399 400 401 402 403 404
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  gtk_signal_emit (GTK_OBJECT (menu_item), menu_item_signals[TOGGLE_SIZE_ALLOCATE], allocation);
}

405 406 407 408 409 410 411 412 413 414
static void
gtk_menu_item_accel_width_foreach (GtkWidget *widget,
				   gpointer data)
{
  guint *width = data;

  if (GTK_IS_ACCEL_LABEL (widget))
    {
      guint w;

415
      w = gtk_accel_label_get_accel_width (GTK_ACCEL_LABEL (widget));
416 417 418 419 420 421 422
      *width = MAX (*width, w);
    }
  else if (GTK_IS_CONTAINER (widget))
    gtk_container_foreach (GTK_CONTAINER (widget),
			   gtk_menu_item_accel_width_foreach,
			   data);
}
Elliot Lee's avatar
Elliot Lee committed
423 424 425 426 427

static void
gtk_menu_item_size_request (GtkWidget      *widget,
			    GtkRequisition *requisition)
{
Tim Janik's avatar
Tim Janik committed
428
  GtkMenuItem *menu_item;
Elliot Lee's avatar
Elliot Lee committed
429
  GtkBin *bin;
430
  guint accel_width;
Elliot Lee's avatar
Elliot Lee committed
431 432 433 434 435

  g_return_if_fail (GTK_IS_MENU_ITEM (widget));
  g_return_if_fail (requisition != NULL);

  bin = GTK_BIN (widget);
Tim Janik's avatar
Tim Janik committed
436
  menu_item = GTK_MENU_ITEM (widget);
Elliot Lee's avatar
Elliot Lee committed
437 438

  requisition->width = (GTK_CONTAINER (widget)->border_width +
439
			widget->style->xthickness +
Elliot Lee's avatar
Elliot Lee committed
440 441
			BORDER_SPACING) * 2;
  requisition->height = (GTK_CONTAINER (widget)->border_width +
442
			 widget->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
443 444 445

  if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
    {
446 447 448
      GtkRequisition child_requisition;
      
      gtk_widget_size_request (bin->child, &child_requisition);
Elliot Lee's avatar
Elliot Lee committed
449

450 451
      requisition->width += child_requisition.width;
      requisition->height += child_requisition.height;
Elliot Lee's avatar
Elliot Lee committed
452
    }
453

Tim Janik's avatar
Tim Janik committed
454 455
  if (menu_item->submenu && menu_item->show_submenu_indicator)
    requisition->width += 21;
456 457 458 459 460 461

  accel_width = 0;
  gtk_container_foreach (GTK_CONTAINER (menu_item),
			 gtk_menu_item_accel_width_foreach,
			 &accel_width);
  menu_item->accelerator_width = accel_width;
Elliot Lee's avatar
Elliot Lee committed
462 463 464 465 466 467
}

static void
gtk_menu_item_size_allocate (GtkWidget     *widget,
			     GtkAllocation *allocation)
{
Tim Janik's avatar
Tim Janik committed
468
  GtkMenuItem *menu_item;
Elliot Lee's avatar
Elliot Lee committed
469 470 471 472 473 474
  GtkBin *bin;
  GtkAllocation child_allocation;

  g_return_if_fail (GTK_IS_MENU_ITEM (widget));
  g_return_if_fail (allocation != NULL);

Tim Janik's avatar
Tim Janik committed
475
  menu_item = GTK_MENU_ITEM (widget);
Elliot Lee's avatar
Elliot Lee committed
476
  bin = GTK_BIN (widget);
Tim Janik's avatar
Tim Janik committed
477 478
  
  widget->allocation = *allocation;
Elliot Lee's avatar
Elliot Lee committed
479 480 481 482

  if (bin->child)
    {
      child_allocation.x = (GTK_CONTAINER (widget)->border_width +
483
                            widget->style->xthickness +
Elliot Lee's avatar
Elliot Lee committed
484
			    BORDER_SPACING);
Owen Taylor's avatar
Owen Taylor committed
485
      child_allocation.y = (GTK_CONTAINER (widget)->border_width +
486
			    widget->style->ythickness);
487 488
      child_allocation.width = MAX (1, (gint)allocation->width - child_allocation.x * 2);
      child_allocation.height = MAX (1, (gint)allocation->height - child_allocation.y * 2);
Elliot Lee's avatar
Elliot Lee committed
489
      child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
Tim Janik's avatar
Tim Janik committed
490
      child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
491 492 493
      child_allocation.x += widget->allocation.x;
      child_allocation.y += widget->allocation.y;
      
Tim Janik's avatar
Tim Janik committed
494 495 496
      if (menu_item->submenu && menu_item->show_submenu_indicator)
	child_allocation.width -= 21;
      
Elliot Lee's avatar
Elliot Lee committed
497 498 499
      gtk_widget_size_allocate (bin->child, &child_allocation);
    }

Tim Janik's avatar
Tim Janik committed
500
  if (GTK_WIDGET_REALIZED (widget))
501
    gdk_window_move_resize (menu_item->event_window,
Tim Janik's avatar
Tim Janik committed
502 503
                            allocation->x, allocation->y,
                            allocation->width, allocation->height);
Elliot Lee's avatar
Elliot Lee committed
504

Tim Janik's avatar
Tim Janik committed
505 506
  if (menu_item->submenu)
    gtk_menu_reposition (GTK_MENU (menu_item->submenu));
Elliot Lee's avatar
Elliot Lee committed
507 508
}

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
static void
gtk_menu_item_realize (GtkWidget *widget)
{
  GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
  GdkWindowAttr attributes;
  gint attributes_mask;

  GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);

  widget->window = gtk_widget_get_parent_window (widget);
  gdk_window_ref (widget->window);
  
  attributes.x = widget->allocation.x;
  attributes.y = widget->allocation.y;
  attributes.width = widget->allocation.width;
  attributes.height = widget->allocation.height;
  attributes.window_type = GDK_WINDOW_CHILD;
  attributes.wclass = GDK_INPUT_ONLY;
  attributes.event_mask = (gtk_widget_get_events (widget) |
			   GDK_EXPOSURE_MASK |
			   GDK_BUTTON_PRESS_MASK |
			   GDK_BUTTON_RELEASE_MASK |
			   GDK_ENTER_NOTIFY_MASK |
			   GDK_LEAVE_NOTIFY_MASK |
			   GDK_POINTER_MOTION_MASK);

  attributes_mask = GDK_WA_X | GDK_WA_Y;
  menu_item->event_window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
  gdk_window_set_user_data (menu_item->event_window, widget);

  widget->style = gtk_style_attach (widget->style, widget->window);
}

static void
gtk_menu_item_unrealize (GtkWidget *widget)
{
  GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);

  gdk_window_set_user_data (menu_item->event_window, NULL);
  gdk_window_destroy (menu_item->event_window);
  menu_item->event_window = NULL;
  
  if (GTK_WIDGET_CLASS (parent_class)->unrealize)
    (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
}

static void
gtk_menu_item_map (GtkWidget *widget)
{
  GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
  
  gdk_window_show (menu_item->event_window);

  GTK_WIDGET_CLASS (parent_class)->map (widget);
}

static void
gtk_menu_item_unmap (GtkWidget *widget)
{
  GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
    
  gdk_window_hide (menu_item->event_window);

  GTK_WIDGET_CLASS (parent_class)->unmap (widget);
}

Elliot Lee's avatar
Elliot Lee committed
575 576 577 578 579 580 581 582 583
static void
gtk_menu_item_paint (GtkWidget    *widget,
		     GdkRectangle *area)
{
  GtkMenuItem *menu_item;
  GtkStateType state_type;
  GtkShadowType shadow_type;
  gint width, height;
  gint x, y;
584
  gint border_width = GTK_CONTAINER (widget)->border_width;
Elliot Lee's avatar
Elliot Lee committed
585 586 587 588 589 590 591

  if (GTK_WIDGET_DRAWABLE (widget))
    {
      menu_item = GTK_MENU_ITEM (widget);

      state_type = widget->state;

592 593 594 595
      x = widget->allocation.x + border_width;
      y = widget->allocation.y + border_width;
      width = widget->allocation.width - border_width * 2;
      height = widget->allocation.height - border_width * 2;
596
      
Elliot Lee's avatar
Elliot Lee committed
597 598
      if ((state_type == GTK_STATE_PRELIGHT) &&
	  (GTK_BIN (menu_item)->child))
599 600 601 602 603 604
	gtk_paint_box (widget->style,
		       widget->window,
		       GTK_STATE_PRELIGHT,
		       GTK_SHADOW_OUT,
		       area, widget, "menuitem",
		       x, y, width, height);
Elliot Lee's avatar
Elliot Lee committed
605

Tim Janik's avatar
Tim Janik committed
606
      if (menu_item->submenu && menu_item->show_submenu_indicator)
Elliot Lee's avatar
Elliot Lee committed
607 608 609 610 611
	{
	  shadow_type = GTK_SHADOW_OUT;
	  if (state_type == GTK_STATE_PRELIGHT)
	    shadow_type = GTK_SHADOW_IN;

612 613 614 615 616
	  gtk_paint_arrow (widget->style, widget->window,
			   state_type, shadow_type, 
			   area, widget, "menuitem", 
			   GTK_ARROW_RIGHT, TRUE,
			   x + width - 15, y + height / 2 - 5, 10, 10);
Elliot Lee's avatar
Elliot Lee committed
617 618 619
	}
      else if (!GTK_BIN (menu_item)->child)
	{
620 621
	   gtk_paint_hline (widget->style, widget->window, GTK_STATE_NORMAL,
			    area, widget, "menuitem",
622 623
			    widget->allocation.x, widget->allocation.width,
			    widget->allocation.y);
Elliot Lee's avatar
Elliot Lee committed
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
	}
    }
}

static gint
gtk_menu_item_expose (GtkWidget      *widget,
		      GdkEventExpose *event)
{
  g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  if (GTK_WIDGET_DRAWABLE (widget))
    {
      gtk_menu_item_paint (widget, &event->area);

639
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653
    }

  return FALSE;
}

static void
gtk_real_menu_item_select (GtkItem *item)
{
  GtkMenuItem *menu_item;

  g_return_if_fail (GTK_IS_MENU_ITEM (item));

  menu_item = GTK_MENU_ITEM (item);

654 655 656
  /*  if (menu_item->submenu && !GTK_WIDGET_VISIBLE (menu_item->submenu))*/
  if (menu_item->submenu)
    {
657 658 659 660 661 662 663 664 665
      guint32 etime;
      GdkEvent *event = gtk_get_current_event ();

      etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
      if (etime >= last_submenu_deselect_time &&
	  last_submenu_deselect_time + SELECT_TIMEOUT > etime)
	menu_item->timer = gtk_timeout_add (SELECT_TIMEOUT - (etime - last_submenu_deselect_time),
					    gtk_menu_item_select_timeout,
					    menu_item);
666
      else
667
	gtk_menu_item_popup_submenu (menu_item);
668 669
      if (event)
	gdk_event_free(event);
670
    }
671
  
Elliot Lee's avatar
Elliot Lee committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
  gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
}

static void
gtk_real_menu_item_deselect (GtkItem *item)
{
  GtkMenuItem *menu_item;

  g_return_if_fail (GTK_IS_MENU_ITEM (item));

  menu_item = GTK_MENU_ITEM (item);

  if (menu_item->submenu)
    {
687 688 689
      guint32 etime;
      GdkEvent *event = gtk_get_current_event ();

Elliot Lee's avatar
Elliot Lee committed
690
      if (menu_item->timer)
691 692 693 694
	{
	  gtk_timeout_remove (menu_item->timer);
	  menu_item->timer = 0;
	}
Elliot Lee's avatar
Elliot Lee committed
695 696
      else
	gtk_menu_popdown (GTK_MENU (menu_item->submenu));
697 698 699 700

      etime = event ? gdk_event_get_time (event) : GDK_CURRENT_TIME;
      if (etime > last_submenu_deselect_time)
	last_submenu_deselect_time = etime;
701 702
      if (event)
	gdk_event_free(event);
Elliot Lee's avatar
Elliot Lee committed
703 704 705 706 707 708
    }

  gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
  gtk_widget_draw (GTK_WIDGET (menu_item), NULL);
}

709
static gboolean
710
gtk_menu_item_mnemonic_activate (GtkWidget *widget,
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
				 gboolean   group_cycling)
{
  if (group_cycling)
    {
      if (widget->parent &&
	  GTK_IS_MENU_SHELL (widget->parent))
	gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent),
				    widget);

    }
  else
    gtk_signal_emit (GTK_OBJECT (widget), menu_item_signals[ACTIVATE_ITEM]);
  
  return TRUE;
}


728 729 730 731
static void
gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
{
  GtkWidget *widget;
732
  GtkMenuShell *submenu; 
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754

  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  widget = GTK_WIDGET (menu_item);
  
  if (widget->parent &&
      GTK_IS_MENU_SHELL (widget->parent))
    {
      if (menu_item->submenu == NULL)
	gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
				      widget, TRUE);
      else
	{
	  GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);

	  if (!menu_shell->active)
	    {
	      gtk_grab_add (GTK_WIDGET (menu_shell));
	      menu_shell->have_grab = TRUE;
	      menu_shell->active = TRUE;
	    }

755 756 757 758 759 760
	  gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget); 
	  gtk_menu_item_popup_submenu (widget); 

	  submenu = GTK_MENU_SHELL (menu_item->submenu);
	  if (submenu->children)
	    gtk_menu_shell_select_item (submenu, submenu->children->data);
761 762 763
	}
    }
}
764 765
static void
gtk_real_menu_item_toggle_size_request (GtkMenuItem *menu_item,
766
					gint        *requisition)
767 768 769 770 771 772 773 774
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  *requisition = 0;
}

static void
gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
775
					 gint         allocation)
776 777 778 779 780
{
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  menu_item->toggle_size = allocation;
}
781

Elliot Lee's avatar
Elliot Lee committed
782 783 784
static gint
gtk_menu_item_select_timeout (gpointer data)
{
785
  GDK_THREADS_ENTER ();
786

787
  gtk_menu_item_popup_submenu (data);
788 789 790 791 792 793 794

  GDK_THREADS_LEAVE ();

  return FALSE;  
}

static void
795
gtk_menu_item_popup_submenu (gpointer data)
796 797 798
{
  GtkMenuItem *menu_item;

Elliot Lee's avatar
Elliot Lee committed
799 800 801
  menu_item = GTK_MENU_ITEM (data);
  menu_item->timer = 0;

802
  if (GTK_WIDGET_IS_SENSITIVE (menu_item->submenu))
803
    {
804 805 806 807 808 809 810
      gtk_menu_popup (GTK_MENU (menu_item->submenu),
		      GTK_WIDGET (menu_item)->parent,
		      GTK_WIDGET (menu_item),
		      gtk_menu_item_position_menu,
		      menu_item,
		      GTK_MENU_SHELL (GTK_WIDGET (menu_item)->parent)->button,
		      0);
811
    }
Elliot Lee's avatar
Elliot Lee committed
812 813 814 815 816 817
}

static void
gtk_menu_item_position_menu (GtkMenu  *menu,
			     gint     *x,
			     gint     *y,
818
			     gboolean *push_in,
Elliot Lee's avatar
Elliot Lee committed
819 820 821
			     gpointer  user_data)
{
  GtkMenuItem *menu_item;
822
  GtkWidget *widget;
Tim Janik's avatar
Tim Janik committed
823
  GtkWidget *parent_menu_item;
Elliot Lee's avatar
Elliot Lee committed
824 825 826 827 828 829 830 831 832 833
  gint screen_width;
  gint screen_height;
  gint twidth, theight;
  gint tx, ty;

  g_return_if_fail (menu != NULL);
  g_return_if_fail (x != NULL);
  g_return_if_fail (y != NULL);

  menu_item = GTK_MENU_ITEM (user_data);
834
  widget = GTK_WIDGET (user_data);
Elliot Lee's avatar
Elliot Lee committed
835 836 837 838 839 840 841

  twidth = GTK_WIDGET (menu)->requisition.width;
  theight = GTK_WIDGET (menu)->requisition.height;

  screen_width = gdk_screen_width ();
  screen_height = gdk_screen_height ();

842
  if (!gdk_window_get_origin (widget->window, &tx, &ty))
Owen Taylor's avatar
Owen Taylor committed
843 844 845 846
    {
      g_warning ("Menu not on screen");
      return;
    }
Elliot Lee's avatar
Elliot Lee committed
847

848 849 850
  tx += widget->allocation.x;
  ty += widget->allocation.y;

Elliot Lee's avatar
Elliot Lee committed
851 852 853
  switch (menu_item->submenu_placement)
    {
    case GTK_TOP_BOTTOM:
854 855
      if ((ty + widget->allocation.height + theight) <= screen_height)
	ty += widget->allocation.height;
Elliot Lee's avatar
Elliot Lee committed
856 857
      else if ((ty - theight) >= 0)
	ty -= theight;
858 859
      else if (screen_height - (ty + widget->allocation.height) > ty)
	ty += widget->allocation.height;
860 861
      else
	ty -= theight;
Elliot Lee's avatar
Elliot Lee committed
862 863 864 865
      break;

    case GTK_LEFT_RIGHT:
      menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
866
      parent_menu_item = GTK_MENU (widget->parent)->parent_menu_item;
Elliot Lee's avatar
Elliot Lee committed
867
      if (parent_menu_item)
Tim Janik's avatar
Tim Janik committed
868
	menu_item->submenu_direction = GTK_MENU_ITEM (parent_menu_item)->submenu_direction;
Elliot Lee's avatar
Elliot Lee committed
869 870 871 872 873 874 875 876 877

      switch (menu_item->submenu_direction)
	{
	case GTK_DIRECTION_LEFT:
	  if ((tx - twidth) >= 0)
	    tx -= twidth;
	  else
	    {
	      menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
878
	      tx += widget->allocation.width - 5;
Elliot Lee's avatar
Elliot Lee committed
879 880 881 882
	    }
	  break;

	case GTK_DIRECTION_RIGHT:
883 884
	  if ((tx + widget->allocation.width + twidth - 5) <= screen_width)
	    tx += widget->allocation.width - 5;
Elliot Lee's avatar
Elliot Lee committed
885 886 887 888 889 890 891 892
	  else
	    {
	      menu_item->submenu_direction = GTK_DIRECTION_LEFT;
	      tx -= twidth;
	    }
	  break;
	}

893
      ty += widget->allocation.height / 4;
894

895 896
      /* If the height of the menu doesn't fit we move it upward. */
      ty = CLAMP (ty, 0, MAX (0, screen_height - theight));
Elliot Lee's avatar
Elliot Lee committed
897 898 899
      break;
    }

900 901
  /* If we have negative, tx, here it is because we can't get
   * the menu all the way on screen. Favor the left portion.
902 903
   */
  *x = CLAMP (tx, 0, MAX (0, screen_width - twidth));
904
  *y = ty;
Elliot Lee's avatar
Elliot Lee committed
905 906
}

907 908 909 910 911 912 913 914 915 916 917 918
/**
 * gtk_menu_item_set_right_justified:
 * @menu_item: a #GtkMenuItem.
 * @right_justified: if %TRUE the menu item will appear at the 
 *   far right if added to a menu bar.
 * 
 * Sets whether the menu item appears justified at the right
 * side of a menu bar. This was traditionally done for "Help" menu
 * items, but is now considered a bad idea. (If the widget
 * layout is reversed for a right-to-left language like Hebrew
 * or Arabic, right-justified-menu-items appear at the left.)
 **/
Elliot Lee's avatar
Elliot Lee committed
919
void
920 921
gtk_menu_item_set_right_justified (GtkMenuItem *menu_item,
				   gboolean     right_justified)
Elliot Lee's avatar
Elliot Lee committed
922
{
923 924 925
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  right_justified = right_justified != FALSE;
Elliot Lee's avatar
Elliot Lee committed
926

927 928 929
  if (right_justified != menu_item->right_justify)
    {
      menu_item->right_justify = right_justified;
930
      gtk_widget_queue_resize (GTK_WIDGET (menu_item));
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
    }
}

/**
 * gtk_menu_item_get_right_justified:
 * @menu_item: a #GtkMenuItem
 * 
 * Gets whether the menu item appears justified at the right
 * side of the menu bar.
 * 
 * Return value: %TRUE if the menu item will appear at the
 *   far right if added to a menu bar.
 **/
gboolean
gtk_menu_item_get_right_justified (GtkMenuItem *menu_item)
{
  g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), FALSE);
  
  return menu_item->right_justify;
Elliot Lee's avatar
Elliot Lee committed
950
}
951

952

953 954 955
static void
gtk_menu_item_show_all (GtkWidget *widget)
{
956
  GtkMenuItem *menu_item;
957 958

  g_return_if_fail (GTK_IS_MENU_ITEM (widget));
959

960 961
  menu_item = GTK_MENU_ITEM (widget);

962
  /* show children including submenu */
963 964
  if (menu_item->submenu)
    gtk_widget_show_all (menu_item->submenu);
965 966
  gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);

967 968 969 970 971 972
  gtk_widget_show (widget);
}

static void
gtk_menu_item_hide_all (GtkWidget *widget)
{
973
  GtkMenuItem *menu_item;
974 975 976 977

  g_return_if_fail (GTK_IS_MENU_ITEM (widget));

  gtk_widget_hide (widget);
978 979 980 981 982

  menu_item = GTK_MENU_ITEM (widget);

  /* hide children including submenu */
  gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
983 984
  if (menu_item->submenu)
    gtk_widget_hide_all (menu_item->submenu);
985 986
}

987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
static void
gtk_menu_item_accel_name_foreach (GtkWidget *widget,
				  gpointer data)
{
  const gchar **path_p = data;

  if (!*path_p)
    {
      if (GTK_IS_LABEL (widget))
	{
	  *path_p = gtk_label_get_text (GTK_LABEL (widget));
	  if (*path_p && (*path_p)[0] == 0)
	    *path_p = NULL;
	}
      else if (GTK_IS_CONTAINER (widget))
	gtk_container_foreach (GTK_CONTAINER (widget),
			       gtk_menu_item_accel_name_foreach,
			       data);
    }
}

void
_gtk_menu_item_refresh_accel_path (GtkMenuItem   *menu_item,
				   const gchar   *prefix,
				   GtkAccelGroup *accel_group,
				   gboolean       group_changed)
{
  const gchar *path;
  GtkWidget *widget;

  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
  g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));

  widget = GTK_WIDGET (menu_item);

  path = _gtk_widget_get_accel_path (widget);
  if (!path)					/* no active accel_path yet */
    {
      path = menu_item->accel_path;
      if (!path && prefix)
	{
	  gchar *postfix = NULL;

	  /* try to construct one from label text */
	  gtk_container_foreach (GTK_CONTAINER (menu_item),
				 gtk_menu_item_accel_name_foreach,
				 &postfix);
	  menu_item->accel_path = postfix ? g_strconcat (prefix, "/", postfix, NULL) : NULL;
	  path = menu_item->accel_path;
	}
      if (path)
	_gtk_widget_set_accel_path (widget, path, accel_group);
    }
  else if (group_changed)			/* reinstall accelerators */
    _gtk_widget_set_accel_path (widget, path, accel_group);
}

/**
 * gtk_menu_item_set_accel_path
 * @menu_item:  a valid #GtkMenuItem
 * @accel_path: accelerator path, corresponding to this menu item's funcitonality
 *
 * Set the accelerator path on @menu_item, through which runtime changes of the
 * menu item's accelerator caused by the user can be identified and saved to
 * persistant storage (see gtk_accel_map_save() on this).
 * To setup a default accelerator for this menu item, call
 * gtk_accel_map_add_entry() with the same @accel_path.
 * See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
 * and gtk_menu_set_accel_path() for a more convenient variant of this function.
 */
void
gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,
			      const gchar *accel_path)
{
  GtkWidget *widget;

  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
  g_return_if_fail (accel_path && accel_path[0] == '<' && strchr (accel_path, '/'));

  widget = GTK_WIDGET (menu_item);

  /* store new path */
  g_free (menu_item->accel_path);
  menu_item->accel_path = g_strdup (accel_path);

  /* forget accelerators associated with old path */
  _gtk_widget_set_accel_path (widget, NULL, NULL);

  /* install accelerators associated with new path */
  if (widget->parent)
    {
      GtkMenu *menu = GTK_MENU (widget->parent);

      if (menu->accel_group)
	_gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
					   NULL,
					   menu->accel_group,
					   FALSE);
    }
}

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
static void
gtk_menu_item_forall (GtkContainer *container,
		      gboolean      include_internals,
		      GtkCallback   callback,
		      gpointer      callback_data)
{
  GtkBin *bin;
  GtkMenuItem *menu_item;

  g_return_if_fail (GTK_IS_MENU_ITEM (container));
  g_return_if_fail (callback != NULL);

  bin = GTK_BIN (container);
  menu_item = GTK_MENU_ITEM (container);

  if (bin->child)
1104
    callback (bin->child, callback_data);
1105
}