gtkbutton.c 57.7 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
#include "gtkimage.h"
#include "gtkhbox.h"
36
#include "gtkvbox.h"
37 38
#include "gtkstock.h"
#include "gtkiconfactory.h"
39
#include "gtkprivate.h"
40
#include "gtkintl.h"
41
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
42

43 44
static const GtkBorder default_default_border = { 1, 1, 1, 1 };
static const GtkBorder default_default_outside_border = { 0, 0, 0, 0 };
45
static const GtkBorder default_inner_border = { 1, 1, 1, 1 };
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
  PROP_IMAGE_POSITION
73 74 75 76 77 78 79
};

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

struct _GtkButtonPrivate
{
80 81 82 83 84 85 86 87
  gfloat          xalign;
  gfloat          yalign;
  GtkWidget      *image;
  guint           align_set      : 1;
  guint           image_is_stock : 1;
  guint           has_grab       : 1;
  guint32         grab_time;
  GtkPositionType image_position;
88
};
89

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

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

144

145
static guint button_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
146

Matthias Clasen's avatar
Matthias Clasen committed
147
G_DEFINE_TYPE (GtkButton, gtk_button, GTK_TYPE_BIN)
Elliot Lee's avatar
Elliot Lee committed
148 149 150 151

static void
gtk_button_class_init (GtkButtonClass *klass)
{
Manish Singh's avatar
Manish Singh committed
152
  GObjectClass *gobject_class;
Elliot Lee's avatar
Elliot Lee committed
153 154 155 156
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

Manish Singh's avatar
Manish Singh committed
157
  gobject_class = G_OBJECT_CLASS (klass);
Elliot Lee's avatar
Elliot Lee committed
158 159 160
  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;
161
  
Manish Singh's avatar
Manish Singh committed
162 163 164
  gobject_class->constructor = gtk_button_constructor;
  gobject_class->set_property = gtk_button_set_property;
  gobject_class->get_property = gtk_button_get_property;
165

166 167
  object_class->destroy = gtk_button_destroy;

Matthias Clasen's avatar
Matthias Clasen committed
168
  widget_class->screen_changed = gtk_button_screen_changed;
169
  widget_class->realize = gtk_button_realize;
170
  widget_class->unrealize = gtk_button_unrealize;
171 172
  widget_class->map = gtk_button_map;
  widget_class->unmap = gtk_button_unmap;
173
  widget_class->style_set = gtk_button_style_set;
174 175 176 177 178
  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;
Matthias Clasen's avatar
Matthias Clasen committed
179
  widget_class->grab_broken_event = gtk_button_grab_broken;
180
  widget_class->key_release_event = gtk_button_key_release;
181 182
  widget_class->enter_notify_event = gtk_button_enter_notify;
  widget_class->leave_notify_event = gtk_button_leave_notify;
183 184
  widget_class->state_changed = gtk_button_state_changed;
  widget_class->grab_notify = gtk_button_grab_notify;
185 186

  container_class->child_type = gtk_button_child_type;
187
  container_class->add = gtk_button_add;
188 189 190 191

  klass->pressed = gtk_real_button_pressed;
  klass->released = gtk_real_button_released;
  klass->clicked = NULL;
192 193
  klass->enter = gtk_button_update_state;
  klass->leave = gtk_button_update_state;
194
  klass->activate = gtk_real_button_activate;
195

Manish Singh's avatar
Manish Singh committed
196
  g_object_class_install_property (gobject_class,
197 198
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
199 200
                                                        P_("Label"),
                                                        P_("Text of the label widget inside the button, if the button contains a label widget"),
201
                                                        NULL,
202
                                                        GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
203
  
Manish Singh's avatar
Manish Singh committed
204
  g_object_class_install_property (gobject_class,
205
                                   PROP_USE_UNDERLINE,
Matthias Clasen's avatar
x  
Matthias Clasen committed
206
                                   g_param_spec_boolean ("use-underline",
207 208
							 P_("Use underline"),
							 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
209
                                                        FALSE,
210
                                                        GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
211
  
Manish Singh's avatar
Manish Singh committed
212
  g_object_class_install_property (gobject_class,
213
                                   PROP_USE_STOCK,
Matthias Clasen's avatar
x  
Matthias Clasen committed
214
                                   g_param_spec_boolean ("use-stock",
215 216
							 P_("Use stock"),
							 P_("If set, the label is used to pick a stock item instead of being displayed"),
217
                                                        FALSE,
218
                                                        GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
219
  
Soeren Sandmann's avatar
Soeren Sandmann committed
220 221
  g_object_class_install_property (gobject_class,
                                   PROP_FOCUS_ON_CLICK,
Matthias Clasen's avatar
x  
Matthias Clasen committed
222
                                   g_param_spec_boolean ("focus-on-click",
223 224
							 P_("Focus on click"),
							 P_("Whether the button grabs focus when it is clicked with the mouse"),
Soeren Sandmann's avatar
Soeren Sandmann committed
225
							 TRUE,
226
							 GTK_PARAM_READWRITE));
Soeren Sandmann's avatar
Soeren Sandmann committed
227
  
Manish Singh's avatar
Manish Singh committed
228
  g_object_class_install_property (gobject_class,
229 230
                                   PROP_RELIEF,
                                   g_param_spec_enum ("relief",
231 232
                                                      P_("Border relief"),
                                                      P_("The border relief style"),
233 234
                                                      GTK_TYPE_RELIEF_STYLE,
                                                      GTK_RELIEF_NORMAL,
235
                                                      GTK_PARAM_READWRITE));
236 237 238 239 240 241 242 243 244 245 246 247 248
  
  /**
   * 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",
249 250
                                                      P_("Horizontal alignment for child"),
                                                      P_("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
251 252 253
                                                      0.0,
                                                      1.0,
                                                      0.5,
254
                                                      GTK_PARAM_READWRITE));
255 256 257 258 259 260 261 262 263 264 265 266 267

  /**
   * 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",
268 269
                                                      P_("Vertical alignment for child"),
                                                      P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
270 271 272
                                                      0.0,
                                                      1.0,
                                                      0.5,
273
                                                      GTK_PARAM_READWRITE));
Elliot Lee's avatar
Elliot Lee committed
274

Matthias Clasen's avatar
Matthias Clasen committed
275 276 277 278 279 280 281 282 283 284 285 286 287
  /**
   * 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,
288
                                                        GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
289

290 291 292
  /**
   * GtkButton:image-position:
   *
293
   * The position of the image relative to the text inside the button.
294 295 296 297 298 299
   * 
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE_POSITION,
                                   g_param_spec_enum ("image-position",
300
                                            P_("Image position"),
301 302 303 304 305
                                                      P_("The position of the image relative to the text"),
                                                      GTK_TYPE_POSITION_TYPE,
                                                      GTK_POS_LEFT,
                                                      GTK_PARAM_READWRITE));

306 307 308 309 310 311
  /**
   * GtkButton::pressed:
   * @button: the object that received the signal
   *
   * Emitted when the button is pressed.
   * 
312
   * Deprecated: 2.8: Use the #GtkWidget::button-press-event signal.
313
   */ 
Elliot Lee's avatar
Elliot Lee committed
314
  button_signals[PRESSED] =
Matthias Clasen's avatar
Matthias Clasen committed
315
    g_signal_new (I_("pressed"),
Manish Singh's avatar
Manish Singh committed
316 317 318 319 320 321
		  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);
322 323 324 325 326 327 328

  /**
   * GtkButton::released:
   * @button: the object that received the signal
   *
   * Emitted when the button is released.
   * 
329
   * Deprecated: 2.8: Use the #GtkWidget::button-release-event signal.
330
   */ 
Elliot Lee's avatar
Elliot Lee committed
331
  button_signals[RELEASED] =
Matthias Clasen's avatar
Matthias Clasen committed
332
    g_signal_new (I_("released"),
Manish Singh's avatar
Manish Singh committed
333 334 335 336 337 338
		  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);
339 340 341 342 343 344 345

  /**
   * 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
346
  button_signals[CLICKED] =
Matthias Clasen's avatar
Matthias Clasen committed
347
    g_signal_new (I_("clicked"),
Manish Singh's avatar
Manish Singh committed
348 349 350 351 352 353
		  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);
354 355 356 357 358 359 360

  /**
   * GtkButton::enter:
   * @button: the object that received the signal
   *
   * Emitted when the pointer enters the button.
   * 
361
   * Deprecated: 2.8: Use the #GtkWidget::enter-notify-event signal.
362
   */ 
Elliot Lee's avatar
Elliot Lee committed
363
  button_signals[ENTER] =
Matthias Clasen's avatar
Matthias Clasen committed
364
    g_signal_new (I_("enter"),
Manish Singh's avatar
Manish Singh committed
365 366 367 368 369 370
		  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);
371 372 373 374 375 376 377

  /**
   * GtkButton::leave:
   * @button: the object that received the signal
   *
   * Emitted when the pointer leaves the button.
   * 
378
   * Deprecated: 2.8: Use the #GtkWidget::leave-notify-event signal.
379
   */ 
Elliot Lee's avatar
Elliot Lee committed
380
  button_signals[LEAVE] =
Matthias Clasen's avatar
Matthias Clasen committed
381
    g_signal_new (I_("leave"),
Manish Singh's avatar
Manish Singh committed
382 383 384 385 386 387
		  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);
388 389 390

  /**
   * GtkButton::activate:
Matthias Clasen's avatar
Matthias Clasen committed
391
   * @widget: the object which received the signal.
392
   *
393
   * The ::activate signal on GtkButton is an action signal and
394 395
   * emitting it causes the button to animate press then release. 
   * Applications should never connect to this signal, but use the
396
   * #GtkButton::clicked signal.
397
   */
398
  button_signals[ACTIVATE] =
Matthias Clasen's avatar
Matthias Clasen committed
399
    g_signal_new (I_("activate"),
Manish Singh's avatar
Manish Singh committed
400 401 402 403 404 405
		  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);
406
  widget_class->activate_signal = button_signals[ACTIVATE];
407 408

  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
409
					   g_param_spec_boxed ("default-border",
410 411
							       P_("Default Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons"),
412
							       GTK_TYPE_BORDER,
413
							       GTK_PARAM_READABLE));
414 415

  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
416
					   g_param_spec_boxed ("default-outside-border",
417 418
							       P_("Default Outside Spacing"),
							       P_("Extra space to add for CAN_DEFAULT buttons that is always drawn outside the border"),
419
							       GTK_TYPE_BORDER,
420
							       GTK_PARAM_READABLE));
421
  gtk_widget_class_install_style_property (widget_class,
Matthias Clasen's avatar
x  
Matthias Clasen committed
422
					   g_param_spec_int ("child-displacement-x",
423 424
							     P_("Child X Displacement"),
							     P_("How far in the x direction to move the child when the button is depressed"),
425 426 427
							     G_MININT,
							     G_MAXINT,
							     0,
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-y",
431 432
							     P_("Child Y Displacement"),
							     P_("How far in the y direction to move the child when the button is depressed"),
433 434 435
							     G_MININT,
							     G_MAXINT,
							     0,
436
							     GTK_PARAM_READABLE));
437

438 439 440
  /**
   * GtkButton:displace-focus:
   *
441 442
   * Whether the child_displacement_x/child_displacement_y properties 
   * should also affect the focus rectangle.
443 444 445 446 447 448 449
   *
   * 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"),
Johan Dahlin's avatar
Johan Dahlin committed
450 451
								 FALSE,
								 GTK_PARAM_READABLE));
452

453
  /**
454
   * GtkButton:inner-border:
455
   *
456
   * Sets the border between the button edges and child.
457 458 459 460
   *
   * Since: 2.10
   */
  gtk_widget_class_install_style_property (widget_class,
461 462 463 464 465
					   g_param_spec_boxed ("inner-border",
                                                               P_("Inner Border"),
                                                               P_("Border between button edges and child."),
                                                               GTK_TYPE_BORDER,
                                                               GTK_PARAM_READABLE));
466

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
  /**
   * GtkButton::image-spacing:
   * 
   * Spacing in pixels between the image and label.
   * 
   * Since: 2.10
   */
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("image-spacing",
							     P_("Image spacing"),
							     P_("Spacing in pixels between the image and label"),
							     0,
							     G_MAXINT,
							     2,
							     GTK_PARAM_READABLE));

Johan Dahlin's avatar
Johan Dahlin committed
483 484 485 486 487 488 489
  /**
   * GtkButton::gtk-button-images:
   * 
   * If stock icon in buttons should be shown at all.
   * 
   * Since: 2.4
   */
Matthias Clasen's avatar
Matthias Clasen committed
490 491 492 493
  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,
494
						       GTK_PARAM_READWRITE));
495 496

  g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));
