gtkbutton.c 36.7 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-2001.  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/. 
 */

27
#include <string.h>
28
#include "gtkalignment.h"
Elliot Lee's avatar
Elliot Lee committed
29 30 31 32
#include "gtkbutton.h"
#include "gtklabel.h"
#include "gtkmain.h"
#include "gtksignal.h"
33 34 35 36
#include "gtkimage.h"
#include "gtkhbox.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
37
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
38 39

#define CHILD_SPACING     1
40

41 42
static GtkBorder default_default_border = { 1, 1, 1, 1 };
static GtkBorder default_default_outside_border = { 0, 0, 0, 0 };
Elliot Lee's avatar
Elliot Lee committed
43

44 45 46 47
/* Time out before giving up on getting a key release when animatng
 * the close button.
 */
#define ACTIVATE_TIMEOUT 250
Elliot Lee's avatar
Elliot Lee committed
48 49 50 51 52 53 54

enum {
  PRESSED,
  RELEASED,
  CLICKED,
  ENTER,
  LEAVE,
55
  ACTIVATE,
Elliot Lee's avatar
Elliot Lee committed
56 57
  LAST_SIGNAL
};
58

59
enum {
60 61
  PROP_0,
  PROP_LABEL,
62 63 64
  PROP_RELIEF,
  PROP_USE_UNDERLINE,
  PROP_USE_STOCK
65
};
66

Elliot Lee's avatar
Elliot Lee committed
67 68
static void gtk_button_class_init     (GtkButtonClass   *klass);
static void gtk_button_init           (GtkButton        *button);
69 70 71 72 73 74 75 76
static void gtk_button_set_property   (GObject         *object,
                                       guint            prop_id,
                                       const GValue    *value,
                                       GParamSpec      *pspec);
static void gtk_button_get_property   (GObject         *object,
                                       guint            prop_id,
                                       GValue          *value,
                                       GParamSpec      *pspec);
Elliot Lee's avatar
Elliot Lee committed
77
static void gtk_button_realize        (GtkWidget        *widget);
78
static void gtk_button_unrealize      (GtkWidget        *widget);
79 80
static void gtk_button_map            (GtkWidget        *widget);
static void gtk_button_unmap          (GtkWidget        *widget);
Elliot Lee's avatar
Elliot Lee committed
81 82 83 84 85 86 87 88 89 90 91 92
static void gtk_button_size_request   (GtkWidget        *widget,
				       GtkRequisition   *requisition);
static void gtk_button_size_allocate  (GtkWidget        *widget,
				       GtkAllocation    *allocation);
static void gtk_button_paint          (GtkWidget        *widget,
				       GdkRectangle     *area);
static gint gtk_button_expose         (GtkWidget        *widget,
				       GdkEventExpose   *event);
static gint gtk_button_button_press   (GtkWidget        *widget,
				       GdkEventButton   *event);
static gint gtk_button_button_release (GtkWidget        *widget,
				       GdkEventButton   *event);
93 94
static gint gtk_button_key_release    (GtkWidget        *widget,
				       GdkEventKey      *event);
Elliot Lee's avatar
Elliot Lee committed
95 96 97 98 99 100
static gint gtk_button_enter_notify   (GtkWidget        *widget,
				       GdkEventCrossing *event);
static gint gtk_button_leave_notify   (GtkWidget        *widget,
				       GdkEventCrossing *event);
static void gtk_real_button_pressed   (GtkButton        *button);
static void gtk_real_button_released  (GtkButton        *button);
101
static void gtk_real_button_activate (GtkButton         *button);
102
static void gtk_button_update_state   (GtkButton        *button);
103
static GtkType gtk_button_child_type  (GtkContainer     *container);
104 105
static void gtk_button_finish_activate (GtkButton *button,
					gboolean   do_it);
Elliot Lee's avatar
Elliot Lee committed
106

107 108 109 110 111 112
static GObject*	gtk_button_constructor     (GType                  type,
					    guint                  n_construct_properties,
					    GObjectConstructParam *construct_params);
static void     gtk_button_construct_child (GtkButton             *button);


113
static GtkBinClass *parent_class = NULL;
114
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
115 116


