-/* GTK - The GIMP Toolkit
+/* GTK - The GTK+ Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
-#include <config.h>
+#include "config.h"
#include <math.h>
#include <string.h>
PROP_PIXEL_SIZE,
PROP_PIXBUF_ANIMATION,
PROP_ICON_NAME,
- PROP_STORAGE_TYPE
+ PROP_STORAGE_TYPE,
+ PROP_GICON
};
G_DEFINE_TYPE (GtkImage, gtk_image, GTK_TYPE_MISC)
/**
* GtkImage:pixel-size:
*
- * The :pixel-size property can be used to specify a fixed size
- * overriding the :icon-size property for images of type
+ * The "pixel-size" property can be used to specify a fixed size
+ * overriding the #GtkImage:icon-size property for images of type
* %GTK_IMAGE_ICON_NAME.
*
* Since: 2.6
/**
* GtkImage:icon-name:
*
- * The name of the icon in the icon theme. If the icon theme is
+ * The name of the icon in the icon theme. If the icon theme is
* changed, the image will be updated automatically.
*
* Since: 2.6
NULL,
GTK_PARAM_READWRITE));
+ /**
+ * GtkImage:gicon:
+ *
+ * The GIcon displayed in the GtkImage. For themed icons,
+ * If the icon theme is changed, the image will be updated
+ * automatically.
+ *
+ * Since: 2.14
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_GICON,
+ g_param_spec_object ("gicon",
+ P_("Icon"),
+ P_("The GIcon being displayed"),
+ G_TYPE_ICON,
+ GTK_PARAM_READWRITE));
+
g_object_class_install_property (gobject_class,
PROP_STORAGE_TYPE,
g_param_spec_enum ("storage-type",
gtk_image_set_from_icon_name (image, g_value_get_string (value),
image->icon_size);
break;
+ case PROP_GICON:
+ gtk_image_set_from_gicon (image, g_value_get_object (value),
+ image->icon_size);
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
g_value_set_string (value,
image->data.name.icon_name);
break;
+ case PROP_GICON:
+ if (image->storage_type != GTK_IMAGE_GICON)
+ g_value_set_object (value, NULL);
+ else
+ g_value_set_object (value,
+ image->data.gicon.icon);
+ break;
case PROP_STORAGE_TYPE:
g_value_set_enum (value, image->storage_type);
break;
*
* Creates a #GtkImage widget displaying a @image with a @mask.
* A #GdkImage is a client-side image buffer in the pixel format of the
- * current display.
- * The #GtkImage does not assume a reference to the
+ * current display. The #GtkImage does not assume a reference to the
* image or mask; you still need to unref them if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
* pixbuf; you still need to unref it if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
- * Note that this function just creates an #GtkImage from the pixbuf. The
- * #GtkImage created will not react to state changes. Should you want that, you
- * should use gtk_image_new_from_icon_set().
+ * Note that this function just creates an #GtkImage from the pixbuf. The
+ * #GtkImage created will not react to state changes. Should you want that,
+ * you should use gtk_image_new_from_icon_set().
*
* Return value: a new #GtkImage
**/
* icon set; you still need to unref it if you own references.
* #GtkImage will add its own reference rather than adopting yours.
*
- *
* Return value: a new #GtkImage
**/
GtkWidget*
return GTK_WIDGET (image);
}
+/**
+ * gtk_image_new_from_gicon:
+ * @icon: an icon
+ * @size: a stock icon size
+ *
+ * Creates a #GtkImage displaying an icon from the current icon theme.
+ * If the icon name isn't known, a "broken image" icon will be
+ * displayed instead. If the current icon theme is changed, the icon
+ * will be updated appropriately.
+ *
+ * Return value: a new #GtkImage displaying the themed icon
+ *
+ * Since: 2.14
+ **/
+GtkWidget*
+gtk_image_new_from_gicon (GIcon *icon,
+ GtkIconSize size)
+{
+ GtkImage *image;
+
+ image = g_object_new (GTK_TYPE_IMAGE, NULL);
+
+ gtk_image_set_from_gicon (image, icon, size);
+
+ return GTK_WIDGET (image);
+}
+
/**
* gtk_image_set_from_pixmap:
* @image: a #GtkImage
* @mask: a #GdkBitmap or %NULL
*
* See gtk_image_new_from_pixmap() for details.
- *
**/
void
gtk_image_set_from_pixmap (GtkImage *image,
* @mask: a #GdkBitmap or %NULL
*
* See gtk_image_new_from_image() for details.
- *
**/
void
gtk_image_set_from_image (GtkImage *image,
* @filename: a filename or %NULL
*
* See gtk_image_new_from_file() for details.
- *
**/
void
gtk_image_set_from_file (GtkImage *image,
* @pixbuf: a #GdkPixbuf or %NULL
*
* See gtk_image_new_from_pixbuf() for details.
- *
**/
void
gtk_image_set_from_pixbuf (GtkImage *image,
* @size: a stock icon size
*
* See gtk_image_new_from_stock() for details.
- *
**/
void
gtk_image_set_from_stock (GtkImage *image,
* @size: a stock icon size
*
* See gtk_image_new_from_icon_set() for details.
- *
**/
void
gtk_image_set_from_icon_set (GtkImage *image,
g_object_thaw_notify (G_OBJECT (image));
}
+/**
+ * gtk_image_set_from_gicon:
+ * @image: a #GtkImage
+ * @icon: an icon
+ * @size: an icon size
+ *
+ * See gtk_image_new_from_gicon() for details.
+ *
+ * Since: 2.14
+ **/
+void
+gtk_image_set_from_gicon (GtkImage *image,
+ GIcon *icon,
+ GtkIconSize size)
+{
+ g_return_if_fail (GTK_IS_IMAGE (image));
+
+ g_object_freeze_notify (G_OBJECT (image));
+
+ /* in case icon == image->data.gicon.icon */
+ if (icon)
+ g_object_ref (icon);
+
+ gtk_image_clear (image);
+
+ if (icon)
+ {
+ image->storage_type = GTK_IMAGE_GICON;
+
+ image->data.gicon.icon = icon;
+ image->icon_size = size;
+
+ /* Size is demand-computed in size request method
+ * if we're a icon theme image, since changing the
+ * style impacts the size request
+ */
+ }
+
+ g_object_notify (G_OBJECT (image), "gicon");
+ g_object_notify (G_OBJECT (image), "icon-size");
+
+ g_object_thaw_notify (G_OBJECT (image));
+}
+
/**
* gtk_image_get_storage_type:
* @image: a #GtkImage
* %GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()).
* The caller of this function does not own a reference to the
* returned pixmap and mask.
- *
**/
void
gtk_image_get_pixmap (GtkImage *image,
* gtk_image_get_pixbuf:
* @image: a #GtkImage
*
- *
* Gets the #GdkPixbuf being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
* %GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
* The returned string is owned by the #GtkImage and should not
* be freed.
- *
**/
void
gtk_image_get_stock (GtkImage *image,
* Gets the icon set and size being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
- *
**/
void
gtk_image_get_icon_set (GtkImage *image,
* gtk_image_get_animation:
* @image: a #GtkImage
*
- *
* Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
*size = image->icon_size;
}
+/**
+ * gtk_image_get_gicon:
+ * @image: a #GtkImage
+ * @gicon: place to store a #GIcon
+ * @size: place to store an icon size
+ *
+ * Gets the #GIcon and size being displayed by the #GtkImage.
+ * The storage type of the image must be %GTK_IMAGE_EMPTY or
+ * %GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
+ * The caller of this function does not own a reference to the
+ * returned #GIcon.
+ *
+ * Since: 2.14
+ **/
+void
+gtk_image_get_gicon (GtkImage *image,
+ GIcon **gicon,
+ GtkIconSize *size)
+{
+ g_return_if_fail (GTK_IS_IMAGE (image));
+ g_return_if_fail (image->storage_type == GTK_IMAGE_GICON ||
+ image->storage_type == GTK_IMAGE_EMPTY);
+
+ if (image->storage_type == GTK_IMAGE_EMPTY)
+ image->data.gicon.icon = NULL;
+
+ if (gicon)
+ *gicon = image->data.gicon.icon;
+
+ if (size)
+ *size = image->icon_size;
+}
+
/**
* gtk_image_new:
*
animation_timeout (gpointer data)
{
GtkImage *image;
+ int delay;
image = GTK_IMAGE (data);
gdk_pixbuf_animation_iter_advance (image->data.anim.iter, NULL);
- if (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter) >= 0)
- image->data.anim.frame_timeout =
- gdk_threads_add_timeout (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter),
- animation_timeout,
- image);
+ delay = gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter);
+ if (delay >= 0)
+ {
+ image->data.anim.frame_timeout =
+ gdk_threads_add_timeout (delay, animation_timeout, image);
- gtk_widget_queue_draw (GTK_WIDGET (image));
+ gtk_widget_queue_draw (GTK_WIDGET (image));
- if (GTK_WIDGET_DRAWABLE (image))
- gdk_window_process_updates (GTK_WIDGET (image)->window, TRUE);
+ if (GTK_WIDGET_DRAWABLE (image))
+ gdk_window_process_updates (GTK_WIDGET (image)->window, TRUE);
+ }
return FALSE;
}
g_object_unref (image->data.name.pixbuf);
image->data.name.pixbuf = NULL;
+ gtk_widget_queue_draw (GTK_WIDGET (image));
+ }
+ if (image->storage_type == GTK_IMAGE_GICON)
+ {
+ if (image->data.gicon.pixbuf)
+ g_object_unref (image->data.gicon.pixbuf);
+ image->data.gicon.pixbuf = NULL;
+
gtk_widget_queue_draw (GTK_WIDGET (image));
}
}
GtkSettings *settings;
gint width, height;
gint *sizes, *s, dist;
+ GtkIconLookupFlags flags;
GError *error = NULL;
g_return_if_fail (image->storage_type == GTK_IMAGE_ICON_NAME);
screen = gtk_widget_get_screen (GTK_WIDGET (image));
icon_theme = gtk_icon_theme_get_for_screen (screen);
settings = gtk_settings_get_for_screen (screen);
+ flags = GTK_ICON_LOOKUP_USE_BUILTIN;
if (image->data.name.pixbuf == NULL)
{
if (priv->pixel_size != -1)
{
width = height = priv->pixel_size;
+ flags |= GTK_ICON_LOOKUP_FORCE_SIZE;
}
else if (!gtk_icon_size_lookup_for_settings (settings,
image->icon_size,
image->data.name.pixbuf =
gtk_icon_theme_load_icon (icon_theme,
image->data.name.icon_name,
- MIN (width, height), 0, &error);
+ MIN (width, height), flags, &error);
if (image->data.name.pixbuf == NULL)
{
g_error_free (error);
}
}
+static void
+ensure_pixbuf_for_gicon (GtkImage *image)
+{
+ GtkImagePrivate *priv;
+ GdkScreen *screen;
+ GtkIconTheme *icon_theme;
+ GtkSettings *settings;
+ gint width, height;
+ GtkIconInfo *info;
+ GtkIconLookupFlags flags;
+ GError *error = NULL;
+
+ g_return_if_fail (image->storage_type == GTK_IMAGE_GICON);
+
+ priv = GTK_IMAGE_GET_PRIVATE (image);
+ screen = gtk_widget_get_screen (GTK_WIDGET (image));
+ icon_theme = gtk_icon_theme_get_for_screen (screen);
+ settings = gtk_settings_get_for_screen (screen);
+ flags = GTK_ICON_LOOKUP_USE_BUILTIN;
+ if (image->data.gicon.pixbuf == NULL)
+ {
+ if (priv->pixel_size != -1)
+ {
+ width = height = priv->pixel_size;
+ flags |= GTK_ICON_LOOKUP_FORCE_SIZE;
+ }
+ else if (!gtk_icon_size_lookup_for_settings (settings,
+ image->icon_size,
+ &width, &height))
+ {
+ if (image->icon_size == -1)
+ width = height = 48;
+ else
+ {
+ g_warning ("Invalid icon size %d\n", image->icon_size);
+ width = height = 24;
+ }
+ }
+
+ info = gtk_icon_theme_lookup_by_gicon (icon_theme,
+ image->data.gicon.icon,
+ MIN (width, height), flags);
+ image->data.gicon.pixbuf = gtk_icon_info_load_icon (info, &error);
+ if (image->data.gicon.pixbuf == NULL)
+ {
+ g_error_free (error);
+ image->data.gicon.pixbuf =
+ gtk_widget_render_icon (GTK_WIDGET (image),
+ GTK_STOCK_MISSING_IMAGE,
+ image->icon_size,
+ NULL);
+ }
+ }
+}
+
+
/*
* Like gdk_rectangle_intersect (dest, src, dest), but make
* sure that the origin of dest is moved by an "even" offset.
}
break;
+ case GTK_IMAGE_GICON:
+ ensure_pixbuf_for_gicon (image);
+ pixbuf = image->data.gicon.pixbuf;
+ if (pixbuf)
+ {
+ g_object_ref (pixbuf);
+ image_bound.width = gdk_pixbuf_get_width (pixbuf);
+ image_bound.height = gdk_pixbuf_get_height (pixbuf);
+ }
+ break;
+
case GTK_IMAGE_EMPTY:
g_assert_not_reached ();
break;
case GTK_IMAGE_ANIMATION:
case GTK_IMAGE_ICON_NAME:
case GTK_IMAGE_EMPTY:
+ case GTK_IMAGE_GICON:
g_assert_not_reached ();
break;
}
break;
+ case GTK_IMAGE_GICON:
+ if (image->data.gicon.icon)
+ g_object_unref (image->data.gicon.icon);
+ image->data.gicon.icon = NULL;
+ if (image->data.gicon.pixbuf)
+ g_object_unref (image->data.gicon.pixbuf);
+ image->data.gicon.pixbuf = NULL;
+
+ g_object_notify (G_OBJECT (image), "gicon");
+
+ break;
+
case GTK_IMAGE_EMPTY:
default:
break;
pixbuf = image->data.name.pixbuf;
if (pixbuf) g_object_ref (pixbuf);
break;
+ case GTK_IMAGE_GICON:
+ ensure_pixbuf_for_gicon (image);
+ pixbuf = image->data.gicon.pixbuf;
+ if (pixbuf)
+ g_object_ref (pixbuf);
+ break;
default:
break;
}
gtk_image_update_size (image, pixel_size, pixel_size);
}
+ if (image->storage_type == GTK_IMAGE_GICON)
+ {
+ if (image->data.gicon.pixbuf)
+ {
+ g_object_unref (image->data.gicon.pixbuf);
+ image->data.gicon.pixbuf = NULL;
+ }
+
+ gtk_image_update_size (image, pixel_size, pixel_size);
+ }
+
g_object_notify (G_OBJECT (image), "pixel-size");
}
}