* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
/**
* SECTION:gtkbutton
- * @Short_description: A widget that creates a signal when clicked on
+ * @Short_description: A widget that emits a signal when clicked on
* @Title: GtkButton
*
- * The #GtkButton widget is generally used to attach a function to that is
+ * The #GtkButton widget is generally used to trigger a callback function that is
* called when the button is pressed. The various signals and how to use them
* are outlined below.
*
- * The #GtkButton widget can hold any valid child widget. That is it can hold
- * most any other standard #GtkWidget. The most commonly used child is the
+ * The #GtkButton widget can hold any valid child widget. That is, it can hold
+ * almost any other standard #GtkWidget. The most commonly used child is the
* #GtkLabel.
*/
#include "gtkmain.h"
#include "gtkmarshalers.h"
#include "gtkimage.h"
-#include "gtkhbox.h"
-#include "gtkvbox.h"
+#include "gtkbox.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
#include "gtkactivatable.h"
#include "gtkprivate.h"
#include "gtkintl.h"
#include "a11y/gtkbuttonaccessible.h"
-
+#include "gtkapplicationprivate.h"
+#include "gtkactionhelper.h"
static const GtkBorder default_default_border = { 1, 1, 1, 1 };
static const GtkBorder default_default_outside_border = { 0, 0, 0, 0 };
-static const GtkBorder default_inner_border = { 1, 1, 1, 1 };
/* Time out before giving up on getting a key release when animating
* the close button.
PROP_XALIGN,
PROP_YALIGN,
PROP_IMAGE_POSITION,
+ PROP_ACTION_NAME,
+ PROP_ACTION_TARGET,
+ PROP_ALWAYS_SHOW_IMAGE,
/* activatable properties */
PROP_ACTIVATABLE_RELATED_ACTION,
GdkEventButton * event);
static gint gtk_button_button_release (GtkWidget * widget,
GdkEventButton * event);
+static gboolean gtk_button_touch (GtkWidget *widget,
+ GdkEventTouch *event);
static gint gtk_button_grab_broken (GtkWidget * widget,
GdkEventGrabBroken * event);
static gint gtk_button_key_release (GtkWidget * widget, GdkEventKey * event);
static void gtk_button_grab_notify (GtkWidget *widget,
gboolean was_grabbed);
-
+static void gtk_button_actionable_iface_init (GtkActionableInterface *iface);
static void gtk_button_activatable_interface_init(GtkActivatableIface *iface);
static void gtk_button_update (GtkActivatable *activatable,
GtkAction *action,
static guint button_signals[LAST_SIGNAL] = { 0 };
G_DEFINE_TYPE_WITH_CODE (GtkButton, gtk_button, GTK_TYPE_BIN,
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIONABLE, gtk_button_actionable_iface_init)
G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
gtk_button_activatable_interface_init))
widget_class->draw = gtk_button_draw;
widget_class->button_press_event = gtk_button_button_press;
widget_class->button_release_event = gtk_button_button_release;
+ widget_class->touch_event = gtk_button_touch;
widget_class->grab_broken_event = gtk_button_grab_broken;
widget_class->key_release_event = gtk_button_key_release;
widget_class->enter_notify_event = gtk_button_enter_notify;
GTK_POS_LEFT,
GTK_PARAM_READWRITE));
+ /**
+ * GtkButton:always-show-image:
+ *
+ * If %TRUE, the button will ignore the #GtkSettings:gtk-button-images
+ * setting and always show the image, if available.
+ *
+ * Use this property if the button would be useless or hard to use
+ * without the image.
+ *
+ * Since: 3.6
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_ALWAYS_SHOW_IMAGE,
+ g_param_spec_boolean ("always-show-image",
+ P_("Always show image"),
+ P_("Whether the image will always be shown"),
+ FALSE,
+ GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
+
+ g_object_class_override_property (gobject_class, PROP_ACTION_NAME, "action-name");
+ g_object_class_override_property (gobject_class, PROP_ACTION_TARGET, "action-target");
+
g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_RELATED_ACTION, "related-action");
g_object_class_override_property (gobject_class, PROP_ACTIVATABLE_USE_ACTION_APPEARANCE, "use-action-appearance");
* Sets the border between the button edges and child.
*
* Since: 2.10
+ *
+ * Deprecated: 3.4: Use the standard border and padding CSS properties;
+ * the value of this style property is ignored.
*/
gtk_widget_class_install_style_property (widget_class,
g_param_spec_boxed ("inner-border",
GtkButton *button = GTK_BUTTON (object);
GtkButtonPrivate *priv = button->priv;
+ g_clear_object (&priv->action_helper);
+
if (priv->action)
{
gtk_activatable_do_set_related_action (GTK_ACTIVATABLE (button), NULL);
G_OBJECT_CLASS (gtk_button_parent_class)->dispose (object);
}
+static void
+gtk_button_set_action_name (GtkActionable *actionable,
+ const gchar *action_name)
+{
+ GtkButton *button = GTK_BUTTON (actionable);
+
+ g_return_if_fail (button->priv->action == NULL);
+
+ if (!button->priv->action_helper)
+ button->priv->action_helper = gtk_action_helper_new (actionable);
+
+ g_signal_handlers_disconnect_by_func (button, gtk_real_button_clicked, NULL);
+ if (action_name)
+ g_signal_connect_after (button, "clicked", G_CALLBACK (gtk_real_button_clicked), NULL);
+
+ gtk_action_helper_set_action_name (button->priv->action_helper, action_name);
+}
+
+static void
+gtk_button_set_action_target_value (GtkActionable *actionable,
+ GVariant *action_target)
+{
+ GtkButton *button = GTK_BUTTON (actionable);
+
+ if (!button->priv->action_helper)
+ button->priv->action_helper = gtk_action_helper_new (actionable);
+
+ gtk_action_helper_set_action_target_value (button->priv->action_helper, action_target);
+}
+
static void
gtk_button_set_property (GObject *object,
guint prop_id,
case PROP_IMAGE:
gtk_button_set_image (button, (GtkWidget *) g_value_get_object (value));
break;
+ case PROP_ALWAYS_SHOW_IMAGE:
+ gtk_button_set_always_show_image (button, g_value_get_boolean (value));
+ break;
case PROP_RELIEF:
gtk_button_set_relief (button, g_value_get_enum (value));
break;
case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
gtk_button_set_use_action_appearance (button, g_value_get_boolean (value));
break;
+ case PROP_ACTION_NAME:
+ gtk_button_set_action_name (GTK_ACTIONABLE (button), g_value_get_string (value));
+ break;
+ case PROP_ACTION_TARGET:
+ gtk_button_set_action_target_value (GTK_ACTIONABLE (button), g_value_get_variant (value));
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
case PROP_IMAGE:
g_value_set_object (value, (GObject *)priv->image);
break;
+ case PROP_ALWAYS_SHOW_IMAGE:
+ g_value_set_boolean (value, gtk_button_get_always_show_image (button));
+ break;
case PROP_RELIEF:
g_value_set_enum (value, priv->relief);
break;
case PROP_ACTIVATABLE_USE_ACTION_APPEARANCE:
g_value_set_boolean (value, priv->use_action_appearance);
break;
+ case PROP_ACTION_NAME:
+ g_value_set_string (value, gtk_action_helper_get_action_name (priv->action_helper));
+ break;
+ case PROP_ACTION_TARGET:
+ g_value_set_variant (value, gtk_action_helper_get_action_target_value (priv->action_helper));
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
+static const gchar *
+gtk_button_get_action_name (GtkActionable *actionable)
+{
+ GtkButton *button = GTK_BUTTON (actionable);
+
+ return gtk_action_helper_get_action_name (button->priv->action_helper);
+}
+
+static GVariant *
+gtk_button_get_action_target_value (GtkActionable *actionable)
+{
+ GtkButton *button = GTK_BUTTON (actionable);
+
+ return gtk_action_helper_get_action_target_value (button->priv->action_helper);
+}
+
+static void
+gtk_button_actionable_iface_init (GtkActionableInterface *iface)
+{
+ iface->get_action_name = gtk_button_get_action_name;
+ iface->set_action_name = gtk_button_set_action_name;
+ iface->get_action_target_value = gtk_button_get_action_target_value;
+ iface->set_action_target_value = gtk_button_set_action_target_value;
+}
+
static void
gtk_button_activatable_interface_init (GtkActivatableIface *iface)
{
activatable_update_gicon (GTK_BUTTON (activatable), action);
activatable_update_icon_name (GTK_BUTTON (activatable), action);
}
+
+ gtk_button_set_always_show_image (button,
+ gtk_action_get_always_show_image (action));
}
static void
{
GtkButtonPrivate *priv = button->priv;
+ g_return_if_fail (gtk_action_helper_get_action_name (button->priv->action_helper) == NULL);
+
if (priv->action == action)
return;
GtkButtonPrivate *priv = button->priv;
gboolean show;
- if (priv->label_text)
+ if (priv->label_text && !priv->always_show_image)
{
GtkSettings *settings;
return show;
}
+
static void
gtk_button_construct_child (GtkButton *button)
{
* gtk_button_new_with_mnemonic:
* @label: The text of the button, with an underscore in front of the
* mnemonic character
- * @returns: a new #GtkButton
*
* Creates a new #GtkButton containing a label.
* If characters in @label are preceded by an underscore, they are underlined.
- * If you need a literal underscore character in a label, use '__' (two
- * underscores). The first underlined character represents a keyboard
+ * If you need a literal underscore character in a label, use '__' (two
+ * underscores). The first underlined character represents a keyboard
* accelerator called a mnemonic.
* Pressing Alt and that key activates the button.
+ *
+ * Returns: a new #GtkButton
**/
GtkWidget*
gtk_button_new_with_mnemonic (const gchar *label)
attributes.wclass = GDK_INPUT_ONLY;
attributes.event_mask = gtk_widget_get_events (widget);
attributes.event_mask |= (GDK_BUTTON_PRESS_MASK |
- GDK_BUTTON_RELEASE_MASK |
- GDK_ENTER_NOTIFY_MASK |
- GDK_LEAVE_NOTIFY_MASK);
+ GDK_BUTTON_RELEASE_MASK |
+ GDK_TOUCH_MASK |
+ GDK_ENTER_NOTIFY_MASK |
+ GDK_LEAVE_NOTIFY_MASK);
attributes_mask = GDK_WA_X | GDK_WA_Y;
priv->event_window = gdk_window_new (window,
&attributes, attributes_mask);
- gdk_window_set_user_data (priv->event_window, button);
+ gtk_widget_register_window (widget, priv->event_window);
}
static void
if (priv->event_window)
{
- gdk_window_set_user_data (priv->event_window, NULL);
+ gtk_widget_unregister_window (widget, priv->event_window);
gdk_window_destroy (priv->event_window);
priv->event_window = NULL;
}
GtkButtonPrivate *priv = button->priv;
if (priv->event_window)
- gdk_window_hide (priv->event_window);
+ {
+ gdk_window_hide (priv->event_window);
+ priv->in_button = FALSE;
+ }
GTK_WIDGET_CLASS (gtk_button_parent_class)->unmap (widget);
}
gtk_button_get_props (GtkButton *button,
GtkBorder *default_border,
GtkBorder *default_outside_border,
- GtkBorder *inner_border,
GtkBorder *padding,
+ GtkBorder *border,
gboolean *interior_focus)
{
GtkStyleContext *context;
*default_outside_border = default_default_outside_border;
}
- if (inner_border)
- {
- gtk_style_context_get_style (context,
- "inner-border", &tmp_border,
- NULL);
-
- if (tmp_border)
- {
- *inner_border = *tmp_border;
- gtk_border_free (tmp_border);
- }
- else
- *inner_border = default_inner_border;
- }
-
if (interior_focus)
{
gtk_style_context_get_style (context,
if (padding)
gtk_style_context_get_padding (context, state, padding);
+
+ if (border)
+ gtk_style_context_get_border (context, state, border);
}
static void
GtkStyleContext *context;
GtkWidget *child;
GtkBorder default_border;
- GtkBorder inner_border;
GtkBorder padding;
+ GtkBorder border;
gint focus_width;
gint focus_pad;
context = gtk_widget_get_style_context (widget);
- gtk_button_get_props (button, &default_border, NULL, &inner_border, &padding, NULL);
+ gtk_button_get_props (button, &default_border, NULL,
+ &padding, &border, NULL);
gtk_style_context_get_style (context,
"focus-line-width", &focus_width,
"focus-padding", &focus_pad,
child = gtk_bin_get_child (GTK_BIN (button));
if (child && gtk_widget_get_visible (child))
{
- child_allocation.x = allocation->x + inner_border.left + padding.left;
- child_allocation.y = allocation->y + inner_border.top + padding.top;
+ child_allocation.x = allocation->x + padding.left + border.left;
+ child_allocation.y = allocation->y + padding.top + border.top;
child_allocation.width =
allocation->width -
(padding.left + padding.right) -
- inner_border.left -
- inner_border.right;
+ (border.left + border.right);
child_allocation.height =
allocation->height -
(padding.top + padding.bottom) -
- inner_border.top -
- inner_border.bottom;
+ (border.top + border.bottom);
if (gtk_widget_get_can_default (GTK_WIDGET (button)))
{
}
}
-void
-_gtk_button_paint (GtkButton *button,
- cairo_t *cr,
- int width,
- int height,
- GtkStateFlags state)
+static gboolean
+gtk_button_draw (GtkWidget *widget,
+ cairo_t *cr)
{
+ GtkButton *button = GTK_BUTTON (widget);
GtkButtonPrivate *priv = button->priv;
- GtkWidget *widget;
gint x, y;
GtkBorder default_border;
GtkBorder default_outside_border;
gint focus_pad;
GtkAllocation allocation;
GtkStyleContext *context;
+ GtkStateFlags state;
+ gboolean draw_focus;
+ gint width, height;
- widget = GTK_WIDGET (button);
context = gtk_widget_get_style_context (widget);
-
- gtk_style_context_save (context);
- gtk_style_context_set_state (context, state);
+ state = gtk_style_context_get_state (context);
gtk_button_get_props (button, &default_border, &default_outside_border, NULL, NULL, &interior_focus);
gtk_style_context_get_style (context,
x = 0;
y = 0;
+ width = allocation.width;
+ height = allocation.height;
if (gtk_widget_has_default (widget) &&
priv->relief == GTK_RELIEF_NORMAL)
y += default_border.top;
width -= default_border.left + default_border.right;
height -= default_border.top + default_border.bottom;
-
- gtk_style_context_add_class (context, GTK_STYLE_CLASS_DEFAULT);
}
else if (gtk_widget_get_can_default (widget))
{
width -= default_outside_border.left + default_outside_border.right;
height -= default_outside_border.top + default_outside_border.bottom;
}
-
- if (!interior_focus && gtk_widget_has_focus (widget))
+
+ draw_focus = gtk_widget_has_visible_focus (widget);
+
+
+ if (!interior_focus && draw_focus)
{
x += focus_width + focus_pad;
y += focus_width + focus_pad;
x, y, width, height);
}
- if (gtk_widget_has_focus (widget))
+ if (draw_focus)
{
gint child_displacement_x;
gint child_displacement_y;
y += child_displacement_y;
}
- gtk_render_focus (context, cr,
- x, y, width, height);
+ gtk_render_focus (context, cr, x, y, width, height);
}
- gtk_style_context_restore (context);
-}
-
-static gboolean
-gtk_button_draw (GtkWidget *widget,
- cairo_t *cr)
-{
- GtkButton *button = GTK_BUTTON (widget);
-
- _gtk_button_paint (button, cr,
- gtk_widget_get_allocated_width (widget),
- gtk_widget_get_allocated_height (widget),
- gtk_widget_get_state_flags (widget));
-
GTK_WIDGET_CLASS (gtk_button_parent_class)->draw (widget, cr);
return FALSE;
if (priv->focus_on_click && !gtk_widget_has_focus (widget))
gtk_widget_grab_focus (widget);
- if (event->button == 1)
- gtk_button_pressed (button);
+ if (event->button == GDK_BUTTON_PRIMARY)
+ g_signal_emit (button, button_signals[PRESSED], 0);
}
return TRUE;
{
GtkButton *button;
- if (event->button == 1)
+ if (event->button == GDK_BUTTON_PRIMARY)
{
button = GTK_BUTTON (widget);
- gtk_button_released (button);
+ g_signal_emit (button, button_signals[RELEASED], 0);
+ }
+
+ return TRUE;
+}
+
+static gboolean
+gtk_button_touch (GtkWidget *widget,
+ GdkEventTouch *event)
+{
+ GtkButton *button = GTK_BUTTON (widget);
+ GtkButtonPrivate *priv = button->priv;
+
+ if (event->type == GDK_TOUCH_BEGIN)
+ {
+ if (priv->focus_on_click && !gtk_widget_has_focus (widget))
+ gtk_widget_grab_focus (widget);
+
+ g_signal_emit (button, button_signals[PRESSED], 0);
+ }
+ else if (event->type == GDK_TOUCH_END)
+ {
+ g_signal_emit (button, button_signals[RELEASED], 0);
}
return TRUE;
{
save_in = priv->in_button;
priv->in_button = FALSE;
- gtk_button_released (button);
+ g_signal_emit (button, button_signals[RELEASED], 0);
if (save_in != priv->in_button)
{
priv->in_button = save_in;
(event->detail != GDK_NOTIFY_INFERIOR))
{
priv->in_button = TRUE;
- gtk_button_enter (button);
+ g_signal_emit (button, button_signals[ENTER], 0);
}
return FALSE;
(gtk_widget_get_sensitive (widget)))
{
priv->in_button = FALSE;
- gtk_button_leave (button);
+ g_signal_emit (button, button_signals[LEAVE], 0);
}
return FALSE;
gtk_button_update_state (button);
}
+static gboolean
+touch_release_in_button (GtkButton *button)
+{
+ GtkButtonPrivate *priv;
+ gint width, height;
+ GdkEvent *event;
+ gdouble x, y;
+
+ priv = button->priv;
+ event = gtk_get_current_event ();
+
+ if (!event)
+ return FALSE;
+
+ if (event->type != GDK_TOUCH_END ||
+ event->touch.window != priv->event_window)
+ {
+ gdk_event_free (event);
+ return FALSE;
+ }
+
+ gdk_event_get_coords (event, &x, &y);
+ width = gdk_window_get_width (priv->event_window);
+ height = gdk_window_get_height (priv->event_window);
+
+ gdk_event_free (event);
+
+ if (x >= 0 && x <= width &&
+ y >= 0 && y <= height)
+ return TRUE;
+
+ return FALSE;
+}
+
static void
gtk_real_button_released (GtkButton *button)
{
if (priv->activate_timeout)
return;
- if (priv->in_button)
+ if (priv->in_button ||
+ touch_release_in_button (button))
gtk_button_clicked (button);
gtk_button_update_state (button);
{
GtkButtonPrivate *priv = button->priv;
+ if (priv->action_helper)
+ gtk_action_helper_activate (priv->action_helper);
+
if (priv->action)
gtk_action_activate (priv->action);
}
GtkStyleContext *context;
GtkWidget *child;
GtkBorder default_border;
- GtkBorder inner_border;
GtkBorder padding;
+ GtkBorder border;
gint focus_width;
gint focus_pad;
gint minimum, natural;
context = gtk_widget_get_style_context (widget);
- gtk_button_get_props (button, &default_border, NULL, &inner_border, &padding, NULL);
+ gtk_button_get_props (button, &default_border, NULL,
+ &padding, &border, NULL);
gtk_style_context_get_style (context,
"focus-line-width", &focus_width,
"focus-padding", &focus_pad,
if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
- minimum = inner_border.left + inner_border.right + padding.left + padding.right;
+ minimum = padding.left + padding.right +
+ border.left + border.right;
if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
minimum += default_border.left + default_border.right;
}
else
{
- minimum = inner_border.top + inner_border.bottom + padding.top + padding.bottom;
+ minimum = padding.top + padding.bottom +
+ border.top + border.bottom;
if (gtk_widget_get_can_default (GTK_WIDGET (widget)))
minimum += default_border.top + default_border.bottom;
if (priv->in_button)
new_state |= GTK_STATE_FLAG_PRELIGHT;
- if (priv->button_down || depressed)
+ if (depressed)
new_state |= GTK_STATE_FLAG_ACTIVE;
_gtk_button_set_depressed (button, depressed);
return button->priv->image_position;
}
+/**
+ * gtk_button_set_always_show_image:
+ * @button: a #GtkButton
+ * @always_show: %TRUE if the menuitem should always show the image
+ *
+ * If %TRUE, the button will ignore the #GtkSettings:gtk-button-images
+ * setting and always show the image, if available.
+ *
+ * Use this property if the button would be useless or hard to use
+ * without the image.
+ *
+ * Since: 3.6
+ */
+void
+gtk_button_set_always_show_image (GtkButton *button,
+ gboolean always_show)
+{
+ GtkButtonPrivate *priv;
+
+ g_return_if_fail (GTK_IS_BUTTON (button));
+
+ priv = button->priv;
+
+ if (priv->always_show_image != always_show)
+ {
+ priv->always_show_image = always_show;
+
+ if (priv->image)
+ {
+ if (show_image (button))
+ gtk_widget_show (priv->image);
+ else
+ gtk_widget_hide (priv->image);
+ }
+
+ g_object_notify (G_OBJECT (button), "always-show-image");
+ }
+}
+
+/**
+ * gtk_button_get_always_show_image:
+ * @button: a #GtkButton
+ *
+ * Returns whether the button will ignore the #GtkSettings:gtk-button-images
+ * setting and always show the image, if available.
+ *
+ * Returns: %TRUE if the button will always show the image
+ *
+ * Since: 3.6
+ */
+gboolean
+gtk_button_get_always_show_image (GtkButton *button)
+{
+ g_return_val_if_fail (GTK_IS_BUTTON (button), FALSE);
+
+ return button->priv->always_show_image;
+}
/**
* gtk_button_get_event_window: