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

#define CHILD_SPACING     1
43

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

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

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

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

#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
79 80 81
  gfloat       xalign;
  gfloat       yalign;
  GtkWidget   *image;
Matthias Clasen's avatar
Matthias Clasen committed
82
  guint        align_set : 1;
Matthias Clasen's avatar
Matthias Clasen committed
83
  guint        image_is_stock : 1;
84 85
  guint        has_grab : 1;
  guint32      grab_time;
86
};
87

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

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

140 141


142
static GtkBinClass *parent_class = NULL;
143
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
144 145


Manish Singh's avatar
Manish Singh committed
146
GType
147
gtk_button_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
148
{
Manish Singh's avatar
Manish Singh committed
149
  static GType button_type = 0;
Elliot Lee's avatar
Elliot Lee committed
150 151 152

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

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

  return button_type;
}

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

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

Manish Singh's avatar
Manish Singh committed
188 189 190
  gobject_class->constructor = gtk_button_constructor;
  gobject_class->set_property = gtk_button_set_property;
  gobject_class->get_property = gtk_button_get_property;
191

192 193
  object_class->destroy = gtk_button_destroy;

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

  container_class->child_type = gtk_button_child_type;
211
  container_class->add = gtk_button_add;
212 213 214 215

  klass->pressed = gtk_real_button_pressed;
  klass->released = gtk_real_button_released;
  klass->clicked = NULL;
216 217
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
218
  klass->activate = gtk_real_button_activate;
219

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

  /**
   * 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",
292 293
                                                      P_("Vertical alignment for child"),
                                                      P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
294 295 296
                                                      0.0,
                                                      1.0,
                                                      0.5,
297
                                                      GTK_PARAM_READWRITE));
Elliot Lee's avatar
Elliot Lee committed
298

Matthias Clasen's avatar
Matthias Clasen committed
299 300 301 302 303 304 305 306 307 308 309 310 311
  /**
   * 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,
312
                                                        GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
313

314 315 316 317 318 319 320 321
  /**
   * GtkButton::pressed:
   * @button: the object that received the signal
   *
   * Emitted when the button is pressed.
   * 
   * @Deprecated: Use the GtkWidget::button-press-event signal.
   */ 
Elliot Lee's avatar
Elliot Lee committed
322
  button_signals[PRESSED] =
Manish Singh's avatar
Manish Singh committed
323 324 325 326 327 328 329
    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);
330 331 332 333 334 335 336 337 338

  /**
   * GtkButton::released:
   * @button: the object that received the signal
   *
   * Emitted when the button is released.
   * 
   * @Deprecated: Use the GtkWidget::button-release-event signal.
   */ 
Elliot Lee's avatar
Elliot Lee committed
339
  button_signals[RELEASED] =
Manish Singh's avatar
Manish Singh committed
340 341 342 343 344 345 346
    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);
347 348 349 350 351 352 353

  /**
   * GtkButton::clicked:
   * @button: the object that received the signal
   *
   * Emitted when the button has been activated (pressed and released).
   */ 
Elliot Lee's avatar
Elliot Lee committed
354
  button_signals[CLICKED] =
Manish Singh's avatar
Manish Singh committed
355 356 357 358 359 360 361
    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);
362 363 364 365 366 367 368 369 370

  /**
   * GtkButton::enter:
   * @button: the object that received the signal
   *
   * Emitted when the pointer enters the button.
   * 
   * @Deprecated: Use the GtkWidget::enter-notify-event signal.
   */ 
Elliot Lee's avatar
Elliot Lee committed
371
  button_signals[ENTER] =
Manish Singh's avatar
Manish Singh committed
372 373 374 375 376 377 378
    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);
379 380 381 382 383 384 385 386 387

  /**
   * GtkButton::leave:
   * @button: the object that received the signal
   *
   * Emitted when the pointer leaves the button.
   * 
   * @Deprecated: Use the GtkWidget::leave-notify-event signal.
   */ 
Elliot Lee's avatar
Elliot Lee committed
388
  button_signals[LEAVE] =
Manish Singh's avatar
Manish Singh committed
389 390 391 392 393 394 395
    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);
396 397 398

  /**
   * GtkButton::activate:
Matthias Clasen's avatar
Matthias Clasen committed
399
   * @widget: the object which received the signal.
400 401 402 403 404 405
   *
   * 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.
   */
406
  button_signals[ACTIVATE] =
Manish Singh's avatar
Manish Singh committed
407 408 409 410 411 412 413
    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);
