gtkbutton.c 36 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
#include "gtkbutton.h"
#include "gtklabel.h"
#include "gtkmain.h"
32
#include "gtkmarshalers.h"
Elliot Lee's avatar
Elliot Lee committed
33
#include "gtksignal.h"
34 35 36 37
#include "gtkimage.h"
#include "gtkhbox.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
38
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
39 40

#define CHILD_SPACING     1
41

42 43
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
44

45 46 47 48
/* 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
49 50 51 52 53 54 55

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

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

Elliot Lee's avatar
Elliot Lee committed
68 69
static void gtk_button_class_init     (GtkButtonClass   *klass);
static void gtk_button_init           (GtkButton        *button);
70
static void gtk_button_destroy        (GtkObject        *object);
71 72 73 74 75 76 77 78
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
79
static void gtk_button_realize        (GtkWidget        *widget);
80
static void gtk_button_unrealize      (GtkWidget        *widget);
81 82
static void gtk_button_map            (GtkWidget        *widget);
static void gtk_button_unmap          (GtkWidget        *widget);
Elliot Lee's avatar
Elliot Lee committed
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 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 163
  object_class->destroy = gtk_button_destroy;

164
  widget_class->realize = gtk_button_realize;
165
  widget_class->unrealize = gtk_button_unrealize;
166 167
  widget_class->map = gtk_button_map;
  widget_class->unmap = gtk_button_unmap;
168 169 170 171 172
  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;
173
  widget_class->key_release_event = gtk_button_key_release;
174 175 176 177 178 179 180 181
  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;
182 183
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
184
  klass->activate = gtk_real_button_activate;
185

186 187 188 189
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
                                                        _("Label"),
Soren Sandmann's avatar
Soren Sandmann committed
190
                                                        _("Text of the label widget inside the button, if the button contains a label widget"),
191
                                                        NULL,
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
                                                        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));
209 210 211 212 213
  
  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_RELIEF,
                                   g_param_spec_enum ("relief",
                                                      _("Border relief"),
Soren Sandmann's avatar
Soren Sandmann committed
214
                                                      _("The border relief style"),
215 216 217
                                                      GTK_TYPE_RELIEF_STYLE,
                                                      GTK_RELIEF_NORMAL,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
Elliot Lee's avatar
Elliot Lee committed
218 219 220

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

  gtk_widget_class_install_style_property (widget_class,
264 265 266 267 268 269 270 271 272 273 274 275
					   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));
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
  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
292 293 294 295 296
}

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

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

312 313 314 315 316 317 318 319 320 321 322 323 324 325
static void
gtk_button_destroy (GtkObject *object)
{
  GtkButton *button = GTK_BUTTON (object);
  
  if (button->label_text)
    {
      g_free (button->label_text);
      button->label_text = NULL;
    }
  
  (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
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;
}


348 349 350
static GtkType
gtk_button_child_type  (GtkContainer     *container)
{
351
  if (!GTK_BIN (container)->child)
352 353 354 355 356
    return GTK_TYPE_WIDGET;
  else
    return GTK_TYPE_NONE;
}

Elliot Lee's avatar
Elliot Lee committed
357
static void
358 359 360 361
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
362
{
363 364 365
  GtkButton *button;

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

367
  switch (prop_id)
368
    {
369
    case PROP_LABEL:
370
      gtk_button_set_label (button, g_value_get_string (value));
371
      break;
372 373
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
374
      break;
375 376 377 378 379 380
    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;
381
    default:
382
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
383 384 385 386 387
      break;
    }
}

static void
388 389 390 391
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
392
{
393 394 395 396
  GtkButton *button;

  button = GTK_BUTTON (object);

397
  switch (prop_id)
398
    {
399
    case PROP_LABEL:
400
      g_value_set_string (value, button->label_text);
401
      break;
402
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
403
      g_value_set_enum (value, gtk_button_get_relief (button));
404
      break;
405 406 407 408 409 410
    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
411
    default:
412
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
413
      break;
Elliot Lee's avatar
Elliot Lee committed
414 415 416 417
    }
}

GtkWidget*
418
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
419 420 421 422
{
  return GTK_WIDGET (gtk_type_new (gtk_button_get_type ()));
}

423 424
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
425
{
426 427 428 429
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *image;
  GtkWidget *hbox;
430
  GtkWidget *align;
Elliot Lee's avatar
Elliot Lee committed
431

432 433 434 435 436
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
437

438 439 440
  if (GTK_BIN (button)->child)
    gtk_container_remove (GTK_CONTAINER (button),
			  GTK_BIN (button)->child);
441

442 443 444
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
445
    {
446 447
      label = gtk_label_new_with_mnemonic (item.label);

448 449 450
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
      image = gtk_image_new_from_stock (button->label_text, GTK_ICON_SIZE_BUTTON);
451
      hbox = gtk_hbox_new (FALSE, 2);
452

453 454
      align = gtk_alignment_new (0.5, 0.5, 0.0, 0.0);
      
Havoc Pennington's avatar
Havoc Pennington committed
455
      gtk_box_pack_start (GTK_BOX (hbox), image, FALSE, FALSE, 0);
456
      gtk_box_pack_end (GTK_BOX (hbox), label, FALSE, FALSE, 0);
457
      
458 459 460
      gtk_container_add (GTK_CONTAINER (button), align);
      gtk_container_add (GTK_CONTAINER (align), hbox);
      gtk_widget_show_all (align);
461 462

      return;
463
    }
464 465

  if (button->use_underline)
466
    {
467 468
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
469
    }
470 471
  else
    label = gtk_label_new (button->label_text);
472
  
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
  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.
493 494 495 496 497
 *
 * 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
498 499
 **/