Elliot Lee's avatar
Elliot Lee committed
497 498 499 500 501
}

static void
gtk_button_init (GtkButton *button)
{
502 503
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

504
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_FOCUS | GTK_RECEIVES_DEFAULT);
505
  GTK_WIDGET_SET_FLAGS (button, GTK_NO_WINDOW);
Elliot Lee's avatar
Elliot Lee committed
506

507 508 509
  button->label_text = NULL;
  
  button->constructed = FALSE;
Elliot Lee's avatar
Elliot Lee committed
510 511
  button->in_button = FALSE;
  button->button_down = FALSE;
512
  button->relief = GTK_RELIEF_NORMAL;
513 514
  button->use_stock = FALSE;
  button->use_underline = FALSE;
515
  button->depressed = FALSE;
516
  button->depress_on_activate = TRUE;
Soeren Sandmann's avatar
Soeren Sandmann committed
517
  button->focus_on_click = TRUE;
518 519 520

  priv->xalign = 0.5;
  priv->yalign = 0.5;
Matthias Clasen's avatar
Matthias Clasen committed
521
  priv->align_set = 0;
522
  priv->image_is_stock = TRUE;
523
  priv->image_position = GTK_POS_LEFT;
Elliot Lee's avatar
Elliot Lee committed
524 525
}

