1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
29 * @Short_description: A widget that creates a signal when clicked on
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
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
43 #include "gtkbutton.h"
44 #include "gtkbuttonprivate.h"
47 #include "gtkalignment.h"
50 #include "gtkmarshalers.h"
55 #include "gtkiconfactory.h"
56 #include "gtkactivatable.h"
57 #include "gtksizerequest.h"
58 #include "gtkprivate.h"
62 static const GtkBorder default_default_border = { 1, 1, 1, 1 };
63 static const GtkBorder default_default_outside_border = { 0, 0, 0, 0 };
64 static const GtkBorder default_inner_border = { 1, 1, 1, 1 };
66 /* Time out before giving up on getting a key release when animating
69 #define ACTIVATE_TIMEOUT 250
94 /* activatable properties */
95 PROP_ACTIVATABLE_RELATED_ACTION,
96 PROP_ACTIVATABLE_USE_ACTION_APPEARANCE
100 static void gtk_button_destroy (GtkWidget *widget);
101 static void gtk_button_dispose (GObject *object);
102 static void gtk_button_set_property (GObject *object,
106 static void gtk_button_get_property (GObject *object,
110 static void gtk_button_screen_changed (GtkWidget *widget,
111 GdkScreen *previous_screen);
112 static void gtk_button_realize (GtkWidget * widget);
113 static void gtk_button_unrealize (GtkWidget * widget);
114 static void gtk_button_map (GtkWidget * widget);
115 static void gtk_button_unmap (GtkWidget * widget);
116 static void gtk_button_style_updated (GtkWidget * widget);
117 static void gtk_button_size_allocate (GtkWidget * widget,
118 GtkAllocation * allocation);
119 static gint gtk_button_draw (GtkWidget * widget, cairo_t *cr);
120 static gint gtk_button_button_press (GtkWidget * widget,
121 GdkEventButton * event);
122 static gint gtk_button_button_release (GtkWidget * widget,
123 GdkEventButton * event);
124 static gint gtk_button_grab_broken (GtkWidget * widget,
125 GdkEventGrabBroken * event);
126 static gint gtk_button_key_release (GtkWidget * widget, GdkEventKey * event);
127 static gint gtk_button_enter_notify (GtkWidget * widget,
128 GdkEventCrossing * event);
129 static gint gtk_button_leave_notify (GtkWidget * widget,
130 GdkEventCrossing * event);
131 static void gtk_real_button_pressed (GtkButton * button);
132 static void gtk_real_button_released (GtkButton * button);
133 static void gtk_real_button_clicked (GtkButton * button);
134 static void gtk_real_button_activate (GtkButton *button);
135 static void gtk_button_update_state (GtkButton *button);
136 static void gtk_button_add (GtkContainer *container,
138 static GType gtk_button_child_type (GtkContainer *container);
139 static void gtk_button_finish_activate (GtkButton *button,
142 static GObject* gtk_button_constructor (GType type,
143 guint n_construct_properties,
144 GObjectConstructParam *construct_params);
145 static void gtk_button_construct_child (GtkButton *button);
146 static void gtk_button_state_changed (GtkWidget *widget,
147 GtkStateType previous_state);
148 static void gtk_button_grab_notify (GtkWidget *widget,
149 gboolean was_grabbed);
152 static void gtk_button_activatable_interface_init(GtkActivatableIface *iface);
153 static void gtk_button_update (GtkActivatable *activatable,
155 const gchar *property_name);
156 static void gtk_button_sync_action_properties (GtkActivatable *activatable,
158 static void gtk_button_set_related_action (GtkButton *button,
160 static void gtk_button_set_use_action_appearance (GtkButton *button,
161 gboolean use_appearance);
163 static void gtk_button_get_preferred_width (GtkWidget *widget,
166 static void gtk_button_get_preferred_height (GtkWidget *widget,
170 static guint button_signals[LAST_SIGNAL] = { 0 };
172 G_DEFINE_TYPE_WITH_CODE (GtkButton, gtk_button, GTK_TYPE_BIN,
173 G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
174 gtk_button_activatable_interface_init))
177 gtk_button_class_init (GtkButtonClass *klass)
179 GObjectClass *gobject_class;
180 GtkWidgetClass *widget_class;
181 GtkContainerClass *container_class;
183 gobject_class = G_OBJECT_CLASS (klass);
184 widget_class = (GtkWidgetClass*) klass;
185 container_class = (GtkContainerClass*) klass;
187 gobject_class->constructor = gtk_button_constructor;
188 gobject_class->dispose = gtk_button_dispose;
189 gobject_class->set_property = gtk_button_set_property;
190 gobject_class->get_property = gtk_button_get_property;
192 widget_class->get_preferred_width = gtk_button_get_preferred_width;
193 widget_class->get_preferred_height = gtk_button_get_preferred_height;
194 widget_class->destroy = gtk_button_destroy;
195 widget_class->screen_changed = gtk_button_screen_changed;
196 widget_class->realize = gtk_button_realize;
197 widget_class->unrealize = gtk_button_unrealize;
198 widget_class->map = gtk_button_map;
199 widget_class->unmap = gtk_button_unmap;
200 widget_class->style_updated = gtk_button_style_updated;
201 widget_class->size_allocate = gtk_button_size_allocate;
202 widget_class->draw = gtk_button_draw;
203 widget_class->button_press_event = gtk_button_button_press;
204 widget_class->button_release_event = gtk_button_button_release;
205 widget_class->grab_broken_event = gtk_button_grab_broken;
206 widget_class->key_release_event = gtk_button_key_release;
207 widget_class->enter_notify_event = gtk_button_enter_notify;
208 widget_class->leave_notify_event = gtk_button_leave_notify;
209 widget_class->state_changed = gtk_button_state_changed;
210 widget_class->grab_notify = gtk_button_grab_notify;
212 container_class->child_type = gtk_button_child_type;
213 container_class->add = gtk_button_add;
214 gtk_container_class_handle_border_width (container_class);
216 klass->pressed = gtk_real_button_pressed;
217 klass->released = gtk_real_button_released;
218 klass->clicked = NULL;
219 klass->enter = gtk_button_update_state;
220 klass->leave = gtk_button_update_state;
221 klass->activate = gtk_real_button_activate;
223 g_object_class_install_property (gobject_class,
225 g_param_spec_string ("label",
227 P_("Text of the label widget inside the button, if the button contains a label widget"),
229 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
231 g_object_class_install_property (gobject_class,
233 g_param_spec_boolean ("use-underline",
235 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
237 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
239 g_object_class_install_property (gobject_class,
241 g_param_spec_boolean ("use-stock",
243 P_("If set, the label is used to pick a stock item instead of being displayed"),
245 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
247 g_object_class_install_property (gobject_class,
249 g_param_spec_boolean ("focus-on-click",
250 P_("Focus on click"),
251 P_("Whether the button grabs focus when it is clicked with the mouse"),
253 GTK_PARAM_READWRITE));
255 g_object_class_install_property (gobject_class,
257 g_param_spec_enum ("relief",
259 P_("The border relief style"),
260 GTK_TYPE_RELIEF_STYLE,
262 GTK_PARAM_READWRITE));
267 * If the child of the button is a #GtkMisc or #GtkAlignment, this property
268 * can be used to control it's horizontal alignment. 0.0 is left aligned,
269 * 1.0 is right aligned.
273 g_object_class_install_property (gobject_class,
275 g_param_spec_float("xalign",
276 P_("Horizontal alignment for child"),
277 P_("Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned"),
281 GTK_PARAM_READWRITE));
286 * If the child of the button is a #GtkMisc or #GtkAlignment, this property
287 * can be used to control it's vertical alignment. 0.0 is top aligned,
288 * 1.0 is bottom aligned.
292 g_object_class_install_property (gobject_class,
294 g_param_spec_float("yalign",
295 P_("Vertical alignment for child"),
296 P_("Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned"),
300 GTK_PARAM_READWRITE));
305 * The child widget to appear next to the button text.
309 g_object_class_install_property (gobject_class,
311 g_param_spec_object ("image",
313 P_("Child widget to appear next to the button text"),
315 GTK_PARAM_READWRITE));
318 * GtkButton:image-position:
320 * The position of the image relative to the text inside the button.
324 g_object_class_install_property (gobject_class,
326 g_param_spec_enum ("image-position",
327 P_("Image position"),
328 P_("The position of the image relative to the text"),
329 GTK_TYPE_POSITION_TYPE,
331 GTK_PARAM_READWRITE));
333 g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_RELATED_ACTION, "related-action");
334 g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_USE_ACTION_APPEARANCE, "use-action-appearance");
337 * GtkButton::pressed:
338 * @button: the object that received the signal
340 * Emitted when the button is pressed.
342 * Deprecated: 2.8: Use the #GtkWidget::button-press-event signal.
344 button_signals[PRESSED] =
345 g_signal_new (I_("pressed"),
346 G_OBJECT_CLASS_TYPE (gobject_class),
348 G_STRUCT_OFFSET (GtkButtonClass, pressed),
350 _gtk_marshal_VOID__VOID,
354 * GtkButton::released:
355 * @button: the object that received the signal
357 * Emitted when the button is released.
359 * Deprecated: 2.8: Use the #GtkWidget::button-release-event signal.
361 button_signals[RELEASED] =
362 g_signal_new (I_("released"),
363 G_OBJECT_CLASS_TYPE (gobject_class),
365 G_STRUCT_OFFSET (GtkButtonClass, released),
367 _gtk_marshal_VOID__VOID,
371 * GtkButton::clicked:
372 * @button: the object that received the signal
374 * Emitted when the button has been activated (pressed and released).
376 button_signals[CLICKED] =
377 g_signal_new (I_("clicked"),
378 G_OBJECT_CLASS_TYPE (gobject_class),
379 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
380 G_STRUCT_OFFSET (GtkButtonClass, clicked),
382 _gtk_marshal_VOID__VOID,
387 * @button: the object that received the signal
389 * Emitted when the pointer enters the button.
391 * Deprecated: 2.8: Use the #GtkWidget::enter-notify-event signal.
393 button_signals[ENTER] =
394 g_signal_new (I_("enter"),
395 G_OBJECT_CLASS_TYPE (gobject_class),
397 G_STRUCT_OFFSET (GtkButtonClass, enter),
399 _gtk_marshal_VOID__VOID,
404 * @button: the object that received the signal
406 * Emitted when the pointer leaves the button.
408 * Deprecated: 2.8: Use the #GtkWidget::leave-notify-event signal.
410 button_signals[LEAVE] =
411 g_signal_new (I_("leave"),
412 G_OBJECT_CLASS_TYPE (gobject_class),
414 G_STRUCT_OFFSET (GtkButtonClass, leave),
416 _gtk_marshal_VOID__VOID,
420 * GtkButton::activate:
421 * @widget: the object which received the signal.
423 * The ::activate signal on GtkButton is an action signal and
424 * emitting it causes the button to animate press then release.
425 * Applications should never connect to this signal, but use the
426 * #GtkButton::clicked signal.
428 button_signals[ACTIVATE] =
429 g_signal_new (I_("activate"),
430 G_OBJECT_CLASS_TYPE (gobject_class),
431 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
432 G_STRUCT_OFFSET (GtkButtonClass, activate),
434 _gtk_marshal_VOID__VOID,
436 widget_class->activate_signal = button_signals[ACTIVATE];
439 * GtkButton:default-border:
441 * The "default-border" style property defines the extra space to add
442 * around a button that can become the default widget of its window.
443 * For more information about default widgets, see gtk_widget_grab_default().
446 gtk_widget_class_install_style_property (widget_class,
447 g_param_spec_boxed ("default-border",
448 P_("Default Spacing"),
449 P_("Extra space to add for GTK_CAN_DEFAULT buttons"),
451 GTK_PARAM_READABLE));
454 * GtkButton:default-outside-border:
456 * The "default-outside-border" style property defines the extra outside
457 * space to add around a button that can become the default widget of its
458 * window. Extra outside space is always drawn outside the button border.
459 * For more information about default widgets, see gtk_widget_grab_default().
461 gtk_widget_class_install_style_property (widget_class,
462 g_param_spec_boxed ("default-outside-border",
463 P_("Default Outside Spacing"),
464 P_("Extra space to add for GTK_CAN_DEFAULT buttons that is always drawn outside the border"),
466 GTK_PARAM_READABLE));
467 gtk_widget_class_install_style_property (widget_class,
468 g_param_spec_int ("child-displacement-x",
469 P_("Child X Displacement"),
470 P_("How far in the x direction to move the child when the button is depressed"),
474 GTK_PARAM_READABLE));
475 gtk_widget_class_install_style_property (widget_class,
476 g_param_spec_int ("child-displacement-y",
477 P_("Child Y Displacement"),
478 P_("How far in the y direction to move the child when the button is depressed"),
482 GTK_PARAM_READABLE));
485 * GtkButton:displace-focus:
487 * Whether the child_displacement_x/child_displacement_y properties
488 * should also affect the focus rectangle.
492 gtk_widget_class_install_style_property (widget_class,
493 g_param_spec_boolean ("displace-focus",
494 P_("Displace focus"),
495 P_("Whether the child_displacement_x/_y properties should also affect the focus rectangle"),
497 GTK_PARAM_READABLE));
500 * GtkButton:inner-border:
502 * Sets the border between the button edges and child.
506 gtk_widget_class_install_style_property (widget_class,
507 g_param_spec_boxed ("inner-border",
509 P_("Border between button edges and child."),
511 GTK_PARAM_READABLE));
514 * GtkButton::image-spacing:
516 * Spacing in pixels between the image and label.
520 gtk_widget_class_install_style_property (widget_class,
521 g_param_spec_int ("image-spacing",
523 P_("Spacing in pixels between the image and label"),
527 GTK_PARAM_READABLE));
529 g_type_class_add_private (gobject_class, sizeof (GtkButtonPrivate));
533 gtk_button_init (GtkButton *button)
535 GtkButtonPrivate *priv;
536 GtkStyleContext *context;
538 button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
543 gtk_widget_set_can_focus (GTK_WIDGET (button), TRUE);
544 gtk_widget_set_receives_default (GTK_WIDGET (button), TRUE);
545 gtk_widget_set_has_window (GTK_WIDGET (button), FALSE);
547 priv->label_text = NULL;
549 priv->constructed = FALSE;
550 priv->in_button = FALSE;
551 priv->button_down = FALSE;
552 priv->relief = GTK_RELIEF_NORMAL;
553 priv->use_stock = FALSE;
554 priv->use_underline = FALSE;
555 priv->depressed = FALSE;
556 priv->depress_on_activate = TRUE;
557 priv->focus_on_click = TRUE;
562 priv->image_is_stock = TRUE;
563 priv->image_position = GTK_POS_LEFT;
564 priv->use_action_appearance = TRUE;
566 context = gtk_widget_get_style_context (GTK_WIDGET (button));
567 gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
571 gtk_button_destroy (GtkWidget *widget)
573 GtkButton *button = GTK_BUTTON (widget);
574 GtkButtonPrivate *priv = button->priv;
576 if (priv->label_text)
578 g_free (priv->label_text);
579 priv->label_text = NULL;
582 GTK_WIDGET_CLASS (gtk_button_parent_class)->destroy (widget);
586 gtk_button_constructor (GType type,
587 guint n_construct_properties,
588 GObjectConstructParam *construct_params)
592 GtkButtonPrivate *priv;
594 object = G_OBJECT_CLASS (gtk_button_parent_class)->constructor (type,
595 n_construct_properties,
598 button = GTK_BUTTON (object);
601 priv->constructed = TRUE;
603 if (priv->label_text != NULL)
604 gtk_button_construct_child (button);
611 gtk_button_child_type (GtkContainer *container)
613 if (!gtk_bin_get_child (GTK_BIN (container)))
614 return GTK_TYPE_WIDGET;
620 maybe_set_alignment (GtkButton *button,
623 GtkButtonPrivate *priv = button->priv;
625 if (GTK_IS_MISC (widget))
627 GtkMisc *misc = GTK_MISC (widget);
630 gtk_misc_set_alignment (misc, priv->xalign, priv->yalign);
632 else if (GTK_IS_ALIGNMENT (widget))
634 GtkAlignment *alignment = GTK_ALIGNMENT (widget);
635 gfloat xscale, yscale;
637 g_object_get (alignment,
643 gtk_alignment_set (alignment,
644 priv->xalign, priv->yalign,
650 gtk_button_add (GtkContainer *container,
653 maybe_set_alignment (GTK_BUTTON (container), widget);
655 GTK_CONTAINER_CLASS (gtk_button_parent_class)->add (container, widget);
659 gtk_button_dispose (GObject *object)
661 GtkButton *button = GTK_BUTTON (object);
662 GtkButtonPrivate *priv = button->priv;
666 gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (button), NULL);
669 G_OBJECT_CLASS (gtk_button_parent_class)->dispose (object);
673 gtk_button_set_property (GObject *object,
678 GtkButton *button = GTK_BUTTON (object);
679 GtkButtonPrivate *priv = button->priv;
684 gtk_button_set_label (button, g_value_get_string (value));
687 gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
690 gtk_button_set_relief (button, g_value_get_enum (value));
692 case PROP_USE_UNDERLINE:
693 gtk_button_set_use_underline (button, g_value_get_boolean (value));
696 gtk_button_set_use_stock (button, g_value_get_boolean (value));
698 case PROP_FOCUS_ON_CLICK:
699 gtk_button_set_focus_on_click (button, g_value_get_boolean (value));
702 gtk_button_set_alignment (button, g_value_get_float (value), priv->yalign);
705 gtk_button_set_alignment (button, priv->xalign, g_value_get_float (value));
707 case PROP_IMAGE_POSITION:
708 gtk_button_set_image_position (button, g_value_get_enum (value));
710 case PROP_ACTIVATABLE_RELATED_ACTION:
711 gtk_button_set_related_action (button, g_value_get_object (value));
713 case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
714 gtk_button_set_use_action_appearance (button, g_value_get_boolean (value));
717 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
723 gtk_button_get_property (GObject *object,
728 GtkButton *button = GTK_BUTTON (object);
729 GtkButtonPrivate *priv = button->priv;
734 g_value_set_string (value, priv->label_text);
737 g_value_set_object (value, (GObject *)priv->image);
740 g_value_set_enum (value, priv->relief);
742 case PROP_USE_UNDERLINE:
743 g_value_set_boolean (value, priv->use_underline);
746 g_value_set_boolean (value, priv->use_stock);
748 case PROP_FOCUS_ON_CLICK:
749 g_value_set_boolean (value, priv->focus_on_click);
752 g_value_set_float (value, priv->xalign);
755 g_value_set_float (value, priv->yalign);
757 case PROP_IMAGE_POSITION:
758 g_value_set_enum (value, priv->image_position);
760 case PROP_ACTIVATABLE_RELATED_ACTION:
761 g_value_set_object (value, priv->action);
763 case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
764 g_value_set_boolean (value, priv->use_action_appearance);
767 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
773 gtk_button_activatable_interface_init (GtkActivatableIface *iface)
775 iface->update = gtk_button_update;
776 iface->sync_action_properties = gtk_button_sync_action_properties;
780 activatable_update_stock_id (GtkButton *button,
783 if (!gtk_button_get_use_stock (button))
786 gtk_button_set_label (button, gtk_action_get_stock_id (action));
790 activatable_update_short_label (GtkButton *button,
796 if (gtk_button_get_use_stock (button))
799 image = gtk_button_get_image (button);
801 /* Dont touch custom child... */
802 child = gtk_bin_get_child (GTK_BIN (button));
803 if (GTK_IS_IMAGE (image) ||
805 GTK_IS_LABEL (child))
807 gtk_button_set_label (button, gtk_action_get_short_label (action));
808 gtk_button_set_use_underline (button, TRUE);
813 activatable_update_icon_name (GtkButton *button,
818 if (gtk_button_get_use_stock (button))
821 image = gtk_button_get_image (button);
823 if (GTK_IS_IMAGE (image) &&
824 (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
825 gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_ICON_NAME))
826 gtk_image_set_from_icon_name (GTK_IMAGE (image),
827 gtk_action_get_icon_name (action), GTK_ICON_SIZE_MENU);
831 activatable_update_gicon (GtkButton *button,
834 GtkWidget *image = gtk_button_get_image (button);
835 GIcon *icon = gtk_action_get_gicon (action);
837 if (GTK_IS_IMAGE (image) &&
838 (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
839 gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_GICON))
840 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, GTK_ICON_SIZE_BUTTON);
844 gtk_button_update (GtkActivatable *activatable,
846 const gchar *property_name)
848 GtkButton *button = GTK_BUTTON (activatable);
849 GtkButtonPrivate *priv = button->priv;
851 if (strcmp (property_name, "visible") == 0)
853 if (gtk_action_is_visible (action))
854 gtk_widget_show (GTK_WIDGET (activatable));
856 gtk_widget_hide (GTK_WIDGET (activatable));
858 else if (strcmp (property_name, "sensitive") == 0)
859 gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));
861 if (!priv->use_action_appearance)
864 if (strcmp (property_name, "stock-id") == 0)
865 activatable_update_stock_id (GTK_BUTTON (activatable), action);
866 else if (strcmp (property_name, "gicon") == 0)
867 activatable_update_gicon (GTK_BUTTON (activatable), action);
868 else if (strcmp (property_name, "short-label") == 0)
869 activatable_update_short_label (GTK_BUTTON (activatable), action);
870 else if (strcmp (property_name, "icon-name") == 0)
871 activatable_update_icon_name (GTK_BUTTON (activatable), action);
875 gtk_button_sync_action_properties (GtkActivatable *activatable,
878 GtkButton *button = GTK_BUTTON (activatable);
879 GtkButtonPrivate *priv = button->priv;
884 if (gtk_action_is_visible (action))
885 gtk_widget_show (GTK_WIDGET (activatable));
887 gtk_widget_hide (GTK_WIDGET (activatable));
889 gtk_widget_set_sensitive (GTK_WIDGET (activatable), gtk_action_is_sensitive (action));
891 if (priv->use_action_appearance)
893 activatable_update_stock_id (GTK_BUTTON (activatable), action);
894 activatable_update_short_label (GTK_BUTTON (activatable), action);
895 activatable_update_gicon (GTK_BUTTON (activatable), action);
896 activatable_update_icon_name (GTK_BUTTON (activatable), action);
901 gtk_button_set_related_action (GtkButton *button,
904 GtkButtonPrivate *priv = button->priv;
906 if (priv->action == action)
909 /* This should be a default handler, but for compatibility reasons
910 * we need to support derived classes that don't chain up their
913 g_signal_handlers_disconnect_by_func (button, gtk_real_button_clicked, NULL);
915 g_signal_connect_after (button, "clicked",
916 G_CALLBACK (gtk_real_button_clicked), NULL);
918 gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (button), action);
920 priv->action = action;
924 gtk_button_set_use_action_appearance (GtkButton *button,
925 gboolean use_appearance)
927 GtkButtonPrivate *priv = button->priv;
929 if (priv->use_action_appearance != use_appearance)
931 priv->use_action_appearance = use_appearance;
933 gtk_activatable_sync_action_properties (GTK_ACTIVATABLE (button), priv->action);
940 * Creates a new #GtkButton widget. To add a child widget to the button,
941 * use gtk_container_add().
943 * Returns: The newly created #GtkButton widget.
946 gtk_button_new (void)
948 return g_object_new (GTK_TYPE_BUTTON, NULL);
952 show_image (GtkButton *button)
954 GtkButtonPrivate *priv = button->priv;
957 if (priv->label_text)
959 GtkSettings *settings;
961 settings = gtk_widget_get_settings (GTK_WIDGET (button));
962 g_object_get (settings, "gtk-button-images", &show, NULL);
971 gtk_button_construct_child (GtkButton *button)
973 GtkButtonPrivate *priv = button->priv;
979 GtkWidget *image = NULL;
980 gchar *label_text = NULL;
983 if (!priv->constructed)
986 if (!priv->label_text && !priv->image)
989 gtk_widget_style_get (GTK_WIDGET (button),
990 "image-spacing", &image_spacing,
993 if (priv->image && !priv->image_is_stock)
997 image = g_object_ref (priv->image);
999 parent = gtk_widget_get_parent (image);
1001 gtk_container_remove (GTK_CONTAINER (parent), image);
1006 child = gtk_bin_get_child (GTK_BIN (button));
1008 gtk_container_remove (GTK_CONTAINER (button), child);
1010 if (priv->use_stock &&
1012 gtk_stock_lookup (priv->label_text, &item))
1015 image = g_object_ref (gtk_image_new_from_stock (priv->label_text, GTK_ICON_SIZE_BUTTON));
1017 label_text = item.label;
1020 label_text = priv->label_text;
1024 priv->image = image;
1025 g_object_set (priv->image,
1026 "visible", show_image (button),
1027 "no-show-all", TRUE,
1030 if (priv->image_position == GTK_POS_LEFT ||
1031 priv->image_position == GTK_POS_RIGHT)
1032 box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, image_spacing);
1034 box = gtk_box_new (GTK_ORIENTATION_VERTICAL, image_spacing);
1036 if (priv->align_set)
1037 align = gtk_alignment_new (priv->xalign, priv->yalign, 0.0, 0.0);
1039 align = gtk_alignment_new (0.5, 0.5, 0.0, 0.0);
1041 if (priv->image_position == GTK_POS_LEFT ||
1042 priv->image_position == GTK_POS_TOP)
1043 gtk_box_pack_start (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
1045 gtk_box_pack_end (GTK_BOX (box), priv->image, FALSE, FALSE, 0);
1049 if (priv->use_underline || priv->use_stock)
1051 label = gtk_label_new_with_mnemonic (label_text);
1052 gtk_label_set_mnemonic_widget (GTK_LABEL (label),
1053 GTK_WIDGET (button));
1056 label = gtk_label_new (label_text);
1058 if (priv->image_position == GTK_POS_RIGHT ||
1059 priv->image_position == GTK_POS_BOTTOM)
1060 gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
1062 gtk_box_pack_end (GTK_BOX (box), label, FALSE, FALSE, 0);
1065 gtk_container_add (GTK_CONTAINER (button), align);
1066 gtk_container_add (GTK_CONTAINER (align), box);
1067 gtk_widget_show_all (align);
1069 g_object_unref (image);
1074 if (priv->use_underline || priv->use_stock)
1076 label = gtk_label_new_with_mnemonic (priv->label_text);
1077 gtk_label_set_mnemonic_widget (GTK_LABEL (label), GTK_WIDGET (button));
1080 label = gtk_label_new (priv->label_text);
1082 if (priv->align_set)
1083 gtk_misc_set_alignment (GTK_MISC (label), priv->xalign, priv->yalign);
1085 gtk_widget_show (label);
1086 gtk_container_add (GTK_CONTAINER (button), label);
1091 * gtk_button_new_with_label:
1092 * @label: The text you want the #GtkLabel to hold.
1094 * Creates a #GtkButton widget with a #GtkLabel child containing the given
1097 * Returns: The newly created #GtkButton widget.
1100 gtk_button_new_with_label (const gchar *label)
1102 return g_object_new (GTK_TYPE_BUTTON, "label", label, NULL);
1106 * gtk_button_new_from_stock:
1107 * @stock_id: the name of the stock item
1109 * Creates a new #GtkButton containing the image and text from a stock item.
1110 * Some stock ids have preprocessor macros like #GTK_STOCK_OK and
1113 * If @stock_id is unknown, then it will be treated as a mnemonic
1114 * label (as for gtk_button_new_with_mnemonic()).
1116 * Returns: a new #GtkButton
1119 gtk_button_new_from_stock (const gchar *stock_id)
1121 return g_object_new (GTK_TYPE_BUTTON,
1124 "use-underline", TRUE,
1129 * gtk_button_new_with_mnemonic:
1130 * @label: The text of the button, with an underscore in front of the
1131 * mnemonic character
1132 * @returns: a new #GtkButton
1134 * Creates a new #GtkButton containing a label.
1135 * If characters in @label are preceded by an underscore, they are underlined.
1136 * If you need a literal underscore character in a label, use '__' (two
1137 * underscores). The first underlined character represents a keyboard
1138 * accelerator called a mnemonic.
1139 * Pressing Alt and that key activates the button.
1142 gtk_button_new_with_mnemonic (const gchar *label)
1144 return g_object_new (GTK_TYPE_BUTTON, "label", label, "use-underline", TRUE, NULL);
1148 * gtk_button_pressed:
1149 * @button: The #GtkButton you want to send the signal to.
1151 * Emits a #GtkButton::pressed signal to the given #GtkButton.
1153 * Deprecated: 2.20: Use the #GtkWidget::button-press-event signal.
1156 gtk_button_pressed (GtkButton *button)
1158 g_return_if_fail (GTK_IS_BUTTON (button));
1160 g_signal_emit (button, button_signals[PRESSED], 0);
1164 * gtk_button_released:
1165 * @button: The #GtkButton you want to send the signal to.
1167 * Emits a #GtkButton::released signal to the given #GtkButton.
1169 * Deprecated: 2.20: Use the #GtkWidget::button-release-event signal.
1172 gtk_button_released (GtkButton *button)
1174 g_return_if_fail (GTK_IS_BUTTON (button));
1176 g_signal_emit (button, button_signals[RELEASED], 0);
1180 * gtk_button_clicked:
1181 * @button: The #GtkButton you want to send the signal to.
1183 * Emits a #GtkButton::clicked signal to the given #GtkButton.
1186 gtk_button_clicked (GtkButton *button)
1188 g_return_if_fail (GTK_IS_BUTTON (button));
1190 g_signal_emit (button, button_signals[CLICKED], 0);
1195 * @button: The #GtkButton you want to send the signal to.
1197 * Emits a #GtkButton::enter signal to the given #GtkButton.
1199 * Deprecated: 2.20: Use the #GtkWidget::enter-notify-event signal.
1202 gtk_button_enter (GtkButton *button)
1204 g_return_if_fail (GTK_IS_BUTTON (button));
1206 g_signal_emit (button, button_signals[ENTER], 0);
1211 * @button: The #GtkButton you want to send the signal to.
1213 * Emits a #GtkButton::leave signal to the given #GtkButton.
1215 * Deprecated: 2.20: Use the #GtkWidget::leave-notify-event signal.
1218 gtk_button_leave (GtkButton *button)
1220 g_return_if_fail (GTK_IS_BUTTON (button));
1222 g_signal_emit (button, button_signals[LEAVE], 0);
1226 * gtk_button_set_relief:
1227 * @button: The #GtkButton you want to set relief styles of.
1228 * @newstyle: The GtkReliefStyle as described above.
1230 * Sets the relief style of the edges of the given #GtkButton widget.
1231 * Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
1232 * The default style is, as one can guess, GTK_RELIEF_NORMAL.
1234 * <!-- FIXME: put pictures of each style -->
1237 gtk_button_set_relief (GtkButton *button,
1238 GtkReliefStyle newrelief)
1240 GtkButtonPrivate *priv;
1242 g_return_if_fail (GTK_IS_BUTTON (button));
1244 priv = button->priv;
1246 if (newrelief != priv->relief)
1248 priv->relief = newrelief;
1249 g_object_notify (G_OBJECT (button), "relief");
1250 gtk_widget_queue_draw (GTK_WIDGET (button));
1255 * gtk_button_get_relief:
1256 * @button: The #GtkButton you want the #GtkReliefStyle from.
1258 * Returns the current relief style of the given #GtkButton.
1260 * Returns: The current #GtkReliefStyle
1263 gtk_button_get_relief (GtkButton *button)
1265 g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_RELIEF_NORMAL);
1267 return button->priv->relief;
1271 gtk_button_realize (GtkWidget *widget)
1273 GtkButton *button = GTK_BUTTON (widget);
1274 GtkButtonPrivate *priv = button->priv;
1275 GtkAllocation allocation;
1277 GdkWindowAttr attributes;
1278 gint attributes_mask;
1280 gtk_widget_get_allocation (widget, &allocation);
1282 gtk_widget_set_realized (widget, TRUE);
1284 attributes.window_type = GDK_WINDOW_CHILD;
1285 attributes.x = allocation.x;
1286 attributes.y = allocation.y;
1287 attributes.width = allocation.width;
1288 attributes.height = allocation.height;
1289 attributes.wclass = GDK_INPUT_ONLY;
1290 attributes.event_mask = gtk_widget_get_events (widget);
1291 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
1292 GDK_BUTTON_RELEASE_MASK |
1293 GDK_ENTER_NOTIFY_MASK |
1294 GDK_LEAVE_NOTIFY_MASK);
1296 attributes_mask = GDK_WA_X | GDK_WA_Y;
1298 window = gtk_widget_get_parent_window (widget);
1299 gtk_widget_set_window (widget, window);
1300 g_object_ref (window);
1302 priv->event_window = gdk_window_new (window,
1303 &attributes, attributes_mask);
1304 gdk_window_set_user_data (priv->event_window, button);
1306 gtk_widget_style_attach (widget);
1310 gtk_button_unrealize (GtkWidget *widget)
1312 GtkButton *button = GTK_BUTTON (widget);
1313 GtkButtonPrivate *priv = button->priv;
1315 if (priv->activate_timeout)
1316 gtk_button_finish_activate (button, FALSE);
1318 if (priv->event_window)
1320 gdk_window_set_user_data (priv->event_window, NULL);
1321 gdk_window_destroy (priv->event_window);
1322 priv->event_window = NULL;
1325 GTK_WIDGET_CLASS (gtk_button_parent_class)->unrealize (widget);
1329 gtk_button_map (GtkWidget *widget)
1331 GtkButton *button = GTK_BUTTON (widget);
1332 GtkButtonPrivate *priv = button->priv;
1334 GTK_WIDGET_CLASS (gtk_button_parent_class)->map (widget);
1336 if (priv->event_window)
1337 gdk_window_show (priv->event_window);
1341 gtk_button_unmap (GtkWidget *widget)
1343 GtkButton *button = GTK_BUTTON (widget);
1344 GtkButtonPrivate *priv = button->priv;
1346 if (priv->event_window)
1347 gdk_window_hide (priv->event_window);
1349 GTK_WIDGET_CLASS (gtk_button_parent_class)->unmap (widget);
1353 gtk_button_update_image_spacing (GtkButton *button)
1355 GtkButtonPrivate *priv = button->priv;
1359 /* Keep in sync with gtk_button_construct_child,
1360 * we only want to update the spacing if the box
1361 * was constructed there.
1363 if (!priv->constructed || !priv->image)
1366 child = gtk_bin_get_child (GTK_BIN (button));
1367 if (GTK_IS_ALIGNMENT (child))
1369 child = gtk_bin_get_child (GTK_BIN (child));
1370 if (GTK_IS_BOX (child))
1372 gtk_widget_style_get (GTK_WIDGET (button),
1373 "image-spacing", &spacing,
1376 gtk_box_set_spacing (GTK_BOX (child), spacing);
1382 gtk_button_style_updated (GtkWidget *widget)
1384 gtk_button_update_image_spacing (GTK_BUTTON (widget));
1388 gtk_button_get_props (GtkButton *button,
1389 GtkBorder *default_border,
1390 GtkBorder *default_outside_border,
1391 GtkBorder *inner_border,
1392 gboolean *interior_focus)
1394 GtkWidget *widget = GTK_WIDGET (button);
1395 GtkBorder *tmp_border;
1399 gtk_widget_style_get (widget, "default-border", &tmp_border, NULL);
1403 *default_border = *tmp_border;
1404 gtk_border_free (tmp_border);
1407 *default_border = default_default_border;
1410 if (default_outside_border)
1412 gtk_widget_style_get (widget, "default-outside-border", &tmp_border, NULL);
1416 *default_outside_border = *tmp_border;
1417 gtk_border_free (tmp_border);
1420 *default_outside_border = default_default_outside_border;
1425 gtk_widget_style_get (widget, "inner-border", &tmp_border, NULL);
1429 *inner_border = *tmp_border;
1430 gtk_border_free (tmp_border);
1433 *inner_border = default_inner_border;
1437 gtk_widget_style_get (widget, "interior-focus", interior_focus, NULL);
1441 gtk_button_size_allocate (GtkWidget *widget,
1442 GtkAllocation *allocation)
1444 GtkButton *button = GTK_BUTTON (widget);
1445 GtkButtonPrivate *priv = button->priv;
1446 GtkAllocation child_allocation;
1447 GtkStyleContext *context;
1448 GtkStateFlags state;
1451 gint xthickness, ythickness;
1452 GtkBorder default_border;
1453 GtkBorder inner_border;
1454 gint focus_width, border_width;
1457 context = gtk_widget_get_style_context (widget);
1458 state = gtk_widget_get_state_flags (widget);
1460 gtk_style_context_get (context, state,
1461 "border-width", &border_width,
1464 xthickness = border_width;
1465 ythickness = border_width;
1467 gtk_button_get_props (button, &default_border, NULL, &inner_border, NULL);
1468 gtk_widget_style_get (GTK_WIDGET (widget),
1469 "focus-line-width", &focus_width,
1470 "focus-padding", &focus_pad,
1473 gtk_widget_set_allocation (widget, allocation);
1475 if (gtk_widget_get_realized (widget))
1476 gdk_window_move_resize (priv->event_window,
1480 allocation->height);
1482 child = gtk_bin_get_child (GTK_BIN (button));
1483 if (child && gtk_widget_get_visible (child))
1485 child_allocation.x = allocation->x + inner_border.left + xthickness;
1486 child_allocation.y = allocation->y + inner_border.top + ythickness;
1488 child_allocation.width =
1494 child_allocation.height =
1495 allocation->height -
1498 inner_border.bottom;
1500 if (gtk_widget_get_can_default (GTK_WIDGET (button)))
1502 child_allocation.x += default_border.left;
1503 child_allocation.y += default_border.top;
1504 child_allocation.width = child_allocation.width - default_border.left - default_border.right;
1505 child_allocation.height = child_allocation.height - default_border.top - default_border.bottom;
1508 if (gtk_widget_get_can_focus (GTK_WIDGET (button)))
1510 child_allocation.x += focus_width + focus_pad;
1511 child_allocation.y += focus_width + focus_pad;
1512 child_allocation.width = child_allocation.width - (focus_width + focus_pad) * 2;
1513 child_allocation.height = child_allocation.height - (focus_width + focus_pad) * 2;
1516 if (priv->depressed)
1518 gint child_displacement_x;
1519 gint child_displacement_y;
1521 gtk_widget_style_get (widget,
1522 "child-displacement-x", &child_displacement_x,
1523 "child-displacement-y", &child_displacement_y,
1525 child_allocation.x += child_displacement_x;
1526 child_allocation.y += child_displacement_y;
1529 child_allocation.width = MAX (1, child_allocation.width);
1530 child_allocation.height = MAX (1, child_allocation.height);
1532 gtk_widget_size_allocate (child, &child_allocation);
1537 _gtk_button_paint (GtkButton *button,
1541 GtkStateType state_type,
1542 GtkShadowType shadow_type,
1543 const gchar *main_detail,
1544 const gchar *default_detail)
1546 GtkButtonPrivate *priv = button->priv;
1549 GtkBorder default_border;
1550 GtkBorder default_outside_border;
1551 gboolean interior_focus;
1554 GtkAllocation allocation;
1556 GtkStyleContext *context;
1557 GtkStateFlags state;
1559 widget = GTK_WIDGET (button);
1561 gtk_button_get_props (button, &default_border, &default_outside_border, NULL, &interior_focus);
1562 gtk_widget_style_get (widget,
1563 "focus-line-width", &focus_width,
1564 "focus-padding", &focus_pad,
1567 gtk_widget_get_allocation (widget, &allocation);
1568 context = gtk_widget_get_style_context (widget);
1569 window = gtk_widget_get_window (widget);
1574 if (gtk_widget_has_default (widget) &&
1575 priv->relief == GTK_RELIEF_NORMAL)
1577 x += default_border.left;
1578 y += default_border.top;
1579 width -= default_border.left + default_border.right;
1580 height -= default_border.top + default_border.bottom;
1582 gtk_style_context_add_class (context, GTK_STYLE_CLASS_DEFAULT);
1584 else if (gtk_widget_get_can_default (widget))
1586 x += default_outside_border.left;
1587 y += default_outside_border.top;
1588 width -= default_outside_border.left + default_outside_border.right;
1589 height -= default_outside_border.top + default_outside_border.bottom;
1592 if (!interior_focus && gtk_widget_has_focus (widget))
1594 x += focus_width + focus_pad;
1595 y += focus_width + focus_pad;
1596 width -= 2 * (focus_width + focus_pad);
1597 height -= 2 * (focus_width + focus_pad);
1600 state = gtk_widget_get_state_flags (widget);
1601 gtk_style_context_set_state (context, state);
1603 if (priv->relief != GTK_RELIEF_NONE || priv->depressed ||
1604 state & GTK_STATE_FLAG_PRELIGHT)
1606 gtk_render_background (context, cr,
1607 x, y, width, height);
1608 gtk_render_frame (context, cr,
1609 x, y, width, height);
1612 if (gtk_widget_has_focus (widget))
1614 gint child_displacement_x;
1615 gint child_displacement_y;
1616 gboolean displace_focus;
1619 gtk_widget_style_get (widget,
1620 "child-displacement-y", &child_displacement_y,
1621 "child-displacement-x", &child_displacement_x,
1622 "displace-focus", &displace_focus,
1625 gtk_style_context_get (context, state,
1626 "border-width", &border_width,
1631 x += border_width + focus_pad;
1632 y += border_width + focus_pad;
1633 width -= 2 * (border_width + focus_pad);
1634 height -= 2 * (border_width + focus_pad);
1638 x -= focus_width + focus_pad;
1639 y -= focus_width + focus_pad;
1640 width += 2 * (focus_width + focus_pad);
1641 height += 2 * (focus_width + focus_pad);
1644 if (priv->depressed && displace_focus)
1646 x += child_displacement_x;
1647 y += child_displacement_y;
1650 gtk_render_focus (context, cr,
1651 x, y, width, height);
1656 gtk_button_draw (GtkWidget *widget,
1659 GtkButton *button = GTK_BUTTON (widget);
1660 GtkButtonPrivate *priv = button->priv;
1662 _gtk_button_paint (button, cr,
1663 gtk_widget_get_allocated_width (widget),
1664 gtk_widget_get_allocated_height (widget),
1665 gtk_widget_get_state (widget),
1666 priv->depressed ? GTK_SHADOW_IN : GTK_SHADOW_OUT,
1667 "button", "buttondefault");
1669 GTK_WIDGET_CLASS (gtk_button_parent_class)->draw (widget, cr);
1675 gtk_button_button_press (GtkWidget *widget,
1676 GdkEventButton *event)
1679 GtkButtonPrivate *priv;
1681 if (event->type == GDK_BUTTON_PRESS)
1683 button = GTK_BUTTON (widget);
1684 priv = button->priv;
1686 if (priv->focus_on_click && !gtk_widget_has_focus (widget))
1687 gtk_widget_grab_focus (widget);
1689 if (event->button == 1)
1690 gtk_button_pressed (button);
1697 gtk_button_button_release (GtkWidget *widget,
1698 GdkEventButton *event)
1702 if (event->button == 1)
1704 button = GTK_BUTTON (widget);
1705 gtk_button_released (button);
1712 gtk_button_grab_broken (GtkWidget *widget,
1713 GdkEventGrabBroken *event)
1715 GtkButton *button = GTK_BUTTON (widget);
1716 GtkButtonPrivate *priv = button->priv;
1719 /* Simulate a button release without the pointer in the button */
1720 if (priv->button_down)
1722 save_in = priv->in_button;
1723 priv->in_button = FALSE;
1724 gtk_button_released (button);
1725 if (save_in != priv->in_button)
1727 priv->in_button = save_in;
1728 gtk_button_update_state (button);
1736 gtk_button_key_release (GtkWidget *widget,
1739 GtkButton *button = GTK_BUTTON (widget);
1740 GtkButtonPrivate *priv = button->priv;
1742 if (priv->activate_timeout)
1744 gtk_button_finish_activate (button, TRUE);
1747 else if (GTK_WIDGET_CLASS (gtk_button_parent_class)->key_release_event)
1748 return GTK_WIDGET_CLASS (gtk_button_parent_class)->key_release_event (widget, event);
1754 gtk_button_enter_notify (GtkWidget *widget,
1755 GdkEventCrossing *event)
1757 GtkButton *button = GTK_BUTTON (widget);
1758 GtkButtonPrivate *priv = button->priv;
1760 if ((event->window == button->priv->event_window) &&
1761 (event->detail != GDK_NOTIFY_INFERIOR))
1763 priv->in_button = TRUE;
1764 gtk_button_enter (button);
1771 gtk_button_leave_notify (GtkWidget *widget,
1772 GdkEventCrossing *event)
1774 GtkButton *button = GTK_BUTTON (widget);
1775 GtkButtonPrivate *priv = button->priv;
1777 if ((event->window == button->priv->event_window) &&
1778 (event->detail != GDK_NOTIFY_INFERIOR) &&
1779 (gtk_widget_get_sensitive (widget)))
1781 priv->in_button = FALSE;
1782 gtk_button_leave (button);
1789 gtk_real_button_pressed (GtkButton *button)
1791 GtkButtonPrivate *priv = button->priv;
1793 if (priv->activate_timeout)
1796 priv->button_down = TRUE;
1797 gtk_button_update_state (button);
1801 gtk_real_button_released (GtkButton *button)
1803 GtkButtonPrivate *priv = button->priv;
1805 if (priv->button_down)
1807 priv->button_down = FALSE;
1809 if (priv->activate_timeout)
1812 if (priv->in_button)
1813 gtk_button_clicked (button);
1815 gtk_button_update_state (button);
1820 gtk_real_button_clicked (GtkButton *button)
1822 GtkButtonPrivate *priv = button->priv;
1825 gtk_action_activate (priv->action);
1829 button_activate_timeout (gpointer data)
1831 gtk_button_finish_activate (data, TRUE);
1837 gtk_real_button_activate (GtkButton *button)
1839 GtkWidget *widget = GTK_WIDGET (button);
1840 GtkButtonPrivate *priv = button->priv;
1844 device = gtk_get_current_event_device ();
1846 if (device && gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1847 device = gdk_device_get_associated_device (device);
1849 g_return_if_fail (device && gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD);
1851 if (gtk_widget_get_realized (widget) && !priv->activate_timeout)
1853 time = gtk_get_current_event_time ();
1855 if (gdk_device_grab (device, priv->event_window,
1856 GDK_OWNERSHIP_WINDOW, TRUE,
1857 GDK_KEY_PRESS | GDK_KEY_RELEASE,
1858 NULL, time) == GDK_GRAB_SUCCESS)
1860 gtk_device_grab_add (widget, device, TRUE);
1861 priv->grab_keyboard = device;
1862 priv->grab_time = time;
1865 priv->activate_timeout = gdk_threads_add_timeout (ACTIVATE_TIMEOUT,
1866 button_activate_timeout,
1868 priv->button_down = TRUE;
1869 gtk_button_update_state (button);
1870 gtk_widget_queue_draw (GTK_WIDGET (button));
1875 gtk_button_finish_activate (GtkButton *button,
1878 GtkWidget *widget = GTK_WIDGET (button);
1879 GtkButtonPrivate *priv = button->priv;
1881 g_source_remove (priv->activate_timeout);
1882 priv->activate_timeout = 0;
1884 if (priv->grab_keyboard)
1886 gdk_device_ungrab (priv->grab_keyboard, priv->grab_time);
1887 gtk_device_grab_remove (widget, priv->grab_keyboard);
1888 priv->grab_keyboard = NULL;
1891 priv->button_down = FALSE;
1893 gtk_button_update_state (button);
1894 gtk_widget_queue_draw (GTK_WIDGET (button));
1897 gtk_button_clicked (button);
1902 gtk_button_get_size (GtkWidget *widget,
1903 GtkOrientation orientation,
1907 GtkButton *button = GTK_BUTTON (widget);
1908 GtkStyleContext *context;
1910 GtkBorder default_border;
1911 GtkBorder inner_border;
1912 GtkStateFlags state;
1913 gint focus_width, border_width;
1915 gint minimum, natural;
1917 gtk_button_get_props (button, &default_border, NULL, &inner_border, NULL);
1918 gtk_widget_style_get (GTK_WIDGET (widget),
1919 "focus-line-width", &focus_width,
1920 "focus-padding", &focus_pad,
1923 context = gtk_widget_get_style_context (GTK_WIDGET (widget));
1924 state = gtk_widget_get_state_flags (GTK_WIDGET (widget));
1926 gtk_style_context_get (context, state,
1927 "border-width", &border_width,
1930 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1932 minimum = (border_width * 2 +
1933 inner_border.left + inner_border.right);
1935 if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
1936 minimum += default_border.left + default_border.right;
1940 minimum = (border_width * 2 +
1941 inner_border.top + inner_border.bottom);
1943 if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
1944 minimum += default_border.top + default_border.bottom;
1947 minimum += 2 * (focus_width + focus_pad);
1950 if ((child = gtk_bin_get_child (GTK_BIN (button))) &&
1951 gtk_widget_get_visible (child))
1953 gint child_min, child_nat;
1955 if (orientation == GTK_ORIENTATION_HORIZONTAL)
1956 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
1958 gtk_widget_get_preferred_height (child, &child_min, &child_nat);
1960 minimum += child_min;
1961 natural += child_nat;
1965 *minimum_size = minimum;
1968 *natural_size = natural;
1972 gtk_button_get_preferred_width (GtkWidget *widget,
1976 gtk_button_get_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
1980 gtk_button_get_preferred_height (GtkWidget *widget,
1984 gtk_button_get_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
1988 * gtk_button_set_label:
1989 * @button: a #GtkButton
1992 * Sets the text of the label of the button to @str. This text is
1993 * also used to select the stock item if gtk_button_set_use_stock()
1996 * This will also clear any previously set labels.
1999 gtk_button_set_label (GtkButton *button,
2002 GtkButtonPrivate *priv;
2005 g_return_if_fail (GTK_IS_BUTTON (button));
2007 priv = button->priv;
2009 new_label = g_strdup (label);
2010 g_free (priv->label_text);
2011 priv->label_text = new_label;
2013 gtk_button_construct_child (button);
2015 g_object_notify (G_OBJECT (button), "label");
2019 * gtk_button_get_label:
2020 * @button: a #GtkButton
2022 * Fetches the text from the label of the button, as set by
2023 * gtk_button_set_label(). If the label text has not
2024 * been set the return value will be %NULL. This will be the
2025 * case if you create an empty button with gtk_button_new() to
2026 * use as a container.
2028 * Return value: The text of the label widget. This string is owned
2029 * by the widget and must not be modified or freed.
2031 G_CONST_RETURN gchar *
2032 gtk_button_get_label (GtkButton *button)
2034 g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2036 return button->priv->label_text;
2040 * gtk_button_set_use_underline:
2041 * @button: a #GtkButton
2042 * @use_underline: %TRUE if underlines in the text indicate mnemonics
2044 * If true, an underline in the text of the button label indicates
2045 * the next character should be used for the mnemonic accelerator key.
2048 gtk_button_set_use_underline (GtkButton *button,
2049 gboolean use_underline)
2051 GtkButtonPrivate *priv;
2053 g_return_if_fail (GTK_IS_BUTTON (button));
2055 priv = button->priv;
2057 use_underline = use_underline != FALSE;
2059 if (use_underline != priv->use_underline)
2061 priv->use_underline = use_underline;
2063 gtk_button_construct_child (button);
2065 g_object_notify (G_OBJECT (button), "use-underline");
2070 * gtk_button_get_use_underline:
2071 * @button: a #GtkButton
2073 * Returns whether an embedded underline in the button label indicates a
2074 * mnemonic. See gtk_button_set_use_underline ().
2076 * Return value: %TRUE if an embedded underline in the button label
2077 * indicates the mnemonic accelerator keys.
2080 gtk_button_get_use_underline (GtkButton *button)
2082 g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2084 return button->priv->use_underline;
2088 * gtk_button_set_use_stock:
2089 * @button: a #GtkButton
2090 * @use_stock: %TRUE if the button should use a stock item
2092 * If %TRUE, the label set on the button is used as a
2093 * stock id to select the stock item for the button.
2096 gtk_button_set_use_stock (GtkButton *button,
2099 GtkButtonPrivate *priv;
2101 g_return_if_fail (GTK_IS_BUTTON (button));
2103 priv = button->priv;
2105 use_stock = use_stock != FALSE;
2107 if (use_stock != priv->use_stock)
2109 priv->use_stock = use_stock;
2111 gtk_button_construct_child (button);
2113 g_object_notify (G_OBJECT (button), "use-stock");
2118 * gtk_button_get_use_stock:
2119 * @button: a #GtkButton
2121 * Returns whether the button label is a stock item.
2123 * Return value: %TRUE if the button label is used to
2124 * select a stock item instead of being
2125 * used directly as the label text.
2128 gtk_button_get_use_stock (GtkButton *button)
2130 g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2132 return button->priv->use_stock;
2136 * gtk_button_set_focus_on_click:
2137 * @button: a #GtkButton
2138 * @focus_on_click: whether the button grabs focus when clicked with the mouse
2140 * Sets whether the button will grab focus when it is clicked with the mouse.
2141 * Making mouse clicks not grab focus is useful in places like toolbars where
2142 * you don't want the keyboard focus removed from the main area of the
2148 gtk_button_set_focus_on_click (GtkButton *button,
2149 gboolean focus_on_click)
2151 GtkButtonPrivate *priv;
2153 g_return_if_fail (GTK_IS_BUTTON (button));
2155 priv = button->priv;
2157 focus_on_click = focus_on_click != FALSE;
2159 if (priv->focus_on_click != focus_on_click)
2161 priv->focus_on_click = focus_on_click;
2163 g_object_notify (G_OBJECT (button), "focus-on-click");
2168 * gtk_button_get_focus_on_click:
2169 * @button: a #GtkButton
2171 * Returns whether the button grabs focus when it is clicked with the mouse.
2172 * See gtk_button_set_focus_on_click().
2174 * Return value: %TRUE if the button grabs focus when it is clicked with
2180 gtk_button_get_focus_on_click (GtkButton *button)
2182 g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
2184 return button->priv->focus_on_click;
2188 * gtk_button_set_alignment:
2189 * @button: a #GtkButton
2190 * @xalign: the horizontal position of the child, 0.0 is left aligned,
2191 * 1.0 is right aligned
2192 * @yalign: the vertical position of the child, 0.0 is top aligned,
2193 * 1.0 is bottom aligned
2195 * Sets the alignment of the child. This property has no effect unless
2196 * the child is a #GtkMisc or a #GtkAlignment.
2201 gtk_button_set_alignment (GtkButton *button,
2205 GtkButtonPrivate *priv;
2207 g_return_if_fail (GTK_IS_BUTTON (button));
2209 priv = button->priv;
2211 priv->xalign = xalign;
2212 priv->yalign = yalign;
2213 priv->align_set = 1;
2215 maybe_set_alignment (button, gtk_bin_get_child (GTK_BIN (button)));
2217 g_object_freeze_notify (G_OBJECT (button));
2218 g_object_notify (G_OBJECT (button), "xalign");
2219 g_object_notify (G_OBJECT (button), "yalign");
2220 g_object_thaw_notify (G_OBJECT (button));
2224 * gtk_button_get_alignment:
2225 * @button: a #GtkButton
2226 * @xalign: return location for horizontal alignment
2227 * @yalign: return location for vertical alignment
2229 * Gets the alignment of the child in the button.
2234 gtk_button_get_alignment (GtkButton *button,
2238 GtkButtonPrivate *priv;
2240 g_return_if_fail (GTK_IS_BUTTON (button));
2242 priv = button->priv;
2245 *xalign = priv->xalign;
2248 *yalign = priv->yalign;
2252 * _gtk_button_set_depressed:
2253 * @button: a #GtkButton
2254 * @depressed: %TRUE if the button should be drawn with a recessed shadow.
2256 * Sets whether the button is currently drawn as down or not. This is
2257 * purely a visual setting, and is meant only for use by derived widgets
2258 * such as #GtkToggleButton.
2261 _gtk_button_set_depressed (GtkButton *button,
2264 GtkWidget *widget = GTK_WIDGET (button);
2265 GtkButtonPrivate *priv = button->priv;
2267 depressed = depressed != FALSE;
2269 if (depressed != priv->depressed)
2271 priv->depressed = depressed;
2272 gtk_widget_queue_resize (widget);
2277 gtk_button_update_state (GtkButton *button)
2279 GtkButtonPrivate *priv = button->priv;
2280 GtkStateFlags new_state = 0;
2283 if (priv->activate_timeout)
2284 depressed = priv->depress_on_activate;
2286 depressed = priv->in_button && priv->button_down;
2288 if (priv->in_button)
2289 new_state |= GTK_STATE_FLAG_PRELIGHT;
2291 if (priv->button_down || depressed)
2292 new_state |= GTK_STATE_FLAG_ACTIVE;
2294 _gtk_button_set_depressed (button, depressed);
2295 gtk_widget_set_state_flags (GTK_WIDGET (button), new_state, TRUE);
2299 show_image_change_notify (GtkButton *button)
2301 GtkButtonPrivate *priv = button->priv;
2305 if (show_image (button))
2306 gtk_widget_show (priv->image);
2308 gtk_widget_hide (priv->image);
2313 traverse_container (GtkWidget *widget,
2316 if (GTK_IS_BUTTON (widget))
2317 show_image_change_notify (GTK_BUTTON (widget));
2318 else if (GTK_IS_CONTAINER (widget))
2319 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
2323 gtk_button_setting_changed (GtkSettings *settings)
2327 list = gtk_window_list_toplevels ();
2329 for (l = list; l; l = l->next)
2330 gtk_container_forall (GTK_CONTAINER (l->data),
2331 traverse_container, NULL);
2338 gtk_button_screen_changed (GtkWidget *widget,
2339 GdkScreen *previous_screen)
2342 GtkButtonPrivate *priv;
2343 GtkSettings *settings;
2344 gulong show_image_connection;
2346 if (!gtk_widget_has_screen (widget))
2349 button = GTK_BUTTON (widget);
2350 priv = button->priv;
2352 /* If the button is being pressed while the screen changes the
2353 release might never occur, so we reset the state. */
2354 if (priv->button_down)
2356 priv->button_down = FALSE;
2357 gtk_button_update_state (button);
2360 settings = gtk_widget_get_settings (widget);
2362 show_image_connection =
2363 g_signal_handler_find (settings, G_SIGNAL_MATCH_FUNC, 0, 0,
2364 NULL, gtk_button_setting_changed, NULL);
2366 if (show_image_connection)
2369 g_signal_connect (settings, "notify::gtk-button-images",
2370 G_CALLBACK (gtk_button_setting_changed), NULL);
2372 show_image_change_notify (button);
2376 gtk_button_state_changed (GtkWidget *widget,
2377 GtkStateType previous_state)
2379 GtkButton *button = GTK_BUTTON (widget);
2380 GtkButtonPrivate *priv = button->priv;
2382 if (!gtk_widget_is_sensitive (widget))
2384 priv->in_button = FALSE;
2385 gtk_real_button_released (button);
2390 gtk_button_grab_notify (GtkWidget *widget,
2391 gboolean was_grabbed)
2393 GtkButton *button = GTK_BUTTON (widget);
2394 GtkButtonPrivate *priv = button->priv;
2397 if (priv->activate_timeout &&
2398 priv->grab_keyboard &&
2399 gtk_widget_device_is_shadowed (widget, priv->grab_keyboard))
2400 gtk_button_finish_activate (button, FALSE);
2404 save_in = priv->in_button;
2405 priv->in_button = FALSE;
2406 gtk_real_button_released (button);
2407 if (save_in != priv->in_button)
2409 priv->in_button = save_in;
2410 gtk_button_update_state (button);
2416 * gtk_button_set_image:
2417 * @button: a #GtkButton
2418 * @image: a widget to set as the image for the button
2420 * Set the image of @button to the given widget. Note that
2421 * it depends on the #GtkSettings:gtk-button-images setting whether the
2422 * image will be displayed or not, you don't have to call
2423 * gtk_widget_show() on @image yourself.
2428 gtk_button_set_image (GtkButton *button,
2431 GtkButtonPrivate *priv;
2434 g_return_if_fail (GTK_IS_BUTTON (button));
2435 g_return_if_fail (image == NULL || GTK_IS_WIDGET (image));
2437 priv = button->priv;
2441 parent = gtk_widget_get_parent (priv->image);
2443 gtk_container_remove (GTK_CONTAINER (parent), priv->image);
2446 priv->image = image;
2447 priv->image_is_stock = (image == NULL);
2449 gtk_button_construct_child (button);
2451 g_object_notify (G_OBJECT (button), "image");
2455 * gtk_button_get_image:
2456 * @button: a #GtkButton
2458 * Gets the widget that is currenty set as the image of @button.
2459 * This may have been explicitly set by gtk_button_set_image()
2460 * or constructed by gtk_button_new_from_stock().
2462 * Return value: (transfer none): a #GtkWidget or %NULL in case there is no image
2467 gtk_button_get_image (GtkButton *button)
2469 g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2471 return button->priv->image;
2475 * gtk_button_set_image_position:
2476 * @button: a #GtkButton
2477 * @position: the position
2479 * Sets the position of the image relative to the text
2480 * inside the button.
2485 gtk_button_set_image_position (GtkButton *button,
2486 GtkPositionType position)
2488 GtkButtonPrivate *priv;
2490 g_return_if_fail (GTK_IS_BUTTON (button));
2491 g_return_if_fail (position >= GTK_POS_LEFT && position <= GTK_POS_BOTTOM);
2493 priv = button->priv;
2495 if (priv->image_position != position)
2497 priv->image_position = position;
2499 gtk_button_construct_child (button);
2501 g_object_notify (G_OBJECT (button), "image-position");
2506 * gtk_button_get_image_position:
2507 * @button: a #GtkButton
2509 * Gets the position of the image relative to the text
2510 * inside the button.
2512 * Return value: the position
2517 gtk_button_get_image_position (GtkButton *button)
2519 g_return_val_if_fail (GTK_IS_BUTTON (button), GTK_POS_LEFT);
2521 return button->priv->image_position;
2526 * gtk_button_get_event_window:
2527 * @button: a #GtkButton
2529 * Returns the button's event window if it is realized, %NULL otherwise.
2530 * This function should be rarely needed.
2532 * Return value: (transfer none): @button's event window.
2537 gtk_button_get_event_window (GtkButton *button)
2539 g_return_val_if_fail (GTK_IS_BUTTON (button), NULL);
2541 return button->priv->event_window;