117
GtkType
118
gtk_button_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
119
{
120
  static GtkType button_type = 0;
Elliot Lee's avatar
Elliot Lee committed
121 122 123

  if (!button_type)
    {
124
      static const GTypeInfo button_info =
Elliot Lee's avatar
Elliot Lee committed
125 126
      {
	sizeof (GtkButtonClass),
127 128 129 130 131 132 133 134
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_button_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkButton),
	16,		/* n_preallocs */
	(GInstanceInitFunc) gtk_button_init,
Elliot Lee's avatar
Elliot Lee committed
135 136
      };

137
      button_type = g_type_register_static (GTK_TYPE_BIN, "GtkButton", &button_info, 0);
Elliot Lee's avatar
Elliot Lee committed
138 139 140 141 142 143 144 145
    }

  return button_type;
}

static void
gtk_button_class_init (GtkButtonClass *klass)
{
146
  GObjectClass *g_object_class;
Elliot Lee's avatar
Elliot Lee committed
147 148 149 150
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

151
  g_object_class = G_OBJECT_CLASS (klass);
Elliot Lee's avatar
Elliot Lee committed
152 153 154
  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;
155 156
  
  parent_class = g_type_class_peek_parent (klass);
157

158 159 160
  g_object_class->constructor = gtk_button_constructor;
  g_object_class->set_property = gtk_button_set_property;
  g_object_class->get_property = gtk_button_get_property;
161 162

  widget_class->realize = gtk_button_realize;
163
  widget_class->unrealize = gtk_button_unrealize;
164 165
  widget_class->map = gtk_button_map;
  widget_class->unmap = gtk_button_unmap;
166 167 168 169 170
  widget_class->size_request = gtk_button_size_request;
  widget_class->size_allocate = gtk_button_size_allocate;
  widget_class->expose_event = gtk_button_expose;
  widget_class->button_press_event = gtk_button_button_press;
  widget_class->button_release_event = gtk_button_button_release;
171
  widget_class->key_release_event = gtk_button_key_release;
172 173 174 175 176 177 178 179
  widget_class->enter_notify_event = gtk_button_enter_notify;
  widget_class->leave_notify_event = gtk_button_leave_notify;

  container_class->child_type = gtk_button_child_type;

  klass->pressed = gtk_real_button_pressed;
  klass->released = gtk_real_button_released;
  klass->clicked = NULL;
180 181
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
182
  klass->activate = gtk_real_button_activate;
183

184 185 186 187 188 189
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
                                                        _("Label"),
                                                        _("Text of the label widget inside the button, if the button contains a label widget."),
                                                        NULL,
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_USE_UNDERLINE,
                                   g_param_spec_boolean ("use_underline",
							 _("Use underline"),
							 _("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
                                                        FALSE,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_USE_STOCK,
                                   g_param_spec_boolean ("use_stock",
							 _("Use stock"),
							 _("If set, the label is used to pick a stock item instead of being displayed"),
                                                        FALSE,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
207 208 209 210 211 212 213 214 215
  
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_RELIEF,
                                   g_param_spec_enum ("relief",
                                                      _("Border relief"),
                                                      _("The border relief style."),
                                                      GTK_TYPE_RELIEF_STYLE,
                                                      GTK_RELIEF_NORMAL,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
Elliot Lee's avatar
Elliot Lee committed
216 217 218

  button_signals[PRESSED] =
    gtk_signal_new ("pressed",
219
                    GTK_RUN_FIRST,
220
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
221
                    GTK_SIGNAL_OFFSET (GtkButtonClass, pressed),
222
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
223 224 225
		    GTK_TYPE_NONE, 0);
  button_signals[RELEASED] =
    gtk_signal_new ("released",
226
                    GTK_RUN_FIRST,
227
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
228
                    GTK_SIGNAL_OFFSET (GtkButtonClass, released),
229
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
230 231 232
		    GTK_TYPE_NONE, 0);
  button_signals[CLICKED] =
    gtk_signal_new ("clicked",
233
                    GTK_RUN_FIRST | GTK_RUN_ACTION,
234
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
235
                    GTK_SIGNAL_OFFSET (GtkButtonClass, clicked),
236
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
237 238 239
		    GTK_TYPE_NONE, 0);
  button_signals[ENTER] =
    gtk_signal_new ("enter",
240
                    GTK_RUN_FIRST,
241
                    GTK_CLASS_TYPE (object_class),
242
                    GTK_SIGNAL_OFFSET (GtkButtonClass, enter),
243
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
244 245 246
		    GTK_TYPE_NONE, 0);
  button_signals[LEAVE] =
    gtk_signal_new ("leave",
247
                    GTK_RUN_FIRST,
248
                    GTK_CLASS_TYPE (object_class),
249
                    GTK_SIGNAL_OFFSET (GtkButtonClass, leave),
250
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
251
		    GTK_TYPE_NONE, 0);
252 253
  button_signals[ACTIVATE] =
    gtk_signal_new ("activate",
254
                    GTK_RUN_FIRST,
255 256 257 258 259
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkButtonClass, activate),
                    gtk_marshal_VOID__VOID,
		    GTK_TYPE_NONE, 0);
  widget_class->activate_signal = button_signals[ACTIVATE];
260 261

  gtk_widget_class_install_style_property (widget_class,
262 263 264 265 266 267 268 269 270 271 272 273
					   g_param_spec_boxed ("default_border",
							       _("Default Spacing"),
							       _("Extra space to add for CAN_DEFAULT buttons"),
							       GTK_TYPE_BORDER,
							       G_PARAM_READABLE));

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_boxed ("default_outside_border",
							       _("Default Outside Spacing"),
							       _("Extra space to add for CAN_DEFAULT buttons that is always drawn outside the border"),
							       GTK_TYPE_BORDER,
							       G_PARAM_READABLE));
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_displacement_x",
							     _("Child X Displacement"),
							     _("How far in the x direction to move the child when the button is depressed"),
							     G_MININT,
							     G_MAXINT,
							     0,
							     G_PARAM_READABLE));
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_displacement_y",
							     _("Child Y Displacement"),
							     _("How far in the y direction to move the child when the button is depressed"),
							     G_MININT,
							     G_MAXINT,
							     0,
							     G_PARAM_READABLE));