526 527 528 529 530 531 532 533 534 535 536
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;
    }
  
Matthias Clasen's avatar
Matthias Clasen committed
537
  (* GTK_OBJECT_CLASS (gtk_button_parent_class)->destroy) (object);
538 539
}

540 541 542 543 544 545 546 547
static GObject*
gtk_button_constructor (GType                  type,
			guint                  n_construct_properties,
			GObjectConstructParam *construct_params)
{
  GObject *object;
  GtkButton *button;

Matthias Clasen's avatar
Matthias Clasen committed
548 549 550
  object = (* G_OBJECT_CLASS (gtk_button_parent_class)->constructor) (type,
								      n_construct_properties,
								      construct_params);
551 552 553 554 555 556 557 558 559 560 561

  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
562
static GType
563 564
gtk_button_child_type  (GtkContainer     *container)
{
565
  if (!GTK_BIN (container)->child)
566 567
    return GTK_TYPE_WIDGET;
  else
Manish Singh's avatar
Manish Singh committed
568
    return G_TYPE_NONE;
569 570
}

571
static void
Matthias Clasen's avatar
Matthias Clasen committed
572 573
maybe_set_alignment (GtkButton *button,
		     GtkWidget *widget)
574
{
Matthias Clasen's avatar
Matthias Clasen committed
575 576
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);

577 578 579
  if (GTK_IS_MISC (widget))
    {
      GtkMisc *misc = GTK_MISC (widget);
Matthias Clasen's avatar
Matthias Clasen committed
580 581 582
      
      if (priv->align_set)
	gtk_misc_set_alignment (misc, priv->xalign, priv->yalign);
583 584 585 586
    }
  else if (GTK_IS_ALIGNMENT (widget))
    {
      GtkAlignment *alignment = GTK_ALIGNMENT (widget);
Matthias Clasen's avatar
Matthias Clasen committed
587 588 589 590

      if (priv->align_set)
	gtk_alignment_set (alignment, priv->xalign, priv->yalign, 
			   alignment->xscale, alignment->yscale);
591 592 593 594 595 596 597
    }
}

