gtkbutton.c 49.6 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 <config.h>
28
#include <string.h>
29
#include "gtkalias.h"
30
#include "gtkalignment.h"
Elliot Lee's avatar
Elliot Lee committed
31 32 33
#include "gtkbutton.h"
#include "gtklabel.h"
#include "gtkmain.h"
34
#include "gtkmarshalers.h"
35 36 37 38
#include "gtkimage.h"
#include "gtkhbox.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
39
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
40 41

#define CHILD_SPACING     1
42

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

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

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

61
enum {
62 63
  PROP_0,
  PROP_LABEL,
Matthias Clasen's avatar
Matthias Clasen committed
64
  PROP_IMAGE,
65 66
  PROP_RELIEF,
  PROP_USE_UNDERLINE,
Soeren Sandmann's avatar
Soeren Sandmann committed
67
  PROP_USE_STOCK,
68 69
  PROP_FOCUS_ON_CLICK,
  PROP_XALIGN,
Matthias Clasen's avatar
Matthias Clasen committed
70
  PROP_YALIGN,
71 72 73 74 75 76 77
};

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

struct _GtkButtonPrivate
{
Matthias Clasen's avatar
Matthias Clasen committed
78 79 80
  gfloat       xalign;
  gfloat       yalign;
  GtkWidget   *image;
Matthias Clasen's avatar
Matthias Clasen committed
81
  guint        align_set : 1;
Matthias Clasen's avatar
Matthias Clasen committed
82
  guint        image_is_stock : 1;
83
};
84

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

128 129 130
static GObject*	gtk_button_constructor (GType                  type,
					guint                  n_construct_properties,
					GObjectConstructParam *construct_params);
Matthias Clasen's avatar
Matthias Clasen committed
131
static void gtk_button_construct_child (GtkButton             *button);
132 133 134 135 136
static void gtk_button_state_changed   (GtkWidget             *widget,
					GtkStateType           previous_state);
static void gtk_button_grab_notify     (GtkWidget             *widget,
					gboolean               was_grabbed);

137 138


139
static GtkBinClass *parent_class = NULL;
140
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
141 142


Manish Singh's avatar
Manish Singh committed
143
GType
144
gtk_button_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
145
{
Manish Singh's avatar
Manish Singh committed
146
  static GType button_type = 0;
Elliot Lee's avatar
Elliot Lee committed
147 148 149

  if (!button_type)
    {
150
      static const GTypeInfo button_info =
Elliot Lee's avatar
Elliot Lee committed
151 152
      {
	sizeof (GtkButtonClass),
153 154 155 156 157 158 159 160
	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
161 162
      };

Manish Singh's avatar
Manish Singh committed
163 164
      button_type = g_type_register_static (GTK_TYPE_BIN, "GtkButton",
					    &button_info, 0);
Elliot Lee's avatar
Elliot Lee committed
165 166 167 168 169 170 171 172
    }

  return button_type;
}

