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

#define CHILD_SPACING     1
39

40 41
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
42

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

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

58
enum {
59 60 61
  PROP_0,
  PROP_LABEL,
  PROP_RELIEF
62
};
63

Elliot Lee's avatar
Elliot Lee committed
64 65
static void gtk_button_class_init     (GtkButtonClass   *klass);
static void gtk_button_init           (GtkButton        *button);
66 67 68 69 70 71 72 73
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
74
static void gtk_button_realize        (GtkWidget        *widget);
75
static void gtk_button_unrealize      (GtkWidget        *widget);
Elliot Lee's avatar
Elliot Lee committed
76 77 78 79 80 81 82 83 84 85 86 87
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);
88 89
static gint gtk_button_key_release    (GtkWidget        *widget,
				       GdkEventKey      *event);
Elliot Lee's avatar
Elliot Lee committed
90 91 92 93 94 95 96 97 98 99
static gint gtk_button_enter_notify   (GtkWidget        *widget,
				       GdkEventCrossing *event);
static gint gtk_button_leave_notify   (GtkWidget        *widget,
				       GdkEventCrossing *event);
static void gtk_button_add            (GtkContainer     *container,
				       GtkWidget        *widget);
static void gtk_button_remove         (GtkContainer     *container,
				       GtkWidget        *widget);
static void gtk_real_button_pressed   (GtkButton        *button);
static void gtk_real_button_released  (GtkButton        *button);
100
static void gtk_real_button_activate (GtkButton         *button);
101
static void gtk_button_update_state   (GtkButton        *button);
102
static GtkType gtk_button_child_type  (GtkContainer     *container);
Elliot Lee's avatar
Elliot Lee committed
103

104 105
static void gtk_button_finish_activate (GtkButton *button,
					gboolean   do_it);
Elliot Lee's avatar
Elliot Lee committed
106

107
static GtkBinClass *parent_class = NULL;
108
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
109 110


111
GtkType
112
gtk_button_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
113
{
114
  static GtkType button_type = 0;
Elliot Lee's avatar
Elliot Lee committed
115 116 117

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

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

  return button_type;
}

static void
gtk_button_class_init (GtkButtonClass *klass)
{
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;
147 148
  
  parent_class = g_type_class_peek_parent (klass);
149

150 151
  G_OBJECT_CLASS(object_class)->set_property = gtk_button_set_property;
  G_OBJECT_CLASS(object_class)->get_property = gtk_button_get_property;
152 153

  widget_class->realize = gtk_button_realize;
154
  widget_class->unrealize = gtk_button_unrealize;
155 156 157 158 159
  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;
160
  widget_class->key_release_event = gtk_button_key_release;
161 162 163 164 165 166 167 168 169 170
  widget_class->enter_notify_event = gtk_button_enter_notify;
  widget_class->leave_notify_event = gtk_button_leave_notify;

  container_class->add = gtk_button_add;
  container_class->remove = gtk_button_remove;
  container_class->child_type = gtk_button_child_type;

  klass->pressed = gtk_real_button_pressed;
  klass->released = gtk_real_button_released;
  klass->clicked = NULL;
171 172
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
173
  klass->activate = gtk_real_button_activate;
174

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  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,
                                                        G_PARAM_READABLE | G_PARAM_WRITABLE));
  
  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
191 192 193 194

  button_signals[PRESSED] =
    gtk_signal_new ("pressed",
                    GTK_RUN_FIRST,
195
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
196
                    GTK_SIGNAL_OFFSET (GtkButtonClass, pressed),
197
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
198 199 200 201
		    GTK_TYPE_NONE, 0);
  button_signals[RELEASED] =
    gtk_signal_new ("released",
                    GTK_RUN_FIRST,
202
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
203
                    GTK_SIGNAL_OFFSET (GtkButtonClass, released),
204
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
205 206 207
		    GTK_TYPE_NONE, 0);
  button_signals[CLICKED] =
    gtk_signal_new ("clicked",
208
                    GTK_RUN_FIRST | GTK_RUN_ACTION,
209
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
210
                    GTK_SIGNAL_OFFSET (GtkButtonClass, clicked),
211
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
212 213 214 215
		    GTK_TYPE_NONE, 0);
  button_signals[ENTER] =
    gtk_signal_new ("enter",
                    GTK_RUN_FIRST,
216
                    GTK_CLASS_TYPE (object_class),
217
                    GTK_SIGNAL_OFFSET (GtkButtonClass, enter),
218
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
219 220 221 222
		    GTK_TYPE_NONE, 0);
  button_signals[LEAVE] =
    gtk_signal_new ("leave",
                    GTK_RUN_FIRST,
223
                    GTK_CLASS_TYPE (object_class),
224
                    GTK_SIGNAL_OFFSET (GtkButtonClass, leave),
225
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
226
		    GTK_TYPE_NONE, 0);
