Description
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:
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.
Handling button press events on a GtkImage.
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 “gdk-pixbuf-csource”. This library
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().
CSS nodes
GtkImage has a single CSS node with the name image. The style classes
may appear on image CSS nodes: .icon-dropshadow, .lowres-icon.
Functions
gtk_image_get_pixbuf ()
GdkPixbuf *
gtk_image_get_pixbuf (GtkImage *image);
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.
Returns
the displayed pixbuf, or NULL if
the image is empty.
[nullable][transfer none]
gtk_image_get_animation ()
GdkPixbufAnimation *
gtk_image_get_animation (GtkImage *image);
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.
Returns
the displayed animation, or NULL if
the image is empty.
[nullable][transfer none]
gtk_image_get_storage_type ()
GtkImageType
gtk_image_get_storage_type (GtkImage *image);
Gets the type of representation being used by the GtkImage
to store image data. If the GtkImage has no image data,
the return value will be GTK_IMAGE_EMPTY.
Returns
image representation being used
gtk_image_new_from_file ()
GtkWidget *
gtk_image_new_from_file (const gchar *filename);
Creates a new GtkImage displaying the file filename
. If the file
isn’t found or can’t be loaded, the resulting GtkImage will
display a “broken image” icon. This function never returns NULL,
it always returns a valid GtkImage widget.
If the file contains an animation, the image will contain an
animation.
If you need to detect failures to load the file, use
gdk_pixbuf_new_from_file() to load the file yourself, then create
the GtkImage from the pixbuf. (Or for animations, use
gdk_pixbuf_animation_new_from_file()).
The storage type (gtk_image_get_storage_type()) of the returned
image is not defined, it will be whatever is appropriate for
displaying the file.
gtk_image_new_from_pixbuf ()
GtkWidget *
gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf);
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_name().
gtk_image_new_from_animation ()
GtkWidget *
gtk_image_new_from_animation (GdkPixbufAnimation *animation);
Creates a GtkImage displaying the given animation.
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.
gtk_image_new_from_icon_name ()
GtkWidget *
gtk_image_new_from_icon_name (const gchar *icon_name,
GtkIconSize 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.
Returns
a new GtkImage displaying the themed icon
Since: 2.6
gtk_image_new_from_gicon ()
GtkWidget *
gtk_image_new_from_gicon (GIcon *icon,
GtkIconSize 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.
Returns
a new GtkImage displaying the themed icon
Since: 2.14
gtk_image_new_from_resource ()
GtkWidget *
gtk_image_new_from_resource (const gchar *resource_path);
Creates a new GtkImage displaying the resource file resource_path
. If the file
isn’t found or can’t be loaded, the resulting GtkImage will
display a “broken image” icon. This function never returns NULL,
it always returns a valid GtkImage widget.
If the file contains an animation, the image will contain an
animation.
If you need to detect failures to load the file, use
gdk_pixbuf_new_from_file() to load the file yourself, then create
the GtkImage from the pixbuf. (Or for animations, use
gdk_pixbuf_animation_new_from_file()).
The storage type (gtk_image_get_storage_type()) of the returned
image is not defined, it will be whatever is appropriate for
displaying the file.
Since: 3.4
gtk_image_new_from_surface ()
GtkWidget *
gtk_image_new_from_surface (cairo_surface_t *surface);
Creates a new GtkImage displaying surface
.
The GtkImage does not assume a reference to the
surface; you still need to unref it if you own references.
GtkImage will add its own reference rather than adopting yours.
Since: 3.10
gtk_image_set_from_animation ()
void
gtk_image_set_from_animation (GtkImage *image,
GdkPixbufAnimation *animation);
Causes the GtkImage to display the given animation (or display
nothing, if you set the animation to NULL).
gtk_image_clear ()
void
gtk_image_clear (GtkImage *image);
Resets the image to be empty.
Since: 2.8
gtk_image_new ()
GtkWidget *
gtk_image_new (void);
Creates a new empty GtkImage widget.
Returns
a newly created GtkImage widget.
gtk_image_set_pixel_size ()
void
gtk_image_set_pixel_size (GtkImage *image,
gint pixel_size);
Sets the pixel size to use for named icons. If the pixel size is set
to a value != -1, it is used instead of the icon size set by
gtk_image_set_from_icon_name().
Since: 2.6
gtk_image_get_pixel_size ()
gint
gtk_image_get_pixel_size (GtkImage *image);
Gets the pixel size used for named icons.
Returns
the pixel size used for named icons.
Since: 2.6
Property Details
The “file” property
“file” gchar *
Filename to load and display.
Owner: GtkImage
Flags: Read / Write
Default value: NULL
The “gicon” property
“gicon” GIcon *
The GIcon displayed in the GtkImage. For themed icons,
If the icon theme is changed, the image will be updated
automatically.
Owner: GtkImage
Flags: Read / Write
Since: 2.14
The “icon-name” property
“icon-name” gchar *
The name of the icon in the icon theme. If the icon theme is
changed, the image will be updated automatically.
Owner: GtkImage
Flags: Read / Write
Default value: NULL
Since: 2.6
The “icon-set” property
“icon-set” GtkIconSet *
Icon set to display.
GtkImage:icon-set has been deprecated since version 3.10 and should not be used in newly-written code.
Use “icon-name” instead.
Owner: GtkImage
Flags: Read / Write
The “icon-size” property
“icon-size” gint
Symbolic size to use for stock icon, icon set or named icon.
Owner: GtkImage
Flags: Read / Write
Allowed values: >= 0
Default value: 4
The “pixbuf” property
“pixbuf” GdkPixbuf *
A GdkPixbuf to display.
Owner: GtkImage
Flags: Read / Write
The “pixbuf-animation” property
“pixbuf-animation” GdkPixbufAnimation *
GdkPixbufAnimation to display.
Owner: GtkImage
Flags: Read / Write
The “pixel-size” property
“pixel-size” gint
The "pixel-size" property can be used to specify a fixed size
overriding the “icon-size” property for images of type
GTK_IMAGE_ICON_NAME.
Owner: GtkImage
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 2.6
The “resource” property
“resource” gchar *
A path to a resource file to display.
Owner: GtkImage
Flags: Read / Write
Default value: NULL
Since: 3.8
The “stock” property
“stock” gchar *
Stock ID for a stock image to display.
GtkImage:stock has been deprecated since version 3.10 and should not be used in newly-written code.
Use “icon-name” instead.
Owner: GtkImage
Flags: Read / Write
Default value: NULL
The “storage-type” property
“storage-type” GtkImageType
The representation being used for image data.
Owner: GtkImage
Flags: Read
Default value: GTK_IMAGE_EMPTY
The “surface” property
“surface” CairoSurface *
A cairo_surface_t to display.
Owner: GtkImage
Flags: Read / Write
The “use-fallback” property
“use-fallback” gboolean
Whether the icon displayed in the GtkImage will use
standard icon names fallback. The value of this property
is only relevant for images of type GTK_IMAGE_ICON_NAME
and GTK_IMAGE_GICON.
Owner: GtkImage
Flags: Read / Write
Default value: FALSE
Since: 3.0