static void
gtk_button_class_init (GtkButtonClass *klass)
{
Manish Singh's avatar
Manish Singh committed
173
  GObjectClass *gobject_class;
Elliot Lee's avatar
Elliot Lee committed
174 175 176 177
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

Manish Singh's avatar
Manish Singh committed
178
  gobject_class = G_OBJECT_CLASS (klass);
Elliot Lee's avatar
Elliot Lee committed
179 180 181
  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;
182 183
  
  parent_class = g_type_class_peek_parent (klass);
184

Manish Singh's avatar
Manish Singh committed
185 186 187
  gobject_class->constructor = gtk_button_constructor;
  gobject_class->set_property = gtk_button_set_property;
  gobject_class->get_property = gtk_button_get_property;
188

189 190
  object_class->destroy = gtk_button_destroy;

Matthias Clasen's avatar
Matthias Clasen committed
191
  widget_class->screen_changed = gtk_button_screen_changed;
192
  widget_class->realize = gtk_button_realize;
193
  widget_class->unrealize = gtk_button_unrealize;
194 195
  widget_class->map = gtk_button_map;
  widget_class->unmap = gtk_button_unmap;
196 197 198 199 200
  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;
201
  widget_class->key_release_event = gtk_button_key_release;
202 203
  widget_class->enter_notify_event = gtk_button_enter_notify;
  widget_class->leave_notify_event = gtk_button_leave_notify;
204 205
  widget_class->state_changed = gtk_button_state_changed;
  widget_class->grab_notify = gtk_button_grab_notify;
206 207

  container_class->child_type = gtk_button_child_type;
208
  container_class->add = gtk_button_add;
209 210 211 212

  klass->pressed = gtk_real_button_pressed;
  klass->released = gtk_real_button_released;
  klass->clicked = NULL;
213 214
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
215
  klass->activate = gtk_real_button_activate;
216

Manish Singh's avatar
Manish Singh committed
217
  g_object_class_install_property (gobject_class,
218 219
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
220 221
                                                        P_("Label"),
                                                        P_("Text of the label widget inside the button, if the button contains a label widget"),
222
                                                        NULL,
223 224
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  
Manish Singh's avatar
Manish Singh committed
225
  g_object_class_install_property (gobject_class,
226 227
                                   PROP_USE_UNDERLINE,
                                   g_param_spec_boolean ("use_underline",
228 229
							 P_("Use underline"),
							 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
230 231 232
                                                        FALSE,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
  
Manish Singh's avatar
Manish Singh committed
233
  g_object_class_install_property (gobject_class,
234 235
                                   PROP_USE_STOCK,
                                   g_param_spec_boolean ("use_stock",
236 237
							 P_("Use stock"),
							 P_("If set, the label is used to pick a stock item instead of being displayed"),
238 239
                                                        FALSE,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
240
  
Soeren Sandmann's avatar
Soeren Sandmann committed
241 242 243
  g_object_class_install_property (gobject_class,
                                   PROP_FOCUS_ON_CLICK,
                                   g_param_spec_boolean ("focus_on_click",
244 245
							 P_("Focus on click"),
							 P_("Whether the button grabs focus when it is clicked with the mouse"),
Soeren Sandmann's avatar
Soeren Sandmann committed
246 247 248
							 TRUE,
							 G_PARAM_READWRITE));
  
Manish Singh's avatar
Manish Singh committed
249
  g_object_class_install_property (gobject_class,
250 251
                                   PROP_RELIEF,
                                   g_param_spec_enum ("relief",
252 253
                                                      P_("Border relief"),
                                                      P_("The border relief style"),
254 255 256
                                                      GTK_TYPE_RELIEF_STYLE,
                                                      GTK_RELIEF_NORMAL,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
257 258 259 260 261 262 263 264 265 266 267 268 269
  
  /**
   * 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",
270 271
                                                      P_("Horizontal alignment for child"),
                                                      P_("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
                                                      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",
289 290
                                                      P_("Vertical alignment for child"),
                                                      P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
291 292 293 294
                                                      0.0,
                                                      1.0,
                                                      0.5,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE));
Elliot Lee's avatar
Elliot Lee committed
295

Matthias Clasen's avatar
Matthias Clasen committed
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  /**
   * GtkButton::image:
   * 
   * The child widget to appear next to the button text.
   * 
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE,
                                   g_param_spec_object ("image",
                                                        P_("Image widget"),
                                                        P_("Child widget to appear next to the button text"),
                                                        GTK_TYPE_WIDGET,
                                                        G_PARAM_READABLE | G_PARAM_WRITABLE));

Elliot Lee's avatar
Elliot Lee committed
311
  button_signals[PRESSED] =
Manish Singh's avatar
Manish Singh committed
312 313 314 315 316 317 318
    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
319
  button_signals[RELEASED] =
Manish Singh's avatar
Manish Singh committed
320 321 322 323 324 325 326
    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
327
  button_signals[CLICKED] =
Manish Singh's avatar
Manish Singh committed
328 329 330 331 332 333 334
    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
335
  button_signals[ENTER] =
Manish Singh's avatar
Manish Singh committed
336 337 338 339 340 341 342
    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
343
  button_signals[LEAVE] =
Manish Singh's avatar
Manish Singh committed
344 345 346 347 348 349 350
    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);
351 352 353

  /**
   * GtkButton::activate:
Matthias Clasen's avatar
Matthias Clasen committed
354
   * @widget: the object which received the signal.
355 356 357 358 359 360
   *
   * 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.
   */
361
  button_signals[ACTIVATE] =
Manish Singh's avatar
Manish Singh committed
362 363 364 365 366 367 368
    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);
369
  widget_class->activate_signal = button_signals[ACTIVATE];
370 371

  gtk_widget_class_install_style_property (widget_class,
372
					   g_param_spec_boxed ("default_border",
373 374
							       P_("Default Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons"),
375 376 377 378 379
							       GTK_TYPE_BORDER,
							       G_PARAM_READABLE));

  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_boxed ("default_outside_border",
380 381
							       P_("Default Outside Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons that is always drawn outside the border"),
382 383
							       GTK_TYPE_BORDER,
							       G_PARAM_READABLE));
384 385
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_displacement_x",
386 387
							     P_("Child X Displacement"),
							     P_("How far in the x direction to move the child when the button is depressed"),
388 389 390 391 392 393
							     G_MININT,
							     G_MAXINT,
							     0,
							     G_PARAM_READABLE));
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("child_displacement_y",
394 395
							     P_("Child Y Displacement"),
							     P_("How far in the y direction to move the child when the button is depressed"),
396 397 398 399
							     G_MININT,
							     G_MAXINT,
							     0,
							     G_PARAM_READABLE));
400

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  /**
   * GtkButton:displace-focus:
   *
   * Whether the child_displacement_x/child_displacement_y properties should also 
   * affect the focus rectangle.
   *
   * Since: 2.6
   */
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_boolean ("displace-focus",
								 P_("Displace focus"),
								 P_("Whether the child_displacement_x/_y properties should also affect the focus rectangle"),
						       FALSE,
						       G_PARAM_READABLE));

Matthias Clasen's avatar
Matthias Clasen committed
416 417 418 419 420 421
  gtk_settings_install_property (g_param_spec_boolean ("gtk-button-images",
						       P_("Show button images"),
						       P_("Whether stock icons should be shown in buttons"),
						       TRUE,
						       G_PARAM_READWRITE));
  
422
  g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));  
Elliot Lee's avatar
Elliot Lee committed
423 424 425 426 427
}

static void
gtk_button_init (GtkButton *button)
{
428 429
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

430
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
431
  GTK_WIDGET_SET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
432

433 434 435
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
436 437
  button->in_button = FALSE;
  button->button_down = FALSE;
438
  button->relief = GTK_RELIEF_NORMAL;
439 440
  button->use_stock = FALSE;
  button->use_underline = FALSE;
441
  button->depressed = FALSE;
442
  button->depress_on_activate = TRUE;
Soeren Sandmann's avatar
Soeren Sandmann committed
443
  button->focus_on_click = TRUE;
444 445 446

  priv->xalign = 0.5;
  priv->yalign = 0.5;
Matthias Clasen's avatar
Matthias Clasen committed
447
  priv->align_set = 0;
Elliot Lee's avatar
Elliot Lee committed
448 449
}

450 451 452 453 454 455 456 457 458 459 460 461 462 463
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);
}

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
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
486
static GType
487 488
gtk_button_child_type  (GtkContainer     *container)
{
489
  if (!GTK_BIN (container)->child)
490 491
    return GTK_TYPE_WIDGET;
  else
Manish Singh's avatar
Manish Singh committed
492
    return G_TYPE_NONE;
493 494
}

495
static void
Matthias Clasen's avatar
Matthias Clasen committed
496 497
maybe_set_alignment (GtkButton *button,
		     GtkWidget *widget)
498
{
Matthias Clasen's avatar
Matthias Clasen committed
499 500
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

501 502 503
  if (GTK_IS_MISC (widget))
    {
      GtkMisc *misc = GTK_MISC (widget);
Matthias Clasen's avatar
Matthias Clasen committed
504 505 506
      
      if (priv->align_set)
	gtk_misc_set_alignment (misc, priv->xalign, priv->yalign);
507 508 509 510
    }
  else if (GTK_IS_ALIGNMENT (widget))
    {
      GtkAlignment *alignment = GTK_ALIGNMENT (widget);
Matthias Clasen's avatar
Matthias Clasen committed
511 512 513 514

      if (priv->align_set)
	gtk_alignment_set (alignment, priv->xalign, priv->yalign, 
			   alignment->xscale, alignment->yscale);
515 516 517 518 519 520 521
    }
}

static void
gtk_button_add (GtkContainer *container,
		GtkWidget    *widget)
{
Matthias Clasen's avatar
Matthias Clasen committed
522
  maybe_set_alignment (GTK_BUTTON (container), widget);
523 524 525 526

  GTK_CONTAINER_CLASS (parent_class)->add (container, widget);
}

Elliot Lee's avatar
Elliot Lee committed
527
static void
528 529 530 531
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
532
{
533 534
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
Elliot Lee's avatar
Elliot Lee committed
535

536
  switch (prop_id)
537
    {
538
    case PROP_LABEL:
539
      gtk_button_set_label (button, g_value_get_string (value));
540
      break;
Matthias Clasen's avatar
Matthias Clasen committed
541 542 543
    case PROP_IMAGE:
      gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
      break;
544 545
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
546
      break;
547 548 549 550 551 552
    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
553 554 555
    case PROP_FOCUS_ON_CLICK:
      gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
      break;
556 557 558 559 560 561
    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;
562
    default:
563
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
564 565 566 567 568
      break;
    }
}

static void
569 570 571 572
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
573
{
574 575
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
576

577
  switch (prop_id)
578
    {
579
    case PROP_LABEL:
580
      g_value_set_string (value, button->label_text);
581
      break;
Matthias Clasen's avatar
Matthias Clasen committed
582 583 584
    case PROP_IMAGE:
      g_value_set_object (value, (GObject *)priv->image);
      break;
585
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
586
      g_value_set_enum (value, gtk_button_get_relief (button));
587
      break;
588 589 590 591 592 593
    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
594 595 596
    case PROP_FOCUS_ON_CLICK:
      g_value_set_boolean (value, button->focus_on_click);
      break;
597 598 599 600 601 602
    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
603
    default:
604
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
605
      break;
Elliot Lee's avatar
Elliot Lee committed
606 607 608 609
    }
}

GtkWidget*
610
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
611
{
Manish Singh's avatar
Manish Singh committed
612
  return g_object_new (GTK_TYPE_BUTTON, NULL);
Elliot Lee's avatar
Elliot Lee committed
613 614
}

Matthias Clasen's avatar
Matthias Clasen committed
615 616 617 618 619 620 621 622 623 624 625
static gboolean
show_image (GtkButton *button)
{
  GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (button));  
  gboolean show;

  g_object_get (settings, "gtk-button-images", &show, NULL);

  return show;
}

