gtkbutton.c 42.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
#include "gtkbutton.h"
#include "gtklabel.h"
#include "gtkmain.h"
32
#include "gtkmarshalers.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 const GtkBorder default_default_border = { 1, 1, 1, 1 };
static const 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
  PROP_RELIEF,
  PROP_USE_UNDERLINE,
Soeren Sandmann's avatar
Soeren Sandmann committed
64
  PROP_USE_STOCK,
65 66 67 68 69 70 71 72 73 74 75 76
  PROP_FOCUS_ON_CLICK,
  PROP_XALIGN,
  PROP_YALIGN
};

#define GTK_BUTTON_GET_PRIVATE(o)       (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_BUTTON, GtkButtonPrivate))
typedef struct _GtkButtonPrivate GtkButtonPrivate;

struct _GtkButtonPrivate
{
  gfloat xalign;
  gfloat yalign;
77
};
78

Elliot Lee's avatar
Elliot Lee committed
79 80
static void gtk_button_class_init     (GtkButtonClass   *klass);
static void gtk_button_init           (GtkButton        *button);
81
static void gtk_button_destroy        (GtkObject        *object);
82 83 84 85 86 87 88 89
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
90
static void gtk_button_realize        (GtkWidget        *widget);
91
static void gtk_button_unrealize      (GtkWidget        *widget);
92 93
static void gtk_button_map            (GtkWidget        *widget);
static void gtk_button_unmap          (GtkWidget        *widget);
Elliot Lee's avatar
Elliot Lee committed
94 95 96 97 98 99 100 101 102 103
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);
104 105
static gint gtk_button_key_release    (GtkWidget        *widget,
				       GdkEventKey      *event);
Elliot Lee's avatar
Elliot Lee committed
106 107 108 109 110 111
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);
Manish Singh's avatar
Manish Singh committed
112
static void gtk_real_button_activate  (GtkButton         *button);
113
static void gtk_button_update_state   (GtkButton        *button);
114 115
static void gtk_button_add            (GtkContainer   *container,
			               GtkWidget      *widget);
Manish Singh's avatar
Manish Singh committed
116
static GType gtk_button_child_type    (GtkContainer     *container);
117 118
static void gtk_button_finish_activate (GtkButton *button,
					gboolean   do_it);
Elliot Lee's avatar
Elliot Lee committed
119

120 121 122 123 124 125
static GObject*	gtk_button_constructor     (GType                  type,
					    guint                  n_construct_properties,
					    GObjectConstructParam *construct_params);
static void     gtk_button_construct_child (GtkButton             *button);


126
static GtkBinClass *parent_class = NULL;
127
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
128 129


Manish Singh's avatar
Manish Singh committed
130
GType
131
gtk_button_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
132
{
Manish Singh's avatar
Manish Singh committed
133
  static GType button_type = 0;
Elliot Lee's avatar
Elliot Lee committed
134 135 136

  if (!button_type)
    {
137
      static const GTypeInfo button_info =
Elliot Lee's avatar
Elliot Lee committed
138 139
      {
	sizeof (GtkButtonClass),
140 141 142 143 144 145 146 147
	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
148 149
      };

Manish Singh's avatar
Manish Singh committed
150 151
      button_type = g_type_register_static (GTK_TYPE_BIN, "GtkButton",
					    &button_info, 0);
Elliot Lee's avatar
Elliot Lee committed
152 153 154 155 156 157 158 159
    }

  return button_type;
}