GtkWidget*
500
gtk_button_new_from_stock (const gchar *stock_id)
501
{
502 503 504 505 506
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
                       "use_stock", TRUE,
                       "use_underline", TRUE,
                       NULL);
507 508
}

509 510 511 512 513 514 515
/**
 * 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.
516 517 518 519
 * If characters in @label are preceded by an underscore, they are underlined.
 * If you need a literal underscore character in a label, use '__' (two 
 * underscores). The first underlined character represents a keyboard 
 * accelerator called a mnemonic.
520 521
 * Pressing Alt and that key activates the button.
 **/
522
GtkWidget*
523
gtk_button_new_with_mnemonic (const gchar *label)
524
{
525
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use_underline", TRUE,  NULL);
526 527
}

Elliot Lee's avatar
Elliot Lee committed
528 529 530
void
gtk_button_pressed (GtkButton *button)
{
531 532
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
533 534 535 536 537 538
  gtk_signal_emit (GTK_OBJECT (button), button_signals[PRESSED]);
}

void
gtk_button_released (GtkButton *button)
{
539 540
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
541 542 543 544 545 546
  gtk_signal_emit (GTK_OBJECT (button), button_signals[RELEASED]);
}

void
gtk_button_clicked (GtkButton *button)
{
547 548
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
549 550 551 552 553 554
  gtk_signal_emit (GTK_OBJECT (button), button_signals[CLICKED]);
}

void
gtk_button_enter (GtkButton *button)
{
555 556
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
557 558 559 560 561 562
  gtk_signal_emit (GTK_OBJECT (button), button_signals[ENTER]);
}

void
gtk_button_leave (GtkButton *button)
{
563 564
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
565 566 567
  gtk_signal_emit (GTK_OBJECT (button), button_signals[LEAVE]);
}

568 569 570 571 572 573
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

574 575 576 577 578 579
  if (newrelief != button->relief) 
    {
       button->relief = newrelief;
       g_object_notify (G_OBJECT (button), "relief");
       gtk_widget_queue_draw (GTK_WIDGET (button));
    }
580 581 582
}

GtkReliefStyle
583
gtk_button_get_relief (GtkButton *button)
584 585 586 587 588 589 590
{
  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
591 592 593 594 595 596
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
597
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
598 599 600 601

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

Owen Taylor's avatar
Owen Taylor committed
602 603
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
604
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
605 606 607 608
  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;
609
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
610 611 612 613 614 615 616
  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);

617
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
618

619 620 621 622 623 624
  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
625 626 627 628

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

629 630 631 632 633 634 635
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
636 637 638 639 640 641 642 643

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }
  
644 645 646
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

