gtkbutton.c 35.8 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);
Elliot Lee's avatar
Elliot Lee committed
79 80 81 82 83 84 85 86 87 88 89 90
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);
91 92
static gint gtk_button_key_release    (GtkWidget        *widget,
				       GdkEventKey      *event);
Elliot Lee's avatar
Elliot Lee committed
93 94 95 96 97 98
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);
99
static void gtk_real_button_activate (GtkButton         *button);
100
static void gtk_button_update_state   (GtkButton        *button);
101
static GtkType gtk_button_child_type  (GtkContainer     *container);
102 103
static void gtk_button_finish_activate (GtkButton *button,
					gboolean   do_it);
Elliot Lee's avatar
Elliot Lee committed
104

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


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


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

  if (!button_type)
    {
122
      static const GTypeInfo button_info =
Elliot Lee's avatar
Elliot Lee committed
123 124
      {
	sizeof (GtkButtonClass),
125 126 127 128 129 130 131 132
	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
133 134
      };

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

  return button_type;
}

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

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

156 157 158
  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;
159 160

  widget_class->realize = gtk_button_realize;
161
  widget_class->unrealize = gtk_button_unrealize;
162 163 164 165 166
  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;
167
  widget_class->key_release_event = gtk_button_key_release;
168 169 170 171 172 173 174 175
  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;
176 177
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
178
  klass->activate = gtk_real_button_activate;
179

180 181 182 183 184 185
  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,
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
                                                        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));
203 204 205 206 207 208 209 210 211
  
  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
212 213 214

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

  gtk_widget_class_install_style_property (widget_class,
258 259 260 261 262 263 264 265 266 267 268 269
					   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));
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  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
286 287 288 289 290
}

static void
gtk_button_init (GtkButton *button)
{
291
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
292
  GTK_WIDGET_UNSET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
293

294 295 296
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
297 298
  button->in_button = FALSE;
  button->button_down = FALSE;
299
  button->relief = GTK_RELIEF_NORMAL;
300 301
  button->use_stock = FALSE;
  button->use_underline = FALSE;
302
  button->depressed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
303 304
}

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
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;
}


327 328 329
static GtkType
gtk_button_child_type  (GtkContainer     *container)
{
330
  if (!GTK_BIN (container)->child)
331 332 333 334 335
    return GTK_TYPE_WIDGET;
  else
    return GTK_TYPE_NONE;
}

Elliot Lee's avatar
Elliot Lee committed
336
static void
337 338 339 340
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
341
{
342 343 344
  GtkButton *button;

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

346
  switch (prop_id)
347
    {
348
    case PROP_LABEL:
349
      gtk_button_set_label (button, g_value_get_string (value));
350
      break;
351 352
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
353
      break;
354 355 356 357 358 359
    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;
360
    default:
361
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
362 363 364 365 366
      break;
    }
}

static void
367 368 369 370
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
371
{
372 373 374 375
  GtkButton *button;

  button = GTK_BUTTON (object);

376
  switch (prop_id)
377
    {
378
    case PROP_LABEL:
379
      g_value_set_string (value, button->label_text);
380
      break;
381
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
382
      g_value_set_enum (value, gtk_button_get_relief (button));
383
      break;
384 385 386 387 388 389
    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
390
    default:
391
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
392
      break;
Elliot Lee's avatar
Elliot Lee committed
393 394 395 396
    }
}

GtkWidget*
397
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
398 399 400 401
{
  return GTK_WIDGET (gtk_type_new (gtk_button_get_type ()));
}

