gtk.image

Module for [Image] class

Types 3

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.Image.newFromFile], 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 [gdkpixbuf.pixbuf.Pixbuf.newFromFile], then create the #GtkImage with [gtk.image.Image.newFromPixbuf].

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.

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;
 }

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 [gdkpixbuf.pixbuf.Pixbuf.newFromInline].

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.

Methods
GType _gType() @property
Image self()Returns `this`, for use in `with` statements.
ImageGidBuilder builder()Get builder for [gtk.image.Image] Returns: New builder object
string file() @property
void file(string propval) @property
gio.icon.Icon gicon() @propertyGet `gicon` property. Returns: The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically.
void gicon(gio.icon.Icon propval) @propertySet `gicon` property. Params: propval = The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically.
string iconName() @propertyGet `iconName` property. Returns: The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.
void iconName(string propval) @propertySet `iconName` property. Params: propval = The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.
void iconSet(gtk.icon_set.IconSet propval) @property
int iconSize() @property
void iconSize(int propval) @property
void pixbuf(gdkpixbuf.pixbuf.Pixbuf propval) @property
int pixelSize() @propertyGet `pixelSize` property. Returns: The "pixel-size" property can be used to specify a fixed size overriding the #GtkImage:icon-size property for images of type [gtk.types.ImageType.IconName].
void pixelSize(int propval) @propertySet `pixelSize` property. Params: propval = The "pixel-size" property can be used to specify a fixed size overriding the #GtkImage:icon-size property for images of type [gtk.types.ImageType.IconName].
string resource() @propertyGet `resource` property. Returns: A path to a resource file to display.
void resource(string propval) @propertySet `resource` property. Params: propval = A path to a resource file to display.
string stock() @property
void stock(string propval) @property
void surface(cairo.surface.Surface propval) @property
bool useFallback() @propertyGet `useFallback` property. Returns: 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.types.Imag...
void useFallback(bool propval) @propertySet `useFallback` property. Params: propval = 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.t...
gtk.image.Image newFromAnimation(gdkpixbuf.pixbuf_animation.PixbufAnimation 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 referenc...
gtk.image.Image newFromFile(string 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 nul...
gtk.image.Image newFromGicon(gio.icon.Icon icon, gtk.types.IconSize 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 i...
gtk.image.Image newFromIconName(string iconName, gtk.types.IconSize 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 i...
gtk.image.Image newFromIconSet(gtk.icon_set.IconSet iconSet, gtk.types.IconSize size)Creates a #GtkImage displaying an icon set. Sample stock sizes are #GTKICONSIZEMENU, #GTKICONSIZESMALLTOOLBAR. Instead of using this function, usually it’s better to create a #GtkIconFactory, put...
gtk.image.Image newFromPixbuf(gdkpixbuf.pixbuf.Pixbuf pixbuf = 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 tha...
gtk.image.Image newFromResource(string resourcePath)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 nev...
gtk.image.Image newFromStock(string stockId, gtk.types.IconSize size)Creates a #GtkImage displaying a stock icon. Sample stock icon names are #GTKSTOCKOPEN, #GTKSTOCKQUIT. Sample stock sizes are #GTKICONSIZEMENU, #GTKICONSIZESMALLTOOLBAR. If the stock icon name isn...
gtk.image.Image newFromSurface(cairo.surface.Surface surface = null)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 t...
void clear()Resets the image to be empty.
gdkpixbuf.pixbuf_animation.PixbufAnimation getAnimation()Gets the #GdkPixbufAnimation being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.Animation] (see [gtk.image.Image.getStorageT...
void getGicon(out gio.icon.Icon gicon, out gtk.types.IconSize size)Gets the #GIcon and size being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.Gicon] (see [gtk.image.Image.getStorageType]). T...
void getIconName(out string iconName, out gtk.types.IconSize size)Gets the icon name and size being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.IconName] (see [gtk.image.Image.getStorageTyp...
void getIconSet(out gtk.icon_set.IconSet iconSet, out gtk.types.IconSize size)Gets the icon set and size being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.IconSet] (see [gtk.image.Image.getStorageType]).
gdkpixbuf.pixbuf.Pixbuf getPixbuf()Gets the #GdkPixbuf being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.Pixbuf] (see [gtk.image.Image.getStorageType]). The c...
int getPixelSize()Gets the pixel size used for named icons. Returns: the pixel size used for named icons.
void getStock(out string stockId, out gtk.types.IconSize size)Gets the stock icon name and size being displayed by the #GtkImage. The storage type of the image must be [gtk.types.ImageType.Empty] or [gtk.types.ImageType.Stock] (see [gtk.image.Image.getStorage...
gtk.types.ImageType getStorageType()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.types.ImageType.Empty]. Returns: image representat...
void setFromAnimation(gdkpixbuf.pixbuf_animation.PixbufAnimation animation)Causes the #GtkImage to display the given animation (or display nothing, if you set the animation to null).
void setFromFile(string filename = null)See [gtk.image.Image.newFromFile] for details.
void setFromGicon(gio.icon.Icon icon, gtk.types.IconSize size)See [gtk.image.Image.newFromGicon] for details.
void setFromIconName(string iconName, gtk.types.IconSize size)See [gtk.image.Image.newFromIconName] for details.
void setFromIconSet(gtk.icon_set.IconSet iconSet, gtk.types.IconSize size)See [gtk.image.Image.newFromIconSet] for details.
void setFromPixbuf(gdkpixbuf.pixbuf.Pixbuf pixbuf = null)See [gtk.image.Image.newFromPixbuf] for details.
void setFromResource(string resourcePath = null)See [gtk.image.Image.newFromResource] for details.
void setFromStock(string stockId, gtk.types.IconSize size)See [gtk.image.Image.newFromStock] for details.
void setFromSurface(cairo.surface.Surface surface = null)See [gtk.image.Image.newFromSurface] for details.
void setPixelSize(int pixelSize)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.Image.setFromIconName].
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new empty #GtkImage widget. Returns: a newly created #GtkImage widget.
Methods
T file(string propval)
T gicon(gio.icon.Icon propval)Set `gicon` property. Params: propval = The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically. Returns: Builder instance for f...
T iconName(string propval)Set `iconName` property. Params: propval = The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically. Returns: Builder instance for fluent chaining
T iconSize(int propval)
T pixelSize(int propval)Set `pixelSize` property. Params: propval = The "pixel-size" property can be used to specify a fixed size overriding the #GtkImage:icon-size property for images of type [gtk.types.ImageType.IconNam...
T resource(string propval)Set `resource` property. Params: propval = A path to a resource file to display. Returns: Builder instance for fluent chaining
T stock(string propval)
T useFallback(bool propval)Set `useFallback` property. Params: propval = 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.t...

Fluent builder for [gtk.image.Image]

Methods