Image

The gtk.Image widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a gdk.Pixbuf ("pixel buffer") from a file, and then display that. There’s a convenience function to do this, Image.newFromFile, used as follows:

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

f 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 Pixbuf.newFromFile, then create the gtk.Image with Image.newFromPixbuf.

The image file may contain an animation, if so the gtk.Image will display an animation (gdkpixbuf.PixbufAnimation) instead of a static image.

gtk.Image is a subclass of gtk.Misc, which implies that you can align it (center, left, right) and add padding to it, using gtk.Misc methods.

gtk.Image is a “no window” widget (has no gdk.Window 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 gtk.EventBox, then connect to the event signals on the event box.

Handling button press events on a gtk.Image

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 gtk.Misc). 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 gdk.Pixbuf using 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.

class Image : Misc {

protected

GtkImage* gtkImage;

GtkImage* getImageStruct(bool transferOwnership);

void* getStruct();

this(GtkImage* gtkImage, bool ownedRef);

this(StockID stockID, GtkIconSize size);

static GType getType();

this();

this(PixbufAnimation animation);

this(string filename);

this(IconIF icon, GtkIconSize size);

this(string iconName, GtkIconSize size);

this(IconSet iconSet, GtkIconSize size);

this(Pixbuf pixbuf);

this(Surface surface);

void clear();

PixbufAnimation getAnimation();

void getGicon(IconIF gicon, GtkIconSize size);

void getIconName(string iconName, GtkIconSize size);

void getIconSet(IconSet iconSet, GtkIconSize size);

Pixbuf getPixbuf();

int getPixelSize();

void getStock(string stockId, GtkIconSize size);

GtkImageType getStorageType();

void setFromAnimation(PixbufAnimation animation);

void setFromFile(string filename);

void setFromGicon(IconIF icon, GtkIconSize size);

void setFromIconName(string iconName, GtkIconSize size);

void setFromIconSet(IconSet iconSet, GtkIconSize size);

void setFromPixbuf(Pixbuf pixbuf);

void setFromResource(string resourcePath);

void setFromStock(string stockId, GtkIconSize size);

void setFromSurface(Surface surface);

void setPixelSize(int pixelSize);

}

Constructors

this this(GtkImage* gtkImage, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(StockID stockID, GtkIconSize size): Creates a Image displaying a stock icon. Sample stock icon names are StockID.OPEN, StockID.EXIT. Sample stock sizes are IconSize.MENU, IconSize.SMALL_TOOLBAR. If the stock icon name isn't known, the image will be empty. You can register your own stock icon names, see gtk.IconFactory.IconFactory.addDefault() and gtk.IconFactory.IconFactory.add().
this this(): Creates a new empty gtk.Image widget.
this this(PixbufAnimation animation): Creates a gtk.Image displaying the given animation. The gtk.Image does not assume a reference to the animation; you still need to unref it if you own references. gtk.Image will add its own reference rather than adopting yours.
this this(string filename): Creates a new gtk.Image displaying the file filename. If the file isn’t found or can’t be loaded, the resulting gtk.Image will display a “broken image” icon. This function never returns NULL, it always returns a valid gtk.Image widget.
this this(IconIF icon, GtkIconSize size): Creates a gtk.Image 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.
this this(string iconName, GtkIconSize size): Creates a gtk.Image 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.
this this(IconSet iconSet, GtkIconSize size): Creates a gtk.Image displaying an icon set. Sample stock sizes are GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_SMALL_TOOLBAR Instead of using this function, usually it’s better to create a gtk.IconFactory, put your icon sets in the icon factory, add the icon factory to the list of default factories with IconFactory.addDefault, and then use Image.newFromStock. This will allow themes to override the icon you ship with your application.
this this(Pixbuf pixbuf): Creates a new gtk.Image displaying pixbuf. The gtk.Image does not assume a reference to the pixbuf; you still need to unref it if you own references. gtk.Image will add its own reference rather than adopting yours.
this this(Surface surface): Creates a new gtk.Image displaying surface. The gtk.Image does not assume a reference to the surface; you still need to unref it if you own references. gtk.Image will add its own reference rather than adopting yours.

Members

Functions

clear void clear(): Resets the image to be empty.
getAnimation PixbufAnimation getAnimation(): Gets the gdkpixbuf.PixbufAnimation being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ANIMATION (see Image.getStorageType). The caller of this function does not own a reference to the returned animation.
getGicon void getGicon(IconIF gicon, GtkIconSize size): Gets the GIcon and size being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_GICON (see Image.getStorageType). The caller of this function does not own a reference to the returned GIcon
getIconName void getIconName(string iconName, GtkIconSize size): Gets the icon name and size being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_NAME (see Image.getStorageType). The returned string is owned by the gtk.Image and should not be freed.
getIconSet void getIconSet(IconSet iconSet, GtkIconSize size): Gets the icon set and size being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_SET (see Image.getStorageType).
getImageStruct GtkImage* getImageStruct(bool transferOwnership): Get the main Gtk struct
getPixbuf Pixbuf getPixbuf(): Gets the gdk.Pixbuf being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXBUF (see Image.getStorageType). The caller of this function does not own a reference to the returned pixbuf.
getPixelSize int getPixelSize(): Gets the pixel size used for named icons.
getStock void getStock(string stockId, GtkIconSize size): Gets the stock icon name and size being displayed by the gtk.Image The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_STOCK (see Image.getStorageType). The returned string is owned by the gtk.Image and should not be freed.
getStorageType GtkImageType getStorageType(): Gets the type of representation being used by the gtk.Image to store image data. If the gtk.Image has no image data, the return value will be GTK_IMAGE_EMPTY.
getStruct void* getStruct(): the main Gtk struct as a void*
setFromAnimation void setFromAnimation(PixbufAnimation animation): Causes the gtk.Image to display the given animation (or display nothing, if you set the animation to NULL).
setFromFile void setFromFile(string filename): See Image.newFromFile for details.
setFromGicon void setFromGicon(IconIF icon, GtkIconSize size): See Image.newFromGicon for details.
setFromIconName void setFromIconName(string iconName, GtkIconSize size): See Image.newFromIconName for details.
setFromIconSet void setFromIconSet(IconSet iconSet, GtkIconSize size): See Image.newFromIconSet for details.
setFromPixbuf void setFromPixbuf(Pixbuf pixbuf): See Image.newFromPixbuf for details.
setFromResource void setFromResource(string resourcePath): See Image.newFromResource for details.
setFromStock void setFromStock(string stockId, GtkIconSize size): See Image.newFromStock for details.
setFromSurface void setFromSurface(Surface surface): See Image.newFromSurface for details.
setPixelSize 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 Image.setFromIconName.

Static functions

getType GType getType()

Variables

gtkImage GtkImage* gtkImage;: the main Gtk struct

Inherited Members

From Misc

gtkMisc GtkMisc* gtkMisc;: the main Gtk struct
getMiscStruct GtkMisc* getMiscStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getAlignment void getAlignment(float xalign, float yalign): Gets the X and Y alignment of the widget within its allocation. See Misc.setAlignment.
getPadding void getPadding(int xpad, int ypad): Gets the padding in the X and Y directions of the widget. See Misc.setPadding.
setAlignment void setAlignment(float xalign, float yalign): Sets the alignment of the widget.
setPadding void setPadding(int xpad, int ypad): Sets the amount of space to add around the widget.

gtk Image classes

Image