647 648 649 650 651 652 653
static void
gtk_button_map (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
  
  g_return_if_fail (GTK_IS_BUTTON (widget));

654 655
  GTK_WIDGET_CLASS (parent_class)->map (widget);

656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
  if (button->event_window)
    gdk_window_show (button->event_window);
}

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
673
static void
674
gtk_button_get_props (GtkButton *button,
675 676
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
677
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
678
{
679
  GtkWidget *widget =  GTK_WIDGET (button);
680 681 682 683 684 685 686 687 688 689 690 691 692 693
  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
694

695 696 697 698 699 700 701 702 703 704 705 706
  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
707

708 709 710 711 712 713 714 715 716
  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);
717
  GtkBorder default_border;
718
  gboolean interior_focus;
719 720
  gint focus_width;
  gint focus_pad;
Elliot Lee's avatar
Elliot Lee committed
721

722
  gtk_button_get_props (button, &default_border, NULL, &interior_focus);
723 724 725 726 727
  gtk_widget_style_get (GTK_WIDGET (widget),
			"focus-line-width", &focus_width,
			"focus-padding", &focus_pad,
			NULL);
 
Elliot Lee's avatar
Elliot Lee committed
728
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
729
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
730
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
731
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
732 733 734

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
735 736
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
737 738
    }

739
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
740
    {
741
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
742

743 744 745 746
      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
747
    }
748 749 750
  
  requisition->width += 2 * (focus_width + focus_pad);
  requisition->height += 2 * (focus_width + focus_pad);
Elliot Lee's avatar
Elliot Lee committed
751 752 753 754 755 756
}

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

760 761 762
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
763
  GtkBorder default_border;
Elliot Lee's avatar
Elliot Lee committed
764

765
  gtk_button_get_props (button, &default_border, NULL, NULL);
766
			    
Elliot Lee's avatar
Elliot Lee committed
767 768 769
  widget->allocation = *allocation;

  if (GTK_WIDGET_REALIZED (widget))
770
    gdk_window_move_resize (button->event_window,
Elliot Lee's avatar
Elliot Lee committed
771 772 773 774 775
			    widget->allocation.x + border_width,
			    widget->allocation.y + border_width,
			    widget->allocation.width - border_width * 2,
			    widget->allocation.height - border_width * 2);

776
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
777
    {
778 779 780 781 782 783 784
      child_allocation.x = widget->allocation.x + border_width + CHILD_SPACING + xthickness;
      child_allocation.y = widget->allocation.y + border_width + CHILD_SPACING + ythickness;
      
      child_allocation.width = MAX (1, widget->allocation.width - (CHILD_SPACING + xthickness) * 2 -
				    border_width * 2);
      child_allocation.height = MAX (1, widget->allocation.height - (CHILD_SPACING + ythickness) * 2 -
				     border_width * 2);
Elliot Lee's avatar
Elliot Lee committed
785 786 787

      if (GTK_WIDGET_CAN_DEFAULT (button))
	{
788 789 790 791
	  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
792 793
	}

794 795 796 797 798 799 800 801 802 803 804 805 806
      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;
	}

807
      gtk_widget_size_allocate (GTK_BIN (button)->child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
808 809 810
    }
}

811 812 813 814 815 816 817
void
_gtk_button_paint (GtkButton    *button,
		   GdkRectangle *area,
		   GtkStateType  state_type,
		   GtkShadowType shadow_type,
		   const gchar  *main_detail,
		   const gchar  *default_detail)
