* "auto" so it behaves like a standard GtkButton.
*
* The #HildonButton can hold any valid child widget, but it usually
- * contains two labels, named title and value. To change the alignment
- * of the labels, use gtk_button_set_alignment()
+ * contains two labels, named title and value, and it can also contain
+ * an image. To change the alignment of the button contents, use
+ * gtk_button_set_alignment()
+ *
+ * If only one label is needed, #GtkButton can be used as well, see
+ * also hildon_gtk_button_new().
+ *
+ * <example>
+ * <title>Creating a HildonButton</title>
+ * <programlisting>
+ * void
+ * button_clicked (HildonButton *button, gpointer user_data)
+ * {
+ * const gchar *title, *value;
+ * <!-- -->
+ * title = hildon_button_get_title (button);
+ * value = hildon_button_get_value (button);
+ * g_debug ("Button clicked with title '%s' and value '%s'", title, value);
+ * }
+ * <!-- -->
+ * GtkWidget *
+ * create_button (void)
+ * {
+ * GtkWidget *button;
+ * GtkWidget *image;
+ * <!-- -->
+ * button = hildon_button_new (HILDON_SIZE_AUTO_WIDTH | HILDON_SIZE_FINGER_HEIGHT,
+ * HILDON_BUTTON_ARRANGEMENT_VERTICAL);
+ * hildon_button_set_text (HILDON_BUTTON (button), "Some title", "Some value");
+ * <!-- -->
+ * image = gtk_image_new_from_stock (GTK_STOCK_INFO, GTK_ICON_SIZE_BUTTON);
+ * hildon_button_set_image (HILDON_BUTTON (button), image);
+ * hildon_button_set_image_position (HILDON_BUTTON (button), GTK_POS_RIGHT);
+ * <!-- -->
+ * gtk_button_set_alignment (GTK_BUTTON (button), 0.0, 0.5);
+ * <!-- -->
+ * g_signal_connect (button, "clicked", G_CALLBACK (button_clicked), NULL);
+ * <!-- -->
+ * return button;
+ * }
+ * </programlisting>
+ * </example>
*/
#include "hildon-button.h"
#include "hildon-enum-types.h"
+#include "hildon-gtk.h"
+#include "hildon-helper.h"
G_DEFINE_TYPE (HildonButton, hildon_button, GTK_TYPE_BUTTON);
GtkLabel *title;
GtkLabel *value;
GtkBox *hbox;
+ GtkWidget *label_box;
GtkWidget *alignment;
GtkWidget *image;
GtkPositionType image_position;
+ gfloat image_xalign;
+ gfloat image_yalign;
};
enum {
hildon_button_set_value (button, g_value_get_string (value));
break;
case PROP_SIZE:
- hildon_helper_set_theme_size (GTK_WIDGET (button), g_value_get_flags (value));
+ hildon_gtk_widget_set_theme_size (GTK_WIDGET (button), g_value_get_flags (value));
break;
case PROP_ARRANGEMENT:
hildon_button_set_arrangement (button, g_value_get_enum (value));
GParamSpec *pspec)
{
HildonButton *button = HILDON_BUTTON (object);
- HildonButtonPrivate *priv = HILDON_BUTTON_GET_PRIVATE (button);
switch (prop_id)
{
case PROP_TITLE:
- g_value_set_string (value, gtk_label_get_text (priv->title));
+ g_value_set_string (value, hildon_button_get_title (button));
break;
case PROP_VALUE:
- g_value_set_string (value, gtk_label_get_text (priv->value));
+ g_value_set_string (value, hildon_button_get_value (button));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
static void
+hildon_button_style_set (GtkWidget *widget,
+ GtkStyle *previous_style)
+{
+ guint horizontal_spacing, vertical_spacing, image_spacing;
+ HildonButtonPrivate *priv = HILDON_BUTTON_GET_PRIVATE (widget);
+
+ if (GTK_WIDGET_CLASS (hildon_button_parent_class)->style_set)
+ GTK_WIDGET_CLASS (hildon_button_parent_class)->style_set (widget, previous_style);
+
+ gtk_widget_style_get (widget,
+ "horizontal-spacing", &horizontal_spacing,
+ "vertical-spacing", &vertical_spacing,
+ "image-spacing", &image_spacing,
+ NULL);
+
+ if (GTK_IS_HBOX (priv->label_box)) {
+ gtk_box_set_spacing (GTK_BOX (priv->label_box), horizontal_spacing);
+ } else {
+ gtk_box_set_spacing (GTK_BOX (priv->label_box), vertical_spacing);
+ }
+
+ if (GTK_IS_BOX (priv->hbox)) {
+ gtk_box_set_spacing (priv->hbox, image_spacing);
+ }
+}
+
+static void
+hildon_button_finalize (GObject *object)
+{
+ HildonButtonPrivate *priv = HILDON_BUTTON_GET_PRIVATE (object);
+
+ g_object_unref (priv->alignment);
+ g_object_unref (priv->label_box);
+
+ G_OBJECT_CLASS (hildon_button_parent_class)->finalize (object);
+}
+
+static void
hildon_button_class_init (HildonButtonClass *klass)
{
GObjectClass *gobject_class = (GObjectClass *)klass;
gobject_class->set_property = hildon_button_set_property;
gobject_class->get_property = hildon_button_get_property;
+ gobject_class->finalize = hildon_button_finalize;
+ widget_class->style_set = hildon_button_style_set;
g_object_class_install_property (
gobject_class,
priv->alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
priv->image = NULL;
priv->image_position = GTK_POS_LEFT;
- priv->hbox = GTK_BOX (gtk_hbox_new (FALSE, 0));
+ priv->image_xalign = 0.5;
+ priv->image_yalign = 0.5;
+ priv->hbox = NULL;
+ priv->label_box = NULL;
gtk_widget_set_name (GTK_WIDGET (priv->title), "hildon-button-title");
gtk_widget_set_name (GTK_WIDGET (priv->value), "hildon-button-value");
gtk_misc_set_alignment (GTK_MISC (priv->title), 0, 0.5);
gtk_misc_set_alignment (GTK_MISC (priv->value), 0, 0.5);
- gtk_box_pack_start (priv->hbox, priv->alignment, TRUE, TRUE, 0);
+ g_object_ref_sink (priv->alignment);
/* The labels are not shown automatically, see hildon_button_set_(title|value) */
gtk_widget_set_no_show_all (GTK_WIDGET (priv->title), TRUE);
}
/**
- * hildon_button_set_size_groups:
+ * hildon_button_add_title_size_group:
* @button: a #HildonButton
- * @title_size_group: A #GtkSizeGroup for the button title (main label), or %NULL
- * @value_size_group: A #GtkSizeGroup group for the button value (secondary label), or %NULL
+ * @size_group: A #GtkSizeGroup for the button title (main label)
*
- * Adds the title and value labels of @button to @title_size_group and
- * @value_size_group respectively. %NULL size groups will be ignored.
+ * Adds the title label of @button to @size_group.
**/
void
-hildon_button_set_size_groups (HildonButton *button,
- GtkSizeGroup *title_size_group,
- GtkSizeGroup *value_size_group)
+hildon_button_add_title_size_group (HildonButton *button,
+ GtkSizeGroup *size_group)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+ g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ gtk_size_group_add_widget (size_group, GTK_WIDGET (priv->title));
+}
+
+/**
+ * hildon_button_add_value_size_group:
+ * @button: a #HildonButton
+ * @size_group: A #GtkSizeGroup for the button value (secondary label)
+ *
+ * Adds the value label of @button to @size_group.
+ **/
+void
+hildon_button_add_value_size_group (HildonButton *button,
+ GtkSizeGroup *size_group)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+ g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ gtk_size_group_add_widget (size_group, GTK_WIDGET (priv->value));
+}
+
+/**
+ * hildon_button_add_image_size_group:
+ * @button: a #HildonButton
+ * @size_group: A #GtkSizeGroup for the button image
+ *
+ * Adds the image of @button to @size_group. You must add an image
+ * using hildon_button_set_image() before calling this function.
+ **/
+void
+hildon_button_add_image_size_group (HildonButton *button,
+ GtkSizeGroup *size_group)
{
HildonButtonPrivate *priv;
g_return_if_fail (HILDON_IS_BUTTON (button));
- g_return_if_fail (!title_size_group || GTK_IS_SIZE_GROUP (title_size_group));
- g_return_if_fail (!value_size_group || GTK_IS_SIZE_GROUP (value_size_group));
+ g_return_if_fail (GTK_IS_SIZE_GROUP (size_group));
priv = HILDON_BUTTON_GET_PRIVATE (button);
+ g_return_if_fail (GTK_IS_WIDGET (priv->image));
+
+ gtk_size_group_add_widget (size_group, GTK_WIDGET (priv->image));
+}
+
+/**
+ * hildon_button_add_size_groups:
+ * @button: a #HildonButton
+ * @title_size_group: A #GtkSizeGroup for the button title (main label), or %NULL
+ * @value_size_group: A #GtkSizeGroup group for the button value (secondary label), or %NULL
+ * @image_size_group: A #GtkSizeGroup group for the button image, or %NULL
+ *
+ * Convenience function to add title, value and image to size
+ * groups. %NULL size groups will be ignored.
+ **/
+void
+hildon_button_add_size_groups (HildonButton *button,
+ GtkSizeGroup *title_size_group,
+ GtkSizeGroup *value_size_group,
+ GtkSizeGroup *image_size_group)
+{
if (title_size_group)
- gtk_size_group_add_widget (title_size_group, GTK_WIDGET (priv->title));
+ hildon_button_add_title_size_group (button, title_size_group);
if (value_size_group)
- gtk_size_group_add_widget (value_size_group, GTK_WIDGET (priv->value));
+ hildon_button_add_value_size_group (button, value_size_group);
+
+ if (image_size_group)
+ hildon_button_add_image_size_group (button, image_size_group);
}
/**
* @size: Flags to set the size of the button.
* @arrangement: How the labels must be arranged.
*
- * Creates a new #HildonButton. To add a child widget use gtk_container_add().
+ * Creates a new #HildonButton. To set text in the labels, use
+ * hildon_button_set_title() and
+ * hildon_button_set_value(). Alternatively, you can add a custom
+ * child widget using gtk_container_add().
*
* Returns: a new #HildonButton
**/
hildon_button_new (HildonSizeType size,
HildonButtonArrangement arrangement)
{
- return hildon_button_new_full (size, arrangement, NULL, NULL, NULL, NULL);
+ return hildon_button_new_with_text (size, arrangement, NULL, NULL);
}
/**
const gchar *title,
const gchar *value)
{
- return hildon_button_new_full (size, arrangement, title, value, NULL, NULL);
-}
-
-/**
- * hildon_button_new_full:
- * @size: Flags to set the size of the button.
- * @arrangement: How the labels must be arranged.
- * @title: Title of the button (main label)
- * @value: Value of the button (secondary label), or %NULL
- * @title_size_group: a #GtkSizeGroup for the @title label, or %NULL
- * @value_size_group: a #GtkSizeGroup for the @value label, or %NULL
- *
- * Creates a new #HildonButton with two labels, @title and @value, and
- * their respective size groups.
- *
- * If you just don't want to use one of the labels, set it to
- * %NULL. You can set it to a non-%NULL value at any time later.
- *
- * @title and @value will be added to @title_size_group and
- * @value_size_group, respectively, if present.
- *
- * Returns: a new #HildonButton
- **/
-GtkWidget *
-hildon_button_new_full (HildonSizeType size,
- HildonButtonArrangement arrangement,
- const gchar *title,
- const gchar *value,
- GtkSizeGroup *title_size_group,
- GtkSizeGroup *value_size_group)
-{
GtkWidget *button;
/* Create widget */
button = g_object_new (HILDON_TYPE_BUTTON,
"size", size,
- "arrangement", arrangement,
"title", title,
"value", value,
- "name", "hildon-button",
+ "arrangement", arrangement,
NULL);
- /* Set size groups */
- if (title_size_group || value_size_group)
- hildon_button_set_size_groups (HILDON_BUTTON (button), title_size_group, value_size_group);
return button;
}
hildon_button_set_arrangement (HildonButton *button,
HildonButtonArrangement arrangement)
{
- GtkWidget *box;
HildonButtonPrivate *priv;
- guint horizontal_spacing;
- guint vertical_spacing;
priv = HILDON_BUTTON_GET_PRIVATE (button);
/* Pack everything */
- gtk_widget_style_get (GTK_WIDGET (button),
- "horizontal-spacing", &horizontal_spacing,
- "vertical-spacing", &vertical_spacing,
- NULL);
-
if (arrangement == HILDON_BUTTON_ARRANGEMENT_VERTICAL) {
- box = gtk_vbox_new (FALSE, vertical_spacing);
+ priv->label_box = gtk_vbox_new (FALSE, 0);
+ hildon_helper_set_logical_font (GTK_WIDGET (priv->value), "SmallSystemFont");
} else {
- box = gtk_hbox_new (FALSE, horizontal_spacing);
+ priv->label_box = gtk_hbox_new (FALSE, 0);
}
- gtk_box_pack_start (GTK_BOX (box), GTK_WIDGET (priv->title), TRUE, TRUE, 0);
- gtk_box_pack_start (GTK_BOX (box), GTK_WIDGET (priv->value), TRUE, TRUE, 0);
+ g_object_ref_sink (priv->label_box);
+
+ /* If we pack both labels with (TRUE, TRUE) or (FALSE, FALSE) they
+ * can be painted outside of the button in some situations, see
+ * NB#88126 */
+ gtk_box_pack_start (GTK_BOX (priv->label_box), GTK_WIDGET (priv->title), TRUE, TRUE, 0);
+ gtk_box_pack_start (GTK_BOX (priv->label_box), GTK_WIDGET (priv->value), FALSE, FALSE, 0);
- gtk_container_add (GTK_CONTAINER (priv->alignment), box);
+ hildon_button_construct_child (button);
}
/**
*
* Sets the title (main label) of @button to @title.
*
- * This will clear the previously set title.
+ * This will clear any previously set title.
*
* If @title is set to %NULL, the title label will be hidden and the
* value label will be realigned.
*
* Sets the value (secondary label) of @button to @value.
*
- * This will clear the previously set value.
+ * This will clear any previously set value.
*
* If @value is set to %NULL, the value label will be hidden and the
* title label will be realigned.
}
/**
+ * hildon_button_get_image:
+ * @button: a #HildonButton
+ *
+ * Gets the widget that is currenty set as the image of @button,
+ * previously set with hildon_button_set_image()
+ *
+ * Returns: a #GtkWidget or %NULL in case there is no image
+ **/
+GtkWidget *
+hildon_button_get_image (HildonButton *button)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_val_if_fail (HILDON_IS_BUTTON (button), NULL);
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ return priv->image;
+}
+
+/**
* hildon_button_set_image_position:
* @button: a #HildonButton
* @position: the position of the image (%GTK_POS_LEFT or %GTK_POS_RIGHT)
*
- * Sets the position of the image inside @button. Only left and right
- * are supported.
+ * Sets the position of the image inside @button. Only %GTK_POS_LEFT
+ * and %GTK_POS_RIGHT are currently supported.
**/
void
hildon_button_set_image_position (HildonButton *button,
hildon_button_construct_child (button);
}
+/**
+ * hildon_button_set_alignment:
+ * @button: a #HildonButton
+ * @xalign: the horizontal alignment of the contents, from 0 (left) to 1 (right).
+ * @yalign: the vertical alignment of the contents, from 0 (top) to 1 (bottom).
+ * @xscale: the amount that the child widget expands horizontally to fill up unused space, from 0 to 1
+ * @yscale: the amount that the child widget expands vertically to fill up unused space, from 0 to 1
+ *
+ * Sets the alignment of the contents of the widget. If you don't need
+ * to change @xscale or @yscale you can just use
+ * gtk_button_set_alignment() instead.
+ **/
+void
+hildon_button_set_alignment (HildonButton *button,
+ gfloat xalign,
+ gfloat yalign,
+ gfloat xscale,
+ gfloat yscale)
+{
+ HildonButtonPrivate *priv;
+ GtkWidget *child;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ child = gtk_bin_get_child (GTK_BIN (button));
+
+ if (GTK_IS_ALIGNMENT (child)) {
+ gtk_button_set_alignment (GTK_BUTTON (button), xalign, yalign);
+ g_object_set (child, "xscale", xscale, "yscale", yscale, NULL);
+ }
+}
+
+/**
+ * hildon_button_set_title_alignment:
+ * @button: a #HildonButton
+ * @xalign: the horizontal alignment of the title label, from 0 (left) to 1 (right).
+ * @yalign: the vertical alignment of the title label, from 0 (top) to 1 (bottom).
+ *
+ * Sets the alignment of the title label. See also
+ * hildon_button_set_alignment() to set the alignment of the whole
+ * contents of the button.
+ **/
+void
+hildon_button_set_title_alignment (HildonButton *button,
+ gfloat xalign,
+ gfloat yalign)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ gtk_misc_set_alignment (GTK_MISC (priv->title), xalign, yalign);
+}
+
+/**
+ * hildon_button_set_value_alignment:
+ * @button: a #HildonButton
+ * @xalign: the horizontal alignment of the value label, from 0 (left) to 1 (right).
+ * @yalign: the vertical alignment of the value label, from 0 (top) to 1 (bottom).
+ *
+ * Sets the alignment of the value label. See also
+ * hildon_button_set_alignment() to set the alignment of the whole
+ * contents of the button.
+ **/
+void
+hildon_button_set_value_alignment (HildonButton *button,
+ gfloat xalign,
+ gfloat yalign)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ gtk_misc_set_alignment (GTK_MISC (priv->value), xalign, yalign);
+}
+
+/**
+ * hildon_button_set_image_alignment:
+ * @button: a #HildonButton
+ * @xalign: the horizontal alignment of the image, from 0 (left) to 1 (right).
+ * @yalign: the vertical alignment of the image, from 0 (top) to 1 (bottom).
+ *
+ * Sets the alignment of the image. See also
+ * hildon_button_set_alignment() to set the alignment of the whole
+ * contents of the button.
+ **/
+void
+hildon_button_set_image_alignment (HildonButton *button,
+ gfloat xalign,
+ gfloat yalign)
+{
+ HildonButtonPrivate *priv;
+
+ g_return_if_fail (HILDON_IS_BUTTON (button));
+
+ priv = HILDON_BUTTON_GET_PRIVATE (button);
+
+ /* Return if there's nothing to do */
+ if (priv->image_xalign == xalign && priv->image_yalign == yalign)
+ return;
+
+ priv->image_xalign = xalign;
+ priv->image_yalign = yalign;
+
+ hildon_button_construct_child (button);
+}
+
static void
hildon_button_construct_child (HildonButton *button)
{
HildonButtonPrivate *priv = HILDON_BUTTON_GET_PRIVATE (button);
- GtkWidget *child = gtk_bin_get_child (GTK_BIN (button));
+ GtkWidget *child;
+ gint image_spacing;
+ const gchar *title, *value;
- /* Save a ref to the alignment if necessary */
- if (priv->alignment->parent != NULL) {
- g_object_ref (priv->alignment);
- gtk_container_remove (GTK_CONTAINER (priv->alignment->parent), priv->alignment);
- }
+ /* Don't do anything if the button is not constructed yet */
+ if (G_UNLIKELY (priv->label_box == NULL))
+ return;
+
+ /* Don't do anything if the button has no contents */
+ title = gtk_label_get_text (priv->title);
+ value = gtk_label_get_text (priv->value);
+ if (!priv->image && !title[0] && !value[0])
+ return;
- /* Save a ref to the image if necessary */
- if (priv->image && priv->image->parent != NULL) {
+ /* Save a ref to the image, and remove it from its container if necessary */
+ if (priv->image) {
g_object_ref (priv->image);
- gtk_container_remove (GTK_CONTAINER (priv->image->parent), priv->image);
+ if (priv->image->parent != NULL)
+ gtk_container_remove (GTK_CONTAINER (priv->image->parent), priv->image);
}
- /* Remove the child from the container */
- if (child != NULL) {
+ if (priv->label_box->parent != NULL) {
+ gtk_container_remove (GTK_CONTAINER (priv->label_box->parent), priv->label_box);
+ }
+
+ /* Remove the child from the container and add priv->alignment */
+ child = gtk_bin_get_child (GTK_BIN (button));
+ if (child != NULL && child != priv->alignment) {
gtk_container_remove (GTK_CONTAINER (button), child);
+ child = NULL;
}
- /* Pack the image and the alignment in a new hbox */
- priv->hbox = GTK_BOX (gtk_hbox_new (FALSE, 0));
+ if (child == NULL) {
+ gtk_container_add (GTK_CONTAINER (button), GTK_WIDGET (priv->alignment));
+ }
+ /* Create a new hbox */
+ if (priv->hbox) {
+ gtk_container_remove (GTK_CONTAINER (priv->alignment), GTK_WIDGET (priv->hbox));
+ }
+ gtk_widget_style_get (GTK_WIDGET (button), "image-spacing", &image_spacing, NULL);
+ priv->hbox = GTK_BOX (gtk_hbox_new (FALSE, image_spacing));
+ gtk_container_add (GTK_CONTAINER (priv->alignment), GTK_WIDGET (priv->hbox));
+
+ /* Pack the image and the alignment in the new hbox */
if (priv->image && priv->image_position == GTK_POS_LEFT)
gtk_box_pack_start (priv->hbox, priv->image, FALSE, FALSE, 0);
- gtk_box_pack_start (priv->hbox, priv->alignment, TRUE, TRUE, 0);
+ gtk_box_pack_start (priv->hbox, priv->label_box, TRUE, TRUE, 0);
if (priv->image && priv->image_position == GTK_POS_RIGHT)
gtk_box_pack_start (priv->hbox, priv->image, FALSE, FALSE, 0);
- /* Add the hbox to the button */
- gtk_container_add (GTK_CONTAINER (button), GTK_WIDGET (priv->hbox));
+ /* Set image alignment and remove previously set ref */
+ if (priv->image) {
+ gtk_misc_set_alignment (GTK_MISC (priv->image), priv->image_xalign, priv->image_yalign);
+ g_object_unref (priv->image);
+ }
- gtk_widget_show_all (GTK_WIDGET (priv->hbox));
+ /* Show everything */
+ gtk_widget_show_all (GTK_WIDGET (priv->alignment));
}
projects / hildon / blobdiff