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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtkcontainer.h"
31 #include "gtkiconhelperprivate.h"
32 #include "gtkimageprivate.h"
33 #include "gtkiconfactory.h"
35 #include "gtkicontheme.h"
36 #include "gtksizerequest.h"
38 #include "gtkprivate.h"
39 #include "gtktypebuiltins.h"
41 #include "a11y/gtkimageaccessible.h"
45 * @Short_description: A widget displaying an image
47 * @See_also:#GdkPixbuf
49 * The #GtkImage widget displays an image. Various kinds of object
50 * can be displayed as an image; most typically, you would load a
51 * #GdkPixbuf ("pixel buffer") from a file, and then display that.
52 * There's a convenience function to do this, gtk_image_new_from_file(),
54 * <informalexample><programlisting>
56 * image = gtk_image_new_from_file ("myfile.png");
57 * </programlisting></informalexample>
58 * If the file isn't loaded successfully, the image will contain a
59 * "broken image" icon similar to that used in many web browsers.
60 * If you want to handle errors in loading the file yourself,
61 * for example by displaying an error message, then load the image with
62 * gdk_pixbuf_new_from_file(), then create the #GtkImage with
63 * gtk_image_new_from_pixbuf().
65 * The image file may contain an animation, if so the #GtkImage will
66 * display an animation (#GdkPixbufAnimation) instead of a static image.
68 * #GtkImage is a subclass of #GtkMisc, which implies that you can
69 * align it (center, left, right) and add padding to it, using
72 * #GtkImage is a "no window" widget (has no #GdkWindow of its own),
73 * so by default does not receive events. If you want to receive events
74 * on the image, such as button clicks, place the image inside a
75 * #GtkEventBox, then connect to the event signals on the event box.
77 * <title>Handling button press events on a
78 * <structname>GtkImage</structname>.</title>
81 * button_press_callback (GtkWidget *event_box,
82 * GdkEventButton *event,
85 * g_print ("Event box clicked at coordinates %f,%f\n",
86 * event->x, event->y);
88 * /<!---->* Returning TRUE means we handled the event, so the signal
89 * * emission should be stopped (don't call any further
90 * * callbacks that may be connected). Return FALSE
91 * * to continue invoking callbacks.
100 * GtkWidget *event_box;
102 * image = gtk_image_new_from_file ("myfile.png");
104 * event_box = gtk_event_box_new (<!-- -->);
106 * gtk_container_add (GTK_CONTAINER (event_box), image);
108 * g_signal_connect (G_OBJECT (event_box),
109 * "button_press_event",
110 * G_CALLBACK (button_press_callback),
118 * When handling events on the event box, keep in mind that coordinates
119 * in the image may be different from event box coordinates due to
120 * the alignment and padding settings on the image (see #GtkMisc).
121 * The simplest way to solve this is to set the alignment to 0.0
122 * (left/top), and set the padding to zero. Then the origin of
123 * the image will be the same as the origin of the event box.
125 * Sometimes an application will want to avoid depending on external data
126 * files, such as image files. GTK+ comes with a program to avoid this,
127 * called <application>gdk-pixbuf-csource</application>. This library
128 * allows you to convert an image into a C variable declaration, which
129 * can then be loaded into a #GdkPixbuf using
130 * gdk_pixbuf_new_from_inline().
134 struct _GtkImagePrivate
136 GtkIconHelper *icon_helper;
138 gint animation_timeout;
139 GdkPixbufAnimationIter *animation_iter;
141 gchar *filename; /* Only used with GTK_IMAGE_ANIMATION, GTK_IMAGE_PIXBUF */
145 #define DEFAULT_ICON_SIZE GTK_ICON_SIZE_BUTTON
146 static gint gtk_image_draw (GtkWidget *widget,
148 static void gtk_image_unmap (GtkWidget *widget);
149 static void gtk_image_unrealize (GtkWidget *widget);
150 static void gtk_image_get_preferred_width (GtkWidget *widget,
153 static void gtk_image_get_preferred_height (GtkWidget *widget,
157 static void gtk_image_style_updated (GtkWidget *widget);
158 static void gtk_image_screen_changed (GtkWidget *widget,
159 GdkScreen *prev_screen);
160 static void gtk_image_finalize (GObject *object);
161 static void gtk_image_reset (GtkImage *image);
163 static void gtk_image_set_property (GObject *object,
167 static void gtk_image_get_property (GObject *object,
172 static void icon_theme_changed (GtkImage *image);
183 PROP_PIXBUF_ANIMATION,
190 G_DEFINE_TYPE (GtkImage, gtk_image, GTK_TYPE_MISC)
193 gtk_image_class_init (GtkImageClass *class)
195 GObjectClass *gobject_class;
196 GtkWidgetClass *widget_class;
198 gobject_class = G_OBJECT_CLASS (class);
200 gobject_class->set_property = gtk_image_set_property;
201 gobject_class->get_property = gtk_image_get_property;
202 gobject_class->finalize = gtk_image_finalize;
204 widget_class = GTK_WIDGET_CLASS (class);
205 widget_class->draw = gtk_image_draw;
206 widget_class->get_preferred_width = gtk_image_get_preferred_width;
207 widget_class->get_preferred_height = gtk_image_get_preferred_height;
208 widget_class->unmap = gtk_image_unmap;
209 widget_class->unrealize = gtk_image_unrealize;
210 widget_class->style_updated = gtk_image_style_updated;
211 widget_class->screen_changed = gtk_image_screen_changed;
213 g_object_class_install_property (gobject_class,
215 g_param_spec_object ("pixbuf",
217 P_("A GdkPixbuf to display"),
219 GTK_PARAM_READWRITE));
221 g_object_class_install_property (gobject_class,
223 g_param_spec_string ("file",
225 P_("Filename to load and display"),
227 GTK_PARAM_READWRITE));
230 g_object_class_install_property (gobject_class,
232 g_param_spec_string ("stock",
234 P_("Stock ID for a stock image to display"),
236 GTK_PARAM_READWRITE));
238 g_object_class_install_property (gobject_class,
240 g_param_spec_boxed ("icon-set",
242 P_("Icon set to display"),
244 GTK_PARAM_READWRITE));
246 g_object_class_install_property (gobject_class,
248 g_param_spec_int ("icon-size",
250 P_("Symbolic size to use for stock icon, icon set or named icon"),
253 GTK_PARAM_READWRITE));
255 * GtkImage:pixel-size:
257 * The "pixel-size" property can be used to specify a fixed size
258 * overriding the #GtkImage:icon-size property for images of type
259 * %GTK_IMAGE_ICON_NAME.
263 g_object_class_install_property (gobject_class,
265 g_param_spec_int ("pixel-size",
267 P_("Pixel size to use for named icon"),
270 GTK_PARAM_READWRITE));
272 g_object_class_install_property (gobject_class,
273 PROP_PIXBUF_ANIMATION,
274 g_param_spec_object ("pixbuf-animation",
276 P_("GdkPixbufAnimation to display"),
277 GDK_TYPE_PIXBUF_ANIMATION,
278 GTK_PARAM_READWRITE));
281 * GtkImage:icon-name:
283 * The name of the icon in the icon theme. If the icon theme is
284 * changed, the image will be updated automatically.
288 g_object_class_install_property (gobject_class,
290 g_param_spec_string ("icon-name",
292 P_("The name of the icon from the icon theme"),
294 GTK_PARAM_READWRITE));
299 * The GIcon displayed in the GtkImage. For themed icons,
300 * If the icon theme is changed, the image will be updated
305 g_object_class_install_property (gobject_class,
307 g_param_spec_object ("gicon",
309 P_("The GIcon being displayed"),
311 GTK_PARAM_READWRITE));
313 g_object_class_install_property (gobject_class,
315 g_param_spec_enum ("storage-type",
317 P_("The representation being used for image data"),
320 GTK_PARAM_READABLE));
323 * GtkImage:use-fallback:
325 * Whether the icon displayed in the GtkImage will use
326 * standard icon names fallback. The value of this property
327 * is only relevant for images of type %GTK_IMAGE_ICON_NAME
328 * and %GTK_IMAGE_GICON.
332 g_object_class_install_property (gobject_class,
334 g_param_spec_boolean ("use-fallback",
336 P_("Whether to use icon names fallback"),
338 GTK_PARAM_READWRITE));
340 g_type_class_add_private (class, sizeof (GtkImagePrivate));
342 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_IMAGE_ACCESSIBLE);
346 gtk_image_init (GtkImage *image)
348 GtkImagePrivate *priv;
350 image->priv = G_TYPE_INSTANCE_GET_PRIVATE (image,
355 gtk_widget_set_has_window (GTK_WIDGET (image), FALSE);
356 priv->icon_helper = _gtk_icon_helper_new ();
358 priv->filename = NULL;
362 gtk_image_finalize (GObject *object)
364 GtkImage *image = GTK_IMAGE (object);
366 g_clear_object (&image->priv->icon_helper);
368 g_free (image->priv->filename);
370 G_OBJECT_CLASS (gtk_image_parent_class)->finalize (object);
374 gtk_image_set_property (GObject *object,
379 GtkImage *image = GTK_IMAGE (object);
380 GtkImagePrivate *priv = image->priv;
381 GtkIconSize icon_size = _gtk_icon_helper_get_icon_size (priv->icon_helper);
383 if (icon_size == GTK_ICON_SIZE_INVALID)
384 icon_size = DEFAULT_ICON_SIZE;
389 gtk_image_set_from_pixbuf (image,
390 g_value_get_object (value));
393 gtk_image_set_from_file (image, g_value_get_string (value));
396 gtk_image_set_from_stock (image, g_value_get_string (value),
400 gtk_image_set_from_icon_set (image, g_value_get_boxed (value),
404 _gtk_icon_helper_set_icon_size (priv->icon_helper, g_value_get_int (value));
406 case PROP_PIXEL_SIZE:
407 gtk_image_set_pixel_size (image, g_value_get_int (value));
409 case PROP_PIXBUF_ANIMATION:
410 gtk_image_set_from_animation (image,
411 g_value_get_object (value));
414 gtk_image_set_from_icon_name (image, g_value_get_string (value),
418 gtk_image_set_from_gicon (image, g_value_get_object (value),
422 case PROP_USE_FALLBACK:
423 _gtk_icon_helper_set_use_fallback (priv->icon_helper, g_value_get_boolean (value));
427 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
433 gtk_image_get_property (GObject *object,
438 GtkImage *image = GTK_IMAGE (object);
439 GtkImagePrivate *priv = image->priv;
444 g_value_set_object (value, _gtk_icon_helper_peek_pixbuf (priv->icon_helper));
447 g_value_set_string (value, priv->filename);
450 g_value_set_string (value, _gtk_icon_helper_get_stock_id (priv->icon_helper));
453 g_value_set_boxed (value, _gtk_icon_helper_peek_icon_set (priv->icon_helper));
456 g_value_set_int (value, _gtk_icon_helper_get_icon_size (priv->icon_helper));
458 case PROP_PIXEL_SIZE:
459 g_value_set_int (value, _gtk_icon_helper_get_pixel_size (priv->icon_helper));
461 case PROP_PIXBUF_ANIMATION:
462 g_value_set_object (value, _gtk_icon_helper_peek_animation (priv->icon_helper));
465 g_value_set_string (value, _gtk_icon_helper_get_icon_name (priv->icon_helper));
468 g_value_set_object (value, _gtk_icon_helper_peek_gicon (priv->icon_helper));
470 case PROP_USE_FALLBACK:
471 g_value_set_boolean (value, _gtk_icon_helper_get_use_fallback (priv->icon_helper));
473 case PROP_STORAGE_TYPE:
474 g_value_set_enum (value, _gtk_icon_helper_get_storage_type (priv->icon_helper));
477 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
484 * gtk_image_new_from_file:
485 * @filename: (type filename): a filename
487 * Creates a new #GtkImage displaying the file @filename. If the file
488 * isn't found or can't be loaded, the resulting #GtkImage will
489 * display a "broken image" icon. This function never returns %NULL,
490 * it always returns a valid #GtkImage widget.
492 * If the file contains an animation, the image will contain an
495 * If you need to detect failures to load the file, use
496 * gdk_pixbuf_new_from_file() to load the file yourself, then create
497 * the #GtkImage from the pixbuf. (Or for animations, use
498 * gdk_pixbuf_animation_new_from_file()).
500 * The storage type (gtk_image_get_storage_type()) of the returned
501 * image is not defined, it will be whatever is appropriate for
502 * displaying the file.
504 * Return value: a new #GtkImage
507 gtk_image_new_from_file (const gchar *filename)
511 image = g_object_new (GTK_TYPE_IMAGE, NULL);
513 gtk_image_set_from_file (image, filename);
515 return GTK_WIDGET (image);
519 * gtk_image_new_from_resource:
520 * @resource_path: a resource path
522 * Creates a new #GtkImage displaying the resource file @resource_path. If the file
523 * isn't found or can't be loaded, the resulting #GtkImage will
524 * display a "broken image" icon. This function never returns %NULL,
525 * it always returns a valid #GtkImage widget.
527 * If the file contains an animation, the image will contain an
530 * If you need to detect failures to load the file, use
531 * gdk_pixbuf_new_from_file() to load the file yourself, then create
532 * the #GtkImage from the pixbuf. (Or for animations, use
533 * gdk_pixbuf_animation_new_from_file()).
535 * The storage type (gtk_image_get_storage_type()) of the returned
536 * image is not defined, it will be whatever is appropriate for
537 * displaying the file.
539 * Return value: a new #GtkImage
544 gtk_image_new_from_resource (const gchar *resource_path)
548 image = g_object_new (GTK_TYPE_IMAGE, NULL);
550 gtk_image_set_from_resource (image, resource_path);
552 return GTK_WIDGET (image);
556 * gtk_image_new_from_pixbuf:
557 * @pixbuf: (allow-none): a #GdkPixbuf, or %NULL
559 * Creates a new #GtkImage displaying @pixbuf.
560 * The #GtkImage does not assume a reference to the
561 * pixbuf; you still need to unref it if you own references.
562 * #GtkImage will add its own reference rather than adopting yours.
564 * Note that this function just creates an #GtkImage from the pixbuf. The
565 * #GtkImage created will not react to state changes. Should you want that,
566 * you should use gtk_image_new_from_icon_set().
568 * Return value: a new #GtkImage
571 gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf)
575 image = g_object_new (GTK_TYPE_IMAGE, NULL);
577 gtk_image_set_from_pixbuf (image, pixbuf);
579 return GTK_WIDGET (image);
583 * gtk_image_new_from_stock:
584 * @stock_id: a stock icon name
585 * @size: (type int): a stock icon size
587 * Creates a #GtkImage displaying a stock icon. Sample stock icon
588 * names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
589 * are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock
590 * icon name isn't known, the image will be empty.
591 * You can register your own stock icon names, see
592 * gtk_icon_factory_add_default() and gtk_icon_factory_add().
594 * Return value: a new #GtkImage displaying the stock icon
597 gtk_image_new_from_stock (const gchar *stock_id,
602 image = g_object_new (GTK_TYPE_IMAGE, NULL);
604 gtk_image_set_from_stock (image, stock_id, size);
606 return GTK_WIDGET (image);
610 * gtk_image_new_from_icon_set:
611 * @icon_set: a #GtkIconSet
612 * @size: (type int): a stock icon size
614 * Creates a #GtkImage displaying an icon set. Sample stock sizes are
615 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
616 * this function, usually it's better to create a #GtkIconFactory, put
617 * your icon sets in the icon factory, add the icon factory to the
618 * list of default factories with gtk_icon_factory_add_default(), and
619 * then use gtk_image_new_from_stock(). This will allow themes to
620 * override the icon you ship with your application.
622 * The #GtkImage does not assume a reference to the
623 * icon set; you still need to unref it if you own references.
624 * #GtkImage will add its own reference rather than adopting yours.
626 * Return value: a new #GtkImage
629 gtk_image_new_from_icon_set (GtkIconSet *icon_set,
634 image = g_object_new (GTK_TYPE_IMAGE, NULL);
636 gtk_image_set_from_icon_set (image, icon_set, size);
638 return GTK_WIDGET (image);
642 * gtk_image_new_from_animation:
643 * @animation: an animation
645 * Creates a #GtkImage displaying the given animation.
646 * The #GtkImage does not assume a reference to the
647 * animation; you still need to unref it if you own references.
648 * #GtkImage will add its own reference rather than adopting yours.
650 * Note that the animation frames are shown using a timeout with
651 * #G_PRIORITY_DEFAULT. When using animations to indicate busyness,
652 * keep in mind that the animation will only be shown if the main loop
653 * is not busy with something that has a higher priority.
655 * Return value: a new #GtkImage widget
658 gtk_image_new_from_animation (GdkPixbufAnimation *animation)
662 g_return_val_if_fail (GDK_IS_PIXBUF_ANIMATION (animation), NULL);
664 image = g_object_new (GTK_TYPE_IMAGE, NULL);
666 gtk_image_set_from_animation (image, animation);
668 return GTK_WIDGET (image);
672 * gtk_image_new_from_icon_name:
673 * @icon_name: an icon name
674 * @size: (type int): a stock icon size
676 * Creates a #GtkImage displaying an icon from the current icon theme.
677 * If the icon name isn't known, a "broken image" icon will be
678 * displayed instead. If the current icon theme is changed, the icon
679 * will be updated appropriately.
681 * Return value: a new #GtkImage displaying the themed icon
686 gtk_image_new_from_icon_name (const gchar *icon_name,
691 image = g_object_new (GTK_TYPE_IMAGE, NULL);
693 gtk_image_set_from_icon_name (image, icon_name, size);
695 return GTK_WIDGET (image);
699 * gtk_image_new_from_gicon:
701 * @size: (type int): a stock icon size
703 * Creates a #GtkImage displaying an icon from the current icon theme.
704 * If the icon name isn't known, a "broken image" icon will be
705 * displayed instead. If the current icon theme is changed, the icon
706 * will be updated appropriately.
708 * Return value: a new #GtkImage displaying the themed icon
713 gtk_image_new_from_gicon (GIcon *icon,
718 image = g_object_new (GTK_TYPE_IMAGE, NULL);
720 gtk_image_set_from_gicon (image, icon, size);
722 return GTK_WIDGET (image);
726 * gtk_image_set_from_file:
727 * @image: a #GtkImage
728 * @filename: (type filename) (allow-none): a filename or %NULL
730 * See gtk_image_new_from_file() for details.
733 gtk_image_set_from_file (GtkImage *image,
734 const gchar *filename)
736 GtkImagePrivate *priv;
737 GdkPixbufAnimation *anim;
739 g_return_if_fail (GTK_IS_IMAGE (image));
743 g_object_freeze_notify (G_OBJECT (image));
745 gtk_image_clear (image);
747 if (filename == NULL)
749 priv->filename = NULL;
750 g_object_thaw_notify (G_OBJECT (image));
754 anim = gdk_pixbuf_animation_new_from_file (filename, NULL);
758 gtk_image_set_from_stock (image,
759 GTK_STOCK_MISSING_IMAGE,
761 g_object_thaw_notify (G_OBJECT (image));
765 /* We could just unconditionally set_from_animation,
766 * but it's nicer for memory if we toss the animation
767 * if it's just a single pixbuf
770 if (gdk_pixbuf_animation_is_static_image (anim))
771 gtk_image_set_from_pixbuf (image,
772 gdk_pixbuf_animation_get_static_image (anim));
774 gtk_image_set_from_animation (image, anim);
776 g_object_unref (anim);
778 priv->filename = g_strdup (filename);
780 g_object_thaw_notify (G_OBJECT (image));
784 * gtk_image_set_from_resource:
785 * @image: a #GtkImage
786 * @resource_path: (allow-none): a resource path or %NULL
788 * See gtk_image_new_from_resource() for details.
791 gtk_image_set_from_resource (GtkImage *image,
792 const gchar *resource_path)
794 GdkPixbuf *pixbuf = NULL;
795 GInputStream *stream;
797 g_return_if_fail (GTK_IS_IMAGE (image));
799 g_object_freeze_notify (G_OBJECT (image));
801 gtk_image_clear (image);
803 if (resource_path == NULL)
805 g_object_thaw_notify (G_OBJECT (image));
809 stream = g_resources_open_stream (resource_path, 0, NULL);
812 pixbuf = gdk_pixbuf_new_from_stream (stream, NULL, NULL);
813 g_object_unref (stream);
818 gtk_image_set_from_stock (image,
819 GTK_STOCK_MISSING_IMAGE,
821 g_object_thaw_notify (G_OBJECT (image));
825 gtk_image_set_from_pixbuf (image, pixbuf);
827 g_object_unref (pixbuf);
829 g_object_thaw_notify (G_OBJECT (image));
834 * gtk_image_set_from_pixbuf:
835 * @image: a #GtkImage
836 * @pixbuf: (allow-none): a #GdkPixbuf or %NULL
838 * See gtk_image_new_from_pixbuf() for details.
841 gtk_image_set_from_pixbuf (GtkImage *image,
844 GtkImagePrivate *priv;
846 g_return_if_fail (GTK_IS_IMAGE (image));
847 g_return_if_fail (pixbuf == NULL ||
848 GDK_IS_PIXBUF (pixbuf));
852 g_object_freeze_notify (G_OBJECT (image));
854 gtk_image_clear (image);
857 _gtk_icon_helper_set_pixbuf (priv->icon_helper, pixbuf);
859 g_object_notify (G_OBJECT (image), "pixbuf");
861 g_object_thaw_notify (G_OBJECT (image));
865 * gtk_image_set_from_stock:
866 * @image: a #GtkImage
867 * @stock_id: a stock icon name
868 * @size: (type int): a stock icon size
870 * See gtk_image_new_from_stock() for details.
873 gtk_image_set_from_stock (GtkImage *image,
874 const gchar *stock_id,
877 GtkImagePrivate *priv;
880 g_return_if_fail (GTK_IS_IMAGE (image));
884 g_object_freeze_notify (G_OBJECT (image));
886 new_id = g_strdup (stock_id);
887 gtk_image_clear (image);
891 _gtk_icon_helper_set_stock_id (priv->icon_helper, new_id, size);
895 g_object_notify (G_OBJECT (image), "stock");
896 g_object_notify (G_OBJECT (image), "icon-size");
898 g_object_thaw_notify (G_OBJECT (image));
902 * gtk_image_set_from_icon_set:
903 * @image: a #GtkImage
904 * @icon_set: a #GtkIconSet
905 * @size: (type int): a stock icon size
907 * See gtk_image_new_from_icon_set() for details.
910 gtk_image_set_from_icon_set (GtkImage *image,
911 GtkIconSet *icon_set,
914 GtkImagePrivate *priv;
916 g_return_if_fail (GTK_IS_IMAGE (image));
920 g_object_freeze_notify (G_OBJECT (image));
923 gtk_icon_set_ref (icon_set);
925 gtk_image_clear (image);
929 _gtk_icon_helper_set_icon_set (priv->icon_helper, icon_set, size);
930 gtk_icon_set_unref (icon_set);
933 g_object_notify (G_OBJECT (image), "icon-set");
934 g_object_notify (G_OBJECT (image), "icon-size");
936 g_object_thaw_notify (G_OBJECT (image));
940 * gtk_image_set_from_animation:
941 * @image: a #GtkImage
942 * @animation: the #GdkPixbufAnimation
944 * Causes the #GtkImage to display the given animation (or display
945 * nothing, if you set the animation to %NULL).
948 gtk_image_set_from_animation (GtkImage *image,
949 GdkPixbufAnimation *animation)
951 GtkImagePrivate *priv;
953 g_return_if_fail (GTK_IS_IMAGE (image));
954 g_return_if_fail (animation == NULL ||
955 GDK_IS_PIXBUF_ANIMATION (animation));
959 g_object_freeze_notify (G_OBJECT (image));
962 g_object_ref (animation);
964 gtk_image_clear (image);
966 if (animation != NULL)
968 _gtk_icon_helper_set_animation (priv->icon_helper, animation);
969 g_object_unref (animation);
972 g_object_notify (G_OBJECT (image), "pixbuf-animation");
974 g_object_thaw_notify (G_OBJECT (image));
978 * gtk_image_set_from_icon_name:
979 * @image: a #GtkImage
980 * @icon_name: an icon name
981 * @size: (type int): an icon size
983 * See gtk_image_new_from_icon_name() for details.
988 gtk_image_set_from_icon_name (GtkImage *image,
989 const gchar *icon_name,
992 GtkImagePrivate *priv;
995 g_return_if_fail (GTK_IS_IMAGE (image));
999 g_object_freeze_notify (G_OBJECT (image));
1001 new_name = g_strdup (icon_name);
1002 gtk_image_clear (image);
1006 _gtk_icon_helper_set_icon_name (priv->icon_helper, new_name, size);
1010 g_object_notify (G_OBJECT (image), "icon-name");
1011 g_object_notify (G_OBJECT (image), "icon-size");
1013 g_object_thaw_notify (G_OBJECT (image));
1017 * gtk_image_set_from_gicon:
1018 * @image: a #GtkImage
1020 * @size: (type int): an icon size
1022 * See gtk_image_new_from_gicon() for details.
1027 gtk_image_set_from_gicon (GtkImage *image,
1031 GtkImagePrivate *priv;
1033 g_return_if_fail (GTK_IS_IMAGE (image));
1037 g_object_freeze_notify (G_OBJECT (image));
1040 g_object_ref (icon);
1042 gtk_image_clear (image);
1046 _gtk_icon_helper_set_gicon (priv->icon_helper, icon, size);
1047 g_object_unref (icon);
1050 g_object_notify (G_OBJECT (image), "gicon");
1051 g_object_notify (G_OBJECT (image), "icon-size");
1053 g_object_thaw_notify (G_OBJECT (image));
1057 * gtk_image_get_storage_type:
1058 * @image: a #GtkImage
1060 * Gets the type of representation being used by the #GtkImage
1061 * to store image data. If the #GtkImage has no image data,
1062 * the return value will be %GTK_IMAGE_EMPTY.
1064 * Return value: image representation being used
1067 gtk_image_get_storage_type (GtkImage *image)
1069 g_return_val_if_fail (GTK_IS_IMAGE (image), GTK_IMAGE_EMPTY);
1071 return _gtk_icon_helper_get_storage_type (image->priv->icon_helper);
1075 * gtk_image_get_pixbuf:
1076 * @image: a #GtkImage
1078 * Gets the #GdkPixbuf being displayed by the #GtkImage.
1079 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1080 * %GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
1081 * The caller of this function does not own a reference to the
1084 * Return value: (transfer none): the displayed pixbuf, or %NULL if
1085 * the image is empty
1088 gtk_image_get_pixbuf (GtkImage *image)
1090 g_return_val_if_fail (GTK_IS_IMAGE (image), NULL);
1092 return _gtk_icon_helper_peek_pixbuf (image->priv->icon_helper);
1096 * gtk_image_get_stock:
1097 * @image: a #GtkImage
1098 * @stock_id: (out) (transfer none) (allow-none): place to store a
1099 * stock icon name, or %NULL
1100 * @size: (out) (allow-none) (type int): place to store a stock icon
1103 * Gets the stock icon name and size being displayed by the #GtkImage.
1104 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1105 * %GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
1106 * The returned string is owned by the #GtkImage and should not
1110 gtk_image_get_stock (GtkImage *image,
1114 GtkImagePrivate *priv;
1116 g_return_if_fail (GTK_IS_IMAGE (image));
1121 *stock_id = (gchar *) _gtk_icon_helper_get_stock_id (priv->icon_helper);
1124 *size = _gtk_icon_helper_get_icon_size (priv->icon_helper);
1128 * gtk_image_get_icon_set:
1129 * @image: a #GtkImage
1130 * @icon_set: (out) (transfer none) (allow-none): location to store a
1131 * #GtkIconSet, or %NULL
1132 * @size: (out) (allow-none) (type int): location to store a stock
1133 * icon size, or %NULL
1135 * Gets the icon set and size being displayed by the #GtkImage.
1136 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1137 * %GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
1140 gtk_image_get_icon_set (GtkImage *image,
1141 GtkIconSet **icon_set,
1144 GtkImagePrivate *priv;
1146 g_return_if_fail (GTK_IS_IMAGE (image));
1151 *icon_set = _gtk_icon_helper_peek_icon_set (priv->icon_helper);
1154 *size = _gtk_icon_helper_get_icon_size (priv->icon_helper);
1158 * gtk_image_get_animation:
1159 * @image: a #GtkImage
1161 * Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
1162 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1163 * %GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
1164 * The caller of this function does not own a reference to the
1165 * returned animation.
1167 * Return value: (transfer none): the displayed animation, or %NULL if
1168 * the image is empty
1171 gtk_image_get_animation (GtkImage *image)
1173 GtkImagePrivate *priv;
1175 g_return_val_if_fail (GTK_IS_IMAGE (image), NULL);
1179 return _gtk_icon_helper_peek_animation (priv->icon_helper);
1183 * gtk_image_get_icon_name:
1184 * @image: a #GtkImage
1185 * @icon_name: (out) (transfer none) (allow-none): place to store an
1186 * icon name, or %NULL
1187 * @size: (out) (allow-none) (type int): place to store an icon size,
1190 * Gets the icon name and size being displayed by the #GtkImage.
1191 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1192 * %GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
1193 * The returned string is owned by the #GtkImage and should not
1199 gtk_image_get_icon_name (GtkImage *image,
1200 const gchar **icon_name,
1203 GtkImagePrivate *priv;
1205 g_return_if_fail (GTK_IS_IMAGE (image));
1210 *icon_name = _gtk_icon_helper_get_icon_name (priv->icon_helper);
1213 *size = _gtk_icon_helper_get_icon_size (priv->icon_helper);
1217 * gtk_image_get_gicon:
1218 * @image: a #GtkImage
1219 * @gicon: (out) (transfer none) (allow-none): place to store a
1221 * @size: (out) (allow-none) (type int): place to store an icon size,
1224 * Gets the #GIcon and size being displayed by the #GtkImage.
1225 * The storage type of the image must be %GTK_IMAGE_EMPTY or
1226 * %GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
1227 * The caller of this function does not own a reference to the
1233 gtk_image_get_gicon (GtkImage *image,
1237 GtkImagePrivate *priv;
1239 g_return_if_fail (GTK_IS_IMAGE (image));
1244 *gicon = _gtk_icon_helper_peek_gicon (priv->icon_helper);
1247 *size = _gtk_icon_helper_get_icon_size (priv->icon_helper);
1253 * Creates a new empty #GtkImage widget.
1255 * Return value: a newly created #GtkImage widget.
1258 gtk_image_new (void)
1260 return g_object_new (GTK_TYPE_IMAGE, NULL);
1264 gtk_image_reset_anim_iter (GtkImage *image)
1266 GtkImagePrivate *priv = image->priv;
1268 if (gtk_image_get_storage_type (image) == GTK_IMAGE_ANIMATION)
1270 /* Reset the animation */
1271 if (priv->animation_timeout)
1273 g_source_remove (priv->animation_timeout);
1274 priv->animation_timeout = 0;
1277 g_clear_object (&priv->animation_iter);
1282 gtk_image_unmap (GtkWidget *widget)
1284 gtk_image_reset_anim_iter (GTK_IMAGE (widget));
1286 GTK_WIDGET_CLASS (gtk_image_parent_class)->unmap (widget);
1290 gtk_image_unrealize (GtkWidget *widget)
1292 gtk_image_reset_anim_iter (GTK_IMAGE (widget));
1294 GTK_WIDGET_CLASS (gtk_image_parent_class)->unrealize (widget);
1298 animation_timeout (gpointer data)
1300 GtkImage *image = GTK_IMAGE (data);
1301 GtkImagePrivate *priv = image->priv;
1304 priv->animation_timeout = 0;
1306 gdk_pixbuf_animation_iter_advance (priv->animation_iter, NULL);
1308 delay = gdk_pixbuf_animation_iter_get_delay_time (priv->animation_iter);
1311 GtkWidget *widget = GTK_WIDGET (image);
1313 priv->animation_timeout =
1314 gdk_threads_add_timeout (delay, animation_timeout, image);
1316 gtk_widget_queue_draw (widget);
1323 get_animation_frame (GtkImage *image)
1325 GtkImagePrivate *priv = image->priv;
1327 if (priv->animation_iter == NULL)
1331 priv->animation_iter =
1332 gdk_pixbuf_animation_get_iter (_gtk_icon_helper_peek_animation (priv->icon_helper), NULL);
1334 delay = gdk_pixbuf_animation_iter_get_delay_time (priv->animation_iter);
1336 priv->animation_timeout =
1337 gdk_threads_add_timeout (delay, animation_timeout, image);
1340 /* don't advance the anim iter here, or we could get frame changes between two
1341 * exposes of different areas.
1343 return g_object_ref (gdk_pixbuf_animation_iter_get_pixbuf (priv->animation_iter));
1347 gtk_image_get_preferred_size (GtkImage *image,
1351 GtkImagePrivate *priv = image->priv;
1354 GtkStyleContext *context;
1356 context = gtk_widget_get_style_context (GTK_WIDGET (image));
1357 _gtk_icon_helper_get_size (priv->icon_helper, context, &width, &height);
1358 _gtk_misc_get_padding_and_border (GTK_MISC (image), &border);
1360 width += border.left + border.right;
1361 height += border.top + border.bottom;
1366 *height_out = height;
1370 gtk_image_draw (GtkWidget *widget,
1374 GtkImagePrivate *priv;
1376 GtkStyleContext *context;
1377 gint x, y, width, height;
1378 gfloat xalign, yalign;
1381 g_return_val_if_fail (GTK_IS_IMAGE (widget), FALSE);
1383 image = GTK_IMAGE (widget);
1384 misc = GTK_MISC (image);
1387 context = gtk_widget_get_style_context (widget);
1389 gtk_render_background (context, cr,
1391 gtk_widget_get_allocated_width (widget), gtk_widget_get_allocated_height (widget));
1392 gtk_render_frame (context, cr,
1394 gtk_widget_get_allocated_width (widget), gtk_widget_get_allocated_height (widget));
1396 gtk_misc_get_alignment (misc, &xalign, &yalign);
1397 gtk_image_get_preferred_size (image, &width, &height);
1398 _gtk_misc_get_padding_and_border (misc, &border);
1400 if (gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
1401 xalign = 1.0 - xalign;
1403 x = floor ((gtk_widget_get_allocated_width (widget) - width) * xalign) + border.left;
1404 y = floor ((gtk_widget_get_allocated_height (widget) - height) * yalign) + border.top;
1406 if (gtk_image_get_storage_type (image) == GTK_IMAGE_ANIMATION)
1408 GdkPixbuf *pixbuf = get_animation_frame (image);
1409 gtk_render_icon (context, cr,
1412 g_object_unref (pixbuf);
1416 _gtk_icon_helper_draw (priv->icon_helper,
1425 gtk_image_reset (GtkImage *image)
1427 GtkImagePrivate *priv = image->priv;
1428 GtkImageType storage_type;
1430 g_object_freeze_notify (G_OBJECT (image));
1431 storage_type = gtk_image_get_storage_type (image);
1433 if (storage_type != GTK_IMAGE_EMPTY)
1434 g_object_notify (G_OBJECT (image), "storage-type");
1436 g_object_notify (G_OBJECT (image), "icon-size");
1438 switch (storage_type)
1440 case GTK_IMAGE_PIXBUF:
1441 g_object_notify (G_OBJECT (image), "pixbuf");
1443 case GTK_IMAGE_STOCK:
1444 g_object_notify (G_OBJECT (image), "stock");
1446 case GTK_IMAGE_ICON_SET:
1447 g_object_notify (G_OBJECT (image), "icon-set");
1449 case GTK_IMAGE_ANIMATION:
1450 gtk_image_reset_anim_iter (image);
1451 g_object_notify (G_OBJECT (image), "pixbuf-animation");
1453 case GTK_IMAGE_ICON_NAME:
1454 g_object_notify (G_OBJECT (image), "icon-name");
1456 case GTK_IMAGE_GICON:
1457 g_object_notify (G_OBJECT (image), "gicon");
1459 case GTK_IMAGE_EMPTY:
1466 g_free (priv->filename);
1467 priv->filename = NULL;
1468 g_object_notify (G_OBJECT (image), "file");
1471 _gtk_icon_helper_clear (priv->icon_helper);
1473 g_object_thaw_notify (G_OBJECT (image));
1478 * @image: a #GtkImage
1480 * Resets the image to be empty.
1485 gtk_image_clear (GtkImage *image)
1487 gtk_image_reset (image);
1489 if (gtk_widget_get_visible (GTK_WIDGET (image)))
1490 gtk_widget_queue_resize (GTK_WIDGET (image));
1494 gtk_image_get_preferred_width (GtkWidget *widget,
1500 gtk_image_get_preferred_size (GTK_IMAGE (widget), &width, NULL);
1501 *minimum = *natural = width;
1505 gtk_image_get_preferred_height (GtkWidget *widget,
1511 gtk_image_get_preferred_size (GTK_IMAGE (widget), NULL, &height);
1512 *minimum = *natural = height;
1516 icon_theme_changed (GtkImage *image)
1518 GtkImagePrivate *priv = image->priv;
1520 _gtk_icon_helper_invalidate (priv->icon_helper);
1521 gtk_widget_queue_draw (GTK_WIDGET (image));
1525 gtk_image_style_updated (GtkWidget *widget)
1527 GTK_WIDGET_CLASS (gtk_image_parent_class)->style_updated (widget);
1529 icon_theme_changed (GTK_IMAGE (widget));
1533 gtk_image_screen_changed (GtkWidget *widget,
1534 GdkScreen *prev_screen)
1538 image = GTK_IMAGE (widget);
1540 if (GTK_WIDGET_CLASS (gtk_image_parent_class)->screen_changed)
1541 GTK_WIDGET_CLASS (gtk_image_parent_class)->screen_changed (widget, prev_screen);
1543 icon_theme_changed (image);
1547 _gtk_image_gicon_data_clear (GtkImageGIconData *data)
1551 g_object_unref (data->pixbuf);
1552 data->pixbuf = NULL;
1556 g_object_unref (data->icon);
1562 * gtk_image_set_pixel_size:
1563 * @image: a #GtkImage
1564 * @pixel_size: the new pixel size
1566 * Sets the pixel size to use for named icons. If the pixel size is set
1567 * to a value != -1, it is used instead of the icon size set by
1568 * gtk_image_set_from_icon_name().
1573 gtk_image_set_pixel_size (GtkImage *image,
1576 GtkImagePrivate *priv;
1577 gint old_pixel_size;
1579 g_return_if_fail (GTK_IS_IMAGE (image));
1582 old_pixel_size = gtk_image_get_pixel_size (image);
1584 if (pixel_size != old_pixel_size)
1586 _gtk_icon_helper_set_pixel_size (priv->icon_helper, pixel_size);
1588 if (gtk_widget_get_visible (GTK_WIDGET (image)))
1589 gtk_widget_queue_resize (GTK_WIDGET (image));
1591 g_object_notify (G_OBJECT (image), "pixel-size");
1596 * gtk_image_get_pixel_size:
1597 * @image: a #GtkImage
1599 * Gets the pixel size used for named icons.
1601 * Returns: the pixel size used for named icons.
1606 gtk_image_get_pixel_size (GtkImage *image)
1608 g_return_val_if_fail (GTK_IS_IMAGE (image), -1);
1610 return _gtk_icon_helper_get_pixel_size (image->priv->icon_helper);