402 403
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
404
{
405 406 407 408
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *image;
  GtkWidget *hbox;
409
  GtkWidget *align;
Elliot Lee's avatar
Elliot Lee committed
410

411 412 413 414 415
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
416

417 418 419
  if (GTK_BIN (button)->child)
    gtk_container_remove (GTK_CONTAINER (button),
			  GTK_BIN (button)->child);
420

421 422 423
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
424
    {
425 426
      label = gtk_label_new_with_mnemonic (item.label);

427 428 429
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
      image = gtk_image_new_from_stock (button->label_text, GTK_ICON_SIZE_BUTTON);
430
      hbox = gtk_hbox_new (FALSE, 2);
431

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

      return;
442
    }
443 444

  if (button->use_underline)
445
    {
446 447
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
448
    }
449 450
  else
    label = gtk_label_new (button->label_text);
451
  
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  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.
472 473 474 475 476
 *
 * 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
477 478
 **/
GtkWidget*
479
gtk_button_new_from_stock (const gchar *stock_id)
480
{
481 482 483 484 485
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
                       "use_stock", TRUE,
                       "use_underline", TRUE,
                       NULL);
486 487
}

488 489 490 491 492 493 494 495 496 497 498
/**
 * 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.
 **/
499
GtkWidget*
500
gtk_button_new_with_mnemonic (const gchar *label)
501
{
502
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use_underline", TRUE,  NULL);
503 504
}

Elliot Lee's avatar
Elliot Lee committed
505 506 507
void
gtk_button_pressed (GtkButton *button)
{
508 509
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
510 511 512 513 514 515
  gtk_signal_emit (GTK_OBJECT (button), button_signals[PRESSED]);
}

void
gtk_button_released (GtkButton *button)
{
516 517
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
518 519 520 521 522 523
  gtk_signal_emit (GTK_OBJECT (button), button_signals[RELEASED]);
}

void
gtk_button_clicked (GtkButton *button)
{
524 525
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
526 527 528 529 530 531
  gtk_signal_emit (GTK_OBJECT (button), button_signals[CLICKED]);
}

void
gtk_button_enter (GtkButton *button)
{
532 533
  g_return_if_fail (GTK_IS_BUTTON (button));

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

void
gtk_button_leave (GtkButton *button)
{
540 541
  g_return_if_fail (GTK_IS_BUTTON (button));

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

545 546 547 548 549 550 551
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

  button->relief = newrelief;
552
  g_object_notify(G_OBJECT(button), "relief");
553
  gtk_widget_queue_draw (GTK_WIDGET (button));
554 555 556
}

GtkReliefStyle
557
gtk_button_get_relief (GtkButton *button)
558 559 560 561 562 563 564
{
  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
565 566 567 568 569 570
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
571
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
572 573 574 575 576 577

  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
578 579
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
580
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
581 582 583 584
  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;
Elliot Lee's avatar
Elliot Lee committed
585 586 587 588 589 590 591 592 593 594 595 596
  attributes.wclass = GDK_INPUT_OUTPUT;
  attributes.visual = gtk_widget_get_visual (widget);
  attributes.colormap = gtk_widget_get_colormap (widget);
  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);

  attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;

597
  widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
Elliot Lee's avatar
Elliot Lee committed
598 599 600 601 602 603
  gdk_window_set_user_data (widget->window, button);

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

604 605 606 607 608 609 610 611 612 613 614
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
    
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

Elliot Lee's avatar
Elliot Lee committed
615
static void
616
gtk_button_get_props (GtkButton *button,
617 618
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
619
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
620
{
621
  GtkWidget *widget =  GTK_WIDGET (button);
622 623 624 625 626 627 628 629 630 631 632 633 634 635
  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
636

637 638 639 640 641 642 643 644 645 646 647 648
  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
649

650 651 652 653 654 655 656 657 658
  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);
659
  GtkBorder default_border;
660
  gboolean interior_focus;
Elliot Lee's avatar
Elliot Lee committed
661

662
  gtk_button_get_props (button, &default_border, NULL, &interior_focus);
663
  
Elliot Lee's avatar
Elliot Lee committed
664
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
665
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
666
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
667
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
668 669 670

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
671 672
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
673 674
    }

675
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
676
    {
677
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
678

679 680 681 682
      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
683
    }
684 685 686 687 688 689

  if (interior_focus)
    {
      requisition->width += 2;
      requisition->height += 2;
    }
Elliot Lee's avatar
Elliot Lee committed
690 691 692 693 694 695
}

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