static void
gtk_button_class_init (GtkButtonClass *klass)
{
Manish Singh's avatar
Manish Singh committed
160
  GObjectClass *gobject_class;
Elliot Lee's avatar
Elliot Lee committed
161 162 163 164
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

Manish Singh's avatar
Manish Singh committed
165
  gobject_class = G_OBJECT_CLASS (klass);
Elliot Lee's avatar
Elliot Lee committed
166 167 168
  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;
169 170
  
  parent_class = g_type_class_peek_parent (klass);
171

Manish Singh's avatar
Manish Singh committed
172 173 174
  gobject_class->constructor = gtk_button_constructor;
  gobject_class->set_property = gtk_button_set_property;
  gobject_class->get_property = gtk_button_get_property;
175

176 177
  object_class->destroy = gtk_button_destroy;

178
  widget_class->realize = gtk_button_realize;
179
  widget_class->unrealize = gtk_button_unrealize;
180 181
  widget_class->map = gtk_button_map;
  widget_class->unmap = gtk_button_unmap;
182 183 184 185 186
  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;
187
  widget_class->key_release_event = gtk_button_key_release;
188 189 190 191 192 193 194 195
  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;
196 197
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
198
  klass->activate = gtk_real_button_activate;
199

Manish Singh's avatar
Manish Singh committed
200
  g_object_class_install_property (gobject_class,
201 202 203
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
                                                        _("Label"),
Soren Sandmann's avatar
Soren Sandmann committed
204
                                                        _("Text of the label widget inside the button, if the button contains a label widget"),
205
                                                        NULL,
206 207
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  
Manish Singh's avatar
Manish Singh committed
208
  g_object_class_install_property (gobject_class,
209 210 211 212 213 214 215
                                   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));
  
Manish Singh's avatar
Manish Singh committed
216
  g_object_class_install_property (gobject_class,
217 218 219 220 221 222
                                   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));
223
  
Soeren Sandmann's avatar
Soeren Sandmann committed
224 225 226 227 228 229 230 231
  g_object_class_install_property (gobject_class,
                                   PROP_FOCUS_ON_CLICK,
                                   g_param_spec_boolean ("focus_on_click",
							 _("Focus on click"),
							 _("Whether the button grabs focus when it is clicked with the mouse"),
							 TRUE,
							 G_PARAM_READWRITE));
  
Manish Singh's avatar
Manish Singh committed
232
  g_object_class_install_property (gobject_class,
233 234 235
                                   PROP_RELIEF,
                                   g_param_spec_enum ("relief",
                                                      _("Border relief"),
Soren Sandmann's avatar
Soren Sandmann committed
236
                                                      _("The border relief style"),
237 238 239
                                                      GTK_TYPE_RELIEF_STYLE,
                                                      GTK_RELIEF_NORMAL,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  
  /**
   * GtkButton:xalign:
   *
   * If the child of the button is a #GtkMisc or #GtkAlignment, this property 
   * can be used to control it's horizontal alignment. 0.0 is left aligned, 
   * 1.0 is right aligned.
   * 
   * Since: 2.4
   */
  g_object_class_install_property (gobject_class,
                                   PROP_XALIGN,
                                   g_param_spec_float("xalign",
                                                      _("Horizontal alignment for child"),
                                                      _("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
                                                      0.0,
                                                      1.0,
                                                      0.5,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));

  /**
   * GtkButton:yalign:
   *
   * If the child of the button is a #GtkMisc or #GtkAlignment, this property 
   * can be used to control it's vertical alignment. 0.0 is top aligned, 
   * 1.0 is bottom aligned.
   * 
   * Since: 2.4
   */
  g_object_class_install_property (gobject_class,
                                   PROP_YALIGN,
                                   g_param_spec_float("yalign",
                                                      _("Vertical alignment for child"),
                                                      _("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
                                                      0.0,
                                                      1.0,
                                                      0.5,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
Elliot Lee's avatar
Elliot Lee committed
278 279

  button_signals[PRESSED] =
Manish Singh's avatar
Manish Singh committed
280 281 282 283 284 285 286
    g_signal_new ("pressed",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkButtonClass, pressed),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
Elliot Lee's avatar
Elliot Lee committed
287
  button_signals[RELEASED] =
Manish Singh's avatar
Manish Singh committed
288 289 290 291 292 293 294
    g_signal_new ("released",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkButtonClass, released),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
Elliot Lee's avatar
Elliot Lee committed
295
  button_signals[CLICKED] =
Manish Singh's avatar
Manish Singh committed
296 297 298 299 300 301 302
    g_signal_new ("clicked",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkButtonClass, clicked),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
Elliot Lee's avatar
Elliot Lee committed
303
  button_signals[ENTER] =
Manish Singh's avatar
Manish Singh committed
304 305 306 307 308 309 310
    g_signal_new ("enter",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkButtonClass, enter),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
Elliot Lee's avatar
Elliot Lee committed
311
  button_signals[LEAVE] =
Manish Singh's avatar
Manish Singh committed
312 313 314 315 316 317 318
    g_signal_new ("leave",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkButtonClass, leave),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
319 320 321 322 323 324 325 326 327

  /**
   * GtkButton::activate:
   *
   * The "activate" signal on GtkButton is an action signal and
   * emitting it causes the button to animate press then release. 
   * Applications should never connect to this signal, but use the
   * "clicked" signal.
   */
328
  button_signals[ACTIVATE] =
Manish Singh's avatar
Manish Singh committed
329 330 331 332 333 334 335
    g_signal_new ("activate",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkButtonClass, activate),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
336
  widget_class->activate_signal = button_signals[ACTIVATE];
337 338

  gtk_widget_class_install_style_property (widget_class,
339 340 341 342 343 344 345 346 347 348 349 350
					   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));
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
  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));
367 368

  g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));  
Elliot Lee's avatar
Elliot Lee committed
369 370 371 372 373
}