414
  widget_class->activate_signal = button_signals[ACTIVATE];
415 416

  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
417
					   g_param_spec_boxed ("default-border",
418 419
							       P_("Default Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons"),
420
							       GTK_TYPE_BORDER,
421
							       GTK_PARAM_READABLE));
422 423

  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
424
					   g_param_spec_boxed ("default-outside-border",
425 426
							       P_("Default Outside Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons that is always drawn outside the border"),
427
							       GTK_TYPE_BORDER,
428
							       GTK_PARAM_READABLE));
429
  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
430
					   g_param_spec_int ("child-displacement-x",
431 432
							     P_("Child X Displacement"),
							     P_("How far in the x direction to move the child when the button is depressed"),
433 434 435
							     G_MININT,
							     G_MAXINT,
							     0,
436
							     GTK_PARAM_READABLE));
437
  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
438
					   g_param_spec_int ("child-displacement-y",
439 440
							     P_("Child Y Displacement"),
							     P_("How far in the y direction to move the child when the button is depressed"),
441 442 443
							     G_MININT,
							     G_MAXINT,
							     0,
444
							     GTK_PARAM_READABLE));
445

446 447 448 449 450 451 452 453 454 455 456 457 458
  /**
   * 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,
459
						       GTK_PARAM_READABLE));
460

Matthias Clasen's avatar
Matthias Clasen committed
461 462 463 464
  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,
465
						       GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
466
  
467
  g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));  
Elliot Lee's avatar
Elliot Lee committed
468 469 470 471 472
}

static void
gtk_button_init (GtkButton *button)
{
473 474
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

475
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
476
  GTK_WIDGET_SET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
477

478 479 480
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
481 482
  button->in_button = FALSE;
  button->button_down = FALSE;
483
  button->relief = GTK_RELIEF_NORMAL;
484 485
  button->use_stock = FALSE;
  button->use_underline = FALSE;
486
  button->depressed = FALSE;
487
  button->depress_on_activate = TRUE;
Soeren Sandmann's avatar
Soeren Sandmann committed
488
  button->focus_on_click = TRUE;
489 490 491

  priv->xalign = 0.5;
  priv->yalign = 0.5;
Matthias Clasen's avatar
Matthias Clasen committed
492
  priv->align_set = 0;
493
  priv->image_is_stock = TRUE;
Elliot Lee's avatar
Elliot Lee committed
494 495
}

496 497 498 499 500 501 502 503 504 505 506 507 508 509
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);
}

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
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
532
static GType
533 534
gtk_button_child_type  (GtkContainer     *container)
{
535
  if (!GTK_BIN (container)->child)
536 537
    return GTK_TYPE_WIDGET;
  else
Manish Singh's avatar
Manish Singh committed
538
    return G_TYPE_NONE;
539 540
}

541
static void
Matthias Clasen's avatar
Matthias Clasen committed
542 543
maybe_set_alignment (GtkButton *button,
		     GtkWidget *widget)
544
{
Matthias Clasen's avatar
Matthias Clasen committed
545 546
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

547 548 549
  if (GTK_IS_MISC (widget))
    {
      GtkMisc *misc = GTK_MISC (widget);
Matthias Clasen's avatar
Matthias Clasen committed
550 551 552
      
      if (priv->align_set)
	gtk_misc_set_alignment (misc, priv->xalign, priv->yalign);
553 554 555 556
    }
  else if (GTK_IS_ALIGNMENT (widget))
    {
      GtkAlignment *alignment = GTK_ALIGNMENT (widget);
Matthias Clasen's avatar
Matthias Clasen committed
557 558 559 560

      if (priv->align_set)
	gtk_alignment_set (alignment, priv->xalign, priv->yalign, 
			   alignment->xscale, alignment->yscale);
561 562 563 564 565 566 567
    }
}

static void
gtk_button_add (GtkContainer *container,
		GtkWidget    *widget)
{
Matthias Clasen's avatar
Matthias Clasen committed
568
  maybe_set_alignment (GTK_BUTTON (container), widget);
569 570 571 572

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

Elliot Lee's avatar
Elliot Lee committed
573
static void
574 575 576 577
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
578
{
579 580
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
Elliot Lee's avatar
Elliot Lee committed
581

582
  switch (prop_id)
583
    {
584
    case PROP_LABEL:
585
      gtk_button_set_label (button, g_value_get_string (value));
586
      break;
Matthias Clasen's avatar
Matthias Clasen committed
587 588 589
    case PROP_IMAGE:
      gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
      break;
590 591
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
592
      break;
593 594 595 596 597 598
    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
599 600 601
    case PROP_FOCUS_ON_CLICK:
      gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
      break;
602 603 604 605 606 607
    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;
608
    default:
609
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
610 611 612 613 614
      break;
    }
}

static void
615 616 617 618
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
619
{
620 621
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
622

623
  switch (prop_id)
624
    {
625
    case PROP_LABEL:
626
      g_value_set_string (value, button->label_text);
627
      break;
Matthias Clasen's avatar
Matthias Clasen committed
628 629 630
    case PROP_IMAGE:
      g_value_set_object (value, (GObject *)priv->image);
      break;
631
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
632
      g_value_set_enum (value, gtk_button_get_relief (button));
633
      break;
634 635 636 637 638 639
    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
640 641 642
    case PROP_FOCUS_ON_CLICK:
      g_value_set_boolean (value, button->focus_on_click);
      break;
643 644 645 646 647 648
    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
649
    default:
650
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
651
      break;
Elliot Lee's avatar
Elliot Lee committed
652 653 654 655
    }
}

GtkWidget*
656
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
657
{
Manish Singh's avatar
Manish Singh committed
658
  return g_object_new (GTK_TYPE_BUTTON, NULL);
Elliot Lee's avatar
Elliot Lee committed
659 660
}

Matthias Clasen's avatar
Matthias Clasen committed
661 662 663 664 665 666 667 668 669 670 671
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;
}

672 673
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
674
{
Matthias Clasen's avatar
Matthias Clasen committed
675
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
676 677 678
  GtkStockItem item;
  GtkWidget *label;
  GtkWidget *hbox;
679
  GtkWidget *align;
Matthias Clasen's avatar
Matthias Clasen committed
680 681
  GtkWidget *image = NULL;
  gchar *label_text = NULL;
682
  
683 684 685 686 687
  if (!button->constructed)
    return;
  
  if (button->label_text == NULL)
    return;
Elliot Lee's avatar
Elliot Lee committed
688

689
  if (GTK_BIN (button)->child)
690
    {
Matthias Clasen's avatar
Matthias Clasen committed
691
      if (priv->image && !priv->image_is_stock)
692 693 694 695 696
	{
	  image = g_object_ref (priv->image);
	  if (image->parent)
	    gtk_container_remove (GTK_CONTAINER (image->parent), image);
	}
Matthias Clasen's avatar
Matthias Clasen committed
697

698 699
      gtk_container_remove (GTK_CONTAINER (button),
  			    GTK_BIN (button)->child);
Matthias Clasen's avatar
Matthias Clasen committed
700
  
701 702
      priv->image = NULL;
    }
703 704 705
  
  if (button->use_stock &&
      gtk_stock_lookup (button->label_text, &item))
706
    {
Matthias Clasen's avatar
Matthias Clasen committed
707 708 709 710 711 712 713
      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;
714

Matthias Clasen's avatar
Matthias Clasen committed
715 716 717
  if (image)
    {
      label = gtk_label_new_with_mnemonic (label_text);
718 719
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
      
Matthias Clasen's avatar
Matthias Clasen committed
720 721
      priv->image = image;

Matthias Clasen's avatar
Matthias Clasen committed
722 723
      g_object_set (priv->image, 
		    "visible", show_image (button),
724
		    "no-show-all", TRUE,
Matthias Clasen's avatar
Matthias Clasen committed
725
		    NULL);
726
      hbox = gtk_hbox_new (FALSE, 2);
727

Matthias Clasen's avatar
Matthias Clasen committed
728 729 730 731 732
      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
733
      gtk_box_pack_start (GTK_BOX (hbox), priv->image, FALSE, FALSE, 0);
734
      gtk_box_pack_end (GTK_BOX (hbox), label, FALSE, FALSE, 0);
735
      
736 737 738
      gtk_container_add (GTK_CONTAINER (button), align);
      gtk_container_add (GTK_CONTAINER (align), hbox);
      gtk_widget_show_all (align);
739

Matthias Clasen's avatar
Matthias Clasen committed
740 741
      g_object_unref (image);

742
      return;
743
    }
Matthias Clasen's avatar
Matthias Clasen committed
744 745
  
 if (button->use_underline)
746
    {
747 748
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
749
    }
750 751
  else
    label = gtk_label_new (button->label_text);
752
  
Matthias Clasen's avatar
Matthias Clasen committed
753 754
  if (priv->align_set)
    gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773

  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.
774 775 776 777 778
 *
 * 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
779 780
 **/