227 228 229 230 231 232 233 234
  button_signals[ACTIVATE] =
    gtk_signal_new ("activate",
                    GTK_RUN_FIRST,
                    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];
235 236

  gtk_widget_class_install_style_property (widget_class,
237 238 239 240 241 242 243 244 245 246 247 248
					   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));
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  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
265 266 267 268 269
}

static void
gtk_button_init (GtkButton *button)
{
270
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
271
  GTK_WIDGET_UNSET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
272 273 274 275

  button->child = NULL;
  button->in_button = FALSE;
  button->button_down = FALSE;
276
  button->relief = GTK_RELIEF_NORMAL;
277
  button->depressed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
278 279
}

280 281 282
static GtkType
gtk_button_child_type  (GtkContainer     *container)
{
283
  if (!GTK_BIN (container)->child)
284 285 286 287 288
    return GTK_TYPE_WIDGET;
  else
    return GTK_TYPE_NONE;
}

Elliot Lee's avatar
Elliot Lee committed
289
static void
290 291 292 293
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
294
{
295 296 297
  GtkButton *button;

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

299
  switch (prop_id)
300
    {
301
      GtkWidget *child;
302

303
    case PROP_LABEL:
304 305 306 307 308 309 310
      child = GTK_BIN (button)->child;
      if (!child)
	child = gtk_widget_new (GTK_TYPE_LABEL,
				"visible", TRUE,
				"parent", button,
				NULL);
      if (GTK_IS_LABEL (child))
311 312 313 314
        {
          gtk_label_set_text (GTK_LABEL (child),
                              g_value_get_string (value) ? g_value_get_string (value) : "");
        }
315
      break;
316 317
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
318
      break;
319
    default:
320
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
321 322 323 324 325
      break;
    }
}

static void
326 327 328 329
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
330
{
331 332 333 334
  GtkButton *button;

  button = GTK_BUTTON (object);

335
  switch (prop_id)
336
    {
337
    case PROP_LABEL:
338
      if (GTK_BIN (button)->child && GTK_IS_LABEL (GTK_BIN (button)->child))
Alexander Larsson's avatar
Alexander Larsson committed
339
	 g_value_set_string (value, GTK_LABEL (GTK_BIN (button)->child)->label); 
340
      else
Alexander Larsson's avatar
Alexander Larsson committed
341
	 g_value_set_string (value, NULL);
342
      break;
343
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
344
      g_value_set_enum (value, gtk_button_get_relief (button));
345
      break;
Tim Janik's avatar
Tim Janik committed
346
    default:
347
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
348
      break;
Elliot Lee's avatar
Elliot Lee committed
349 350 351 352
    }
}

GtkWidget*
353
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
{
  return GTK_WIDGET (gtk_type_new (gtk_button_get_type ()));
}

GtkWidget*
gtk_button_new_with_label (const gchar *label)
{
  GtkWidget *button;
  GtkWidget *label_widget;

  button = gtk_button_new ();
  label_widget = gtk_label_new (label);
  gtk_misc_set_alignment (GTK_MISC (label_widget), 0.5, 0.5);

  gtk_container_add (GTK_CONTAINER (button), label_widget);
  gtk_widget_show (label_widget);

  return button;
}

374 375 376 377 378 379
/**
 * gtk_button_new_from_stock:
 * @stock_id: the name of the stock item 
 * @returns: a new #GtkButton
 *
 * Creates a new #GtkButton containing the image and text from a stock item.
380 381
 * Some stock ids have preprocessor macros like #GTK_STOCK_OK and
 * #GTK_STOCK_APPLY.
382
 **/