Elliot Lee's avatar
Elliot Lee committed
290 291 292 293 294
}

static void
gtk_button_init (GtkButton *button)
{
295
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
296
  GTK_WIDGET_SET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
297

298 299 300
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
301 302
  button->in_button = FALSE;
  button->button_down = FALSE;
303
  button->relief = GTK_RELIEF_NORMAL;
304 305
  button->use_stock = FALSE;
  button->use_underline = FALSE;
306
  button->depressed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
static GObject*
gtk_button_constructor (GType                  type,
			guint                  n_construct_properties,
			GObjectConstructParam *construct_params)
{
  GObject *object;
  GtkButton *button;

  object = (* G_OBJECT_CLASS (parent_class)->constructor) (type,
							   n_construct_properties,
							   construct_params);

  button = GTK_BUTTON (object);
  button->constructed = TRUE;

  if (button->label_text != NULL)
    gtk_button_construct_child (button);
  
  return object;
}


331 332 333
static GtkType
gtk_button_child_type  (GtkContainer     *container)
{
334
  if (!GTK_BIN (container)->child)
335 336 337 338 339
    return GTK_TYPE_WIDGET;
  else
    return GTK_TYPE_NONE;
}

Elliot Lee's avatar
Elliot Lee committed
340
static void
341 342 343 344
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
345
{
346 347 348
  GtkButton *button;

  button = GTK_BUTTON (object);
Elliot Lee's avatar
Elliot Lee committed
349

350
  switch (prop_id)
351
    {
352
    case PROP_LABEL:
353
      gtk_button_set_label (button, g_value_get_string (value));
354
      break;
355 356
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
357
      break;
358 359 360 361 362 363
    case PROP_USE_UNDERLINE:
      gtk_button_set_use_underline (button, g_value_get_boolean (value));
      break;
    case PROP_USE_STOCK:
      gtk_button_set_use_stock (button, g_value_get_boolean (value));
      break;
364
    default:
365
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
366 367 368 369 370
      break;
    }
}

static void
371 372 373 374
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
375
{
376 377 378 379
  GtkButton *button;

  button = GTK_BUTTON (object);

380
  switch (prop_id)
381
    {
382
    case PROP_LABEL:
383
      g_value_set_string (value, button->label_text);
384
      break;
385
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
386
      g_value_set_enum (value, gtk_button_get_relief (button));
387
      break;
388 389 390 391 392 393
    case PROP_USE_UNDERLINE:
      g_value_set_boolean (value, button->use_underline);
      break;
    case PROP_USE_STOCK:
      g_value_set_boolean (value, button->use_stock);
      break;
Tim Janik's avatar
Tim Janik committed
394
    default:
395
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
396
      break;
Elliot Lee's avatar
Elliot Lee committed
397 398 399 400
    }
}

GtkWidget*
401
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
402 403 404 405
{
  return GTK_WIDGET (gtk_type_new (gtk_button_get_type ()));
}

406 407
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
408
{
409 410 411 412
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *image;
  GtkWidget *hbox;
413
  GtkWidget *align;
Elliot Lee's avatar
Elliot Lee committed
414

415 416 417 418 419
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
420

421 422 423
  if (GTK_BIN (button)->child)
    gtk_container_remove (GTK_CONTAINER (button),
			  GTK_BIN (button)->child);
424

425 426 427
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
428
    {
429 430
      label = gtk_label_new_with_mnemonic (item.label);

431 432 433
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
      image = gtk_image_new_from_stock (button->label_text, GTK_ICON_SIZE_BUTTON);
434
      hbox = gtk_hbox_new (FALSE, 2);
435

436 437
      align = gtk_alignment_new (0.5, 0.5, 0.0, 0.0);
      
Havoc Pennington's avatar
Havoc Pennington committed
438
      gtk_box_pack_start (GTK_BOX (hbox), image, FALSE, FALSE, 0);
439
      gtk_box_pack_end (GTK_BOX (hbox), label, FALSE, FALSE, 0);
440
      
441 442 443
      gtk_container_add (GTK_CONTAINER (button), align);
      gtk_container_add (GTK_CONTAINER (align), hbox);
      gtk_widget_show_all (align);
444 445

      return;
446
    }
447 448

  if (button->use_underline)
449
    {
450 451
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
452
    }
453 454
  else
    label = gtk_label_new (button->label_text);
455
  
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
  gtk_misc_set_alignment (GTK_MISC (label), 0.5, 0.5);

  gtk_widget_show (label);
  gtk_container_add (GTK_CONTAINER (button), label);
}


GtkWidget*
gtk_button_new_with_label (const gchar *label)
{
  return g_object_new (GTK_TYPE_BUTTON, "label", label, NULL);
}

/**
 * gtk_button_new_from_stock:
 * @stock_id: the name of the stock item 
 *
 * Creates a new #GtkButton containing the image and text from a stock item.
 * Some stock ids have preprocessor macros like #GTK_STOCK_OK and
 * #GTK_STOCK_APPLY.
476 477 478 479 480
 *
 * If @stock_id is unknown, then it will be treated as a mnemonic
 * label (as for gtk_button_new_with_mnemonic()).
 *
 * Returns: a new #GtkButton
481 482
 **/
GtkWidget*
483
gtk_button_new_from_stock (const gchar *stock_id)
484
{
485 486 487 488 489
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
                       "use_stock", TRUE,
                       "use_underline", TRUE,
                       NULL);
490 491
}