static void
gtk_button_init (GtkButton *button)
{
374 375
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

376
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
377
  GTK_WIDGET_SET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
378

379 380 381
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
382 383
  button->in_button = FALSE;
  button->button_down = FALSE;
384
  button->relief = GTK_RELIEF_NORMAL;
385 386
  button->use_stock = FALSE;
  button->use_underline = FALSE;
387
  button->depressed = FALSE;
388
  button->depress_on_activate = TRUE;
Soeren Sandmann's avatar
Soeren Sandmann committed
389
  button->focus_on_click = TRUE;
390 391 392

  priv->xalign = 0.5;
  priv->yalign = 0.5;
Elliot Lee's avatar
Elliot Lee committed
393 394
}

395 396 397 398 399 400 401 402 403 404 405 406 407 408
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);
}

409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
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;
}


Manish Singh's avatar
Manish Singh committed
431
static GType
432 433
gtk_button_child_type  (GtkContainer     *container)
{
434
  if (!GTK_BIN (container)->child)
435 436
    return GTK_TYPE_WIDGET;
  else
Manish Singh's avatar
Manish Singh committed
437
    return G_TYPE_NONE;
438 439
}

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
static void
maybe_set_alignment (GtkWidget *widget,
		     gfloat     xalign,
		     gfloat     yalign)
{
  if (GTK_IS_MISC (widget))
    {
      GtkMisc *misc = GTK_MISC (widget);
      gtk_misc_set_alignment (misc, xalign, yalign);
    }
  else if (GTK_IS_ALIGNMENT (widget))
    {
      GtkAlignment *alignment = GTK_ALIGNMENT (widget);
      gtk_alignment_set (alignment, xalign, yalign, alignment->xscale, alignment->yscale);
    }
}

static void
gtk_button_add (GtkContainer *container,
		GtkWidget    *widget)
{
  GtkButton *button = GTK_BUTTON (container);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

  maybe_set_alignment (widget, priv->xalign, priv->yalign);
  GTK_CONTAINER_CLASS (parent_class)->add (container, widget);
}

