Image

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_image_get_type ()" ) ]
public class Image : Widget, Accessible, Buildable, ConstraintTarget

The Image widget displays an image.

Various kinds of object can be displayed as an image; most typically, you would load a Texture from a file, and then display that. There’s a convenience function to do this, Image.from_file, used as follows:

  GtkWidget *image;
  image = gtk_image_new_from_file ("myfile.png");

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 from_file, then create the Image with Image.from_paintable.

Sometimes an application will want to avoid depending on external data files, such as image files. See the documentation of Resource for details. In this case, the resource, Image.from_resource and set_from_resource should be used.

CSS nodes

GtkImage has a single CSS node with the name image. The style classes .normal-icons or .large-icons may appear, depending on the icon_size property.

Accessibility

GtkImage uses the IMG role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public string file { owned get; set; }
public Icon gicon { owned get; set; }
The GIcon displayed in the GtkImage.
public string icon_name { owned get; set; }
The name of the icon in the icon theme.
public IconSize icon_size { get; set; }
public Paintable paintable { owned get; set; }
public int pixel_size { get; set; }
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.
public string resource { owned get; set; }
A path to a resource file to display.
public ImageType storage_type { get; }
public bool use_fallback { get; set; }
Whether the icon displayed in the GtkImage will use standard icon names fallback.

Creation methods:

public Image ()
Creates a new empty Image widget.
public Image.from_file (string filename)
Creates a new Image displaying the file filename.
public Image.from_gicon (Icon icon)
Creates a Image displaying an icon from the current icon theme.
public Image.from_icon_name (string? icon_name)
Creates a Image displaying an icon from the current icon theme.
public Image.from_paintable (Paintable? paintable)
Creates a new Image displaying paintable.
public Image.from_pixbuf (Pixbuf? pixbuf)
Creates a new Image displaying pixbuf.
public Image.from_resource (string resource_path)
Creates a new Image displaying the resource file resource_path.

Methods:

public void clear ()
Resets the image to be empty.
public unowned Icon? get_gicon ()
Gets the Icon and size being displayed by the Image.
public unowned string? get_icon_name ()
Gets the icon name and size being displayed by the Image .
public IconSize get_icon_size ()
Gets the icon size used by the this when rendering icons.
public unowned Paintable? get_paintable ()
Gets the image Paintable being displayed by the Image.
public int get_pixel_size ()
Gets the pixel size used for named icons.
public ImageType get_storage_type ()
Gets the type of representation being used by the Image to store image data.
public void set_from_file (string? filename)
See Image.from_file for details.
public void set_from_gicon (Icon icon)
See Image.from_gicon for details.
public void set_from_icon_name (string? icon_name)
See Image.from_icon_name for details.
public void set_from_paintable (Paintable? paintable)
See Image.from_paintable for details.
public void set_from_pixbuf (Pixbuf? pixbuf)
See Image.from_pixbuf for details.
public void set_from_resource (string? resource_path)
See Image.from_resource for details.
public void set_icon_size (IconSize icon_size)
Suggests an icon size to the theme for named icons.
public void set_pixel_size (int pixel_size)
Sets the pixel size to use for named icons.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable