GtkImage

typedef struct _GtkImage GtkImage;

This struct contain private data only and should be accessed by the functions below.

enum GtkImageType

typedef enum
{
  GTK_IMAGE_EMPTY,
  GTK_IMAGE_PIXMAP,
  GTK_IMAGE_IMAGE,
  GTK_IMAGE_PIXBUF,
  GTK_IMAGE_STOCK,
  GTK_IMAGE_ICON_SET,
  GTK_IMAGE_ANIMATION,
  GTK_IMAGE_ICON_NAME
} GtkImageType;

Describes the image data representation used by a GtkImage. If you want to get the image from the widget, you can only get the currently-stored representation. e.g. if the gtk_image_get_storage_type() returns GTK_IMAGE_PIXBUF, then you can call gtk_image_get_pixbuf() but not gtk_image_get_stock(). For empty images, you can request any storage type (call any of the "get" functions), but they will all return NULL values.

gtk_image_get_icon_set ()

void                gtk_image_get_icon_set              (GtkImage *image,
                                                         GtkIconSet **icon_set,
                                                         GtkIconSize *size);

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

gtk_image_get_image ()

void                gtk_image_get_image                 (GtkImage *image,
                                                         GdkImage **gdk_image,
                                                         GdkBitmap **mask);

Gets the GdkImage and mask being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_IMAGE (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned image and mask.

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.

gtk_image_get_pixmap ()

void                gtk_image_get_pixmap                (GtkImage *image,
                                                         GdkPixmap **pixmap,
                                                         GdkBitmap **mask);

Gets the pixmap and mask being displayed by the GtkImage. The storage type of the image must be GTK_IMAGE_EMPTY or GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()). The caller of this function does not own a reference to the returned pixmap and mask.

gtk_image_get_stock ()

void                gtk_image_get_stock                 (GtkImage *image,
                                                         gchar **stock_id,
                                                         GtkIconSize *size);

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.

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.

gtk_image_get_icon_name ()

void                gtk_image_get_icon_name             (GtkImage *image,
                                                         G_CONST_RETURN gchar **icon_name,
                                                         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

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.

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

GtkWidget*          gtk_image_new_from_icon_set         (GtkIconSet *icon_set,
                                                         GtkIconSize size);

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.

gtk_image_new_from_image ()

GtkWidget*          gtk_image_new_from_image            (GdkImage *image,
                                                         GdkBitmap *mask);

Creates a GtkImage widget displaying a image with a mask. A GdkImage is a client-side image buffer in the pixel format of the current display. The GtkImage does not assume a reference to the image or mask; you still need to unref them if you own references. GtkImage will add its own reference rather than adopting yours.

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

gtk_image_new_from_pixmap ()

GtkWidget*          gtk_image_new_from_pixmap           (GdkPixmap *pixmap,
                                                         GdkBitmap *mask);

Creates a GtkImage widget displaying pixmap with a mask. A GdkPixmap is a server-side image buffer in the pixel format of the current display. The GtkImage does not assume a reference to the pixmap or mask; you still need to unref them if you own references. GtkImage will add its own reference rather than adopting yours.

gtk_image_new_from_stock ()

GtkWidget*          gtk_image_new_from_stock            (const gchar *stock_id,
                                                         GtkIconSize size);

Creates a GtkImage displaying a stock icon. Sample stock icon names are GTK_STOCK_OPEN, GTK_STOCK_QUIT. 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().

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.

Since 2.6

gtk_image_set_from_file ()

void                gtk_image_set_from_file             (GtkImage *image,
                                                         const gchar *filename);

See gtk_image_new_from_file() for details.

gtk_image_set_from_icon_set ()

void                gtk_image_set_from_icon_set         (GtkImage *image,
                                                         GtkIconSet *icon_set,
                                                         GtkIconSize size);

See gtk_image_new_from_icon_set() for details.

gtk_image_set_from_image ()

void                gtk_image_set_from_image            (GtkImage *image,
                                                         GdkImage *gdk_image,
                                                         GdkBitmap *mask);

See gtk_image_new_from_image() for details.

gtk_image_set_from_pixbuf ()

void                gtk_image_set_from_pixbuf           (GtkImage *image,
                                                         GdkPixbuf *pixbuf);

See gtk_image_new_from_pixbuf() for details.

gtk_image_set_from_pixmap ()

void                gtk_image_set_from_pixmap           (GtkImage *image,
                                                         GdkPixmap *pixmap,
                                                         GdkBitmap *mask);

See gtk_image_new_from_pixmap() for details.

gtk_image_set_from_stock ()

void                gtk_image_set_from_stock            (GtkImage *image,
                                                         const gchar *stock_id,
                                                         GtkIconSize size);

See gtk_image_new_from_stock() for details.

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

void                gtk_image_set_from_icon_name        (GtkImage *image,
                                                         const gchar *icon_name,
                                                         GtkIconSize size);

See gtk_image_new_from_icon_name() for details.

Since 2.6

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.

gtk_image_set ()

void                gtk_image_set                       (GtkImage *image,
                                                         GdkImage *val,
                                                         GdkBitmap *mask);

Sets the GtkImage.

gtk_image_get ()

void                gtk_image_get                       (GtkImage *image,
                                                         GdkImage **val,
                                                         GdkBitmap **mask);

Gets the GtkImage.

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.

Since 2.6

The "file" property

  "file"                     gchararray            : Read / Write

Filename to load and display.

Default value: NULL

The "icon-name" property

  "icon-name"                gchararray            : Read / Write

The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.

Default value: NULL

Since 2.6

The "icon-set" property

  "icon-set"                 GtkIconSet            : Read / Write

Icon set to display.

The "icon-size" property

  "icon-size"                gint                  : Read / Write

Symbolic size to use for stock icon, icon set or named icon.

Allowed values: >= 0

Default value: 4

The "image" property

  "image"                    GdkImage              : Read / Write

A GdkImage to display.

The "mask" property

  "mask"                     GdkPixmap             : Read / Write

Mask bitmap to use with GdkImage or GdkPixmap.

The "pixbuf" property

  "pixbuf"                   GdkPixbuf             : Read / Write

A GdkPixbuf to display.

The "pixbuf-animation" property

  "pixbuf-animation"         GdkPixbufAnimation    : Read / Write

GdkPixbufAnimation to display.

The "pixel-size" property

  "pixel-size"               gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "pixmap" property

  "pixmap"                   GdkPixmap             : Read / Write

A GdkPixmap to display.

The "stock" property

  "stock"                    gchararray            : Read / Write

Stock ID for a stock image to display.

Default value: NULL

The "storage-type" property

  "storage-type"             GtkImageType          : Read

The representation being used for image data.

Default value: GTK_IMAGE_EMPTY