383
GtkWidget*
384
gtk_button_new_from_stock (const gchar   *stock_id)
385 386 387 388 389 390 391 392 393 394 395 396
{
  GtkWidget *button;
  GtkStockItem item;

  if (gtk_stock_lookup (stock_id, &item))
    {
      GtkWidget *label;
      GtkWidget *image;
      GtkWidget *hbox;
      
      button = gtk_button_new ();

397 398 399
      label = gtk_label_new_with_mnemonic (item.label);

      gtk_label_set_mnemonic_widget (GTK_LABEL (label), button);
400 401

      image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_BUTTON);
Havoc Pennington's avatar
Havoc Pennington committed
402
      hbox = gtk_hbox_new (FALSE, 1);
403

Havoc Pennington's avatar
Havoc Pennington committed
404 405
      gtk_box_pack_start (GTK_BOX (hbox), image, FALSE, FALSE, 0);
      gtk_box_pack_end (GTK_BOX (hbox), label, TRUE, TRUE, 0);
406 407 408 409 410 411
      
      gtk_container_add (GTK_CONTAINER (button), hbox);
      gtk_widget_show_all (hbox);
    }
  else
    {
412
      button = gtk_button_new_with_mnemonic (stock_id);
413 414 415 416 417
    }
  
  return button;
}

418 419 420 421 422 423 424 425 426 427 428
/**
 * 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.
 **/
429
GtkWidget*
430
gtk_button_new_with_mnemonic (const gchar *label)
431 432
{
  GtkWidget *button;
433
  GtkWidget *label_widget;
434 435 436

  button = gtk_button_new ();
  
437
  label_widget = gtk_label_new_with_mnemonic (label);
438

439
  gtk_label_set_mnemonic_widget (GTK_LABEL (label_widget), button);
440
  
441 442
  gtk_container_add (GTK_CONTAINER (button), label_widget);
  gtk_widget_show (label_widget);
443 444 445 446

  return button;
}

Elliot Lee's avatar
Elliot Lee committed
447 448 449
void
gtk_button_pressed (GtkButton *button)
{
450 451
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
452 453 454 455 456 457
  gtk_signal_emit (GTK_OBJECT (button), button_signals[PRESSED]);
}

void
gtk_button_released (GtkButton *button)
{
458 459
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
460 461 462 463 464 465
  gtk_signal_emit (GTK_OBJECT (button), button_signals[RELEASED]);
}

void
gtk_button_clicked (GtkButton *button)
{
466 467
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
468 469 470 471 472 473
  gtk_signal_emit (GTK_OBJECT (button), button_signals[CLICKED]);
}

void
gtk_button_enter (GtkButton *button)
{
474 475
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
476 477 478 479 480 481
  gtk_signal_emit (GTK_OBJECT (button), button_signals[ENTER]);
}

void
gtk_button_leave (GtkButton *button)
{
482 483
  g_return_if_fail (GTK_IS_BUTTON (button));

Elliot Lee's avatar
Elliot Lee committed
484 485 486
  gtk_signal_emit (GTK_OBJECT (button), button_signals[LEAVE]);
}

487 488 489 490 491 492 493
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

  button->relief = newrelief;
494
  g_object_notify(G_OBJECT(button), "relief");
495
  gtk_widget_queue_draw (GTK_WIDGET (button));
496 497 498
}

GtkReliefStyle
499
gtk_button_get_relief (GtkButton *button)
500 501 502 503 504 505 506
{
  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
507 508 509 510 511 512
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
513
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
514 515 516 517 518 519

  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
520 521
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
522
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
523 524 525 526
  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
527 528 529 530 531 532 533 534 535 536 537 538
  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;

539
  widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
Elliot Lee's avatar
Elliot Lee committed
540 541 542 543 544 545
  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);
}

546 547 548 549 550 551 552 553 554 555 556
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
557
static void
558
gtk_button_get_props (GtkButton *button,
559 560
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
561
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
562
{
563
  GtkWidget *widget =  GTK_WIDGET (button);
564 565 566 567 568 569 570 571 572 573 574 575 576 577
  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
578

579 580 581 582 583 584 585 586 587 588 589 590
  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
591

592 593 594 595 596 597 598 599 600
  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);
601
  GtkBorder default_border;
602
  gboolean interior_focus;
Elliot Lee's avatar
Elliot Lee committed
603

604
  gtk_button_get_props (button, &default_border, NULL, &interior_focus);
605
  
Elliot Lee's avatar
Elliot Lee committed
606
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
607
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
608
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
609
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
610 611 612

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
613 614
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
615 616
    }