626 627
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
628
{
Matthias Clasen's avatar
Matthias Clasen committed
629
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
630 631 632
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *hbox;
633
  GtkWidget *align;
Matthias Clasen's avatar
Matthias Clasen committed
634 635
  GtkWidget *image = NULL;
  gchar *label_text = NULL;
636
  
637 638 639 640 641
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
642

643
  if (GTK_BIN (button)->child)
644
    {
Matthias Clasen's avatar
Matthias Clasen committed
645 646 647
      if (priv->image && !priv->image_is_stock)
	image = g_object_ref (priv->image);

648 649
      gtk_container_remove (GTK_CONTAINER (button),
  			    GTK_BIN (button)->child);
Matthias Clasen's avatar
Matthias Clasen committed
650
  
651 652
      priv->image = NULL;
    }
653 654 655
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
656
    {
Matthias Clasen's avatar
Matthias Clasen committed
657 658 659 660 661 662 663
      if (!image)
	image = g_object_ref (gtk_image_new_from_stock (button->label_text, GTK_ICON_SIZE_BUTTON));

      label_text = item.label;
    }
  else
    label_text = button->label_text;
664

Matthias Clasen's avatar
Matthias Clasen committed
665 666 667
  if (image)
    {
      label = gtk_label_new_with_mnemonic (label_text);
668 669
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
Matthias Clasen's avatar
Matthias Clasen committed
670 671
      priv->image = image;

Matthias Clasen's avatar
Matthias Clasen committed
672 673 674 675
      g_object_set (priv->image, 
		    "visible", show_image (button),
		    "no_show_all", TRUE,
		    NULL);
676
      hbox = gtk_hbox_new (FALSE, 2);
677

Matthias Clasen's avatar
Matthias Clasen committed
678 679 680 681 682
      if (priv->align_set)
	align = gtk_alignment_new (priv->xalign, priv->yalign, 0.0, 0.0);
      else
	align = gtk_alignment_new (0.5, 0.5, 0.0, 0.0);
	
Matthias Clasen's avatar
Matthias Clasen committed
683
      gtk_box_pack_start (GTK_BOX (hbox), priv->image, FALSE, FALSE, 0);
684
      gtk_box_pack_end (GTK_BOX (hbox), label, FALSE, FALSE, 0);
685
      
686 687 688
      gtk_container_add (GTK_CONTAINER (button), align);
      gtk_container_add (GTK_CONTAINER (align), hbox);
      gtk_widget_show_all (align);
689

Matthias Clasen's avatar
Matthias Clasen committed
690 691
      g_object_unref (image);

692
      return;
693
    }
Matthias Clasen's avatar
Matthias Clasen committed
694 695
  
 if (button->use_underline)
696
    {
697 698
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
699
    }
700 701
  else
    label = gtk_label_new (button->label_text);
702
  
Matthias Clasen's avatar
Matthias Clasen committed
703 704
  if (priv->align_set)
    gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723

  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.
724 725 726 727 728
 *
 * 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
729 730
 **/
GtkWidget*
731
gtk_button_new_from_stock (const gchar *stock_id)
732
{
733 734 735 736 737
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
                       "use_stock", TRUE,
                       "use_underline", TRUE,
                       NULL);
738 739
}

740 741 742 743 744 745 746
/**
 * 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.
747 748 749 750
 * 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.
751 752
 * Pressing Alt and that key activates the button.
 **/
753
GtkWidget*
754
gtk_button_new_with_mnemonic (const gchar *label)
755
{
756
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use_underline", TRUE,  NULL);
757 758
}

Elliot Lee's avatar
Elliot Lee committed
759 760 761
void
gtk_button_pressed (GtkButton *button)
{
762 763
  g_return_if_fail (GTK_IS_BUTTON (button));

Matthias Clasen's avatar
Matthias Clasen committed
764
  
Manish Singh's avatar
Manish Singh committed
765
  g_signal_emit (button, button_signals[PRESSED], 0);
Elliot Lee's avatar
Elliot Lee committed
766 767 768 769 770
}

void
gtk_button_released (GtkButton *button)
{
771 772
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
773
  g_signal_emit (button, button_signals[RELEASED], 0);
Elliot Lee's avatar
Elliot Lee committed
774 775 776 777 778
}

void
gtk_button_clicked (GtkButton *button)
{
779 780
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
781
  g_signal_emit (button, button_signals[CLICKED], 0);
Elliot Lee's avatar
Elliot Lee committed
782 783 784 785 786
}

void
gtk_button_enter (GtkButton *button)
{
787 788
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
789
  g_signal_emit (button, button_signals[ENTER], 0);
Elliot Lee's avatar
Elliot Lee committed
790 791 792 793 794
}

void
gtk_button_leave (GtkButton *button)
{
795 796
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
797
  g_signal_emit (button, button_signals[LEAVE], 0);
Elliot Lee's avatar
Elliot Lee committed
798 799
}

800 801 802 803 804 805
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

806 807 808 809 810 811
  if (newrelief != button->relief) 
    {
       button->relief = newrelief;
       g_object_notify (G_OBJECT (button), "relief");
       gtk_widget_queue_draw (GTK_WIDGET (button));
    }
812 813 814
}

GtkReliefStyle
815
gtk_button_get_relief (GtkButton *button)
816 817 818 819 820 821
{
  g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);

  return button->relief;
}

Elliot Lee's avatar
Elliot Lee committed
822 823 824 825 826 827
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
828
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
829 830 831 832

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