699 700 701
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
702
  GtkBorder default_border;
Elliot Lee's avatar
Elliot Lee committed
703

704
  gtk_button_get_props (button, &default_border, NULL, NULL);
705
  
Elliot Lee's avatar
Elliot Lee committed
706 707 708 709 710 711 712 713 714
  widget->allocation = *allocation;

  if (GTK_WIDGET_REALIZED (widget))
    gdk_window_move_resize (widget->window,
			    widget->allocation.x + border_width,
			    widget->allocation.y + border_width,
			    widget->allocation.width - border_width * 2,
			    widget->allocation.height - border_width * 2);

715
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
716
    {
717 718
      child_allocation.x = (CHILD_SPACING + xthickness);
      child_allocation.y = (CHILD_SPACING + ythickness);
Elliot Lee's avatar
Elliot Lee committed
719

720
      child_allocation.width = MAX (1, (gint)widget->allocation.width - child_allocation.x * 2 -
Owen Taylor's avatar
Owen Taylor committed
721
	                         border_width * 2);
722
      child_allocation.height = MAX (1, (gint)widget->allocation.height - child_allocation.y * 2 -
Owen Taylor's avatar
Owen Taylor committed
723
	                          border_width * 2);
Elliot Lee's avatar
Elliot Lee committed
724 725 726

      if (GTK_WIDGET_CAN_DEFAULT (button))
	{
727 728 729 730
	  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
731 732
	}

733 734 735 736 737 738 739 740 741 742 743 744 745
      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;
	}

746
      gtk_widget_size_allocate (GTK_BIN (button)->child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
747 748 749
    }
}

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
/*
 * +------------------------------------------------+
 * |                   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
776 777 778 779 780 781 782 783
static void
gtk_button_paint (GtkWidget    *widget,
		  GdkRectangle *area)
{
  GtkButton *button;
  GtkShadowType shadow_type;
  gint width, height;
  gint x, y;
784 785
  GtkBorder default_border;
  GtkBorder default_outside_border;
786
  gboolean interior_focus;
787
   
Elliot Lee's avatar
Elliot Lee committed
788 789 790
  if (GTK_WIDGET_DRAWABLE (widget))
    {
      button = GTK_BUTTON (widget);
791

792
      gtk_button_get_props (button, &default_border, &default_outside_border, &interior_focus);
793
	
Elliot Lee's avatar
Elliot Lee committed
794 795 796 797 798
      x = 0;
      y = 0;
      width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
      height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;

799 800 801 802 803 804 805 806 807 808 809
      gdk_window_set_back_pixmap (widget->window, NULL, TRUE);
      gdk_window_clear_area (widget->window, area->x, area->y, area->width, area->height);

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

810 811 812 813 814 815
	  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
816
	{
817 818 819 820
	  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
821
	}
822
       
823
      if (!interior_focus && GTK_WIDGET_HAS_FOCUS (widget))
Elliot Lee's avatar
Elliot Lee committed
824 825 826 827 828 829
	{
	  x += 1;
	  y += 1;
	  width -= 2;
	  height -= 2;
	}
830 831

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

833 834 835 836 837 838 839 840
      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
841 842
      if (GTK_WIDGET_HAS_FOCUS (widget))
	{
843 844 845 846 847 848 849 850 851 852 853 854 855 856
	  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
857

858 859 860
	  gtk_paint_focus (widget->style, widget->window,
			   area, widget, "button",
			   x, y, width - 1, height - 1);
Elliot Lee's avatar
Elliot Lee committed
861 862 863 864
	}
    }
}

865
static gboolean
Elliot Lee's avatar
Elliot Lee committed
866 867 868
gtk_button_expose (GtkWidget      *widget,
		   GdkEventExpose *event)
{
869
  GtkBin *bin;
Elliot Lee's avatar
Elliot Lee committed
870 871 872 873 874 875 876

  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
877
      bin = GTK_BIN (widget);
878
      
Elliot Lee's avatar
Elliot Lee committed
879
      gtk_button_paint (widget, &event->area);
880 881
      
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
882
    }
883
  
Elliot Lee's avatar
Elliot Lee committed
884 885 886
  return FALSE;
}

887
static gboolean
Elliot Lee's avatar
Elliot Lee committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
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)
905
	gtk_button_pressed (button);
Elliot Lee's avatar
Elliot Lee committed
906 907 908 909 910
    }

  return TRUE;
}

911
static gboolean
Elliot Lee's avatar
Elliot Lee committed
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
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;
}

930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
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;
}

947
static gboolean
Elliot Lee's avatar
Elliot Lee committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
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;
}

971
static gboolean
Elliot Lee's avatar
Elliot Lee committed
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
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)
{
998 999 1000
  if (button->activate_timeout)
    return;
  
Elliot Lee's avatar
Elliot Lee committed
1001
  button->button_down = TRUE;
1002
  gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1003 1004 1005 1006 1007 1008 1009 1010 1011
}

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

1012 1013
      if (button->activate_timeout)
	return;
1014
      
Elliot Lee's avatar
Elliot Lee committed
1015 1016 1017
      if (button->in_button)
	gtk_button_clicked (button);

1018
      gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
1019 1020
    }
}
1021 1022 1023 1024

static gboolean
button_activate_timeout (gpointer data)
{
1025 1026
  GDK_THREADS_ENTER ();
  
1027 1028
  gtk_button_finish_activate (data, TRUE);

1029 1030
  GDK_THREADS_LEAVE ();

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
  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)
    {
      if (gdk_keyboard_grab (widget->window, TRUE,
			     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;
1052
	  gtk_button_update_state (button);
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	}
    }
}

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

1071
  gtk_button_update_state (button);
1072 1073 1074 1075 1076

  if (do_it)
    gtk_button_clicked (button);
}

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
/**
 * gtk_button_set_label:
 * @button: a #GtkButton
 * @label: a string
 *
 * Sets the text of the label of the button to @str. This text is
 * also used to select the stock item if gtk_button_set_use_stock()
 * is used.
 *
 * This will also clear any previously set labels.
 **/