Elliot Lee's avatar
Elliot Lee committed
468
static void
469 470 471 472
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
473
{
474 475
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
Elliot Lee's avatar
Elliot Lee committed
476

477
  switch (prop_id)
478
    {
479
    case PROP_LABEL:
480
      gtk_button_set_label (button, g_value_get_string (value));
481
      break;
482 483
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
484
      break;
485 486 487 488 489 490
    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;
Soeren Sandmann's avatar
Soeren Sandmann committed
491 492 493
    case PROP_FOCUS_ON_CLICK:
      gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
      break;
494 495 496 497 498 499
    case PROP_XALIGN:
      gtk_button_set_alignment (button, g_value_get_float (value), priv->yalign);
      break;
    case PROP_YALIGN:
      gtk_button_set_alignment (button, priv->xalign, g_value_get_float (value));
      break;
500
    default:
501
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
502 503 504 505 506
      break;
    }
}

static void
507 508 509 510
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
511
{
512 513
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
514

515
  switch (prop_id)
516
    {
517
    case PROP_LABEL:
518
      g_value_set_string (value, button->label_text);
519
      break;
520
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
521
      g_value_set_enum (value, gtk_button_get_relief (button));
522
      break;
523 524 525 526 527 528
    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;
Soeren Sandmann's avatar
Soeren Sandmann committed
529 530 531
    case PROP_FOCUS_ON_CLICK:
      g_value_set_boolean (value, button->focus_on_click);
      break;
532 533 534 535 536 537
    case PROP_XALIGN:
      g_value_set_float (value, priv->xalign);
      break;
    case PROP_YALIGN:
      g_value_set_float (value, priv->yalign);
      break;
Tim Janik's avatar
Tim Janik committed
538
    default:
539
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
540
      break;
Elliot Lee's avatar
Elliot Lee committed
541 542 543 544
    }
}

GtkWidget*
545
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
546
{
Manish Singh's avatar
Manish Singh committed
547
  return g_object_new (GTK_TYPE_BUTTON, NULL);
Elliot Lee's avatar
Elliot Lee committed
548 549
}

550 551
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
552
{
553 554 555 556
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *image;
  GtkWidget *hbox;
557
  GtkWidget *align;
558 559
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
  
560 561 562 563 564
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
565

566 567 568 569 570 571
  if (GTK_BIN (button)->child)
    gtk_container_remove (GTK_CONTAINER (button),
			  GTK_BIN (button)->child);
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
572
    {
573 574
      label = gtk_label_new_with_mnemonic (item.label);

575 576 577
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
      image = gtk_image_new_from_stock (button->label_text, GTK_ICON_SIZE_BUTTON);
578
      hbox = gtk_hbox_new (FALSE, 2);
579

580
      align = gtk_alignment_new (priv->xalign, priv->yalign, 0.0, 0.0);
581
      
Havoc Pennington's avatar
Havoc Pennington committed
582
      gtk_box_pack_start (GTK_BOX (hbox), image, FALSE, FALSE, 0);
583
      gtk_box_pack_end (GTK_BOX (hbox), label, FALSE, FALSE, 0);
584
      
585 586 587
      gtk_container_add (GTK_CONTAINER (button), align);
      gtk_container_add (GTK_CONTAINER (align), hbox);
      gtk_widget_show_all (align);
588 589

      return;
590
    }
591 592

  if (button->use_underline)
593
    {
594 595
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
596
    }
597 598
  else
    label = gtk_label_new (button->label_text);
599
  
600
  gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619

  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.
620 621 622 623 624
 *
 * 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
625 626
 **/
GtkWidget*
627
gtk_button_new_from_stock (const gchar *stock_id)
628
{
629 630 631 632 633
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
                       "use_stock", TRUE,
                       "use_underline", TRUE,
                       NULL);
634 635
}

636 637 638 639 640 641 642
/**
 * 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.
643 644 645 646
 * 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.
647 648
 * Pressing Alt and that key activates the button.
 **/
649
GtkWidget*
650
gtk_button_new_with_mnemonic (const gchar *label)
651
{
652
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use_underline", TRUE,  NULL);
653 654
}

Elliot Lee's avatar
Elliot Lee committed
655 656 657
void
gtk_button_pressed (GtkButton *button)
{
658 659
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
660
  g_signal_emit (button, button_signals[PRESSED], 0);
Elliot Lee's avatar
Elliot Lee committed
661 662 663 664 665
}