static void
gtk_button_add (GtkContainer *container,
		GtkWidget    *widget)
{
Matthias Clasen's avatar
Matthias Clasen committed
598
  maybe_set_alignment (GTK_BUTTON (container), widget);
599

Matthias Clasen's avatar
Matthias Clasen committed
600
  GTK_CONTAINER_CLASS (gtk_button_parent_class)->add (container, widget);
601 602
}

Elliot Lee's avatar
Elliot Lee committed
603
static void
604 605 606 607
gtk_button_set_property (GObject         *object,
                         guint            prop_id,
                         const GValue    *value,
                         GParamSpec      *pspec)
Elliot Lee's avatar
Elliot Lee committed
608
{
609 610
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
Elliot Lee's avatar
Elliot Lee committed
611

612
  switch (prop_id)
613
    {
614
    case PROP_LABEL:
615
      gtk_button_set_label (button, g_value_get_string (value));
616
      break;
Matthias Clasen's avatar
Matthias Clasen committed
617 618 619
    case PROP_IMAGE:
      gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
      break;
620 621
    case PROP_RELIEF:
      gtk_button_set_relief (button, g_value_get_enum (value));
622
      break;
623 624 625 626 627 628
    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
629 630 631
    case PROP_FOCUS_ON_CLICK:
      gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
      break;
632 633 634 635 636 637
    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;
638 639 640
    case PROP_IMAGE_POSITION:
      gtk_button_set_image_position (button, g_value_get_enum (value));
      break;
641
    default:
642
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
643 644 645 646 647
      break;
    }
}