Elliot Lee's avatar
Elliot Lee committed
818
{
819
  GtkWidget *widget;
Elliot Lee's avatar
Elliot Lee committed
820 821
  gint width, height;
  gint x, y;
822
  gint border_width;
823 824
  GtkBorder default_border;
  GtkBorder default_outside_border;
825
  gboolean interior_focus;
826 827
  gint focus_width;
  gint focus_pad;
828
   
829
  if (GTK_WIDGET_DRAWABLE (button))
Elliot Lee's avatar
Elliot Lee committed
830
    {
831
      widget = GTK_WIDGET (button);
832
      border_width = GTK_CONTAINER (widget)->border_width;
833

834
      gtk_button_get_props (button, &default_border, &default_outside_border, &interior_focus);
835 836 837 838
      gtk_widget_style_get (GTK_WIDGET (widget),
			    "focus-line-width", &focus_width,
			    "focus-padding", &focus_pad,
			    NULL); 
839
	
840 841 842 843
      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;
844 845 846 847 848 849 850 851 852

      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);

853 854 855 856 857 858
	  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
859
	{
860 861 862 863
	  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
864
	}
865
       
866
      if (!interior_focus && GTK_WIDGET_HAS_FOCUS (widget))
Elliot Lee's avatar
Elliot Lee committed
867
	{
868 869 870 871
	  x += focus_width + focus_pad;
	  y += focus_width + focus_pad;
	  width -= 2 * (focus_width + focus_pad);
	  height -= 2 * (focus_width + focus_pad);
Elliot Lee's avatar
Elliot Lee committed
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,
878
		       state_type,
879 880 881
		       shadow_type, area, widget, "button",
		       x, y, width, height);
       
Elliot Lee's avatar
Elliot Lee committed
882 883
      if (GTK_WIDGET_HAS_FOCUS (widget))
	{
884 885
	  if (interior_focus)
	    {
886 887 888 889
	      x += widget->style->xthickness + focus_pad;
	      y += widget->style->ythickness + focus_pad;
	      width -= 2 * (widget->style->xthickness + focus_pad);
	      height -=  2 * (widget->style->xthickness + focus_pad);
890 891 892
	    }
	  else
	    {
893 894 895 896
	      x -= focus_width + focus_pad;
	      y -= focus_width + focus_pad;
	      width += 2 * (focus_width + focus_pad);
	      height += 2 * (focus_width + focus_pad);
897
	    }
Elliot Lee's avatar
Elliot Lee committed
898

899
	  gtk_paint_focus (widget->style, widget->window, GTK_WIDGET_STATE (widget),
900
			   area, widget, "button",
901
			   x, y, width, height);
Elliot Lee's avatar
Elliot Lee committed
902 903 904 905
	}
    }
}

906
static gboolean
Elliot Lee's avatar
Elliot Lee committed
907 908 909 910 911
gtk_button_expose (GtkWidget      *widget,
		   GdkEventExpose *event)
{
  if (GTK_WIDGET_DRAWABLE (widget))
    {
912
      GtkButton *button = GTK_BUTTON (widget);
913
      
914 915 916 917
      _gtk_button_paint (button, &event->area,
			 GTK_WIDGET_STATE (widget),
			 button->depressed ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
			 "button", "buttondefault");
918 919
      
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
920
    }
921
  
Elliot Lee's avatar
Elliot Lee committed
922 923 924
  return FALSE;
}

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

  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)
939
	gtk_button_pressed (button);
Elliot Lee's avatar
Elliot Lee committed
940 941 942 943 944
    }

  return TRUE;
}

945
static gboolean
Elliot Lee's avatar
Elliot Lee committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959
gtk_button_button_release (GtkWidget      *widget,
			   GdkEventButton *event)
{
  GtkButton *button;

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

  return TRUE;
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
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;
}

977
static gboolean
Elliot Lee's avatar
Elliot Lee committed
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
gtk_button_enter_notify (GtkWidget        *widget,
			 GdkEventCrossing *event)
{
  GtkButton *button;
  GtkWidget *event_widget;

  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;
}

997
static gboolean
Elliot Lee's avatar
Elliot Lee committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
gtk_button_leave_notify (GtkWidget        *widget,
			 GdkEventCrossing *event)
{
  GtkButton *button;
  GtkWidget *event_widget;

  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)
{
1020 1021 1022
  if (button->activate_timeout)
    return;
  
Elliot Lee's avatar
Elliot Lee committed
1023
  button->button_down = TRUE;
1024
  gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1025 1026 1027 1028 1029 1030 1031 1032 1033
}

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

1034 1035
      if (button->activate_timeout)
	return;
1036
      
Elliot Lee's avatar
Elliot Lee committed
1037 1038 1039
      if (button->in_button)
	gtk_button_clicked (button);

1040
      gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1041 1042
    }
}
1043 1044 1045 1046

static gboolean
button_activate_timeout (gpointer data)
{
1047 1048
  GDK_THREADS_ENTER ();
  
1049 1050
  gtk_button_finish_activate (data, TRUE);

1051 1052
  GDK_THREADS_LEAVE ();

Owen Taylor's avatar