GtkWidget*
781
gtk_button_new_from_stock (const gchar *stock_id)
782
{
783 784
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
785 786
                       "use-stock", TRUE,
                       "use-underline", TRUE,
787
                       NULL);
788 789
}

790 791 792 793 794 795 796
/**
 * 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.
797 798 799 800
 * 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.
801 802
 * Pressing Alt and that key activates the button.
 **/
803
GtkWidget*
804
gtk_button_new_with_mnemonic (const gchar *label)
805
{
806
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use-underline", TRUE,  NULL);
807 808
}

Elliot Lee's avatar
Elliot Lee committed
809 810 811
void
gtk_button_pressed (GtkButton *button)
{
812 813
  g_return_if_fail (GTK_IS_BUTTON (button));

Matthias Clasen's avatar
Matthias Clasen committed
814
  
Manish Singh's avatar
Manish Singh committed
815
  g_signal_emit (button, button_signals[PRESSED], 0);
Elliot Lee's avatar
Elliot Lee committed
816 817 818 819 820
}

void
gtk_button_released (GtkButton *button)
{
821 822
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
823
  g_signal_emit (button, button_signals[RELEASED], 0);
Elliot Lee's avatar
Elliot Lee committed
824 825 826 827 828
}

void
gtk_button_clicked (GtkButton *button)
{
829 830
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
831
  g_signal_emit (button, button_signals[CLICKED], 0);
Elliot Lee's avatar
Elliot Lee committed
832 833 834 835 836
}