static void
648 649 650 651
gtk_button_get_property (GObject         *object,
                         guint            prop_id,
                         GValue          *value,
                         GParamSpec      *pspec)
652
{
653 654
  GtkButton *button = GTK_BUTTON (object);
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
655

656
  switch (prop_id)
657
    {
658
    case PROP_LABEL:
659
      g_value_set_string (value, button->label_text);
660
      break;
Matthias Clasen's avatar
Matthias Clasen committed
661 662 663
    case PROP_IMAGE:
      g_value_set_object (value, (GObject *)priv->image);
      break;
664
    case PROP_RELIEF:
Alexander Larsson's avatar
Alexander Larsson committed
665
      g_value_set_enum (value, gtk_button_get_relief (button));
666
      break;
667 668 669 670 671 672
    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
673 674 675
    case PROP_FOCUS_ON_CLICK:
      g_value_set_boolean (value, button->focus_on_click);
      break;
676 677 678 679 680 681
    case PROP_XALIGN:
      g_value_set_float (value, priv->xalign);
      break;
    case PROP_YALIGN:
      g_value_set_float (value, priv->yalign);
      break;
682 683 684
    case PROP_IMAGE_POSITION:
      g_value_set_enum (value, priv->image_position);
      break;
Tim Janik's avatar
Tim Janik committed
685
    default:
686
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
687
      break;
Elliot Lee's avatar
Elliot Lee committed
688 689 690 691
    }
}

GtkWidget*
692
gtk_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
693
{
Manish Singh's avatar
Manish Singh committed
694
  return g_object_new (GTK_TYPE_BUTTON, NULL);
Elliot Lee's avatar
Elliot Lee committed
695 696
}

Matthias Clasen's avatar
Matthias Clasen committed
697 698 699 700
static gboolean
show_image (GtkButton *button)
{
  gboolean show;
701 702 703 704
  
  if (button->label_text)
    {
      GtkSettings *settings;
Matthias Clasen's avatar
Matthias Clasen committed
705

706 707 708 709 710
      settings = gtk_widget_get_settings (GTK_WIDGET (button));        
      g_object_get (settings, "gtk-button-images", &show, NULL);
    }
  else
    show = TRUE;
Matthias Clasen's avatar
Matthias Clasen committed
711 712 713 714

  return show;
}