492 493 494 495 496 497 498 499 500 501 502
/**
 * gtk_button_new_with_mnemonic:
 * @label: The text of the button, with an underscore in front of the
 *         mnemonic character
 * @returns: a new #GtkButton
 *
 * Creates a new #GtkButton containing a label.
 * If characters in @label are preceded by an underscore, they are underlined
 * indicating that they represent a keyboard accelerator called a mnemonic.
 * Pressing Alt and that key activates the button.
 **/
503
GtkWidget*
504
gtk_button_new_with_mnemonic (const gchar *label)
505
{
506
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use_underline", TRUE,  NULL);
507 508
}

Elliot Lee's avatar
Elliot Lee committed
509 510 511
void
gtk_button_pressed (GtkButton *button)
{
512 513
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
514 515 516 517 518 519
  gtk_signal_emit (GTK_OBJECT (button), button_signals[PRESSED]);
}

void
gtk_button_released (GtkButton *button)
{
520 521
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
522 523 524 525 526 527
  gtk_signal_emit (GTK_OBJECT (button), button_signals[RELEASED]);
}

void
gtk_button_clicked (GtkButton *button)
{
528 529
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
530 531 532 533 534 535
  gtk_signal_emit (GTK_OBJECT (button), button_signals[CLICKED]);
}

void
gtk_button_enter (GtkButton *button)
{
536 537
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
538 539 540 541 542 543
  gtk_signal_emit (GTK_OBJECT (button), button_signals[ENTER]);
}

void
gtk_button_leave (GtkButton *button)
{
544 545
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
546 547 548
  gtk_signal_emit (GTK_OBJECT (button), button_signals[LEAVE]);
}

549 550 551 552 553 554 555
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

  button->relief = newrelief;
556
  g_object_notify(G_OBJECT(button), "relief");
557
  gtk_widget_queue_draw (GTK_WIDGET (button));