void
gtk_button_enter (GtkButton *button)
{
837 838
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
839
  g_signal_emit (button, button_signals[ENTER], 0);
Elliot Lee's avatar
Elliot Lee committed
840 841 842 843 844
}

void
gtk_button_leave (GtkButton *button)
{
845 846
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
847
  g_signal_emit (button, button_signals[LEAVE], 0);
Elliot Lee's avatar
Elliot Lee committed
848 849
}

850 851 852 853 854 855
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

856 857 858 859 860 861
  if (newrelief != button->relief) 
    {
       button->relief = newrelief;
       g_object_notify (G_OBJECT (button), "relief");
       gtk_widget_queue_draw (GTK_WIDGET (button));
    }
862 863 864
}

GtkReliefStyle
865
gtk_button_get_relief (GtkButton *button)
866 867 868 869 870 871
{
  g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);

  return button->relief;
}

Elliot Lee's avatar
Elliot Lee committed
872 873 874 875 876 877
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
878
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
879 880 881 882

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

Owen Taylor's avatar
Owen Taylor committed
883 884
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
885
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
886 887 888 889
  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;
890
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
891
  attributes.event_mask = gtk_widget_get_events (widget);
892
  attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
893 894 895 896
			    GDK_BUTTON_RELEASE_MASK |
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

897
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
898

899
  widget->window = gtk_widget_get_parent_window (widget);
Manish Singh's avatar
Manish Singh committed
900
  g_object_ref (widget->window);
901 902 903 904
  
  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
905 906 907 908

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

909 910 911 912 913 914 915
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
916 917 918 919 920 921 922 923

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }
  
924 925 926
  GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
}

927 928 929 930 931
static void
gtk_button_map (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);
  
932 933
  GTK_WIDGET_CLASS (parent_class)->map (widget);

934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
  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
949
static void
950
gtk_button_get_props (GtkButton *button,
951 952
		      GtkBorder *default_border,
		      GtkBorder *default_outside_border,
953
		      gboolean  *interior_focus)
Elliot Lee's avatar
Elliot Lee committed
954
{
955
  GtkWidget *widget =  GTK_WIDGET (button);
956 957 958 959
  GtkBorder *tmp_border;

  if (default_border)
    {
960
      gtk_widget_style_get (widget, "default-border", &tmp_border, NULL);
961 962 963 964 965 966 967 968 969

      if (tmp_border)
	{
	  *default_border = *tmp_border;
	  g_free (tmp_border);
	}
      else
	*default_border = default_default_border;
    }
Elliot Lee's avatar
Elliot Lee committed
970

971 972
  if (default_outside_border)
    {
973
      gtk_widget_style_get (widget, "default-outside-border", &tmp_border, NULL);
974 975 976 977 978 979 980 981 982

      if (tmp_border)
	{
	  *default_outside_border = *tmp_border;
	  g_free (tmp_border);
	}
      else
	*default_outside_border