Pileus Git - ~andy/gtk/blob - gtk/gtkbutton.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2001.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /**
  28  * SECTION:gtkbutton
  29  * @Short_description: A widget that creates a signal when clicked on
  30  * @Title: GtkButton
  31  *
  32  * The #GtkButton widget is generally used to attach a function to that is
  33  * called when the button is pressed.  The various signals and how to use them
  34  * are outlined below.
  35  *
  36  * The #GtkButton widget can hold any valid child widget.  That is it can hold
  37  * most any other standard #GtkWidget.  The most commonly used child is the
  38  * #GtkLabel.
  39  */
  40
  41 #include "config.h"
  42
  43 #include "gtkbutton.h"
  44 #include "gtkbuttonprivate.h"
  45
  46 #include <string.h>
  47 #include "gtkalignment.h"
  48 #include "gtklabel.h"
  49 #include "gtkmain.h"
  50 #include "gtkmarshalers.h"
  51 #include "gtkimage.h"
  52 #include "gtkhbox.h"
  53 #include "gtkvbox.h"
  54 #include "gtkstock.h"
  55 #include "gtkiconfactory.h"
  56 #include "gtkactivatable.h"
  57 #include "gtksizerequest.h"
  58 #include "gtktypebuiltins.h"
  59 #include "gtkprivate.h"
  60 #include "gtkintl.h"
  61
  62
  63 static const GtkBorder default_default_border = { 1, 1, 1, 1 };
  64 static const GtkBorder default_default_outside_border = { 0, 0, 0, 0 };
  65 static const GtkBorder default_inner_border = { 1, 1, 1, 1 };
  66
  67 /* Time out before giving up on getting a key release when animating
  68  * the close button.
  69  */
  70 #define ACTIVATE_TIMEOUT 250
  71
  72
  73 enum {
  74   PRESSED,
  75   RELEASED,
  76   CLICKED,
  77   ENTER,
  78   LEAVE,
  79   ACTIVATE,
  80   LAST_SIGNAL
  81 };
  82
  83 enum {
  84   PROP_0,
  85   PROP_LABEL,
  86   PROP_IMAGE,
  87   PROP_RELIEF,
  88   PROP_USE_UNDERLINE,
  89   PROP_USE_STOCK,
  90   PROP_FOCUS_ON_CLICK,
  91   PROP_XALIGN,
  92   PROP_YALIGN,
  93   PROP_IMAGE_POSITION,
  94
  95   /* activatable properties */
  96   PROP_ACTIVATABLE_RELATED_ACTION,
  97   PROP_ACTIVATABLE_USE_ACTION_APPEARANCE
  98 };
  99
 100
 101 static void gtk_button_destroy        (GtkWidget          *widget);
 102 static void gtk_button_dispose        (GObject            *object);
 103 static void gtk_button_set_property   (GObject            *object,
 104                                        guint               prop_id,
 105                                        const GValue       *value,
 106                                        GParamSpec         *pspec);
 107 static void gtk_button_get_property   (GObject            *object,
 108                                        guint               prop_id,
 109                                        GValue             *value,
 110                                        GParamSpec         *pspec);
 111 static void gtk_button_screen_changed (GtkWidget          *widget,
 112                                        GdkScreen          *previous_screen);
 113 static void gtk_button_realize (GtkWidget * widget);
 114 static void gtk_button_unrealize (GtkWidget * widget);
 115 static void gtk_button_map (GtkWidget * widget);
 116 static void gtk_button_unmap (GtkWidget * widget);
 117 static void gtk_button_style_updated (GtkWidget * widget);
 118 static void gtk_button_size_allocate (GtkWidget * widget,
 119                                       GtkAllocation * allocation);
 120 static gint gtk_button_draw (GtkWidget * widget, cairo_t *cr);
 121 static gint gtk_button_button_press (GtkWidget * widget,
 122                                      GdkEventButton * event);
 123 static gint gtk_button_button_release (GtkWidget * widget,
 124                                        GdkEventButton * event);
 125 static gint gtk_button_grab_broken (GtkWidget * widget,
 126                                     GdkEventGrabBroken * event);
 127 static gint gtk_button_key_release (GtkWidget * widget, GdkEventKey * event);
 128 static gint gtk_button_enter_notify (GtkWidget * widget,
 129                                      GdkEventCrossing * event);
 130 static gint gtk_button_leave_notify (GtkWidget * widget,
 131                                      GdkEventCrossing * event);
 132 static void gtk_real_button_pressed (GtkButton * button);
 133 static void gtk_real_button_released (GtkButton * button);
 134 static void gtk_real_button_clicked (GtkButton * button);
 135 static void gtk_real_button_activate  (GtkButton          *button);
 136 static void gtk_button_update_state   (GtkButton          *button);
 137 static void gtk_button_add            (GtkContainer       *container,
 138                                        GtkWidget          *widget);
 139 static GType gtk_button_child_type    (GtkContainer       *container);
 140 static void gtk_button_finish_activate (GtkButton         *button,
 141                                         gboolean           do_it);
 142
 143 static GObject* gtk_button_constructor (GType                  type,
 144                                         guint                  n_construct_properties,
 145                                         GObjectConstructParam *construct_params);
 146 static void gtk_button_construct_child (GtkButton             *button);
 147 static void gtk_button_state_changed   (GtkWidget             *widget,
 148                                         GtkStateType           previous_state);
 149 static void gtk_button_grab_notify     (GtkWidget             *widget,
 150                                         gboolean               was_grabbed);
 151
 152
 153 static void gtk_button_activatable_interface_init(GtkActivatableIface  *iface);
 154 static void gtk_button_update                    (GtkActivatable       *activatable,
 155                                                   GtkAction            *action,
 156                                                   const gchar          *property_name);
 157 static void gtk_button_sync_action_properties    (GtkActivatable       *activatable,
 158                                                   GtkAction            *action);
 159 static void gtk_button_set_related_action        (GtkButton            *button,
 160                                                   GtkAction            *action);
 161 static void gtk_button_set_use_action_appearance (GtkButton            *button,
 162                                                   gboolean              use_appearance);
 163
 164 static void gtk_button_get_preferred_width       (GtkWidget           *widget,
 165                                                   gint                *minimum_size,
 166                                                   gint                *natural_size);
 167 static void gtk_button_get_preferred_height      (GtkWidget           *widget,
 168                                                   gint                *minimum_size,
 169                                                   gint                *natural_size);
 170
 171 static guint button_signals[LAST_SIGNAL] = { 0 };
 172
 173 G_DEFINE_TYPE_WITH_CODE (GtkButton, gtk_button, GTK_TYPE_BIN,
 174                          G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
 175                                                 gtk_button_activatable_interface_init))
 176
 177 static void
 178 gtk_button_class_init (GtkButtonClass *klass)
 179 {
 180   GObjectClass *gobject_class;
 181   GtkWidgetClass *widget_class;
 182   GtkContainerClass *container_class;
 183
 184   gobject_class = G_OBJECT_CLASS (klass);
 185   widget_class = (GtkWidgetClass*) klass;
 186   container_class = (GtkContainerClass*) klass;
 187
 188   gobject_class->constructor  = gtk_button_constructor;
 189   gobject_class->dispose      = gtk_button_dispose;
 190   gobject_class->set_property = gtk_button_set_property;
 191   gobject_class->get_property = gtk_button_get_property;
 192
 193   widget_class->get_preferred_width  = gtk_button_get_preferred_width;
 194   widget_class->get_preferred_height = gtk_button_get_preferred_height;
 195   widget_class->destroy = gtk_button_destroy;
 196   widget_class->screen_changed = gtk_button_screen_changed;
 197   widget_class->realize = gtk_button_realize;
 198   widget_class->unrealize = gtk_button_unrealize;
 199   widget_class->map = gtk_button_map;
 200   widget_class->unmap = gtk_button_unmap;
 201   widget_class->style_updated = gtk_button_style_updated;
 202   widget_class->size_allocate = gtk_button_size_allocate;
 203   widget_class->draw = gtk_button_draw;
 204   widget_class->button_press_event = gtk_button_button_press;
 205   widget_class->button_release_event = gtk_button_button_release;
 206   widget_class->grab_broken_event = gtk_button_grab_broken;
 207   widget_class->key_release_event = gtk_button_key_release;
 208   widget_class->enter_notify_event = gtk_button_enter_notify;
 209   widget_class->leave_notify_event = gtk_button_leave_notify;
 210   widget_class->state_changed = gtk_button_state_changed;
 211   widget_class->grab_notify = gtk_button_grab_notify;
 212
 213   container_class->child_type = gtk_button_child_type;
 214   container_class->add = gtk_button_add;
 215   gtk_container_class_handle_border_width (container_class);
 216
 217   klass->pressed = gtk_real_button_pressed;
 218   klass->released = gtk_real_button_released;
 219   klass->clicked = NULL;
 220   klass->enter = gtk_button_update_state;
 221   klass->leave = gtk_button_update_state;
 222   klass->activate = gtk_real_button_activate;
 223
 224   g_object_class_install_property (gobject_class,
 225                                    PROP_LABEL,
 226                                    g_param_spec_string ("label",
 227                                                         P_("Label"),
 228                                                         P_("Text of the label widget inside the button, if the button contains a label widget"),
 229                                                         NULL,
 230                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 231
 232   g_object_class_install_property (gobject_class,
 233                                    PROP_USE_UNDERLINE,
 234                                    g_param_spec_boolean ("use-underline",
 235                                                          P_("Use underline"),
 236                                                          P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
 237                                                         FALSE,
 238                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 239
 240   g_object_class_install_property (gobject_class,
 241                                    PROP_USE_STOCK,
 242                                    g_param_spec_boolean ("use-stock",
 243                                                          P_("Use stock"),
 244                                                          P_("If set, the label is used to pick a stock item instead of being displayed"),
 245                                                         FALSE,
 246                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 247
 248   g_object_class_install_property (gobject_class,
 249                                    PROP_FOCUS_ON_CLICK,
 250                                    g_param_spec_boolean ("focus-on-click",
 251                                                          P_("Focus on click"),
 252                                                          P_("Whether the button grabs focus when it is clicked with the mouse"),
 253                                                          TRUE,
 254                                                          GTK_PARAM_READWRITE));
 255
 256   g_object_class_install_property (gobject_class,
 257                                    PROP_RELIEF,
 258                                    g_param_spec_enum ("relief",
 259                                                       P_("Border relief"),
 260                                                       P_("The border relief style"),
 261                                                       GTK_TYPE_RELIEF_STYLE,
 262                                                       GTK_RELIEF_NORMAL,
 263                                                       GTK_PARAM_READWRITE));
 264
 265   /**
 266    * GtkButton:xalign:
 267    *
 268    * If the child of the button is a #GtkMisc or #GtkAlignment, this property
 269    * can be used to control its horizontal alignment. 0.0 is left aligned,
 270    * 1.0 is right aligned.
 271    *
 272    * Since: 2.4
 273    */
 274   g_object_class_install_property (gobject_class,
 275                                    PROP_XALIGN,
 276                                    g_param_spec_float("xalign",
 277                                                       P_("Horizontal alignment for child"),
 278                                                       P_("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
 279                                                       0.0,
 280                                                       1.0,
 281                                                       0.5,
 282                                                       GTK_PARAM_READWRITE));
 283
 284   /**
 285    * GtkButton:yalign:
 286    *
 287    * If the child of the button is a #GtkMisc or #GtkAlignment, this property
 288    * can be used to control its vertical alignment. 0.0 is top aligned,
 289    * 1.0 is bottom aligned.
 290    *
 291    * Since: 2.4
 292    */
 293   g_object_class_install_property (gobject_class,
 294                                    PROP_YALIGN,
 295                                    g_param_spec_float("yalign",
 296                                                       P_("Vertical alignment for child"),
 297                                                       P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
 298                                                       0.0,
 299                                                       1.0,
 300                                                       0.5,
 301                                                       GTK_PARAM_READWRITE));
 302
 303   /**
 304    * GtkButton:image:
 305    *
 306    * The child widget to appear next to the button text.
 307    *
 308    * Since: 2.6
 309    */
 310   g_object_class_install_property (gobject_class,
 311                                    PROP_IMAGE,
 312                                    g_param_spec_object ("image",
 313                                                         P_("Image widget"),
 314                                                         P_("Child widget to appear next to the button text"),
 315                                                         GTK_TYPE_WIDGET,
 316                                                         GTK_PARAM_READWRITE));
 317
 318   /**
 319    * GtkButton:image-position:
 320    *
 321    * The position of the image relative to the text inside the button.
 322    *
 323    * Since: 2.10
 324    */
 325   g_object_class_install_property (gobject_class,
 326                                    PROP_IMAGE_POSITION,
 327                                    g_param_spec_enum ("image-position",
 328                                             P_("Image position"),
 329                                                       P_("The position of the image relative to the text"),
 330                                                       GTK_TYPE_POSITION_TYPE,
 331                                                       GTK_POS_LEFT,
 332                                                       GTK_PARAM_READWRITE));
 333
 334   g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_RELATED_ACTION, "related-action");
 335   g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_USE_ACTION_APPEARANCE, "use-action-appearance");
 336
 337   /**
 338    * GtkButton::pressed:
 339    * @button: the object that received the signal
 340    *
 341    * Emitted when the button is pressed.
 342    *
 343    * Deprecated: 2.8: Use the #GtkWidget::button-press-event signal.
 344    */
 345   button_signals[PRESSED] =
 346     g_signal_new (I_("pressed"),
 347                   G_OBJECT_CLASS_TYPE (gobject_class),
 348                   G_SIGNAL_RUN_FIRST,
 349                   G_STRUCT_OFFSET (GtkButtonClass, pressed),
 350                   NULL, NULL,
 351                   _gtk_marshal_VOID__VOID,
 352                   G_TYPE_NONE, 0);
 353
 354   /**
 355    * GtkButton::released:
 356    * @button: the object that received the signal
 357    *
 358    * Emitted when the button is released.
 359    *
 360    * Deprecated: 2.8: Use the #GtkWidget::button-release-event signal.
 361    */
 362   button_signals[RELEASED] =
 363     g_signal_new (I_("released"),
 364                   G_OBJECT_CLASS_TYPE (gobject_class),
 365                   G_SIGNAL_RUN_FIRST,
 366                   G_STRUCT_OFFSET (GtkButtonClass, released),
 367                   NULL, NULL,
 368                   _gtk_marshal_VOID__VOID,
 369                   G_TYPE_NONE, 0);
 370
 371   /**
 372    * GtkButton::clicked:
 373    * @button: the object that received the signal
 374    *
 375    * Emitted when the button has been activated (pressed and released).
 376    */
 377   button_signals[CLICKED] =
 378     g_signal_new (I_("clicked"),
 379                   G_OBJECT_CLASS_TYPE (gobject_class),
 380                   G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
 381                   G_STRUCT_OFFSET (GtkButtonClass, clicked),
 382                   NULL, NULL,
 383                   _gtk_marshal_VOID__VOID,
 384                   G_TYPE_NONE, 0);
 385
 386   /**
 387    * GtkButton::enter:
 388    * @button: the object that received the signal
 389    *
 390    * Emitted when the pointer enters the button.
 391    *
 392    * Deprecated: 2.8: Use the #GtkWidget::enter-notify-event signal.
 393    */
 394   button_signals[ENTER] =
 395     g_signal_new (I_("enter"),
 396                   G_OBJECT_CLASS_TYPE (gobject_class),
 397                   G_SIGNAL_RUN_FIRST,
 398                   G_STRUCT_OFFSET (GtkButtonClass, enter),
 399                   NULL, NULL,
 400                   _gtk_marshal_VOID__VOID,
 401                   G_TYPE_NONE, 0);
 402
 403   /**
 404    * GtkButton::leave:
 405    * @button: the object that received the signal
 406    *
 407    * Emitted when the pointer leaves the button.
 408    *
 409    * Deprecated: 2.8: Use the #GtkWidget::leave-notify-event signal.
 410    */
 411   button_signals[LEAVE] =
 412     g_signal_new (I_("leave"),
 413                   G_OBJECT_CLASS_TYPE (gobject_class),
 414                   G_SIGNAL_RUN_FIRST,
 415                   G_STRUCT_OFFSET (GtkButtonClass, leave),
 416                   NULL, NULL,
 417                   _gtk_marshal_VOID__VOID,
 418                   G_TYPE_NONE, 0);
 419
 420   /**
 421    * GtkButton::activate:
 422    * @widget: the object which received the signal.
 423    *
 424    * The ::activate signal on GtkButton is an action signal and
 425    * emitting it causes the button to animate press then release.
 426    * Applications should never connect to this signal, but use the
 427    * #GtkButton::clicked signal.
 428    */
 429   button_signals[ACTIVATE] =
 430     g_signal_new (I_("activate"),
 431                   G_OBJECT_CLASS_TYPE (gobject_class),
 432                   G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
 433                   G_STRUCT_OFFSET (GtkButtonClass, activate),
 434                   NULL, NULL,
 435                   _gtk_marshal_VOID__VOID,
 436                   G_TYPE_NONE, 0);
 437   widget_class->activate_signal = button_signals[ACTIVATE];
 438
 439   /**
 440    * GtkButton:default-border:
 441    *
 442    * The "default-border" style property defines the extra space to add
 443    * around a button that can become the default widget of its window.
 444    * For more information about default widgets, see gtk_widget_grab_default().
 445    */
 446
 447   gtk_widget_class_install_style_property (widget_class,
 448                                            g_param_spec_boxed ("default-border",
 449                                                                P_("Default Spacing"),
 450                                                                P_("Extra space to add for GTK_CAN_DEFAULT buttons"),
 451                                                                GTK_TYPE_BORDER,
 452                                                                GTK_PARAM_READABLE));
 453
 454   /**
 455    * GtkButton:default-outside-border:
 456    *
 457    * The "default-outside-border" style property defines the extra outside
 458    * space to add around a button that can become the default widget of its
 459    * window. Extra outside space is always drawn outside the button border.
 460    * For more information about default widgets, see gtk_widget_grab_default().
 461    */
 462   gtk_widget_class_install_style_property (widget_class,
 463                                            g_param_spec_boxed ("default-outside-border",
 464                                                                P_("Default Outside Spacing"),
 465                                                                P_("Extra space to add for GTK_CAN_DEFAULT buttons that is always drawn outside the border"),
 466                                                                GTK_TYPE_BORDER,
 467                                                                GTK_PARAM_READABLE));
 468   gtk_widget_class_install_style_property (widget_class,
 469                                            g_param_spec_int ("child-displacement-x",
 470                                                              P_("Child X Displacement"),
 471                                                              P_("How far in the x direction to move the child when the button is depressed"),
 472                                                              G_MININT,
 473                                                              G_MAXINT,
 474                                                              0,
 475                                                              GTK_PARAM_READABLE));
 476   gtk_widget_class_install_style_property (widget_class,
 477                                            g_param_spec_int ("child-displacement-y",
 478                                                              P_("Child Y Displacement"),
 479                                                              P_("How far in the y direction to move the child when the button is depressed"),
 480                                                              G_MININT,
 481                                                              G_MAXINT,
 482                                                              0,
 483                                                              GTK_PARAM_READABLE));
 484
 485   /**
 486    * GtkButton:displace-focus:
 487    *
 488    * Whether the child_displacement_x/child_displacement_y properties
 489    * should also affect the focus rectangle.
 490    *
 491    * Since: 2.6
 492    */
 493   gtk_widget_class_install_style_property (widget_class,
 494                                            g_param_spec_boolean ("displace-focus",
 495                                                                  P_("Displace focus"),
 496                                                                  P_("Whether the child_displacement_x/_y properties should also affect the focus rectangle"),
 497                                                                  FALSE,
 498                                                                  GTK_PARAM_READABLE));
 499
 500   /**
 501    * GtkButton:inner-border:
 502    *
 503    * Sets the border between the button edges and child.
 504    *
 505    * Since: 2.10
 506    */
 507   gtk_widget_class_install_style_property (widget_class,
 508                                            g_param_spec_boxed ("inner-border",
 509                                                                P_("Inner Border"),
 510                                                                P_("Border between button edges and child."),
 511                                                                GTK_TYPE_BORDER,
 512                                                                GTK_PARAM_READABLE));
 513
 514   /**
 515    * GtkButton::image-spacing:
 516    *
 517    * Spacing in pixels between the image and label.
 518    *
 519    * Since: 2.10
 520    */
 521   gtk_widget_class_install_style_property (widget_class,
 522                                            g_param_spec_int ("image-spacing",
 523                                                              P_("Image spacing"),
 524                                                              P_("Spacing in pixels between the image and label"),
 525                                                              0,
 526                                                              G_MAXINT,
 527                                                              2,
 528                                                              GTK_PARAM_READABLE));
 529
 530   g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));
 531 }
 532
 533 static void
 534 gtk_button_init (GtkButton *button)
 535 {
 536   GtkButtonPrivate *priv;
 537   GtkStyleContext *context;
 538
 539   button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
 540                                               GTK_TYPE_BUTTON,
 541                                               GtkButtonPrivate);
 542   priv = button->priv;
 543
 544   gtk_widget_set_can_focus (GTK_WIDGET (button), TRUE);
 545   gtk_widget_set_receives_default (GTK_WIDGET (button), TRUE);
 546   gtk_widget_set_has_window (GTK_WIDGET (button), FALSE);
 547
 548   priv->label_text = NULL;
 549
 550   priv->constructed = FALSE;
 551   priv->in_button = FALSE;
 552   priv->button_down = FALSE;
 553   priv->relief = GTK_RELIEF_NORMAL;
 554   priv->use_stock = FALSE;
 555   priv->use_underline = FALSE;
 556   priv->depressed = FALSE;
 557   priv->depress_on_activate = TRUE;
 558   priv->focus_on_click = TRUE;
 559
 560   priv->xalign = 0.5;
 561   priv->yalign = 0.5;
 562   priv->align_set = 0;
 563   priv->image_is_stock = TRUE;
 564   priv->image_position = GTK_POS_LEFT;
 565   priv->use_action_appearance = TRUE;
 566
 567   context = gtk_widget_get_style_context (GTK_WIDGET (button));
 568   gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
 569 }
 570
 571 static void
 572 gtk_button_destroy (GtkWidget *widget)
 573 {
 574   GtkButton *button = GTK_BUTTON (widget);
 575   GtkButtonPrivate *priv = button->priv;
 576
 577   if (priv->label_text)
 578     {
 579       g_free (priv->label_text);
 580       priv->label_text = NULL;
 581     }
 582
 583   GTK_WIDGET_CLASS (gtk_button_parent_class)->destroy (widget);
 584 }
 585
 586 static GObject*
 587 gtk_button_constructor (GType                  type,
 588                         guint                  n_construct_properties,
 589                         GObjectConstructParam *construct_params)
 590 {
 591   GObject *object;
 592   GtkButton *button;
 593   GtkButtonPrivate *priv;
 594
 595   object = G_OBJECT_CLASS (gtk_button_parent_class)->constructor (type,
 596                                                                   n_construct_properties,
 597                                                                   construct_params);
 598
 599   button = GTK_BUTTON (object);
 600   priv = button->priv;
 601
 602   priv->constructed = TRUE;
 603
 604   if (priv->label_text != NULL)
 605     gtk_button_construct_child (button);
 606
 607   return object;
 608 }
 609
 610
 611 static GType
 612 gtk_button_child_type  (GtkContainer     *container)
 613 {
 614   if (!gtk_bin_get_child (GTK_BIN (container)))
 615     return GTK_TYPE_WIDGET;
 616   else
 617     return G_TYPE_NONE;
 618 }
 619
 620 static void
 621 maybe_set_alignment (GtkButton *button,
 622                      GtkWidget *widget)
 623 {
 624   GtkButtonPrivate *priv = button->priv;
 625
 626   if (GTK_IS_MISC (widget))
 627     {
 628       GtkMisc *misc = GTK_MISC (widget);
 629
 630       if (priv->align_set)
 631         gtk_misc_set_alignment (misc, priv->xalign, priv->yalign);
 632     }
 633   else if (GTK_IS_ALIGNMENT (widget))
 634     {
 635       GtkAlignment *alignment = GTK_ALIGNMENT (widget);
 636       gfloat xscale, yscale;
 637
 638       g_object_get (alignment,
 639                     "xscale", &xscale,
 640                     "yscale", &yscale,
 641                     NULL);
 642
 643       if (priv->align_set)
 644         gtk_alignment_set (alignment,
 645                            priv->xalign, priv->yalign,
 646                            xscale, yscale);
 647     }
 648 }
 649
 650 static void
 651 gtk_button_add (GtkContainer *container,
 652                 GtkWidget    *widget)
 653 {
 654   maybe_set_alignment (GTK_BUTTON (container), widget);
 655
 656   GTK_CONTAINER_CLASS (gtk_button_parent_class)->add (container, widget);
 657 }
 658
 659 static void
 660 gtk_button_dispose (GObject *object)
 661 {
 662   GtkButton *button = GTK_BUTTON (object);
 663   GtkButtonPrivate *priv = button->priv;
 664
 665   if (priv->action)
 666     {
 667       gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (button), NULL);
 668       priv->action = NULL;
 669     }
 670   G_OBJECT_CLASS (gtk_button_parent_class)->dispose (object);
 671 }
 672
 673 static void
 674 gtk_button_set_property (GObject         *object,
 675                          guint            prop_id,
 676                          const GValue    *value,
 677                          GParamSpec      *pspec)
 678 {
 679   GtkButton *button = GTK_BUTTON (object);
 680   GtkButtonPrivate *priv = button->priv;
 681
 682   switch (prop_id)
 683     {
 684     case PROP_LABEL:
 685       gtk_button_set_label (button, g_value_get_string (value));
 686       break;
 687     case PROP_IMAGE:
 688       gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
 689       break;
 690     case PROP_RELIEF:
 691       gtk_button_set_relief (button, g_value_get_enum (value));
 692       break;
 693     case PROP_USE_UNDERLINE:
 694       gtk_button_set_use_underline (button, g_value_get_boolean (value));
 695       break;
 696     case PROP_USE_STOCK:
 697       gtk_button_set_use_stock (button, g_value_get_boolean (value));
 698       break;
 699     case PROP_FOCUS_ON_CLICK:
 700       gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
 701       break;
 702     case PROP_XALIGN:
 703       gtk_button_set_alignment (button, g_value_get_float (value), priv->yalign);
 704       break;
 705     case PROP_YALIGN:
 706       gtk_button_set_alignment (button, priv->xalign, g_value_get_float (value));
 707       break;
 708     case PROP_IMAGE_POSITION:
 709       gtk_button_set_image_position (button, g_value_get_enum (value));
 710       break;
 711     case PROP_ACTIVATABLE_RELATED_ACTION:
 712       gtk_button_set_related_action (button, g_value_get_object (value));
 713       break;
 714     case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
 715       gtk_button_set_use_action_appearance (button, g_value_get_boolean (value));
 716       break;
 717     default:
 718       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 719       break;
 720     }
 721 }
 722
 723 static void
 724 gtk_button_get_property (GObject         *object,
 725                          guint            prop_id,
 726                          GValue          *value,
 727                          GParamSpec      *pspec)
 728 {
 729   GtkButton *button = GTK_BUTTON (object);
 730   GtkButtonPrivate *priv = button->priv;
 731
 732   switch (prop_id)
 733     {
 734     case PROP_LABEL:
 735       g_value_set_string (value, priv->label_text);
 736       break;
 737     case PROP_IMAGE:
 738       g_value_set_object (value, (GObject *)priv->image);
 739       break;
 740     case PROP_RELIEF:
 741       g_value_set_enum (value, priv->relief);
 742       break;
 743     case PROP_USE_UNDERLINE:
 744       g_value_set_boolean (value, priv->use_underline);
 745       break;
 746     case PROP_USE_STOCK:
 747       g_value_set_boolean (value, priv->use_stock);
 748       break;
 749     case PROP_FOCUS_ON_CLICK:
 750       g_value_set_boolean (value, priv->focus_on_click);
 751       break;
 752     case PROP_XALIGN:
 753       g_value_set_float (value, priv->xalign);
 754       break;
 755     case PROP_YALIGN:
 756       g_value_set_float (value, priv->yalign);
 757       break;
 758     case PROP_IMAGE_POSITION:
 759       g_value_set_enum (value, priv->image_position);
 760       break;
 761     case PROP_ACTIVATABLE_RELATED_ACTION:
 762       g_value_set_object (value, priv->action);
 763       break;
 764     case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
 765       g_value_set_boolean (value, priv->use_action_appearance);
 766       break;
 767     default:
 768       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 769       break;
 770     }
 771 }
 772
 773 static void
 774 gtk_button_activatable_interface_init (GtkActivatableIface  *iface)
 775 {
 776   iface->update = gtk_button_update;
 777   iface->sync_action_properties = gtk_button_sync_action_properties;
 778 }
 779
 780 static void
 781 activatable_update_stock_id (GtkButton *button,
 782                              GtkAction *action)
 783 {
 784   if (!gtk_button_get_use_stock (button))
 785     return;
 786
 787   gtk_button_set_label (button, gtk_action_get_stock_id (action));
 788 }
 789
 790 static void
 791 activatable_update_short_label (GtkButton *button,
 792                                 GtkAction *action)
 793 {
 794   GtkWidget *child;
 795   GtkWidget *image;
 796
 797   if (gtk_button_get_use_stock (button))
 798     return;
 799
 800   image = gtk_button_get_image (button);
 801
 802   /* Dont touch custom child... */
 803   child = gtk_bin_get_child (GTK_BIN (button));
 804   if (GTK_IS_IMAGE (image) ||
 805       child == NULL ||
 806       GTK_IS_LABEL (child))
 807     {
 808       gtk_button_set_label (button, gtk_action_get_short_label (action));
 809       gtk_button_set_use_underline (button, TRUE);
 810     }
 811 }
 812
 813 static void
 814 activatable_update_icon_name (GtkButton *button,
 815                               GtkAction *action)
 816 {
 817   GtkWidget *image;
 818
 819   if (gtk_button_get_use_stock (button))
 820     return;
 821
 822   image = gtk_button_get_image (button);
 823
 824   if (GTK_IS_IMAGE (image) &&
 825       (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
 826        gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_ICON_NAME))
 827     gtk_image_set_from_icon_name (GTK_IMAGE (image),
 828                                   gtk_action_get_icon_name (action), GTK_ICON_SIZE_MENU);
 829 }
 830
 831 static void
 832 activatable_update_gicon (GtkButton *button,
 833                           GtkAction *action)
 834 {
 835   GtkWidget *image = gtk_button_get_image (button);
 836   GIcon *icon = gtk_action_get_gicon (action);
 837
 838   if (GTK_IS_IMAGE (image) &&
 839       (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
 840        gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_GICON))
 841     gtk_image_set_from_gicon (GTK_IMAGE (image), icon, GTK_ICON_SIZE_BUTTON);
 842 }
 843
 844 static void
 845 gtk_button_update (GtkActivatable *activatable,
 846                    GtkAction      *action,
 847                    const gchar    *property_name)
 848 {
 849   GtkButton *button = GTK_BUTTON (activatable);
 850   GtkButtonPrivate *priv = button->priv;
 851
 852   if (strcmp (property_name, "visible") == 0)
 853     {
 854       if (gtk_action_is_visible (action))
 855         gtk_widget_show (GTK_WIDGET (activatable));
 856       else
 857         gtk_widget_hide (GTK_WIDGET (activatable));
 858     }
 859   else if (strcmp (property_name, "sensitive") == 0)
 860     gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));
 861
 862   if (!priv->use_action_appearance)
 863     return;
 864
 865   if (strcmp (property_name, "stock-id") == 0)
 866     activatable_update_stock_id (GTK_BUTTON (activatable), action);
 867   else if (strcmp (property_name, "gicon") == 0)
 868     activatable_update_gicon (GTK_BUTTON (activatable), action);
 869   else if (strcmp (property_name, "short-label") == 0)
 870     activatable_update_short_label (GTK_BUTTON (activatable), action);
 871   else if (strcmp (property_name, "icon-name") == 0)
 872     activatable_update_icon_name (GTK_BUTTON (activatable), action);
 873 }
 874
 875 static void
 876 gtk_button_sync_action_properties (GtkActivatable *activatable,
 877                                    GtkAction      *action)
 878 {
 879   GtkButton *button = GTK_BUTTON (activatable);
 880   GtkButtonPrivate *priv = button->priv;
 881
 882   if (!action)
 883     return;
 884
 885   if (gtk_action_is_visible (action))
 886     gtk_widget_show (GTK_WIDGET (activatable));
 887   else
 888     gtk_widget_hide (GTK_WIDGET (activatable));
 889
 890   gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));
 891
 892   if (priv->use_action_appearance)
 893     {
 894       activatable_update_stock_id (GTK_BUTTON (activatable), action);
 895       activatable_update_short_label (GTK_BUTTON (activatable), action);
 896       activatable_update_gicon (GTK_BUTTON (activatable), action);
 897       activatable_update_icon_name (GTK_BUTTON (activatable), action);
 898     }
 899 }
 900
 901 static void
 902 gtk_button_set_related_action (GtkButton *button,
 903                                GtkAction *action)
 904 {
 905   GtkButtonPrivate *priv = button->priv;
 906
 907   if (priv->action == action)
 908     return;
 909
 910   /* This should be a default handler, but for compatibility reasons
 911    * we need to support derived classes that don't chain up their
 912    * clicked handler.
 913    */
 914   g_signal_handlers_disconnect_by_func (button, gtk_real_button_clicked, NULL);
 915   if (action)
 916     g_signal_connect_after (button, "clicked",
 917                             G_CALLBACK (gtk_real_button_clicked), NULL);
 918
 919   gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (button), action);
 920
 921   priv->action = action;
 922 }
 923
 924 static void
 925 gtk_button_set_use_action_appearance (GtkButton *button,
 926                                       gboolean   use_appearance)
 927 {
 928   GtkButtonPrivate *priv = button->priv;
 929
 930   if (priv->use_action_appearance != use_appearance)
 931     {
 932       priv->use_action_appearance = use_appearance;
 933
 934       gtk_activatable_sync_action_properties (GTK_ACTIVATABLE (button), priv->action);
 935     }
 936 }
 937
 938 /**
 939  * gtk_button_new:
 940  *
 941  * Creates a new #GtkButton widget. To add a child widget to the button,
 942  * use gtk_container_add().
 943  *
 944  * Returns: The newly created #GtkButton widget.
 945  */
 946 GtkWidget*
 947 gtk_button_new (void)
 948 {
 949   return g_object_new (GTK_TYPE_BUTTON, NULL);
 950 }
 951
 952 static gboolean
 953 show_image (GtkButton *button)
 954 {
 955   GtkButtonPrivate *priv = button->priv;
 956   gboolean show;
 957
 958   if (priv->label_text)
 959     {
 960       GtkSettings *settings;
 961
 962       settings = gtk_widget_get_settings (GTK_WIDGET (button));
 963       g_object_get (settings, "gtk-button-images", &show, NULL);
 964     }
 965   else
 966     show = TRUE;
 967
 968   return show;
 969 }
 970
 971 static void
 972 gtk_button_construct_child (GtkButton *button)
 973 {
 974   GtkButtonPrivate *priv = button->priv;
 975   GtkStyleContext *context;
 976   GtkStockItem item;
 977   GtkWidget *child;
 978   GtkWidget *label;
 979   GtkWidget *box;
 980   GtkWidget *align;
 981   GtkWidget *image = NULL;
 982   gchar *label_text = NULL;
 983   gint image_spacing;
 984
 985   if (!priv->constructed)
 986     return;
 987
 988   if (!priv->label_text && !priv->image)
 989     return;
 990
 991   context = gtk_widget_get_style_context (GTK_WIDGET (button));
 992
 993   gtk_style_context_get_style (context,
 994                                "image-spacing", &image_spacing,
 995                                NULL);
 996
 997   if (priv->image && !priv->image_is_stock)
 998     {
 999       GtkWidget *parent;
1000
1001       image = g_object_ref (priv->image);
1002
1003       parent = gtk_widget_get_parent (image);
1004       if (parent)
1005         gtk_container_remove (GTK_CONTAINER (parent), image);
1006     }
1007
1008   priv->image = NULL;
1009
1010   child = gtk_bin_get_child (GTK_BIN (button));
1011   if (child)
1012     gtk_container_remove (GTK_CONTAINER (button), child);
1013
1014   if (priv->use_stock &&
1015       priv->label_text &&
1016       gtk_stock_lookup (priv->label_text, &item))
1017     {
1018       if (!image)
1019         image = g_object_ref (gtk_image_new_from_stock (priv->label_text, GTK_ICON_SIZE_BUTTON));
1020
1021       label_text = item.label;
1022     }
1023   else
1024     label_text = priv->label_text;
1025
1026   if (image)
1027     {
1028       priv->image = image;
1029       g_object_set (priv->image,
1030                     "visible", show_image (button),
1031                     "no-show-all", TRUE,
1032                     NULL);
1033
1034       if (priv->image_position == GTK_POS_LEFT ||
1035           priv->image_position == GTK_POS_RIGHT)
1036         box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, image_spacing);
1037       else
1038         box = gtk_box_new (GTK_ORIENTATION_VERTICAL, image_spacing);
1039
1040       if (priv->align_set)
1041         align = gtk_alignment_new (priv->xalign, priv->yalign, 0.0, 0.0);
1042       else
1043         align = gtk_alignment_new (0.5, 0.5, 0.0, 0.0);
1044
1045       if (priv->image_position == GTK_POS_LEFT ||
1046           priv->image_position == GTK_POS_TOP)
1047         gtk_box_pack_start (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
1048       else
1049         gtk_box_pack_end (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
1050
1051       if (label_text)
1052         {
1053           if (priv->use_underline || priv->use_stock)
1054             {
1055               label = gtk_label_new_with_mnemonic (label_text);
1056               gtk_label_set_mnemonic_widget (GTK_LABEL (label),
1057                                              GTK_WIDGET (button));
1058             }
1059           else
1060             label = gtk_label_new (label_text);
1061
1062           if (priv->image_position == GTK_POS_RIGHT ||
1063               priv->image_position == GTK_POS_BOTTOM)
1064             gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
1065           else
1066             gtk_box_pack_end (GTK_BOX (box), label, FALSE, FALSE, 0);
1067         }
1068
1069       gtk_container_add (GTK_CONTAINER (button), align);
1070       gtk_container_add (GTK_CONTAINER (align), box);
1071       gtk_widget_show_all (align);
1072
1073       g_object_unref (image);
1074
1075       return;
1076     }
1077
1078   if (priv->use_underline || priv->use_stock)
1079     {
1080       label = gtk_label_new_with_mnemonic (priv->label_text);
1081       gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
1082     }
1083   else
1084     label = gtk_label_new (priv->label_text);
1085
1086   if (priv->align_set)
1087     gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
1088
1089   gtk_widget_show (label);
1090   gtk_container_add (GTK_CONTAINER (button), label);
1091 }
1092
1093
1094 /**
1095  * gtk_button_new_with_label:
1096  * @label: The text you want the #GtkLabel to hold.
1097  *
1098  * Creates a #GtkButton widget with a #GtkLabel child containing the given
1099  * text.
1100  *
1101  * Returns: The newly created #GtkButton widget.
1102  */
1103 GtkWidget*
1104 gtk_button_new_with_label (const gchar *label)
1105 {
1106   return g_object_new (GTK_TYPE_BUTTON, "label", label, NULL);
1107 }
1108
1109 /**
1110  * gtk_button_new_from_stock:
1111  * @stock_id: the name of the stock item
1112  *
1113  * Creates a new #GtkButton containing the image and text from a stock item.
1114  * Some stock ids have preprocessor macros like #GTK_STOCK_OK and
1115  * #GTK_STOCK_APPLY.
1116  *
1117  * If @stock_id is unknown, then it will be treated as a mnemonic
1118  * label (as for gtk_button_new_with_mnemonic()).
1119  *
1120  * Returns: a new #GtkButton
1121  **/
1122 GtkWidget*
1123 gtk_button_new_from_stock (const gchar *stock_id)
1124 {
1125   return g_object_new (GTK_TYPE_BUTTON,
1126                        "label", stock_id,
1127                        "use-stock", TRUE,
1128                        "use-underline", TRUE,
1129                        NULL);
1130 }
1131
1132 /**
1133  * gtk_button_new_with_mnemonic:
1134  * @label: The text of the button, with an underscore in front of the
1135  *         mnemonic character
1136  * @returns: a new #GtkButton
1137  *
1138  * Creates a new #GtkButton containing a label.
1139  * If characters in @label are preceded by an underscore, they are underlined.
1140  * If you need a literal underscore character in a label, use '__' (two
1141  * underscores). The first underlined character represents a keyboard
1142  * accelerator called a mnemonic.
1143  * Pressing Alt and that key activates the button.
1144  **/
1145 GtkWidget*
1146 gtk_button_new_with_mnemonic (const gchar *label)
1147 {
1148   return g_object_new (GTK_TYPE_BUTTON, "label", label, "use-underline", TRUE,  NULL);
1149 }
1150
1151 /**
1152  * gtk_button_pressed:
1153  * @button: The #GtkButton you want to send the signal to.
1154  *
1155  * Emits a #GtkButton::pressed signal to the given #GtkButton.
1156  *
1157  * Deprecated: 2.20: Use the #GtkWidget::button-press-event signal.
1158  */
1159 void
1160 gtk_button_pressed (GtkButton *button)
1161 {
1162   g_return_if_fail (GTK_IS_BUTTON (button));
1163
1164   g_signal_emit (button, button_signals[PRESSED], 0);
1165 }
1166
1167 /**
1168  * gtk_button_released:
1169  * @button: The #GtkButton you want to send the signal to.
1170  *
1171  * Emits a #GtkButton::released signal to the given #GtkButton.
1172  *
1173  * Deprecated: 2.20: Use the #GtkWidget::button-release-event signal.
1174  */
1175 void
1176 gtk_button_released (GtkButton *button)
1177 {
1178   g_return_if_fail (GTK_IS_BUTTON (button));
1179
1180   g_signal_emit (button, button_signals[RELEASED], 0);
1181 }
1182
1183 /**
1184  * gtk_button_clicked:
1185  * @button: The #GtkButton you want to send the signal to.
1186  *
1187  * Emits a #GtkButton::clicked signal to the given #GtkButton.
1188  */
1189 void
1190 gtk_button_clicked (GtkButton *button)
1191 {
1192   g_return_if_fail (GTK_IS_BUTTON (button));
1193
1194   g_signal_emit (button, button_signals[CLICKED], 0);
1195 }
1196
1197 /**
1198  * gtk_button_enter:
1199  * @button: The #GtkButton you want to send the signal to.
1200  *
1201  * Emits a #GtkButton::enter signal to the given #GtkButton.
1202  *
1203  * Deprecated: 2.20: Use the #GtkWidget::enter-notify-event signal.
1204  */
1205 void
1206 gtk_button_enter (GtkButton *button)
1207 {
1208   g_return_if_fail (GTK_IS_BUTTON (button));
1209
1210   g_signal_emit (button, button_signals[ENTER], 0);
1211 }
1212
1213 /**
1214  * gtk_button_leave:
1215  * @button: The #GtkButton you want to send the signal to.
1216  *
1217  * Emits a #GtkButton::leave signal to the given #GtkButton.
1218  *
1219  * Deprecated: 2.20: Use the #GtkWidget::leave-notify-event signal.
1220  */
1221 void
1222 gtk_button_leave (GtkButton *button)
1223 {
1224   g_return_if_fail (GTK_IS_BUTTON (button));
1225
1226   g_signal_emit (button, button_signals[LEAVE], 0);
1227 }
1228
1229 /**
1230  * gtk_button_set_relief:
1231  * @button: The #GtkButton you want to set relief styles of.
1232  * @newstyle: The GtkReliefStyle as described above.
1233  *
1234  * Sets the relief style of the edges of the given #GtkButton widget.
1235  * Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
1236  * The default style is, as one can guess, GTK_RELIEF_NORMAL.
1237  *
1238  * <!-- FIXME: put pictures of each style -->
1239  */
1240 void
1241 gtk_button_set_relief (GtkButton *button,
1242                        GtkReliefStyle newrelief)
1243 {
1244   GtkButtonPrivate *priv;
1245
1246   g_return_if_fail (GTK_IS_BUTTON (button));
1247
1248   priv = button->priv;
1249
1250   if (newrelief != priv->relief)
1251     {
1252        priv->relief = newrelief;
1253        g_object_notify (G_OBJECT (button), "relief");
1254        gtk_widget_queue_draw (GTK_WIDGET (button));
1255     }
1256 }
1257
1258 /**
1259  * gtk_button_get_relief:
1260  * @button: The #GtkButton you want the #GtkReliefStyle from.
1261  *
1262  * Returns the current relief style of the given #GtkButton.
1263  *
1264  * Returns: The current #GtkReliefStyle
1265  */
1266 GtkReliefStyle
1267 gtk_button_get_relief (GtkButton *button)
1268 {
1269   g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);
1270
1271   return button->priv->relief;
1272 }
1273
1274 static void
1275 gtk_button_realize (GtkWidget *widget)
1276 {
1277   GtkButton *button = GTK_BUTTON (widget);
1278   GtkButtonPrivate *priv = button->priv;
1279   GtkAllocation allocation;
1280   GdkWindow *window;
1281   GdkWindowAttr attributes;
1282   gint attributes_mask;
1283
1284   gtk_widget_get_allocation (widget, &allocation);
1285
1286   gtk_widget_set_realized (widget, TRUE);
1287
1288   attributes.window_type = GDK_WINDOW_CHILD;
1289   attributes.x = allocation.x;
1290   attributes.y = allocation.y;
1291   attributes.width = allocation.width;
1292   attributes.height = allocation.height;
1293   attributes.wclass = GDK_INPUT_ONLY;
1294   attributes.event_mask = gtk_widget_get_events (widget);
1295   attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
1296                             GDK_BUTTON_RELEASE_MASK |
1297                             GDK_ENTER_NOTIFY_MASK |
1298                             GDK_LEAVE_NOTIFY_MASK);
1299
1300   attributes_mask = GDK_WA_X | GDK_WA_Y;
1301
1302   window = gtk_widget_get_parent_window (widget);
1303   gtk_widget_set_window (widget, window);
1304   g_object_ref (window);
1305
1306   priv->event_window = gdk_window_new (window,
1307                                        &attributes, attributes_mask);
1308   gdk_window_set_user_data (priv->event_window, button);
1309 }
1310
1311 static void
1312 gtk_button_unrealize (GtkWidget *widget)
1313 {
1314   GtkButton *button = GTK_BUTTON (widget);
1315   GtkButtonPrivate *priv = button->priv;
1316
1317   if (priv->activate_timeout)
1318     gtk_button_finish_activate (button, FALSE);
1319
1320   if (priv->event_window)
1321     {
1322       gdk_window_set_user_data (priv->event_window, NULL);
1323       gdk_window_destroy (priv->event_window);
1324       priv->event_window = NULL;
1325     }
1326
1327   GTK_WIDGET_CLASS (gtk_button_parent_class)->unrealize (widget);
1328 }
1329
1330 static void
1331 gtk_button_map (GtkWidget *widget)
1332 {
1333   GtkButton *button = GTK_BUTTON (widget);
1334   GtkButtonPrivate *priv = button->priv;
1335
1336   GTK_WIDGET_CLASS (gtk_button_parent_class)->map (widget);
1337
1338   if (priv->event_window)
1339     gdk_window_show (priv->event_window);
1340 }
1341
1342 static void
1343 gtk_button_unmap (GtkWidget *widget)
1344 {
1345   GtkButton *button = GTK_BUTTON (widget);
1346   GtkButtonPrivate *priv = button->priv;
1347
1348   if (priv->event_window)
1349     gdk_window_hide (priv->event_window);
1350
1351   GTK_WIDGET_CLASS (gtk_button_parent_class)->unmap (widget);
1352 }
1353
1354 static void
1355 gtk_button_update_image_spacing (GtkButton       *button,
1356                                  GtkStyleContext *context)
1357 {
1358   GtkButtonPrivate *priv = button->priv;
1359   GtkWidget *child;
1360   gint spacing;
1361
1362   /* Keep in sync with gtk_button_construct_child,
1363    * we only want to update the spacing if the box
1364    * was constructed there.
1365    */
1366   if (!priv->constructed || !priv->image)
1367     return;
1368
1369   child = gtk_bin_get_child (GTK_BIN (button));
1370   if (GTK_IS_ALIGNMENT (child))
1371     {
1372       child = gtk_bin_get_child (GTK_BIN (child));
1373       if (GTK_IS_BOX (child))
1374         {
1375           gtk_style_context_get_style (context,
1376                                        "image-spacing", &spacing,
1377                                        NULL);
1378
1379           gtk_box_set_spacing (GTK_BOX (child), spacing);
1380         }
1381     }
1382 }
1383
1384 static void
1385 gtk_button_style_updated (GtkWidget *widget)
1386 {
1387   GtkStyleContext *context;
1388
1389   GTK_WIDGET_CLASS (gtk_button_parent_class)->style_updated (widget);
1390
1391   context = gtk_widget_get_style_context (widget);
1392
1393   gtk_button_update_image_spacing (GTK_BUTTON (widget), context);
1394 }
1395
1396 static void
1397 gtk_button_get_props (GtkButton *button,
1398                       GtkBorder *default_border,
1399                       GtkBorder *default_outside_border,
1400                       GtkBorder *inner_border,
1401                       GtkBorder *padding,
1402                       gboolean  *interior_focus)
1403 {
1404   GtkStyleContext *context;
1405   GtkStateFlags state;
1406   GtkBorder *tmp_border;
1407
1408   context = gtk_widget_get_style_context (GTK_WIDGET (button));
1409   state = gtk_style_context_get_state (context);
1410
1411   if (default_border)
1412     {
1413       gtk_style_context_get_style (context,
1414                                    "default-border", &tmp_border,
1415                                    NULL);
1416
1417       if (tmp_border)
1418         {
1419           *default_border = *tmp_border;
1420           gtk_border_free (tmp_border);
1421         }
1422       else
1423         *default_border = default_default_border;
1424     }
1425
1426   if (default_outside_border)
1427     {
1428       gtk_style_context_get_style (context,
1429                                    "default-outside-border", &tmp_border,
1430                                    NULL);
1431
1432       if (tmp_border)
1433         {
1434           *default_outside_border = *tmp_border;
1435           gtk_border_free (tmp_border);
1436         }
1437       else
1438         *default_outside_border = default_default_outside_border;
1439     }
1440
1441   if (inner_border)
1442     {
1443       gtk_style_context_get_style (context,
1444                                    "inner-border", &tmp_border,
1445                                    NULL);
1446
1447       if (tmp_border)
1448         {
1449           *inner_border = *tmp_border;
1450           gtk_border_free (tmp_border);
1451         }
1452       else
1453         *inner_border = default_inner_border;
1454     }
1455
1456   if (interior_focus)
1457     {
1458       gtk_style_context_get_style (context,
1459                                    "interior-focus", interior_focus,
1460                                    NULL);
1461     }
1462
1463   if (padding)
1464     gtk_style_context_get_padding (context, state, padding);
1465 }
1466
1467 static void
1468 gtk_button_size_allocate (GtkWidget     *widget,
1469                           GtkAllocation *allocation)
1470 {
1471   GtkButton *button = GTK_BUTTON (widget);
1472   GtkButtonPrivate *priv = button->priv;
1473   GtkAllocation child_allocation;
1474   GtkStyleContext *context;
1475   GtkWidget *child;
1476   GtkBorder default_border;
1477   GtkBorder inner_border;
1478   GtkBorder padding;
1479   gint focus_width;
1480   gint focus_pad;
1481
1482   context = gtk_widget_get_style_context (widget);
1483
1484   gtk_button_get_props (button, &default_border, NULL, &inner_border, &padding, NULL);
1485   gtk_style_context_get_style (context,
1486                               "focus-line-width", &focus_width,
1487                               "focus-padding", &focus_pad,
1488                               NULL);
1489
1490   gtk_widget_set_allocation (widget, allocation);
1491
1492   if (gtk_widget_get_realized (widget))
1493     gdk_window_move_resize (priv->event_window,
1494                             allocation->x,
1495                             allocation->y,
1496                             allocation->width,
1497                             allocation->height);
1498
1499   child = gtk_bin_get_child (GTK_BIN (button));
1500   if (child && gtk_widget_get_visible (child))
1501     {
1502       child_allocation.x = allocation->x + inner_border.left + padding.left;
1503       child_allocation.y = allocation->y + inner_border.top + padding.top;
1504
1505       child_allocation.width =
1506         allocation->width -
1507         (padding.left + padding.right) -
1508         inner_border.left -
1509         inner_border.right;
1510
1511       child_allocation.height =
1512         allocation->height -
1513         (padding.top + padding.bottom) -
1514         inner_border.top -
1515         inner_border.bottom;
1516
1517       if (gtk_widget_get_can_default (GTK_WIDGET (button)))
1518         {
1519           child_allocation.x += default_border.left;
1520           child_allocation.y += default_border.top;
1521           child_allocation.width =  child_allocation.width - default_border.left - default_border.right;
1522           child_allocation.height = child_allocation.height - default_border.top - default_border.bottom;
1523         }
1524
1525       if (gtk_widget_get_can_focus (GTK_WIDGET (button)))
1526         {
1527           child_allocation.x += focus_width + focus_pad;
1528           child_allocation.y += focus_width + focus_pad;
1529           child_allocation.width =  child_allocation.width - (focus_width + focus_pad) * 2;
1530           child_allocation.height = child_allocation.height - (focus_width + focus_pad) * 2;
1531         }
1532
1533       if (priv->depressed)
1534         {
1535           gint child_displacement_x;
1536           gint child_displacement_y;
1537
1538           gtk_style_context_get_style (context,
1539                                        "child-displacement-x", &child_displacement_x,
1540                                        "child-displacement-y", &child_displacement_y,
1541                                        NULL);
1542           child_allocation.x += child_displacement_x;
1543           child_allocation.y += child_displacement_y;
1544         }
1545
1546       child_allocation.width  = MAX (1, child_allocation.width);
1547       child_allocation.height = MAX (1, child_allocation.height);
1548
1549       gtk_widget_size_allocate (child, &child_allocation);
1550     }
1551 }
1552
1553 void
1554 _gtk_button_paint (GtkButton          *button,
1555                    cairo_t            *cr,
1556                    int                 width,
1557                    int                 height,
1558                    GtkStateFlags       state)
1559 {
1560   GtkButtonPrivate *priv = button->priv;
1561   GtkWidget *widget;
1562   gint x, y;
1563   GtkBorder default_border;
1564   GtkBorder default_outside_border;
1565   gboolean interior_focus;
1566   gint focus_width;
1567   gint focus_pad;
1568   GtkAllocation allocation;
1569   GtkStyleContext *context;
1570
1571   widget = GTK_WIDGET (button);
1572   context = gtk_widget_get_style_context (widget);
1573
1574   gtk_style_context_save (context);
1575   gtk_style_context_set_state (context, state);
1576
1577   gtk_button_get_props (button, &default_border, &default_outside_border, NULL, NULL, &interior_focus);
1578   gtk_style_context_get_style (context,
1579                                "focus-line-width", &focus_width,
1580                                "focus-padding", &focus_pad,
1581                                NULL);
1582
1583   gtk_widget_get_allocation (widget, &allocation);
1584
1585   x = 0;
1586   y = 0;
1587
1588   if (gtk_widget_has_default (widget) &&
1589       priv->relief == GTK_RELIEF_NORMAL)
1590     {
1591       x += default_border.left;
1592       y += default_border.top;
1593       width -= default_border.left + default_border.right;
1594       height -= default_border.top + default_border.bottom;
1595
1596       gtk_style_context_add_class (context, GTK_STYLE_CLASS_DEFAULT);
1597     }
1598   else if (gtk_widget_get_can_default (widget))
1599     {
1600       x += default_outside_border.left;
1601       y += default_outside_border.top;
1602       width -= default_outside_border.left + default_outside_border.right;
1603       height -= default_outside_border.top + default_outside_border.bottom;
1604     }
1605
1606   if (!interior_focus && gtk_widget_has_focus (widget))
1607     {
1608       x += focus_width + focus_pad;
1609       y += focus_width + focus_pad;
1610       width -= 2 * (focus_width + focus_pad);
1611       height -= 2 * (focus_width + focus_pad);
1612     }
1613
1614   if (priv->relief != GTK_RELIEF_NONE || priv->depressed ||
1615       state & GTK_STATE_FLAG_PRELIGHT)
1616     {
1617       gtk_render_background (context, cr,
1618                              x, y, width, height);
1619       gtk_render_frame (context, cr,
1620                         x, y, width, height);
1621     }
1622
1623   if (gtk_widget_has_focus (widget))
1624     {
1625       gint child_displacement_x;
1626       gint child_displacement_y;
1627       gboolean displace_focus;
1628       GtkBorder border;
1629
1630       gtk_style_context_get_style (context,
1631                                    "child-displacement-y", &child_displacement_y,
1632                                    "child-displacement-x", &child_displacement_x,
1633                                    "displace-focus", &displace_focus,
1634                                    NULL);
1635       gtk_style_context_get_border (context, state, &border);
1636
1637       if (interior_focus)
1638         {
1639           x += border.left + focus_pad;
1640           y += border.top + focus_pad;
1641           width -= (2 * focus_pad) + border.left + border.right;
1642           height -=  (2 * focus_pad) + border.top + border.bottom;
1643         }
1644       else
1645         {
1646           x -= focus_width + focus_pad;
1647           y -= focus_width + focus_pad;
1648           width += 2 * (focus_width + focus_pad);
1649           height += 2 * (focus_width + focus_pad);
1650         }
1651
1652       if (priv->depressed && displace_focus)
1653         {
1654           x += child_displacement_x;
1655           y += child_displacement_y;
1656         }
1657
1658       gtk_render_focus (context, cr,
1659                         x, y, width, height);
1660     }
1661
1662   gtk_style_context_restore (context);
1663 }
1664
1665 static gboolean
1666 gtk_button_draw (GtkWidget *widget,
1667                  cairo_t   *cr)
1668 {
1669   GtkButton *button = GTK_BUTTON (widget);
1670
1671   _gtk_button_paint (button, cr,
1672                      gtk_widget_get_allocated_width (widget),
1673                      gtk_widget_get_allocated_height (widget),
1674                      gtk_widget_get_state_flags (widget));
1675
1676   GTK_WIDGET_CLASS (gtk_button_parent_class)->draw (widget, cr);
1677
1678   return FALSE;
1679 }
1680
1681 static gboolean
1682 gtk_button_button_press (GtkWidget      *widget,
1683                          GdkEventButton *event)
1684 {
1685   GtkButton *button;
1686   GtkButtonPrivate *priv;
1687
1688   if (event->type == GDK_BUTTON_PRESS)
1689     {
1690       button = GTK_BUTTON (widget);
1691       priv = button->priv;
1692
1693       if (priv->focus_on_click && !gtk_widget_has_focus (widget))
1694         gtk_widget_grab_focus (widget);
1695
1696       if (event->button == 1)
1697         gtk_button_pressed (button);
1698     }
1699
1700   return TRUE;
1701 }
1702
1703 static gboolean
1704 gtk_button_button_release (GtkWidget      *widget,
1705                            GdkEventButton *event)
1706 {
1707   GtkButton *button;
1708
1709   if (event->button == 1)
1710     {
1711       button = GTK_BUTTON (widget);
1712       gtk_button_released (button);
1713     }
1714
1715   return TRUE;
1716 }
1717
1718 static gboolean
1719 gtk_button_grab_broken (GtkWidget          *widget,
1720                         GdkEventGrabBroken *event)
1721 {
1722   GtkButton *button = GTK_BUTTON (widget);
1723   GtkButtonPrivate *priv = button->priv;
1724   gboolean save_in;
1725
1726   /* Simulate a button release without the pointer in the button */
1727   if (priv->button_down)
1728     {
1729       save_in = priv->in_button;
1730       priv->in_button = FALSE;
1731       gtk_button_released (button);
1732       if (save_in != priv->in_button)
1733         {
1734           priv->in_button = save_in;
1735           gtk_button_update_state (button);
1736         }
1737     }
1738
1739   return TRUE;
1740 }
1741
1742 static gboolean
1743 gtk_button_key_release (GtkWidget   *widget,
1744                         GdkEventKey *event)
1745 {
1746   GtkButton *button = GTK_BUTTON (widget);
1747   GtkButtonPrivate *priv = button->priv;
1748
1749   if (priv->activate_timeout)
1750     {
1751       gtk_button_finish_activate (button, TRUE);
1752       return TRUE;
1753     }
1754   else if (GTK_WIDGET_CLASS (gtk_button_parent_class)->key_release_event)
1755     return GTK_WIDGET_CLASS (gtk_button_parent_class)->key_release_event (widget, event);
1756   else
1757     return FALSE;
1758 }
1759
1760 static gboolean
1761 gtk_button_enter_notify (GtkWidget        *widget,
1762                          GdkEventCrossing *event)
1763 {
1764   GtkButton *button = GTK_BUTTON (widget);
1765   GtkButtonPrivate *priv = button->priv;
1766
1767   if ((event->window == button->priv->event_window) &&
1768       (event->detail != GDK_NOTIFY_INFERIOR))
1769     {
1770       priv->in_button = TRUE;
1771       gtk_button_enter (button);
1772     }
1773
1774   return FALSE;
1775 }
1776
1777 static gboolean
1778 gtk_button_leave_notify (GtkWidget        *widget,
1779                          GdkEventCrossing *event)
1780 {
1781   GtkButton *button = GTK_BUTTON (widget);
1782   GtkButtonPrivate *priv = button->priv;
1783
1784   if ((event->window == button->priv->event_window) &&
1785       (event->detail != GDK_NOTIFY_INFERIOR) &&
1786       (gtk_widget_get_sensitive (widget)))
1787     {
1788       priv->in_button = FALSE;
1789       gtk_button_leave (button);
1790     }
1791
1792   return FALSE;
1793 }
1794
1795 static void
1796 gtk_real_button_pressed (GtkButton *button)
1797 {
1798   GtkButtonPrivate *priv = button->priv;
1799
1800   if (priv->activate_timeout)
1801     return;
1802
1803   priv->button_down = TRUE;
1804   gtk_button_update_state (button);
1805 }
1806
1807 static void
1808 gtk_real_button_released (GtkButton *button)
1809 {
1810   GtkButtonPrivate *priv = button->priv;
1811
1812   if (priv->button_down)
1813     {
1814       priv->button_down = FALSE;
1815
1816       if (priv->activate_timeout)
1817         return;
1818
1819       if (priv->in_button)
1820         gtk_button_clicked (button);
1821
1822       gtk_button_update_state (button);
1823     }
1824 }
1825
1826 static void
1827 gtk_real_button_clicked (GtkButton *button)
1828 {
1829   GtkButtonPrivate *priv = button->priv;
1830
1831   if (priv->action)
1832     gtk_action_activate (priv->action);
1833 }
1834
1835 static gboolean
1836 button_activate_timeout (gpointer data)
1837 {
1838   gtk_button_finish_activate (data, TRUE);
1839
1840   return FALSE;
1841 }
1842
1843 static void
1844 gtk_real_button_activate (GtkButton *button)
1845 {
1846   GtkWidget *widget = GTK_WIDGET (button);
1847   GtkButtonPrivate *priv = button->priv;
1848   GdkDevice *device;
1849   guint32 time;
1850
1851   device = gtk_get_current_event_device ();
1852
1853   if (device && gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1854     device = gdk_device_get_associated_device (device);
1855
1856   if (gtk_widget_get_realized (widget) && !priv->activate_timeout)
1857     {
1858       time = gtk_get_current_event_time ();
1859
1860       /* bgo#626336 - Only grab if we have a device (from an event), not if we
1861        * were activated programmatically when no event is available.
1862        */
1863       if (device && gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1864         {
1865           if (gdk_device_grab (device, priv->event_window,
1866                                GDK_OWNERSHIP_WINDOW, TRUE,
1867                                GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
1868                                NULL, time) == GDK_GRAB_SUCCESS)
1869             {
1870               gtk_device_grab_add (widget, device, TRUE);
1871               priv->grab_keyboard = device;
1872               priv->grab_time = time;
1873             }
1874         }
1875
1876       priv->activate_timeout = gdk_threads_add_timeout (ACTIVATE_TIMEOUT,
1877                                                 button_activate_timeout,
1878                                                 button);
1879       priv->button_down = TRUE;
1880       gtk_button_update_state (button);
1881       gtk_widget_queue_draw (GTK_WIDGET (button));
1882     }
1883 }
1884
1885 static void
1886 gtk_button_finish_activate (GtkButton *button,
1887                             gboolean   do_it)
1888 {
1889   GtkWidget *widget = GTK_WIDGET (button);
1890   GtkButtonPrivate *priv = button->priv;
1891
1892   g_source_remove (priv->activate_timeout);
1893   priv->activate_timeout = 0;
1894
1895   if (priv->grab_keyboard)
1896     {
1897       gdk_device_ungrab (priv->grab_keyboard, priv->grab_time);
1898       gtk_device_grab_remove (widget, priv->grab_keyboard);
1899       priv->grab_keyboard = NULL;
1900     }
1901
1902   priv->button_down = FALSE;
1903
1904   gtk_button_update_state (button);
1905   gtk_widget_queue_draw (GTK_WIDGET (button));
1906
1907   if (do_it)
1908     gtk_button_clicked (button);
1909 }
1910
1911
1912 static void
1913 gtk_button_get_size (GtkWidget      *widget,
1914                      GtkOrientation  orientation,
1915                      gint           *minimum_size,
1916                      gint           *natural_size)
1917 {
1918   GtkButton *button = GTK_BUTTON (widget);
1919   GtkStyleContext *context;
1920   GtkWidget *child;
1921   GtkBorder default_border;
1922   GtkBorder inner_border;
1923   GtkBorder padding;
1924   gint focus_width;
1925   gint focus_pad;
1926   gint minimum, natural;
1927
1928   context = gtk_widget_get_style_context (widget);
1929
1930   gtk_button_get_props (button, &default_border, NULL, &inner_border, &padding, NULL);
1931   gtk_style_context_get_style (context,
1932                                "focus-line-width", &focus_width,
1933                                "focus-padding", &focus_pad,
1934                                NULL);
1935
1936   if (orientation == GTK_ORIENTATION_HORIZONTAL)
1937     {
1938       minimum = inner_border.left + inner_border.right + padding.left + padding.right;
1939
1940       if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
1941         minimum += default_border.left + default_border.right;
1942     }
1943   else
1944     {
1945       minimum = inner_border.top + inner_border.bottom + padding.top + padding.bottom;
1946
1947       if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
1948         minimum += default_border.top + default_border.bottom;
1949     }
1950
1951   minimum += 2 * (focus_width + focus_pad);
1952   natural = minimum;
1953
1954   if ((child = gtk_bin_get_child (GTK_BIN (button))) &&
1955       gtk_widget_get_visible (child))
1956     {
1957       gint child_min, child_nat;
1958
1959       if (orientation == GTK_ORIENTATION_HORIZONTAL)
1960         gtk_widget_get_preferred_width (child, &child_min, &child_nat);
1961       else
1962         gtk_widget_get_preferred_height (child, &child_min, &child_nat);
1963
1964       minimum += child_min;
1965       natural += child_nat;
1966     }
1967
1968   if (minimum_size)
1969     *minimum_size = minimum;
1970
1971   if (natural_size)
1972     *natural_size = natural;
1973 }
1974
1975 static void
1976 gtk_button_get_preferred_width (GtkWidget *widget,
1977                                 gint      *minimum_size,
1978                                 gint      *natural_size)
1979 {
1980   gtk_button_get_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
1981 }
1982
1983 static void
1984 gtk_button_get_preferred_height (GtkWidget *widget,
1985                                  gint      *minimum_size,
1986                                  gint      *natural_size)
1987 {
1988   gtk_button_get_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
1989 }
1990
1991 /**
1992  * gtk_button_set_label:
1993  * @button: a #GtkButton
1994  * @label: a string
1995  *
1996  * Sets the text of the label of the button to @str. This text is
1997  * also used to select the stock item if gtk_button_set_use_stock()
1998  * is used.
1999  *
2000  * This will also clear any previously set labels.
2001  **/
2002 void
2003 gtk_button_set_label (GtkButton   *button,
2004                       const gchar *label)
2005 {
2006   GtkButtonPrivate *priv;
2007   gchar *new_label;
2008
2009   g_return_if_fail (GTK_IS_BUTTON (button));
2010
2011   priv = button->priv;
2012
2013   new_label = g_strdup (label);
2014   g_free (priv->label_text);
2015   priv->label_text = new_label;
2016
2017   gtk_button_construct_child (button);
2018
2019   g_object_notify (G_OBJECT (button), "label");
2020 }
2021
2022 /**
2023  * gtk_button_get_label:
2024  * @button: a #GtkButton
2025  *
2026  * Fetches the text from the label of the button, as set by
2027  * gtk_button_set_label(). If the label text has not
2028  * been set the return value will be %NULL. This will be the
2029  * case if you create an empty button with gtk_button_new() to
2030  * use as a container.
2031  *
2032  * Return value: The text of the label widget. This string is owned
2033  * by the widget and must not be modified or freed.
2034  **/
2035 const gchar *
2036 gtk_button_get_label (GtkButton *button)
2037 {
2038   g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2039
2040   return button->priv->label_text;
2041 }
2042
2043 /**
2044  * gtk_button_set_use_underline:
2045  * @button: a #GtkButton
2046  * @use_underline: %TRUE if underlines in the text indicate mnemonics
2047  *
2048  * If true, an underline in the text of the button label indicates
2049  * the next character should be used for the mnemonic accelerator key.
2050  */
2051 void
2052 gtk_button_set_use_underline (GtkButton *button,
2053                               gboolean   use_underline)
2054 {
2055   GtkButtonPrivate *priv;
2056
2057   g_return_if_fail (GTK_IS_BUTTON (button));
2058
2059   priv = button->priv;
2060
2061   use_underline = use_underline != FALSE;
2062
2063   if (use_underline != priv->use_underline)
2064     {
2065       priv->use_underline = use_underline;
2066
2067       gtk_button_construct_child (button);
2068
2069       g_object_notify (G_OBJECT (button), "use-underline");
2070     }
2071 }
2072
2073 /**
2074  * gtk_button_get_use_underline:
2075  * @button: a #GtkButton
2076  *
2077  * Returns whether an embedded underline in the button label indicates a
2078  * mnemonic. See gtk_button_set_use_underline ().
2079  *
2080  * Return value: %TRUE if an embedded underline in the button label
2081  *               indicates the mnemonic accelerator keys.
2082  **/
2083 gboolean
2084 gtk_button_get_use_underline (GtkButton *button)
2085 {
2086   g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2087
2088   return button->priv->use_underline;
2089 }
2090
2091 /**
2092  * gtk_button_set_use_stock:
2093  * @button: a #GtkButton
2094  * @use_stock: %TRUE if the button should use a stock item
2095  *
2096  * If %TRUE, the label set on the button is used as a
2097  * stock id to select the stock item for the button.
2098  */
2099 void
2100 gtk_button_set_use_stock (GtkButton *button,
2101                           gboolean   use_stock)
2102 {
2103   GtkButtonPrivate *priv;
2104
2105   g_return_if_fail (GTK_IS_BUTTON (button));
2106
2107   priv = button->priv;
2108
2109   use_stock = use_stock != FALSE;
2110
2111   if (use_stock != priv->use_stock)
2112     {
2113       priv->use_stock = use_stock;
2114
2115       gtk_button_construct_child (button);
2116
2117       g_object_notify (G_OBJECT (button), "use-stock");
2118     }
2119 }
2120
2121 /**
2122  * gtk_button_get_use_stock:
2123  * @button: a #GtkButton
2124  *
2125  * Returns whether the button label is a stock item.
2126  *
2127  * Return value: %TRUE if the button label is used to
2128  *               select a stock item instead of being
2129  *               used directly as the label text.
2130  */
2131 gboolean
2132 gtk_button_get_use_stock (GtkButton *button)
2133 {
2134   g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2135
2136   return button->priv->use_stock;
2137 }
2138
2139 /**
2140  * gtk_button_set_focus_on_click:
2141  * @button: a #GtkButton
2142  * @focus_on_click: whether the button grabs focus when clicked with the mouse
2143  *
2144  * Sets whether the button will grab focus when it is clicked with the mouse.
2145  * Making mouse clicks not grab focus is useful in places like toolbars where
2146  * you don't want the keyboard focus removed from the main area of the
2147  * application.
2148  *
2149  * Since: 2.4
2150  **/
2151 void
2152 gtk_button_set_focus_on_click (GtkButton *button,
2153                                gboolean   focus_on_click)
2154 {
2155   GtkButtonPrivate *priv;
2156
2157   g_return_if_fail (GTK_IS_BUTTON (button));
2158
2159   priv = button->priv;
2160
2161   focus_on_click = focus_on_click != FALSE;
2162
2163   if (priv->focus_on_click != focus_on_click)
2164     {
2165       priv->focus_on_click = focus_on_click;
2166
2167       g_object_notify (G_OBJECT (button), "focus-on-click");
2168     }
2169 }
2170
2171 /**
2172  * gtk_button_get_focus_on_click:
2173  * @button: a #GtkButton
2174  *
2175  * Returns whether the button grabs focus when it is clicked with the mouse.
2176  * See gtk_button_set_focus_on_click().
2177  *
2178  * Return value: %TRUE if the button grabs focus when it is clicked with
2179  *               the mouse.
2180  *
2181  * Since: 2.4
2182  **/
2183 gboolean
2184 gtk_button_get_focus_on_click (GtkButton *button)
2185 {
2186   g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2187
2188   return button->priv->focus_on_click;
2189 }
2190
2191 /**
2192  * gtk_button_set_alignment:
2193  * @button: a #GtkButton
2194  * @xalign: the horizontal position of the child, 0.0 is left aligned,
2195  *   1.0 is right aligned
2196  * @yalign: the vertical position of the child, 0.0 is top aligned,
2197  *   1.0 is bottom aligned
2198  *
2199  * Sets the alignment of the child. This property has no effect unless
2200  * the child is a #GtkMisc or a #GtkAlignment.
2201  *
2202  * Since: 2.4
2203  */
2204 void
2205 gtk_button_set_alignment (GtkButton *button,
2206                           gfloat     xalign,
2207                           gfloat     yalign)
2208 {
2209   GtkButtonPrivate *priv;
2210
2211   g_return_if_fail (GTK_IS_BUTTON (button));
2212
2213   priv = button->priv;
2214
2215   priv->xalign = xalign;
2216   priv->yalign = yalign;
2217   priv->align_set = 1;
2218
2219   maybe_set_alignment (button, gtk_bin_get_child (GTK_BIN (button)));
2220
2221   g_object_freeze_notify (G_OBJECT (button));
2222   g_object_notify (G_OBJECT (button), "xalign");
2223   g_object_notify (G_OBJECT (button), "yalign");
2224   g_object_thaw_notify (G_OBJECT (button));
2225 }
2226
2227 /**
2228  * gtk_button_get_alignment:
2229  * @button: a #GtkButton
2230  * @xalign: (out): return location for horizontal alignment
2231  * @yalign: (out): return location for vertical alignment
2232  *
2233  * Gets the alignment of the child in the button.
2234  *
2235  * Since: 2.4
2236  */
2237 void
2238 gtk_button_get_alignment (GtkButton *button,
2239                           gfloat    *xalign,
2240                           gfloat    *yalign)
2241 {
2242   GtkButtonPrivate *priv;
2243
2244   g_return_if_fail (GTK_IS_BUTTON (button));
2245
2246   priv = button->priv;
2247
2248   if (xalign)
2249     *xalign = priv->xalign;
2250
2251   if (yalign)
2252     *yalign = priv->yalign;
2253 }
2254
2255 /**
2256  * _gtk_button_set_depressed:
2257  * @button: a #GtkButton
2258  * @depressed: %TRUE if the button should be drawn with a recessed shadow.
2259  *
2260  * Sets whether the button is currently drawn as down or not. This is
2261  * purely a visual setting, and is meant only for use by derived widgets
2262  * such as #GtkToggleButton.
2263  **/
2264 void
2265 _gtk_button_set_depressed (GtkButton *button,
2266                            gboolean   depressed)
2267 {
2268   GtkWidget *widget = GTK_WIDGET (button);
2269   GtkButtonPrivate *priv = button->priv;
2270
2271   depressed = depressed != FALSE;
2272
2273   if (depressed != priv->depressed)
2274     {
2275       priv->depressed = depressed;
2276       gtk_widget_queue_resize (widget);
2277     }
2278 }
2279
2280 static void
2281 gtk_button_update_state (GtkButton *button)
2282 {
2283   GtkButtonPrivate *priv = button->priv;
2284   GtkStateFlags new_state;
2285   gboolean depressed;
2286
2287   if (priv->activate_timeout)
2288     depressed = priv->depress_on_activate;
2289   else
2290     depressed = priv->in_button && priv->button_down;
2291
2292   new_state = gtk_widget_get_state_flags (GTK_WIDGET (button)) &
2293     ~(GTK_STATE_FLAG_PRELIGHT | GTK_STATE_FLAG_ACTIVE);
2294
2295   if (priv->in_button)
2296     new_state |= GTK_STATE_FLAG_PRELIGHT;
2297
2298   if (priv->button_down || depressed)
2299     new_state |= GTK_STATE_FLAG_ACTIVE;
2300
2301   _gtk_button_set_depressed (button, depressed);
2302   gtk_widget_set_state_flags (GTK_WIDGET (button), new_state, TRUE);
2303 }
2304
2305 static void
2306 show_image_change_notify (GtkButton *button)
2307 {
2308   GtkButtonPrivate *priv = button->priv;
2309
2310   if (priv->image)
2311     {
2312       if (show_image (button))
2313         gtk_widget_show (priv->image);
2314       else
2315         gtk_widget_hide (priv->image);
2316     }
2317 }
2318
2319 static void
2320 traverse_container (GtkWidget *widget,
2321                     gpointer   data)
2322 {
2323   if (GTK_IS_BUTTON (widget))
2324     show_image_change_notify (GTK_BUTTON (widget));
2325   else if (GTK_IS_CONTAINER (widget))
2326     gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
2327 }
2328
2329 static void
2330 gtk_button_setting_changed (GtkSettings *settings)
2331 {
2332   GList *list, *l;
2333
2334   list = gtk_window_list_toplevels ();
2335
2336   for (l = list; l; l = l->next)
2337     gtk_container_forall (GTK_CONTAINER (l->data),
2338                           traverse_container, NULL);
2339
2340   g_list_free (list);
2341 }
2342
2343
2344 static void
2345 gtk_button_screen_changed (GtkWidget *widget,
2346                            GdkScreen *previous_screen)
2347 {
2348   GtkButton *button;
2349   GtkButtonPrivate *priv;
2350   GtkSettings *settings;
2351   gulong show_image_connection;
2352
2353   if (!gtk_widget_has_screen (widget))
2354     return;
2355
2356   button = GTK_BUTTON (widget);
2357   priv = button->priv;
2358
2359   /* If the button is being pressed while the screen changes the
2360     release might never occur, so we reset the state. */
2361   if (priv->button_down)
2362     {
2363       priv->button_down = FALSE;
2364       gtk_button_update_state (button);
2365     }
2366
2367   settings = gtk_widget_get_settings (widget);
2368
2369   show_image_connection =
2370     g_signal_handler_find (settings, G_SIGNAL_MATCH_FUNC, 0, 0,
2371                            NULL, gtk_button_setting_changed, NULL);
2372
2373   if (show_image_connection)
2374     return;
2375
2376   g_signal_connect (settings, "notify::gtk-button-images",
2377                     G_CALLBACK (gtk_button_setting_changed), NULL);
2378
2379   show_image_change_notify (button);
2380 }
2381
2382 static void
2383 gtk_button_state_changed (GtkWidget    *widget,
2384                           GtkStateType  previous_state)
2385 {
2386   GtkButton *button = GTK_BUTTON (widget);
2387   GtkButtonPrivate *priv = button->priv;
2388
2389   if (!gtk_widget_is_sensitive (widget))
2390     {
2391       priv->in_button = FALSE;
2392       gtk_real_button_released (button);
2393     }
2394 }
2395
2396 static void
2397 gtk_button_grab_notify (GtkWidget *widget,
2398                         gboolean   was_grabbed)
2399 {
2400   GtkButton *button = GTK_BUTTON (widget);
2401   GtkButtonPrivate *priv = button->priv;
2402   gboolean save_in;
2403
2404   if (priv->activate_timeout &&
2405       priv->grab_keyboard &&
2406       gtk_widget_device_is_shadowed (widget, priv->grab_keyboard))
2407     gtk_button_finish_activate (button, FALSE);
2408
2409   if (!was_grabbed)
2410     {
2411       save_in = priv->in_button;
2412       priv->in_button = FALSE;
2413       gtk_real_button_released (button);
2414       if (save_in != priv->in_button)
2415         {
2416           priv->in_button = save_in;
2417           gtk_button_update_state (button);
2418         }
2419     }
2420 }
2421
2422 /**
2423  * gtk_button_set_image:
2424  * @button: a #GtkButton
2425  * @image: a widget to set as the image for the button
2426  *
2427  * Set the image of @button to the given widget. Note that
2428  * it depends on the #GtkSettings:gtk-button-images setting whether the
2429  * image will be displayed or not, you don't have to call
2430  * gtk_widget_show() on @image yourself.
2431  *
2432  * Since: 2.6
2433  */
2434 void
2435 gtk_button_set_image (GtkButton *button,
2436                       GtkWidget *image)
2437 {
2438   GtkButtonPrivate *priv;
2439   GtkWidget *parent;
2440
2441   g_return_if_fail (GTK_IS_BUTTON (button));
2442   g_return_if_fail (image == NULL || GTK_IS_WIDGET (image));
2443
2444   priv = button->priv;
2445
2446   if (priv->image)
2447     {
2448       parent = gtk_widget_get_parent (priv->image);
2449       if (parent)
2450         gtk_container_remove (GTK_CONTAINER (parent), priv->image);
2451     }
2452
2453   priv->image = image;
2454   priv->image_is_stock = (image == NULL);
2455
2456   gtk_button_construct_child (button);
2457
2458   g_object_notify (G_OBJECT (button), "image");
2459 }
2460
2461 /**
2462  * gtk_button_get_image:
2463  * @button: a #GtkButton
2464  *
2465  * Gets the widget that is currenty set as the image of @button.
2466  * This may have been explicitly set by gtk_button_set_image()
2467  * or constructed by gtk_button_new_from_stock().
2468  *
2469  * Return value: (transfer none): a #GtkWidget or %NULL in case there is no image
2470  *
2471  * Since: 2.6
2472  */
2473 GtkWidget *
2474 gtk_button_get_image (GtkButton *button)
2475 {
2476   g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2477
2478   return button->priv->image;
2479 }
2480
2481 /**
2482  * gtk_button_set_image_position:
2483  * @button: a #GtkButton
2484  * @position: the position
2485  *
2486  * Sets the position of the image relative to the text
2487  * inside the button.
2488  *
2489  * Since: 2.10
2490  */
2491 void
2492 gtk_button_set_image_position (GtkButton       *button,
2493                                GtkPositionType  position)
2494 {
2495   GtkButtonPrivate *priv;
2496
2497   g_return_if_fail (GTK_IS_BUTTON (button));
2498   g_return_if_fail (position >= GTK_POS_LEFT && position <= GTK_POS_BOTTOM);
2499
2500   priv = button->priv;
2501
2502   if (priv->image_position != position)
2503     {
2504       priv->image_position = position;
2505
2506       gtk_button_construct_child (button);
2507
2508       g_object_notify (G_OBJECT (button), "image-position");
2509     }
2510 }
2511
2512 /**
2513  * gtk_button_get_image_position:
2514  * @button: a #GtkButton
2515  *
2516  * Gets the position of the image relative to the text
2517  * inside the button.
2518  *
2519  * Return value: the position
2520  *
2521  * Since: 2.10
2522  */
2523 GtkPositionType
2524 gtk_button_get_image_position (GtkButton *button)
2525 {
2526   g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_POS_LEFT);
2527
2528   return button->priv->image_position;
2529 }
2530
2531
2532 /**
2533  * gtk_button_get_event_window:
2534  * @button: a #GtkButton
2535  *
2536  * Returns the button's event window if it is realized, %NULL otherwise.
2537  * This function should be rarely needed.
2538  *
2539  * Return value: (transfer none): @button's event window.
2540  *
2541  * Since: 2.22
2542  */
2543 GdkWindow*
2544 gtk_button_get_event_window (GtkButton *button)
2545 {
2546   g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2547
2548   return button->priv->event_window;
2549 }