715 716
static void
gtk_button_construct_child (GtkButton *button)
Elliot Lee's avatar
Elliot Lee committed
717
{
Matthias Clasen's avatar
Matthias Clasen committed
718
  GtkButtonPrivate *priv = GTK_BUTTON_GET_PRIVATE (button);
719 720
  GtkStockItem item;
  GtkWidget *label;
721
  GtkWidget *box;
722
  GtkWidget *align;
Matthias Clasen's avatar
Matthias Clasen committed
723 724
  GtkWidget *image = NULL;
  gchar *label_text = NULL;
725
  gint image_spacing;
726
  
727 728
  if (!button->constructed)
    return;
729 730
 
  if (!button->label_text && !priv->image)
731
    return;
Matthias Clasen's avatar
Matthias Clasen committed
732
  
733 734 735 736
  gtk_widget_style_get (GTK_WIDGET (button), 
			"image-spacing", &image_spacing, 
			NULL);

737 738 739 740 741
  if (priv->image && !priv->image_is_stock)
    {
      image = g_object_ref (priv->image);
      if (image->parent)
	gtk_container_remove (GTK_CONTAINER (image->parent), image);
742
    }
743
  
744 745
  priv->image = NULL;

746 747 748
  if (GTK_BIN (button)->child)
    gtk_container_remove (GTK_CONTAINER (button),
			  GTK_BIN (button)->child);
749

750
  if (button->use_stock &&
751
      button->label_text &&
752
      gtk_stock_lookup (button->label_text, &item))
753
    {
Matthias Clasen's avatar
Matthias Clasen committed
754 755 756 757 758 759 760
      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;
761

Matthias Clasen's avatar
Matthias Clasen committed
762 763 764
  if (image)
    {
      priv->image = image;
Matthias Clasen's avatar
Matthias Clasen committed
765 766
      g_object_set (priv->image, 
		    "visible", show_image (button),
767
		    "no-show-all", TRUE,
Matthias Clasen's avatar
Matthias Clasen committed
768
		    NULL);
769 770 771

      if (priv->image_position == GTK_POS_LEFT ||
	  priv->image_position == GTK_POS_RIGHT)
772
	box = gtk_hbox_new (FALSE, image_spacing);
773
      else
774
	box = gtk_vbox_new (FALSE, image_spacing);
775

Matthias Clasen's avatar
Matthias Clasen committed
776 777 778 779
      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);
780 781 782 783 784 785

      if (priv->image_position == GTK_POS_LEFT ||
	  priv->image_position == GTK_POS_TOP)
	gtk_box_pack_start (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
      else
	gtk_box_pack_end (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
786 787 788 789 790 791 792

      if (label_text)
	{
	  label = gtk_label_new_with_mnemonic (label_text);
	  gtk_label_set_mnemonic_widget (GTK_LABEL (label), 
					 GTK_WIDGET (button));

793 794 795 796 797
	  if (priv->image_position == GTK_POS_RIGHT ||
	      priv->image_position == GTK_POS_BOTTOM)
	    gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
	  else
	    gtk_box_pack_end (GTK_BOX (box), label, FALSE, FALSE, 0);
798
	}
799
      
800
      gtk_container_add (GTK_CONTAINER (button), align);
801
      gtk_container_add (GTK_CONTAINER (align), box);
802
      gtk_widget_show_all (align);
803

Matthias Clasen's avatar
Matthias Clasen committed
804 805
      g_object_unref (image);

806
      return;
807
    }
Matthias Clasen's avatar
Matthias Clasen committed
808
  
809
  if (button->use_underline)
810
    {
811 812
      label = gtk_label_new_with_mnemonic (button->label_text);
      gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
813
    }
814 815
  else
    label = gtk_label_new (button->label_text);
816
  
Matthias Clasen's avatar
Matthias Clasen committed
817 818
  if (priv->align_set)
    gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
819
  
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
  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.
838 839 840 841 842
 *
 * 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
843 844
 **/
GtkWidget*
845
gtk_button_new_from_stock (const gchar *stock_id)
846
{
847 848
  return g_object_new (GTK_TYPE_BUTTON,
                       "label", stock_id,
849 850
                       "use-stock", TRUE,
                       "use-underline", TRUE,
851
                       NULL);
852 853
}

854 855 856 857 858 859 860
/**
 * 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.
861 862 863 864
 * 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.
865 866
 * Pressing Alt and that key activates the button.
 **/
867
GtkWidget*
868
gtk_button_new_with_mnemonic (const gchar *label)
869
{
870
  return g_object_new (GTK_TYPE_BUTTON, "label", label, "use-underline", TRUE,  NULL);
871 872
}

Elliot Lee's avatar
Elliot Lee committed
873 874 875
void
gtk_button_pressed (GtkButton *button)
{
876 877
  g_return_if_fail (GTK_IS_BUTTON (button));

Matthias Clasen's avatar
Matthias Clasen committed
878
  
Manish Singh's avatar
Manish Singh committed
879
  g_signal_emit (button, button_signals[PRESSED], 0);
Elliot Lee's avatar
Elliot Lee committed
880 881 882 883 884
}

void
gtk_button_released (GtkButton *button)
{
885 886
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
887
  g_signal_emit (button, button_signals[RELEASED], 0);
Elliot Lee's avatar
Elliot Lee committed
888 889 890 891 892
}

void
gtk_button_clicked (GtkButton *button)
{
893 894
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
895
  g_signal_emit (button, button_signals[CLICKED], 0);
Elliot Lee's avatar
Elliot Lee committed
896 897 898 899 900
}

void
gtk_button_enter (GtkButton *button)
{
901 902
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
903
  g_signal_emit (button, button_signals[ENTER], 0);
Elliot Lee's avatar
Elliot Lee committed
904 905 906 907 908
}

void
gtk_button_leave (GtkButton *button)
{
909 910
  g_return_if_fail (GTK_IS_BUTTON (button));

Manish Singh's avatar
Manish Singh committed
911
  g_signal_emit (button, button_signals[LEAVE], 0);
Elliot Lee's avatar
Elliot Lee committed
912 913
}

914 915 916 917 918 919
void
gtk_button_set_relief (GtkButton *button,
		       GtkReliefStyle newrelief)
{
  g_return_if_fail (GTK_IS_BUTTON (button));

920 921 922 923 924 925
  if (newrelief != button->relief) 
    {
       button->relief = newrelief;
       g_object_notify (G_OBJECT (button), "relief");
       gtk_widget_queue_draw (GTK_WIDGET (button));
    }
926 927 928
}

GtkReliefStyle
929
gtk_button_get_relief (GtkButton *button)
930 931 932 933 934 935
{
  g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);

  return button->relief;
}

Elliot Lee's avatar
Elliot Lee committed
936 937 938 939 940 941
static void
gtk_button_realize (GtkWidget *widget)
{
  GtkButton *button;
  GdkWindowAttr attributes;
  gint attributes_mask;
Owen Taylor's avatar
Owen Taylor committed
942
  gint border_width;
Elliot Lee's avatar
Elliot Lee committed
943 944 945 946

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

Owen Taylor's avatar
Owen Taylor committed
947 948
  border_width = GTK_CONTAINER (widget)->border_width;

Elliot Lee's avatar
Elliot Lee committed
949
  attributes.window_type = GDK_WINDOW_CHILD;
Owen Taylor's avatar
Owen Taylor committed
950 951 952 953
  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;
954
  attributes.wclass = GDK_INPUT_ONLY;
Elliot Lee's avatar
Elliot Lee committed
955
  attributes.event_mask = gtk_widget_get_events (widget);
956
  attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
957 958 959 960
			    GDK_BUTTON_RELEASE_MASK |
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

961
  attributes_mask = GDK_WA_X | GDK_WA_Y;
Elliot Lee's avatar
Elliot Lee committed
962

963
  widget->window = gtk_widget_get_parent_window (widget);
Manish Singh's avatar
Manish Singh committed
964
  g_object_ref (widget->window);
965 966 967 968
  
  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
969 970 971 972

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

973 974 975 976 977 978 979
static void
gtk_button_unrealize (GtkWidget *widget)
{
  GtkButton *button = GTK_BUTTON (widget);

  if (button->activate_timeout)
    gtk_button_finish_activate (button, FALSE);
980 981 982 983 984 985 986 987

  if (button->event_window)
    {
      gdk_window_set_user_data (button->event_window, NULL);
      gdk_window_destroy (button->event_window);
      button->event_window = NULL;
    }