617
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
618
    {
619
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
620

621 622 623 624
      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
625
    }
626 627 628 629 630 631

  if (interior_focus)
    {
      requisition->width += 2;
      requisition->height += 2;
    }
Elliot Lee's avatar
Elliot Lee committed
632 633 634 635 636 637
}

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

641 642 643
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
644
  GtkBorder default_border;
Elliot Lee's avatar
Elliot Lee committed
645

646
  gtk_button_get_props (button, &default_border, NULL, NULL);
647
  
Elliot Lee's avatar
Elliot Lee committed
648 649 650 651 652 653 654 655 656
  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);

657
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
658
    {
659 660
      child_allocation.x = (CHILD_SPACING + xthickness);
      child_allocation.y = (CHILD_SPACING + ythickness);
Elliot Lee's avatar
Elliot Lee committed
661

662
      child_allocation.width = MAX (1, (gint)widget->allocation.width - child_allocation.x * 2 -
Owen Taylor's avatar
Owen Taylor committed
663
	                         border_width * 2);
664
      child_allocation.height = MAX (1, (gint)widget->allocation.height - child_allocation.y * 2 -
Owen Taylor's avatar
Owen Taylor committed
665
	                          border_width * 2);
Elliot Lee's avatar
Elliot Lee committed
666 667 668

      if (GTK_WIDGET_CAN_DEFAULT (button))
	{
669 670 671 672
	  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
673 674
	}

675 676 677 678 679 680 681 682 683 684 685 686 687
      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;
	}

688
      gtk_widget_size_allocate (GTK_BIN (button)->child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
689 690 691
    }
}