void
gtk_button_released (GtkButton *button)
{
666 667
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
668
  g_signal_emit (button, button_signals[RELEASED], 0);
Elliot Lee's avatar
Elliot Lee committed
669 670 671 672 673
}

void
gtk_button_clicked (GtkButton *button)
{
674 675
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
676
  g_signal_emit (button, button_signals[CLICKED], 0);
Elliot Lee's avatar
Elliot Lee committed
677 678 679 680 681
}

void
gtk_button_enter (GtkButton *button)
{
682 683
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
684
  g_signal_emit (button, button_signals[ENTER], 0);
Elliot Lee's avatar
Elliot Lee committed
685 686 687 688 689
}

void
gtk_button_leave (GtkButton *button)
{
690 691
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
692
  g_signal_emit (button, button_signals[LEAVE], 0);
Elliot Lee's avatar
Elliot Lee committed
693 694
}

695 696 697 698 699 700
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

701 702 703 704 705 706
  if (newrelief != button->relief) 
    {
       button->relief = newrelief;
       g_object_notify (G_OBJECT (button), "relief");
       gtk_widget_queue_draw (GTK_WIDGET (button));
    }
707 708 709
}

GtkReliefStyle
710
gtk_button_get_relief (GtkButton *button)
711 712 713 714 715 716 717
{
  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
718 719 720 721 722 723
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
724
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
725 726 727 728

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

Owen Taylor's avatar
Owen Taylor committed
729 730
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
731
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
732 733 734 735
  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;
736
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
737
  attributes.event_mask = gtk_widget_get_events (widget);
738
  attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
739 740 741 742
			    GDK_BUTTON_RELEASE_MASK |
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

743
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
744

745
  widget->window = gtk_widget_get_parent_window (widget);
Manish Singh's avatar
Manish Singh committed
746
  g_object_ref (widget->window);
747 748 749 750
  
  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
751 752 753 754

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

755 756 757 758 759 760 761
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
762 763 764 765 766 767 768 769

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }
  
770 771 772
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

773 774 775 776 777 778 779
static void
gtk_button_map (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
  
  g_return_if_fail (GTK_IS_BUTTON (widget));

780 781
  GTK_WIDGET_CLASS (parent_class)->map (widget);

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
  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
799
static void
800
gtk_button_get_props (GtkButton *button,
801 802
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
803
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
804
{
805
  GtkWidget *widget =  GTK_WIDGET (button);
806 807 808 809 810 811 812 813 814 815 816 817 818 819
  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
820

821 822 823 824 825 826 827 828 829 830 831 832
  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
833

834 835 836 837 838 839 840 841 842
  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);
843
  GtkBorder default_border;
844
  gboolean interior_focus;
845 846
  gint focus_width;
  gint focus_pad;
Elliot Lee's avatar
Elliot Lee committed
847

848
  gtk_button_get_props (button, &default_border, NULL, &interior_focus);
849 850 851 852 853
  gtk_widget_style_get (GTK_WIDGET (widget),
			"focus-line-width", &focus_width,
			"focus-padding", &focus_pad,
			NULL);
 
Elliot Lee's avatar
Elliot Lee committed
854
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
855
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
856
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
857
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
858 859 860

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
861 862
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
863 864
    }

865
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
866
    {
867
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
868

869 870 871 872
      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
873
    }
874 875 876
  
  requisition->width += 2 * (focus_width + focus_pad);
  requisition->height += 2 * (focus_width + focus_pad);
Elliot Lee's avatar
Elliot Lee committed
877 878 879 880 881 882
}

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

886 887 888
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
889
  GtkBorder default_border;
Elliot Lee's avatar
Elliot Lee committed
890

891
  gtk_button_get_props (button, &default_border, NULL, NULL);
892
			    
Elliot Lee's avatar
Elliot Lee committed
893 894 895
  widget->allocation = *allocation;

  if (GTK_WIDGET_REALIZED (widget))