Owen Taylor's avatar
Owen Taylor committed
833 834
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
835
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
836 837 838 839
  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;
840
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
841
  attributes.event_mask = gtk_widget_get_events (widget);
842
  attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
843 844 845 846
			    GDK_BUTTON_RELEASE_MASK |
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

847
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
848

849
  widget->window = gtk_widget_get_parent_window (widget);
Manish Singh's avatar
Manish Singh committed
850
  g_object_ref (widget->window);
851 852 853 854
  
  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
855 856 857 858

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

859 860 861 862 863 864 865
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
866 867 868 869 870 871 872 873

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }
  
874 875 876
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

877 878 879 880 881
static void
gtk_button_map (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
  
882 883
  GTK_WIDGET_CLASS (parent_class)->map (widget);

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
  if (button->event_window)
    gdk_window_show (button->event_window);
}

static void
gtk_button_unmap (GtkWidget *widget)
{
  GtkButton *button = GTK_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
899
static void
900
gtk_button_get_props (GtkButton *button,
901 902
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
903
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
904
{
905
  GtkWidget *widget =  GTK_WIDGET (button);
906 907 908 909 910 911 912 913 914 915 916 917 918 919
  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
920

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

934 935 936 937 938 939 940 941 942
  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);
943
  GtkBorder default_border;
944 945
  gint focus_width;
  gint focus_pad;
Elliot Lee's avatar
Elliot Lee committed
946

947
  gtk_button_get_props (button, &default_border, NULL, NULL);
948 949 950 951 952
  gtk_widget_style_get (GTK_WIDGET (widget),
			"focus-line-width", &focus_width,
			"focus-padding", &focus_pad,
			NULL);
 
Elliot Lee's avatar
Elliot Lee committed
953
  requisition->width = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
954
			GTK_WIDGET (widget)->style->xthickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
955
  requisition->height = (GTK_CONTAINER (widget)->border_width + CHILD_SPACING +
956
			 GTK_WIDGET (widget)->style->ythickness) * 2;
Elliot Lee's avatar
Elliot Lee committed
957 958 959

  if (GTK_WIDGET_CAN_DEFAULT (widget))
    {
960 961
      requisition->width += default_border.left + default_border.right;
      requisition->height += default_border.top + default_border.bottom;
Elliot Lee's avatar
Elliot Lee committed
962 963
    }

964
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
965
    {
966
      GtkRequisition child_requisition;
Elliot Lee's avatar
Elliot Lee committed
967

968 969 970 971
      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
972
    }
973
  
974 975
  requisition->width += 2 * (focus_width + focus_pad);
  requisition->height += 2 * (focus_width + focus_pad);
Elliot Lee's avatar
Elliot Lee committed
976 977 978 979 980 981
}

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

985 986 987
  gint border_width = GTK_CONTAINER (widget)->border_width;
  gint xthickness = GTK_WIDGET (widget)->style->xthickness;
  gint ythickness = GTK_WIDGET (widget)->style->ythickness;
988
  GtkBorder default_border;
989 990
  gint focus_width;
  gint focus_pad;
Elliot Lee's avatar
Elliot Lee committed
991

992
  gtk_button_get_props (button, &default_border, NULL, NULL);
993 994 995 996 997
  gtk_widget_style_get (GTK_WIDGET (widget),
			"focus-line-width", &focus_width,
			"focus-padding", &focus_pad,
			NULL);
 
998
			    
Elliot Lee's avatar
Elliot Lee committed
999 1000 1001
  widget->allocation = *allocation;

  if (GTK_WIDGET_REALIZED (widget))
1002
    gdk_window_move_resize (button->event_window,
Elliot Lee's avatar
Elliot Lee committed
1003 1004 1005 1006 1007
			    widget->allocation.x + border_width,
			    widget->allocation.y + border_width,
			    widget->allocation.width - border_width * 2,
			    widget->allocation.height - border_width * 2);

1008
  if (GTK_BIN (button)->child && GTK_WIDGET_VISIBLE (GTK_BIN (button)->child))
Elliot Lee's avatar
Elliot Lee committed
1009
    {
1010