692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
/*
 * +------------------------------------------------+
 * |                   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
718 719 720 721 722 723 724 725
static void
gtk_button_paint (GtkWidget    *widget,
		  GdkRectangle *area)
{
  GtkButton *button;
  GtkShadowType shadow_type;
  gint width, height;
  gint x, y;
726 727
  GtkBorder default_border;
  GtkBorder default_outside_border;
728
  gboolean interior_focus;
729
   
Elliot Lee's avatar
Elliot Lee committed
730 731 732
  if (GTK_WIDGET_DRAWABLE (widget))
    {
      button = GTK_BUTTON (widget);
733

734
      gtk_button_get_props (button, &default_border, &default_outside_border, &interior_focus);
735
	
Elliot Lee's avatar
Elliot Lee committed
736 737 738 739 740
      x = 0;
      y = 0;
      width = widget->allocation.width - GTK_CONTAINER (widget)->border_width * 2;
      height = widget->allocation.height - GTK_CONTAINER (widget)->border_width * 2;

741 742 743 744 745 746 747 748 749 750 751
      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);

752 753 754 755 756 757
	  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
758
	{
759 760 761 762
	  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
763
	}
764
       
765
      if (!interior_focus && GTK_WIDGET_HAS_FOCUS (widget))
Elliot Lee's avatar
Elliot Lee committed
766 767 768 769 770 771
	{
	  x += 1;
	  y += 1;
	  width -= 2;
	  height -= 2;
	}
772 773

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

775 776 777 778 779 780 781 782
      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
783 784
      if (GTK_WIDGET_HAS_FOCUS (widget))
	{
785 786 787 788 789 790 791 792 793 794 795 796 797 798
	  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
799

800 801 802
	  gtk_paint_focus (widget->style, widget->window,
			   area, widget, "button",
			   x, y, width - 1, height - 1);
Elliot Lee's avatar
Elliot Lee committed
803 804 805 806
	}
    }
}

807
static gboolean
Elliot Lee's avatar
Elliot Lee committed
808 809 810
gtk_button_expose (GtkWidget      *widget,
		   GdkEventExpose *event)
{
811
  GtkBin *bin;
Elliot Lee's avatar
Elliot Lee committed
812 813 814 815 816 817 818

  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
819
      bin = GTK_BIN (widget);
820
      
Elliot Lee's avatar
Elliot Lee committed
821
      gtk_button_paint (widget, &event->area);
822 823
      
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
824
    }
825
  
Elliot Lee's avatar
Elliot Lee committed
826 827 828
  return FALSE;
}

829
static gboolean
Elliot Lee's avatar
Elliot Lee committed
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
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)
847
	gtk_button_pressed (button);
Elliot Lee's avatar
Elliot Lee committed
848 849 850 851 852
    }

  return TRUE;
}

853
static gboolean
Elliot Lee's avatar
Elliot Lee committed
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
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;
}

872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
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;
}

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

913
static gboolean
Elliot Lee's avatar
Elliot Lee committed
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
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_button_add (GtkContainer *container,
		GtkWidget    *widget)
{
  g_return_if_fail (container != NULL);
  g_return_if_fail (widget != NULL);

944 945
  if (GTK_CONTAINER_CLASS (parent_class)->add)
    GTK_CONTAINER_CLASS (parent_class)->add (container, widget);
Elliot Lee's avatar
Elliot Lee committed
946

947
  GTK_BUTTON (container)->child = GTK_BIN (container)->child;
Elliot Lee's avatar
Elliot Lee committed
948 949 950 951 952 953 954
}

static void
gtk_button_remove (GtkContainer *container,
		   GtkWidget    *widget)
{
  g_return_if_fail (container != NULL);
Tim Janik's avatar
Tim Janik committed
955
  g_return_if_fail (widget != NULL);
Elliot Lee's avatar
Elliot Lee committed
956

957 958
  if (GTK_CONTAINER_CLASS (parent_class)->remove)
    GTK_CONTAINER_CLASS (parent_class)->remove (container, widget);
Elliot Lee's avatar
Elliot Lee committed
959

960
  GTK_BUTTON (container)->child = GTK_BIN (container)->child;
Elliot Lee's avatar
Elliot Lee committed
961 962 963 964 965
}

static void
gtk_real_button_pressed (GtkButton *button)
{
966 967 968
  if (button->activate_timeout)
    return;
  
Elliot Lee's avatar
Elliot Lee committed
969
  button->button_down = TRUE;
970
  gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
971 972 973 974 975 976 977 978 979
}

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

980 981
      if (button->activate_timeout)
	return;
982
      
Elliot Lee's avatar
Elliot Lee committed
983 984 985
      if (button->in_button)
	gtk_button_clicked (button);

986
      gtk_button_update_state (button);
Elliot Lee's avatar
Elliot Lee committed
987 988
    }
}
989 990 991 992

static gboolean
button_activate_timeout (gpointer data)
{
993 994
  GDK_THREADS_ENTER ();
  
995 996
  gtk_button_finish_activate (data, TRUE);

997 998
  GDK_THREADS_LEAVE ();

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
  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;
1020
	  gtk_button_update_state (button);
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
	}
    }
}

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;
1038
  gtk_button_update_state (button);
1039 1040 1041 1042 1043

  if (do_it)
    gtk_button_clicked (button);
}

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
/**
 * _gtk_button_set_depressed:
 * @button: a #GtkButton
 * @depressed: %TRUE if the button should be drawn with a recessed shadow.
 * 
 * Sets whether the button is currently drawn as down or not. This is 
 * purely a visual setting, and is meant only for use by derived widgets
 * such as #GtkToggleButton.
 **/
void
_gtk_button_set_depressed (GtkButton *button,
			   gboolean   depressed)
{
  GtkWidget *widget = GTK_WIDGET (button);

  depressed = depressed != FALSE;

  if (depressed != button->depressed)
    {
      button->depressed = depressed;
      gtk_widget_queue_resize (widget);
    }
}

static void
gtk_button_update_state (GtkButton *button)
{
  gboolean depressed;
  GtkStateType new_state;

  depressed = button->in_button && button->button_down;
      
  if (!button->button_down && button->in_button)
    new_state = GTK_STATE_PRELIGHT;
  else
    new_state = depressed ? GTK_STATE_ACTIVE: GTK_STATE_NORMAL;

  _gtk_button_set_depressed (button, depressed); 
  gtk_widget_set_state (GTK_WIDGET (button), new_state);
}