558 559 560
}

GtkReliefStyle
561
gtk_button_get_relief (GtkButton *button)
562 563 564 565 566 567 568
{
  g_return_val_if_fail (button != NULL, GTK_RELIEF_NORMAL);
  g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);

  return button->relief;
}

Elliot Lee's avatar
Elliot Lee committed
569 570 571 572 573 574
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
575
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
576 577 578 579 580 581

  g_return_if_fail (GTK_IS_BUTTON (widget));

  button = GTK_BUTTON (widget);
  GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);

Owen Taylor's avatar
Owen Taylor committed
582 583
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
584
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
585 586 587 588
  attributes.x = widget->allocation.x + border_width;
  attributes.y = widget->allocation.y + border_width;
  attributes.width = widget->allocation.width - border_width * 2;
  attributes.height = widget->allocation.height - border_width * 2;
589
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
590 591 592 593 594 595 596
  attributes.event_mask = gtk_widget_get_events (widget);
  attributes.event_mask |= (GDK_EXPOSURE_MASK |
			    GDK_BUTTON_PRESS_MASK |
			    GDK_BUTTON_RELEASE_MASK |
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

597
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
598

599 600 601 602 603 604
  widget->window = gtk_widget_get_parent_window (widget);
  gdk_window_ref (widget->window);
  
  button->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
					 &attributes, attributes_mask);
  gdk_window_set_user_data (button->event_window, button);
Elliot Lee's avatar
Elliot Lee committed
605 606 607 608

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

609 610 611 612 613 614 615
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
616 617 618 619 620 621 622 623

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }
  
