* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
-#include <config.h>
+#include "config.h"
#include <math.h>
#include <string.h>
#include "gtkprivate.h"
#include "gtkalias.h"
+/**
+ * SECTION:gtkimage
+ * @Short_description: A widget displaying an image
+ * @Title: GtkImage
+ * @See_also:#GdkPixbuf
+ *
+ * The #GtkImage widget displays an image. Various kinds of object
+ * can be displayed as an image; most typically, you would load a
+ * #GdkPixbuf ("pixel buffer") from a file, and then display that.
+ * There's a convenience function to do this, gtk_image_new_from_file(),
+ * used as follows:
+ * <informalexample><programlisting>
+ * GtkWidget *image;
+ * image = gtk_image_new_from_file ("myfile.png");
+ * </programlisting></informalexample>
+ * If the file isn't loaded successfully, the image will contain a
+ * "broken image" icon similar to that used in many web browsers.
+ * If you want to handle errors in loading the file yourself,
+ * for example by displaying an error message, then load the image with
+ * gdk_pixbuf_new_from_file(), then create the #GtkImage with
+ * gtk_image_new_from_pixbuf().
+ *
+ * The image file may contain an animation, if so the #GtkImage will
+ * display an animation (#GdkPixbufAnimation) instead of a static image.
+ *
+ * #GtkImage is a subclass of #GtkMisc, which implies that you can
+ * align it (center, left, right) and add padding to it, using
+ * #GtkMisc methods.
+ *
+ * #GtkImage is a "no window" widget (has no #GdkWindow of its own),
+ * so by default does not receive events. If you want to receive events
+ * on the image, such as button clicks, place the image inside a
+ * #GtkEventBox, then connect to the event signals on the event box.
+ * <example>
+ * <title>Handling button press events on a
+ * <structname>GtkImage</structname>.</title>
+ * <programlisting>
+ * static gboolean
+ * button_press_callback (GtkWidget *event_box,
+ * GdkEventButton *event,
+ * gpointer data)
+ * {
+ * g_print ("Event box clicked at coordinates %f,%f\n",
+ * event->x, event->y);
+ *
+ * /<!---->* Returning TRUE means we handled the event, so the signal
+ * * emission should be stopped (don't call any further
+ * * callbacks that may be connected). Return FALSE
+ * * to continue invoking callbacks.
+ * *<!---->/
+ * return TRUE;
+ * }
+ *
+ * static GtkWidget*
+ * create_image (void)
+ * {
+ * GtkWidget *image;
+ * GtkWidget *event_box;
+ *
+ * image = gtk_image_new_from_file ("myfile.png");
+ *
+ * event_box = gtk_event_box_new (<!-- -->);
+ *
+ * gtk_container_add (GTK_CONTAINER (event_box), image);
+ *
+ * g_signal_connect (G_OBJECT (event_box),
+ * "button_press_event",
+ * G_CALLBACK (button_press_callback),
+ * image);
+ *
+ * return image;
+ * }
+ * </programlisting>
+ * </example>
+ *
+ * When handling events on the event box, keep in mind that coordinates
+ * in the image may be different from event box coordinates due to
+ * the alignment and padding settings on the image (see #GtkMisc).
+ * The simplest way to solve this is to set the alignment to 0.0
+ * (left/top), and set the padding to zero. Then the origin of
+ * the image will be the same as the origin of the event box.
+ *
+ * Sometimes an application will want to avoid depending on external data
+ * files, such as image files. GTK+ comes with a program to avoid this,
+ * called <application>gdk-pixbuf-csource</application>. This program
+ * allows you to convert an image into a C variable declaration, which
+ * can then be loaded into a #GdkPixbuf using
+ * gdk_pixbuf_new_from_inline().
+ */
+
typedef struct _GtkImagePrivate GtkImagePrivate;
struct _GtkImagePrivate
{
+ /* Only used with GTK_IMAGE_ANIMATION, GTK_IMAGE_PIXBUF */
+ gchar *filename;
+
gint pixel_size;
+ guint need_calc_size : 1;
};
#define GTK_IMAGE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_IMAGE, GtkImagePrivate))
#define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON
-
-static void gtk_image_class_init (GtkImageClass *klass);
-static void gtk_image_init (GtkImage *image);
static gint gtk_image_expose (GtkWidget *widget,
GdkEventExpose *event);
static void gtk_image_unmap (GtkWidget *widget);
static void gtk_image_screen_changed (GtkWidget *widget,
GdkScreen *prev_screen);
static void gtk_image_destroy (GtkObject *object);
-static void gtk_image_clear (GtkImage *image);
static void gtk_image_reset (GtkImage *image);
static void gtk_image_calc_size (GtkImage *image);
static void icon_theme_changed (GtkImage *image);
-static gpointer parent_class;
-
enum
{
PROP_0,
PROP_PIXEL_SIZE,
PROP_PIXBUF_ANIMATION,
PROP_ICON_NAME,
- PROP_STORAGE_TYPE
+ PROP_STORAGE_TYPE,
+ PROP_GICON
};
-GType
-gtk_image_get_type (void)
-{
- static GType image_type = 0;
-
- if (!image_type)
- {
- static const GTypeInfo image_info =
- {
- sizeof (GtkImageClass),
- NULL, /* base_init */
- NULL, /* base_finalize */
- (GClassInitFunc) gtk_image_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof (GtkImage),
- 0, /* n_preallocs */
- (GInstanceInitFunc) gtk_image_init,
- };
-
- image_type = g_type_register_static (GTK_TYPE_MISC, "GtkImage",
- &image_info, 0);
- }
-
- return image_type;
-}
+G_DEFINE_TYPE (GtkImage, gtk_image, GTK_TYPE_MISC)
static void
gtk_image_class_init (GtkImageClass *class)
GtkObjectClass *object_class;
GtkWidgetClass *widget_class;
- parent_class = g_type_class_peek_parent (class);
-
gobject_class = G_OBJECT_CLASS (class);
gobject_class->set_property = gtk_image_set_property;
P_("Filename"),
P_("Filename to load and display"),
NULL,
- GTK_PARAM_WRITABLE));
+ GTK_PARAM_READWRITE));
g_object_class_install_property (gobject_class,
/**
* 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",
image->mask = NULL;
priv->pixel_size = -1;
+
+ priv->filename = NULL;
}
static void
{
GtkImage *image = GTK_IMAGE (object);
- gtk_image_clear (image);
+ gtk_image_reset (image);
- GTK_OBJECT_CLASS (parent_class)->destroy (object);
+ GTK_OBJECT_CLASS (gtk_image_parent_class)->destroy (object);
}
static void
GParamSpec *pspec)
{
GtkImage *image;
- GtkImagePrivate *priv;
image = GTK_IMAGE (object);
- priv = GTK_IMAGE_GET_PRIVATE (image);
switch (prop_id)
{
if (mask)
g_object_ref (mask);
- gtk_image_reset (image);
+ gtk_image_clear (image);
image->mask = mask;
}
break;
case PROP_FILE:
- gtk_image_set_from_file (image,
- g_value_get_string (value));
+ gtk_image_set_from_file (image, g_value_get_string (value));
break;
case PROP_STOCK:
gtk_image_set_from_stock (image, g_value_get_string (value),
gtk_image_set_from_icon_name (image,
image->data.name.icon_name,
g_value_get_int (value));
+ else if (image->storage_type == GTK_IMAGE_GICON)
+ gtk_image_set_from_gicon (image,
+ image->data.gicon.icon,
+ g_value_get_int (value));
else
- /* Save to be used when STOCK or ICON_SET property comes in */
+ /* Save to be used when STOCK, ICON_SET, ICON_NAME or GICON property comes in */
image->icon_size = g_value_get_int (value);
break;
case PROP_PIXEL_SIZE:
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_object (value,
image->data.image.image);
break;
+ case PROP_FILE:
+ g_value_set_string (value, priv->filename);
+ break;
case PROP_STOCK:
if (image->storage_type != GTK_IMAGE_STOCK)
g_value_set_string (value, NULL);
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;
/**
* gtk_image_new_from_pixmap:
- * @pixmap: a #GdkPixmap, or %NULL
- * @mask: a #GdkBitmap, or %NULL
- *
+ * @pixmap: (allow-none): a #GdkPixmap, or %NULL
+ * @mask: (allow-none): a #GdkBitmap, or %NULL
+ *
* Creates a #GtkImage widget displaying @pixmap with a @mask.
* A #GdkPixmap is a server-side image buffer in the pixel format of the
* current display. The #GtkImage does not assume a reference to the
/**
* gtk_image_new_from_image:
- * @image: a #GdkImage, or %NULL
- * @mask: a #GdkBitmap, or %NULL
- *
+ * @image: (allow-none): a #GdkImage, or %NULL
+ * @mask: (allow-none): a #GdkBitmap, or %NULL
+ *
* 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.
*
/**
* gtk_image_new_from_pixbuf:
- * @pixbuf: a #GdkPixbuf, or %NULL
- *
+ * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
+ *
* Creates a new #GtkImage displaying @pixbuf.
* The #GtkImage does not assume a reference to the
* 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
**/
/**
* gtk_image_new_from_stock:
* @stock_id: a stock icon name
- * @size: a stock icon size
+ * @size: (type int): a stock icon size
*
* Creates a #GtkImage displaying a stock icon. Sample stock icon
- * names are #GTK_STOCK_OPEN, #GTK_STOCK_EXIT. Sample stock sizes
+ * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
* are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock
- * icon name isn't known, a "broken image" icon will be displayed instead.
+ * icon name isn't known, the image will be empty.
* You can register your own stock icon names, see
* gtk_icon_factory_add_default() and gtk_icon_factory_add().
*
/**
* gtk_image_new_from_icon_set:
* @icon_set: a #GtkIconSet
- * @size: a stock icon size
+ * @size: (type int): a stock icon size
*
* Creates a #GtkImage displaying an icon set. Sample stock sizes are
* #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
* 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*
* The #GtkImage does not assume a reference to the
* animation; you still need to unref it if you own references.
* #GtkImage will add its own reference rather than adopting yours.
- *
+ *
+ * Note that the animation frames are shown using a timeout with
+ * #G_PRIORITY_DEFAULT. When using animations to indicate busyness,
+ * keep in mind that the animation will only be shown if the main loop
+ * is not busy with something that has a higher priority.
+ *
* Return value: a new #GtkImage widget
**/
GtkWidget*
/**
* gtk_image_new_from_icon_name:
* @icon_name: an icon name
- * @size: a stock icon size
+ * @size: (type int): 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
return GTK_WIDGET (image);
}
+/**
+ * gtk_image_new_from_gicon:
+ * @icon: an icon
+ * @size: (type int): 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
- * @pixmap: a #GdkPixmap or %NULL
- * @mask: a #GdkBitmap or %NULL
+ * @pixmap: (allow-none): a #GdkPixmap or %NULL
+ * @mask: (allow-none): a #GdkBitmap or %NULL
*
* See gtk_image_new_from_pixmap() for details.
- *
**/
void
gtk_image_set_from_pixmap (GtkImage *image,
if (mask)
g_object_ref (mask);
- gtk_image_reset (image);
+ gtk_image_clear (image);
image->mask = mask;
/**
* gtk_image_set_from_image:
* @image: a #GtkImage
- * @gdk_image: a #GdkImage or %NULL
- * @mask: a #GdkBitmap or %NULL
+ * @gdk_image: (allow-none): a #GdkImage or %NULL
+ * @mask: (allow-none): a #GdkBitmap or %NULL
*
* See gtk_image_new_from_image() for details.
- *
**/
void
gtk_image_set_from_image (GtkImage *image,
if (mask)
g_object_ref (mask);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (gdk_image)
{
/**
* gtk_image_set_from_file:
* @image: a #GtkImage
- * @filename: a filename or %NULL
+ * @filename: (allow-none): a filename or %NULL
*
* See gtk_image_new_from_file() for details.
- *
**/
void
gtk_image_set_from_file (GtkImage *image,
const gchar *filename)
{
+ GtkImagePrivate *priv = GTK_IMAGE_GET_PRIVATE (image);
GdkPixbufAnimation *anim;
g_return_if_fail (GTK_IS_IMAGE (image));
g_object_freeze_notify (G_OBJECT (image));
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (filename == NULL)
{
+ priv->filename = NULL;
g_object_thaw_notify (G_OBJECT (image));
return;
}
-
+
anim = gdk_pixbuf_animation_new_from_file (filename, NULL);
if (anim == NULL)
*/
if (gdk_pixbuf_animation_is_static_image (anim))
- {
- gtk_image_set_from_pixbuf (image,
- gdk_pixbuf_animation_get_static_image (anim));
- }
+ gtk_image_set_from_pixbuf (image,
+ gdk_pixbuf_animation_get_static_image (anim));
else
- {
- gtk_image_set_from_animation (image, anim);
- }
+ gtk_image_set_from_animation (image, anim);
g_object_unref (anim);
+ priv->filename = g_strdup (filename);
+
g_object_thaw_notify (G_OBJECT (image));
}
/**
* gtk_image_set_from_pixbuf:
* @image: a #GtkImage
- * @pixbuf: a #GdkPixbuf or %NULL
+ * @pixbuf: (allow-none): a #GdkPixbuf or %NULL
*
- * See gtk_image_new_from_pixbuf() for details.
- *
+ * See gtk_image_new_from_pixbuf() for details.
**/
void
gtk_image_set_from_pixbuf (GtkImage *image,
if (pixbuf)
g_object_ref (pixbuf);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (pixbuf != NULL)
{
* gtk_image_set_from_stock:
* @image: a #GtkImage
* @stock_id: a stock icon name
- * @size: a stock icon size
+ * @size: (type int): a stock icon size
*
* See gtk_image_new_from_stock() for details.
- *
**/
void
gtk_image_set_from_stock (GtkImage *image,
/* in case stock_id == image->data.stock.stock_id */
new_id = g_strdup (stock_id);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (new_id)
{
* gtk_image_set_from_icon_set:
* @image: a #GtkImage
* @icon_set: a #GtkIconSet
- * @size: a stock icon size
+ * @size: (type int): a stock icon size
*
* See gtk_image_new_from_icon_set() for details.
- *
**/
void
gtk_image_set_from_icon_set (GtkImage *image,
if (icon_set)
gtk_icon_set_ref (icon_set);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (icon_set)
{
if (animation)
g_object_ref (animation);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (animation != NULL)
{
* gtk_image_set_from_icon_name:
* @image: a #GtkImage
* @icon_name: an icon name
- * @size: an icon size
+ * @size: (type int): an icon size
*
* See gtk_image_new_from_icon_name() for details.
*
/* in case icon_name == image->data.name.icon_name */
new_name = g_strdup (icon_name);
- gtk_image_reset (image);
+ gtk_image_clear (image);
if (new_name)
{
g_object_thaw_notify (G_OBJECT (image));
}
+/**
+ * gtk_image_set_from_gicon:
+ * @image: a #GtkImage
+ * @icon: an icon
+ * @size: (type int): 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_get_pixmap:
* @image: a #GtkImage
- * @pixmap: location to store the pixmap, or %NULL
- * @mask: location to store the mask, or %NULL
+ * @pixmap: (out) (transfer none) (allow-none): location to store the
+ * pixmap, or %NULL
+ * @mask: (out) (transfer none) (allow-none): location to store the
+ * mask, or %NULL
*
* Gets the pixmap and mask being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %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_image:
* @image: a #GtkImage
- * @gdk_image: return location for a #GtkImage
- * @mask: return location for a #GdkBitmap
+ * @gdk_image: (out) (transfer none) (allow-none): return location for
+ * a #GtkImage, or %NULL
+ * @mask: (out) (transfer none) (allow-none): return location for a
+ * #GdkBitmap, or %NULL
*
* Gets the #GdkImage and mask being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* 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()).
* The caller of this function does not own a reference to the
* returned pixbuf.
*
- * Return value: the displayed pixbuf, or %NULL if the image is empty
+ * Return value: (transfer none): the displayed pixbuf, or %NULL if
+ * the image is empty
**/
GdkPixbuf*
gtk_image_get_pixbuf (GtkImage *image)
/**
* gtk_image_get_stock:
* @image: a #GtkImage
- * @stock_id: place to store a stock icon name
- * @size: place to store a stock icon size
+ * @stock_id: (out) (transfer none) (allow-none): place to store a
+ * stock icon name, or %NULL
+ * @size: (out) (allow-none) (type int): place to store a stock icon
+ * size, or %NULL
*
* Gets the stock icon name and size being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
* %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,
/**
* gtk_image_get_icon_set:
* @image: a #GtkImage
- * @icon_set: location to store a #GtkIconSet
- * @size: location to store a stock icon size
+ * @icon_set: (out) (transfer none) (allow-none): location to store a
+ * #GtkIconSet, or %NULL
+ * @size: (out) (allow-none) (type int): location to store a stock
+ * icon size, or %NULL
*
* 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()).
* The caller of this function does not own a reference to the
* returned animation.
*
- * Return value: the displayed animation, or %NULL if the image is empty
+ * Return value: (transfer none): the displayed animation, or %NULL if
+ * the image is empty
**/
GdkPixbufAnimation*
gtk_image_get_animation (GtkImage *image)
/**
* gtk_image_get_icon_name:
* @image: a #GtkImage
- * @icon_name: place to store an icon name
- * @size: place to store an icon size
+ * @icon_name: (out) (transfer none) (allow-none): place to store an
+ * icon name, or %NULL
+ * @size: (out) (allow-none) (type int): place to store an icon size,
+ * or %NULL
*
* Gets the icon name and size being displayed by the #GtkImage.
* The storage type of the image must be %GTK_IMAGE_EMPTY or
*size = image->icon_size;
}
+/**
+ * gtk_image_get_gicon:
+ * @image: a #GtkImage
+ * @gicon: (out) (transfer none) (allow-none): place to store a
+ * #GIcon, or %NULL
+ * @size: (out) (allow-none) (type int): place to store an icon size,
+ * or %NULL
+ *
+ * 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:
*
return g_object_new (GTK_TYPE_IMAGE, NULL);
}
+/**
+ * gtk_image_set:
+ * @image: a #GtkImage
+ * @val: a #GdkImage
+ * @mask: a #GdkBitmap that indicates which parts of the image should be transparent.
+ *
+ * Sets the #GtkImage.
+ *
+ * Deprecated: 2.0: Use gtk_image_set_from_image() instead.
+ */
void
gtk_image_set (GtkImage *image,
GdkImage *val,
gtk_image_set_from_image (image, val, mask);
}
+/**
+ * gtk_image_get:
+ * @image: a #GtkImage
+ * @val: return location for a #GdkImage
+ * @mask: a #GdkBitmap that indicates which parts of the image should be transparent.
+ *
+ * Gets the #GtkImage.
+ *
+ * Deprecated: 2.0: Use gtk_image_get_image() instead.
+ */
void
gtk_image_get (GtkImage *image,
GdkImage **val,
{
gtk_image_reset_anim_iter (GTK_IMAGE (widget));
- if (GTK_WIDGET_CLASS (parent_class)->unmap)
- GTK_WIDGET_CLASS (parent_class)->unmap (widget);
+ GTK_WIDGET_CLASS (gtk_image_parent_class)->unmap (widget);
}
static void
{
gtk_image_reset_anim_iter (GTK_IMAGE (widget));
- if (GTK_WIDGET_CLASS (parent_class)->unrealize)
- GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
+ GTK_WIDGET_CLASS (gtk_image_parent_class)->unrealize (widget);
}
static gint
animation_timeout (gpointer data)
{
GtkImage *image;
-
- GDK_THREADS_ENTER ();
+ 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 =
- g_timeout_add (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter),
- animation_timeout,
- image);
-
- gtk_widget_queue_draw (GTK_WIDGET (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);
- GDK_THREADS_LEAVE ();
+ gtk_widget_queue_draw (GTK_WIDGET (image));
+
+ if (gtk_widget_is_drawable (GTK_WIDGET (image)))
+ gdk_window_process_updates (GTK_WIDGET (image)->window, TRUE);
+ }
return FALSE;
}
static void
icon_theme_changed (GtkImage *image)
{
- if (image->data.name.pixbuf)
- g_object_unref (image->data.name.pixbuf);
- image->data.name.pixbuf = NULL;
+ if (image->storage_type == GTK_IMAGE_ICON_NAME)
+ {
+ if (image->data.name.pixbuf)
+ 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));
+ gtk_widget_queue_draw (GTK_WIDGET (image));
+ }
}
static void
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;
+
+ 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);
+ if (info)
+ {
+ image->data.gicon.pixbuf = gtk_icon_info_load_icon (info, NULL);
+ gtk_icon_info_free (info);
+ }
+
+ if (image->data.gicon.pixbuf == NULL)
+ {
+ 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.
g_return_val_if_fail (GTK_IS_IMAGE (widget), FALSE);
g_return_val_if_fail (event != NULL, FALSE);
- if (GTK_WIDGET_MAPPED (widget) &&
+ if (gtk_widget_get_mapped (widget) &&
GTK_IMAGE (widget)->storage_type != GTK_IMAGE_EMPTY)
{
GtkImage *image;
GtkMisc *misc;
+ GtkImagePrivate *priv;
GdkRectangle area, image_bound;
gfloat xalign;
gint x, y, mask_x, mask_y;
GdkBitmap *mask;
GdkPixbuf *pixbuf;
gboolean needs_state_transform;
-
+
image = GTK_IMAGE (widget);
misc = GTK_MISC (widget);
+ priv = GTK_IMAGE_GET_PRIVATE (image);
area = event->area;
* and size_request() if something explicitely forces
* a redraw.
*/
- if (widget->requisition.width == 0 && widget->requisition.height == 0)
+ if (priv->need_calc_size)
gtk_image_calc_size (image);
if (!gdk_rectangle_intersect (&area, &widget->allocation, &area))
xalign = misc->xalign;
else
xalign = 1.0 - misc->xalign;
-
+
x = floor (widget->allocation.x + misc->xpad
- + ((widget->allocation.width - widget->requisition.width) * xalign)
- + 0.5);
+ + ((widget->allocation.width - widget->requisition.width) * xalign));
y = floor (widget->allocation.y + misc->ypad
- + ((widget->allocation.height - widget->requisition.height) * misc->yalign)
- + 0.5);
+ + ((widget->allocation.height - widget->requisition.height) * misc->yalign));
mask_x = x;
mask_y = y;
case GTK_IMAGE_PIXBUF:
image_bound.width = gdk_pixbuf_get_width (image->data.pixbuf.pixbuf);
- image_bound.height = gdk_pixbuf_get_height (image->data.pixbuf.pixbuf);
-
+ image_bound.height = gdk_pixbuf_get_height (image->data.pixbuf.pixbuf);
if (rectangle_intersect_even (&area, &image_bound) &&
needs_state_transform)
if (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter) >= 0)
image->data.anim.frame_timeout =
- g_timeout_add (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter),
+ gdk_threads_add_timeout (gdk_pixbuf_animation_iter_get_delay_time (image->data.anim.iter),
animation_timeout,
image);
}
}
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;
image_bound.height,
GDK_RGB_DITHER_NORMAL,
0, 0);
-
- g_object_unref (pixbuf);
- pixbuf = NULL;
}
}
else
case GTK_IMAGE_ANIMATION:
case GTK_IMAGE_ICON_NAME:
case GTK_IMAGE_EMPTY:
+ case GTK_IMAGE_GICON:
g_assert_not_reached ();
break;
}
gdk_gc_set_clip_origin (widget->style->black_gc, 0, 0);
}
+ if (pixbuf)
+ g_object_unref (pixbuf);
+
} /* if widget is drawable */
return FALSE;
}
static void
-gtk_image_clear (GtkImage *image)
+gtk_image_reset (GtkImage *image)
{
+ GtkImagePrivate *priv;
+
+ priv = GTK_IMAGE_GET_PRIVATE (image);
+
g_object_freeze_notify (G_OBJECT (image));
if (image->storage_type != GTK_IMAGE_EMPTY)
break;
case GTK_IMAGE_ICON_NAME:
- if (image->data.name.icon_name)
- g_free (image->data.name.icon_name);
+ g_free (image->data.name.icon_name);
image->data.name.icon_name = NULL;
if (image->data.name.pixbuf)
g_object_unref (image->data.name.pixbuf);
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;
}
+ if (priv->filename)
+ {
+ g_free (priv->filename);
+ priv->filename = NULL;
+ g_object_notify (G_OBJECT (image), "file");
+ }
+
image->storage_type = GTK_IMAGE_EMPTY;
memset (&image->data, '\0', sizeof (image->data));
g_object_thaw_notify (G_OBJECT (image));
}
-static void
-gtk_image_reset (GtkImage *image)
+/**
+ * gtk_image_clear:
+ * @image: a #GtkImage
+ *
+ * Resets the image to be empty.
+ *
+ * Since: 2.8
+ */
+void
+gtk_image_clear (GtkImage *image)
{
- gtk_image_clear (image);
+ GtkImagePrivate *priv;
+ priv = GTK_IMAGE_GET_PRIVATE (image);
+
+ priv->need_calc_size = 1;
+
+ gtk_image_reset (image);
gtk_image_update_size (image, 0, 0);
}
{
GtkWidget *widget = GTK_WIDGET (image);
GdkPixbuf *pixbuf = NULL;
-
+ GtkImagePrivate *priv;
+
+ priv = GTK_IMAGE_GET_PRIVATE (image);
+
+ priv->need_calc_size = 0;
+
/* We update stock/icon set on every size request, because
* the theme could have affected the size; for other kinds of
* image, we just update the requisition when the image data
{
case GTK_IMAGE_STOCK:
pixbuf = gtk_widget_render_icon (widget,
- image->data.stock.stock_id,
+ image->data.stock.stock_id,
image->icon_size,
NULL);
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_calc_size (image);
/* Chain up to default that simply reads current requisition */
- GTK_WIDGET_CLASS (parent_class)->size_request (widget, requisition);
+ GTK_WIDGET_CLASS (gtk_image_parent_class)->size_request (widget, requisition);
}
static void
image = GTK_IMAGE (widget);
- if (GTK_WIDGET_CLASS (parent_class)->style_set)
- GTK_WIDGET_CLASS (parent_class)->style_set (widget, prev_style);
-
+ GTK_WIDGET_CLASS (gtk_image_parent_class)->style_set (widget, prev_style);
+
icon_theme_changed (image);
}
image = GTK_IMAGE (widget);
- if (GTK_WIDGET_CLASS (parent_class)->screen_changed)
- GTK_WIDGET_CLASS (parent_class)->screen_changed (widget, prev_screen);
+ if (GTK_WIDGET_CLASS (gtk_image_parent_class)->screen_changed)
+ GTK_WIDGET_CLASS (gtk_image_parent_class)->screen_changed (widget, prev_screen);
icon_theme_changed (image);
}
gint image_width,
gint image_height)
{
- GTK_WIDGET (image)->requisition.width = image_width + GTK_MISC (image)->xpad * 2;
- GTK_WIDGET (image)->requisition.height = image_height + GTK_MISC (image)->ypad * 2;
+ GtkWidget *widget = GTK_WIDGET (image);
+
+ widget->requisition.width = image_width + GTK_MISC (image)->xpad * 2;
+ widget->requisition.height = image_height + GTK_MISC (image)->ypad * 2;
- if (GTK_WIDGET_VISIBLE (image))
- gtk_widget_queue_resize (GTK_WIDGET (image));
+ if (gtk_widget_get_visible (widget))
+ gtk_widget_queue_resize (widget);
}
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");
}
}
return priv->pixel_size;
}
-#ifdef G_OS_WIN32
+#if defined (G_OS_WIN32) && !defined (_WIN64)
#undef gtk_image_new_from_file
projects / ~andy / gtk / blobdiff