896
    gdk_window_move_resize (button->event_window,
Elliot Lee's avatar
Elliot Lee committed
897 898 899 900 901
			    widget->allocation.x + border_width,
			    widget->allocation.y + border_width,
			    widget->allocation.width - border_width * 2,
			    widget->allocation.height - border_width * 2);

902
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
903
    {
904 905 906 907 908 909 910
      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
911 912 913

      if (GTK_WIDGET_CAN_DEFAULT (button))
	{
914 915 916 917
	  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
918 919
	}

920 921 922 923 924 925 926 927 928 929 930 931 932
      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;
	}

933
      gtk_widget_size_allocate (GTK_BIN (button)->child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
934 935 936
    }
}

937 938 939 940 941 942 943
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
944
{
945
  GtkWidget *widget;
Elliot Lee's avatar
Elliot Lee committed
946 947
  gint width, height;
  gint x, y;
948
  gint border_width;
949 950
  GtkBorder default_border;
  GtkBorder default_outside_border;
951
  gboolean interior_focus;
952 953
  gint focus_width;
  gint focus_pad;
954
   
955
  if (GTK_WIDGET_DRAWABLE (button))
Elliot Lee's avatar
Elliot Lee committed
956
    {
957
      widget = GTK_WIDGET (button);
958
      border_width = GTK_CONTAINER (widget)->border_width;
959

960
      gtk_button_get_props (button, &default_border, &default_outside_border, &interior_focus);
961 962 963 964
      gtk_widget_style_get (GTK_WIDGET (widget),
			    "focus-line-width", &focus_width,
			    "focus-padding", &focus_pad,
			    NULL); 
965
	
966 967 968 969
      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;
970 971 972 973 974 975 976 977 978

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

979 980 981 982 983 984
	  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
985
	{
986 987 988 989
	  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
990
	}
991
       
992
      if (!interior_focus && GTK_WIDGET_HAS_FOCUS (widget))
Elliot Lee's avatar
Elliot Lee committed
993
	{
994 995 996 997
	  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
998
	}
999

1000 1001 1002 1003
      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,
1004
		       state_type,
1005 1006 1007
		       shadow_type, area, widget, "button",
		       x, y, width, height);
       
Elliot Lee's avatar
Elliot Lee committed
1008 1009
      if (GTK_WIDGET_HAS_FOCUS (widget))
	{
1010 1011
	  if (interior_focus)
	    {
1012 1013 1014 1015
	      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);
1016 1017 1018
	    }
	  else
	    {
1019 1020 1021 1022
	      x -= focus_width + focus_pad;
	      y -= focus_width + focus_pad;
	      width += 2 * (focus_width + focus_pad);
	      height += 2 * (focus_width + focus_pad);
1023
	    }
Elliot Lee's avatar
Elliot Lee committed
1024

1025
	  gtk_paint_focus (widget->style, widget->window, GTK_WIDGET_STATE (widget),
1026
			   area, widget, "button",
1027
			   x, y, width, height);
Elliot Lee's avatar
Elliot Lee committed
1028 1029 1030 1031
	}
    }
}

1032
static gboolean
Elliot Lee's avatar
Elliot Lee committed
1033 1034 1035 1036 1037
gtk_button_expose (GtkWidget      *widget,
		   GdkEventExpose *event)
{
  if (GTK_WIDGET_DRAWABLE (widget))
    {
1038
      GtkButton *button = GTK_BUTTON (widget);
1039
      
1040 1041 1042 1043
      _gtk_button_paint (button, &event->area,
			 GTK_WIDGET_STATE (widget),
			 button->depressed ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
			 "button", "buttondefault");
1044 1045
      
      (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
Elliot Lee's avatar
Elliot Lee committed
1046
    }
1047
  
Elliot Lee's avatar
Elliot Lee committed
1048 1049 1050
  return FALSE;
}

1051
static gboolean
Elliot Lee's avatar
Elliot Lee committed
1052