624 625 626
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
static void
gtk_button_map (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
  
  g_return_if_fail (GTK_IS_BUTTON (widget));

  if (button->event_window)
    gdk_window_show (button->event_window);

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

static void
gtk_button_unmap (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
    
  g_return_if_fail (GTK_IS_BUTTON (widget));

  if (button->event_window)
    gdk_window_hide (button->event_window);

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

Elliot Lee's avatar
Elliot Lee committed
653
static void
654
gtk_button_get_props (GtkButton *button,
655 656
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
657
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
658
{
659
  GtkWidget *widget =  GTK_WIDGET (button);
660 661 662 663 664 665 666 667 668 669 670 671 672 673
  GtkBorder *tmp_border;

  if (default_border)
    {
      gtk_widget_style_get (widget, "default_border", &tmp_border, NULL);

      if (tmp_border)
	{
	  *default_border = *tmp_border;
	  g_free (tmp_border);
	}
      else
	*default_border = default_default_border;
    }
Elliot Lee's avatar
Elliot Lee committed
674

675 676 677 678 679 680 681 682 683 684 685 686
  if (default_outside_border)
    {
      gtk_widget_style_get (widget, "default_outside_border", &tmp_border, NULL);

      if (tmp_border)
	{
	  *default_outside_border = *tmp_border;
	  g_free (tmp_border);
	}
      else
	*default_outside_border = default_default_outside_border;
    }
Elliot Lee's avatar
Elliot Lee committed
687

688 689 690 691 692 693 694 695 696
  if (interior_focus)
    gtk_widget_style_get (widget, "interior_focus", interior_focus, NULL);
}
	
static void
gtk_button_size_request (GtkWidget      *widget,
			 GtkRequisition *requisition)
{
  GtkButton *button = GTK_BUTTON (widget);
697
  GtkBorder default_border;
698
  gboolean interior_focus;
Elliot Lee's avatar
Elliot Lee committed
699

700
  gtk_button_get_props (button, &default_border, NULL, &interior_focus);
701
  
Elliot Lee's avatar
Elliot Lee committed
702
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
703
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
704
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
705
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
706 707 708

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
709 710
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
711 712
    }

713
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
714
    {
715
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
716

717 718 719 720
      gtk_widget_size_request (GTK_BIN (button)->child, &child_requisition);

      requisition->width += child_requisition.width;
      requisition->height += child_requisition.height;
Elliot Lee's avatar
Elliot Lee committed
721
    }
722 723 724 725 726 727

  if (interior_focus)
    {
      requisition->width += 2;
      requisition->height += 2;
    }
Elliot Lee's avatar
Elliot Lee committed
728 729 730 731 732 733
}

static void
gtk_button_size_allocate (GtkWidget     *widget,
			  GtkAllocation *allocation)
{
734
  GtkButton *button = GTK_BUTTON (widget);
Elliot Lee's avatar
Elliot Lee committed
735 736
  GtkAllocation child_allocation;

737 738 739
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
740
  GtkBorder default_border;
Elliot Lee's avatar
Elliot Lee committed
741

742
  gtk_button_get_props (button, &default_border, NULL, NULL);
743
  
Elliot Lee's avatar
Elliot Lee committed
744 745 746
  widget->allocation = *allocation;

  if (GTK_WIDGET_REALIZED (widget))
747
    gdk_window_move_resize (button->event_window,
Elliot Lee's avatar
Elliot Lee committed
748 749 750 751 752
			    widget->allocation.x + border_width,
			    widget->allocation.y + border_width,
			    widget->allocation.width - border_width * 2,
			    widget->allocation.height - border_width * 2);

753
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
754
    {
755 756
      child_allocation.x = widget->allocation.x + border_width + (CHILD_SPACING + xthickness);
      child_allocation.y = widget->allocation.y + border_width + (CHILD_SPACING + ythickness);
Elliot Lee's avatar
Elliot Lee committed
757

758
      child_allocation.width = MAX (1, (gint)widget->allocation.width - (CHILD_SPACING + xthickness) * 2 -
Owen Taylor's avatar
Owen Taylor committed
759
	                         border_width * 2);
760
      child_allocation.height = MAX (1, (gint)widget->allocation.height - (CHILD_SPACING + ythickness) * 2 -
Owen Taylor's avatar
Owen Taylor committed
761
	                          border_width * 2);
Elliot Lee's avatar
Elliot Lee committed
762 763 764

      if (GTK_WIDGET_CAN_DEFAULT (button))
	{
765 766 767 768
	  child_allocation.x += default_border.left;
	  child_allocation.y += default_border.top;
	  child_allocation.width =  MAX (1, child_allocation.width - default_border.left - default_border.right);
	  child_allocation.height = MAX (1, child_allocation.height - default_border.top - default_border.bottom);
Elliot Lee's avatar
Elliot Lee committed
769 770
	}

771 772 773 774 775 776 777 778 779 780 781 782 783
      if (button->depressed)
	{
	  gint child_displacement_x;
	  gint child_displacement_y;
	  
	  gtk_widget_style_get (widget,
				"child_displacement_x", &child_displacement_x, 
				"child_displacement_y", &child_displacement_y,
				NULL);
	  child_allocation.x += child_displacement_x;
	  child_allocation.y += child_displacement_y;
	}

784
      gtk_widget_size_allocate (GTK_BIN (button)->child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
785 786 787
    }
}

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
/*
 * +------------------------------------------------+
 * |                   BORDER                       |
 * |  +------------------------------------------+  |
 * |  |\\\\\\\\\\\\\\\\DEFAULT\\\\\\\\\\\\\\\\\  |  |
 * |  |\\+------------------------------------+  |  |
 * |  |\\| |           SPACING       3      | |  |  |
 * |  |\\| +--------------------------------+ |  |  |
 * |  |\\| |########## FOCUS ###############| |  |  |
 * |  |\\| |#+----------------------------+#| |  |  |
 * |  |\\| |#|         RELIEF            \|#| |  |  |
 * |  |\\| |#|  +-----------------------+\|#| |  |  |
 * |  |\\|1|#|  +     THE TEXT          +\|#|2|  |  |
 * |  |\\| |#|  +-----------------------+\|#| |  |  |
 * |  |\\| |#| \\\\\ ythickness \\\\\\\\\\|#| |  |  |
 * |  |\\| |#+----------------------------+#| |  |  |
 * |  |\\| |########### 1 ##################| |  |  |
 * |  |\\| +--------------------------------+ |  |  |
 * |  |\\| |        default spacing   4     | |  |  |
 * |  |\\+------------------------------------+  |  |
 * |  |\            ythickness                   |  |
 * |  +------------------------------------------+  |
 * |                border_width                    |
 * +------------------------------------------------+
 */

Elliot Lee's avatar
Elliot Lee committed
814 815 816 817 818 819 820 821
static void
gtk_button_paint (GtkWidget    *widget,
		  GdkRectangle *area)
{
  GtkButton *button;
  GtkShadowType shadow_type;
  gint width, height;
  gint x, y;
822
  gint border_width;
823 824
  GtkBorder default_border;
  GtkBorder default_outside_border;
825
  gboolean interior_focus;
826
   
Elliot Lee's avatar
Elliot Lee committed
827 828
  if (GTK_WIDGET_DRAWABLE (widget))
    {
829
      border_width = GTK_CONTAINER (widget)->border_width;
Elliot Lee's avatar
Elliot Lee committed
830
      button = GTK_BUTTON (widget);
831

832
      gtk_button_get_props (button, &default_border, &default_outside_border, &interior_focus);
833
	
834 835 836 837
      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;
838 839 840 841 842 843 844 845 846

      if (GTK_WIDGET_HAS_DEFAULT (widget) &&
	  GTK_BUTTON (widget)->relief == GTK_RELIEF_NORMAL)
	{
	  gtk_paint_box (widget->style, widget->window,
			 GTK_STATE_NORMAL, GTK_SHADOW_IN,
			 area, widget, "buttondefault",
			 x, y, width, height);

847 848 849 850 851 852
	  x += default_border.left;
	  y += default_border.top;
	  width -= default_border.left + default_border.right;
	  height -= default_border.top + default_border.bottom;
	}
      else if (GTK_WIDGET_CAN_DEFAULT (widget))
Elliot Lee's avatar
Elliot Lee committed
853
	{
854 855 856 857
	  x += default_outside_border.left;
	  y += default_outside_border.top;
	  width -= default_outside_border.left + default_outside_border.right;
	  height -= default_outside_border.top + default_outside_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
858
	}
859
       
860
      if (!interior_focus && GTK_WIDGET_HAS_FOCUS (widget))
Elliot Lee's avatar
Elliot Lee committed
861 862 863 864 865 866
	{
	  x += 1;
	  y += 1;
	  width -= 2;
	  height -= 2;
	}
867 868

      shadow_type = button->depressed ? GTK_SHADOW_IN : GTK_SHADOW_OUT;
Elliot Lee's avatar
Elliot Lee committed
869

870 871 872 873 874 875 876 877
      if ((button->relief != GTK_RELIEF_NONE) ||
	  ((GTK_WIDGET_STATE(widget) != GTK_STATE_NORMAL) &&
	   (GTK_WIDGET_STATE(widget) != GTK_STATE_INSENSITIVE)))
	gtk_paint_box (widget->style, widget->window,
		       GTK_WIDGET_STATE (widget),
		       shadow_type, area, widget, "button",
		       x, y, width, height);
       
Elliot Lee's avatar
Elliot Lee committed
878 879
      if (GTK_WIDGET_HAS_FOCUS (widget))
	{
880 881 882 883 884 885 886 887 888 889 890 891 892 893
	  if (interior_focus)
	    {
	      x += widget->style->xthickness + 1;
	      y += widget->style->ythickness + 1;
	      width -= 2 * (widget->style->xthickness + 1);
	      height -=  2 * (widget->style->xthickness + 1);
	    }
	  else
	    {
	      x -= 1;
	      y -= 1;
	      width += 2;
	      height += 2;
	    }
Elliot Lee's avatar
Elliot Lee committed
894

895 896 897
	  gtk_paint_focus (widget->style, widget->window,
			   area, widget, "button",
			   x, y, width - 1, height - 1);
Elliot Lee's avatar
Elliot Lee committed
898 899 900 901
	}
    }
}

902
static gboolean
Elliot Lee's avatar
Elliot Lee committed
903 904 905
gtk_button_expose (GtkWidget      *widget,
		   GdkEventExpose *event)
{
906
  GtkBin *bin;
Elliot Lee's avatar
Elliot Lee committed
907 908 909 910 911 912 913

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_BUTTON (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  if (GTK_WIDGET_DRAWABLE (widget))
    {
Owen Taylor's avatar
Owen Taylor committed
914
      bin = GTK_BIN (widget);
915
      
Elliot Lee's avatar
Elliot Lee committed
916
      gtk_button_paint (widget, &event->area);
917 918
      
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
919
    }
920
  
Elliot Lee's avatar
Elliot Lee committed
921 922 923
  return FALSE;
}

924
static gboolean
Elliot Lee's avatar
Elliot Lee committed
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
gtk_button_button_press (GtkWidget      *widget,
			 GdkEventButton *event)
{
  GtkButton *button;

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_BUTTON (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  if (event->type == GDK_BUTTON_PRESS)
    {
      button = GTK_BUTTON (widget);

      if (!GTK_WIDGET_HAS_FOCUS (widget))
	gtk_widget_grab_focus (widget);

      if (event->button == 1)
942
	gtk_button_pressed (button);
Elliot Lee's avatar
Elliot Lee committed
943 944 945 946 947
    }

  return TRUE;
}

948
static gboolean
Elliot Lee's avatar
Elliot Lee committed
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
gtk_button_button_release (GtkWidget      *widget,
			   GdkEventButton *event)
{
  GtkButton *button;

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_BUTTON (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  if (event->button == 1)
    {
      button = GTK_BUTTON (widget);
      gtk_button_released (button);
    }

  return TRUE;
}

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
static gboolean
gtk_button_key_release (GtkWidget   *widget,
			GdkEventKey *event)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    {
      gtk_button_finish_activate (button, TRUE);
      return TRUE;
    }
  else if (GTK_WIDGET_CLASS (parent_class)->key_release_event)
    return GTK_WIDGET_CLASS (parent_class)->key_release_event (widget, event);
  else
    return FALSE;
}

984
static gboolean
Elliot Lee's avatar
Elliot Lee committed
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
gtk_button_enter_notify (GtkWidget        *widget,
			 GdkEventCrossing *event)
{
  GtkButton *button;
  GtkWidget *event_widget;

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_BUTTON (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  button = GTK_BUTTON (widget);
  event_widget = gtk_get_event_widget ((GdkEvent*) event);

  if ((event_widget == widget) &&
      (event->detail != GDK_NOTIFY_INFERIOR))
    {
      button->in_button = TRUE;
      gtk_button_enter (button);
    }

  return FALSE;
}

1008
static gboolean
Elliot Lee's avatar
Elliot Lee committed
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
gtk_button_leave_notify (GtkWidget        *widget,
			 GdkEventCrossing *event)
{
  GtkButton *button;
  GtkWidget *event_widget;

  g_return_val_if_fail (widget != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_BUTTON (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  button = GTK_BUTTON (widget);
  event_widget = gtk_get_event_widget ((GdkEvent*) event);

  if ((event_widget == widget) &&
      (event->detail != GDK_NOTIFY_INFERIOR))
    {
      button->in_button = FALSE;
      gtk_button_leave (button);
    }

  return FALSE;
}

static void
gtk_real_button_pressed (GtkButton *button)
{
1035 1036 1037
  if (button->activate_timeout)
    return;
  
Elliot Lee's avatar
Elliot Lee committed
1038
  button->button_down = TRUE;
1039
  gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1040 1041 1042 1043 1044 1045 1046 1047 1048
}

static void
gtk_real_button_released (GtkButton *button)
{
  if (button->button_down)
    {
      button->button_down = FALSE;

1049 1050
      if (button->activate_timeout)
	return;
1051
      
Elliot Lee's avatar
Elliot Lee committed
1052 1053 1054
      if (button->in_button)
	gtk_button_clicked (button);

1055
      gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1056 1057
    }
}
1058 1059 1060 1061

static gboolean
button_activate_timeout (gpointer data)
{
1062 1063
  GDK_THREADS_ENTER ();
  
1064 1065
  gtk_button_finish_activate (data, TRUE);

1066 1067
  GDK_THREADS_LEAVE ();

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
  return FALSE;
}

static void
gtk_real_button_activate (GtkButton *button)
{
  GtkWidget *widget = GTK_WIDGET (button);
  
  g_return_if_fail (GTK_IS_BUTTON (button));

  if (GTK_WIDGET_REALIZED (button) && !button->activate_timeout)
    {
1080
      if (gdk_keyboard_grab (button->event_window, TRUE,
1081 1082 1083 1084 1085 1086 1087 1088
			     gtk_get_current_event_time ()) == 0)
	{
	  gtk_grab_add (widget);
	  
	  button->activate_timeout = g_timeout_add (ACTIVATE_TIMEOUT,
						    button_activate_timeout,
						    button);
	  button->button_down = TRUE;
1089
	  gtk_button_update_state (button);
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	}
    }
}

static void
gtk_button_finish_activate (GtkButton *button,
			    gboolean   do_it)
{
  GtkWidget *widget = GTK_WIDGET (button);
  
  g_source_remove (button->activate_timeout);
  button->activate_timeout = 0;

  gdk_keyboard_ungrab (gtk_get_current_event_time ());
  gtk_grab_remove (widget);

  button->button_down = FALSE;
1107

1108
  gtk_button_update_state (button);
1109 1110 1111 1112 1113

  if (do_it)
    gtk_button_clicked (button);
}