Image

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.

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().

class Image : Misc {

protected

GtkImage* gtkImage;

GtkImage* getImageStruct();

void* getStruct();

this(GtkImage* gtkImage);

void setStruct(GObject* obj);

this(StockID stockID, GtkIconSize size);

void getIconSet(IconSet iconSet, GtkIconSize size);

Pixbuf getPixbuf();

void getStock(string stockId, GtkIconSize size);

PixbufAnimation getAnimation();

void getIconName(string iconName, GtkIconSize size);

void getGicon(IconIF gicon, GtkIconSize size);

GtkImageType getStorageType();

this(string filename);

this(IconSet iconSet, GtkIconSize size);

this(Pixbuf pixbuf);

this(PixbufAnimation animation);

this(string iconName, GtkIconSize size);

this(IconIF icon, GtkIconSize size);

void setFromFile(string filename);

void setFromIconSet(IconSet iconSet, GtkIconSize size);

void setFromPixbuf(Pixbuf pixbuf);

void setFromStock(string stockId, GtkIconSize size);

void setFromAnimation(PixbufAnimation animation);

void setFromIconName(string iconName, GtkIconSize size);

void setFromGicon(IconIF icon, GtkIconSize size);

void setFromResource(string resourcePath);

void clear();

this();

void setPixelSize(int pixelSize);

int getPixelSize();

}

Constructors

this this(GtkImage* gtkImage): Sets our main struct and passes it to the parent class
this this(StockID stockID, GtkIconSize size): Creates a GtkImage displaying a stock icon. Sample stock icon names are GTK_STOCK_OPEN, GTK_STOCK_EXIT. Sample stock sizes are GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_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_icon_factory_add_default() and gtk_icon_factory_add().
this this(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 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.
this this(IconSet iconSet, GtkIconSize size): Warning gtk_image_new_from_icon_set has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_image_new_from_icon_name() instead. Creates a GtkImage 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 GtkIconFactory, put your icon sets in the icon factory, add the icon factory to the list of default factories with gtk_icon_factory_add_default(), and then use gtk_image_new_from_stock(). This will allow themes to override the icon you ship with your application. The GtkImage does not assume a reference to the icon set; you still need to unref it if you own references. GtkImage will add its own reference rather than adopting yours.
this this(Pixbuf 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().
this this(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 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.
this this(string iconName, 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. Since 2.6
this this(IconIF 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. Since 2.14
this this(): Creates a new empty GtkImage widget.

Members

Functions

clear void clear(): Resets the image to be empty. Since 2.8
getAnimation PixbufAnimation getAnimation(): 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.
getGicon void getGicon(IconIF gicon, GtkIconSize size): Gets the GIcon and size being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_GICON (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned GIcon. Since 2.14
getIconName void getIconName(string iconName, GtkIconSize size): Gets the icon name and size being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()). The returned string is owned by the GtkImage and should not be freed. Since 2.6
getIconSet void getIconSet(IconSet iconSet, GtkIconSize size): Warning gtk_image_get_icon_set has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_image_get_icon_name() instead. Gets the icon set and size being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
getImageStruct GtkImage* getImageStruct(): Get the main Gtk struct
getPixbuf Pixbuf getPixbuf(): 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.
getPixelSize int getPixelSize(): Gets the pixel size used for named icons. Since 2.6
getStock void getStock(string stockId, GtkIconSize size): Warning gtk_image_get_stock has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_image_get_icon_name() instead. Gets the stock icon name and size being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_STOCK (see gtk_image_get_storage_type()). The returned string is owned by the GtkImage and should not be freed.
getStorageType GtkImageType 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_IMAGE_EMPTY.
getStruct void* getStruct(): the main Gtk struct as a void*
setFromAnimation void setFromAnimation(PixbufAnimation animation): Causes the GtkImage to display the given animation (or display nothing, if you set the animation to NULL).
setFromFile void setFromFile(string filename): See gtk_image_new_from_file() for details.
setFromGicon void setFromGicon(IconIF icon, GtkIconSize size): See gtk_image_new_from_gicon() for details. Since 2.14
setFromIconName void setFromIconName(string iconName, GtkIconSize size): See gtk_image_new_from_icon_name() for details. Since 2.6
setFromIconSet void setFromIconSet(IconSet iconSet, GtkIconSize size): Warning gtk_image_set_from_icon_set has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_image_set_from_icon_name() instead. See gtk_image_new_from_icon_set() for details.
setFromPixbuf void setFromPixbuf(Pixbuf pixbuf): See gtk_image_new_from_pixbuf() for details.
setFromResource void setFromResource(string resourcePath): See gtk_image_new_from_resource() for details.
setFromStock void setFromStock(string stockId, GtkIconSize size): Warning gtk_image_set_from_stock has been deprecated since version 3.10 and should not be used in newly-written code. Use gtk_image_set_from_icon_name() instead. See gtk_image_new_from_stock() 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 gtk_image_set_from_icon_name(). Since 2.6
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

gtkImage GtkImage* gtkImage;: the main Gtk struct

Inherited Members

From Misc

gtkMisc GtkMisc* gtkMisc;: the main Gtk struct
getMiscStruct GtkMisc* getMiscStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
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.
getAlignment void getAlignment(float xalign, float yalign): Gets the X and Y alignment of the widget within its allocation. See gtk_misc_set_alignment().
getPadding void getPadding(int xpad, int ypad): Gets the padding in the X and Y directions of the widget. See gtk_misc_set_padding().