void
gtk_button_set_label (GtkButton   *button,
		      const gchar *label)
{
  g_return_if_fail (GTK_IS_BUTTON (button));
  
  g_free (button->label_text);
  button->label_text = g_strdup (label);
  
  gtk_button_construct_child (button);
  
  g_object_notify (G_OBJECT (button), "label");
}

/**
 * gtk_button_get_label:
 * @button: a #GtkButton
 *
 * Fetches the text from the label of the button, as set by
Matthias Clasen's avatar
Matthias Clasen committed
1107 1108 1109 1110 1111
 * gtk_button_set_label().  This string is owned by the widget 
 * and must not be modified or freed.  If the label text has not 
 * been set the return value  will be %NULL. This will be the 
 * case if you create an empty button with gtk_button_new() to 
 * use as a container.
1112
 *
Matthias Clasen's avatar
Matthias Clasen committed
1113
 * Return value: the text of the label widget. 
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
 **/
G_CONST_RETURN gchar *
gtk_button_get_label (GtkButton *button)
{
  g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
  
  return button->label_text;
}

/**
 * gtk_button_set_use_underline:
 * @button: a #GtkButton
 * @use_underline: %TRUE if underlines in the text indicate mnemonics
 *
 * If true, an underline in the text of the button label indicates
 * the next character should be used for the mnemonic accelerator key.
 */
void
gtk_button_set_use_underline (GtkButton *button,
			      gboolean   use_underline)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

  use_underline = use_underline != FALSE;

  if (use_underline != button->use_underline)
    {
      button->use_underline = use_underline;
  
      gtk_button_construct_child (button);
      
      g_object_notify (G_OBJECT (button), "use_underline");
    }
}

/**
 * gtk_button_get_use_underline: