GtkImage: GTK+ 2 Reference Manual

## GtkImage GtkImage |

## Functions

void | gtk_image_get_icon_set ()
void | gtk_image_get_image ()
GdkPixbuf * | gtk_image_get_pixbuf ()
void | gtk_image_get_pixmap ()
void | gtk_image_get_stock ()
GdkPixbufAnimation * | gtk_image_get_animation ()
void | gtk_image_get_icon_name ()
void | gtk_image_get_gicon ()
GtkImageType | gtk_image_get_storage_type ()
GtkWidget * | gtk_image_new_from_icon_set ()
GtkWidget * | gtk_image_new_from_image ()
GtkWidget * | gtk_image_new_from_pixbuf ()
GtkWidget * | gtk_image_new_from_pixmap ()
GtkWidget * | gtk_image_new_from_stock ()
GtkWidget * | gtk_image_new_from_animation ()
GtkWidget * | gtk_image_new_from_icon_name ()
GtkWidget * | gtk_image_new_from_gicon ()
void | gtk_image_set_from_icon_set ()
void | gtk_image_set_from_image ()
void | gtk_image_set_from_pixbuf ()
void | gtk_image_set_from_pixmap ()
void | gtk_image_set_from_stock ()
void | gtk_image_set_from_animation ()
void | gtk_image_set_from_icon_name ()
void | gtk_image_set_from_gicon ()
void | gtk_image_clear ()
GtkWidget * | gtk_image_new ()
void | gtk_image_set ()
void | gtk_image_get ()
void | gtk_image_set_pixel_size ()
gint | gtk_image_get_pixel_size ()

## Properties

gchar * | file | Read / Write
GIcon * | gicon | Read / Write
gchar * | icon-name | Read / Write
GtkIconSet * | icon-set | Read / Write
gint | icon-size | Read / Write
GdkImage * | image | Read / Write
GdkPixmap * | mask | Read / Write
GdkPixbuf * | pixbuf | Read / Write
GdkPixbufAnimation * | pixbuf-animation | Read / Write
gint | pixel-size | Read / Write
GdkPixmap * | pixmap | Read / Write
gchar * | stock | Read / Write
GtkImageType | storage-type | Read

## Types and Values

struct | GtkImage
enum | GtkImageType
#define | gtk_image_new_from_file
#define | gtk_image_set_from_file

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkWidget
                    ╰── GtkMisc
                        ╰── GtkImage

## Implemented Interfaces

GtkImage implements AtkImplementorIface and GtkBuildable.

## Includes

    #include <gtk/gtk.h>

## Description

## Functions

### gtk_image_get_icon_set ()

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

### gtk_image_get_image ()

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

### gtk_image_get_pixbuf ()

    GdkPixbuf *
    gtk_image_get_pixbuf (GtkImage *image);

### gtk_image_get_pixmap ()

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

### gtk_image_get_stock ()

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

### gtk_image_get_animation ()

    GdkPixbufAnimation *
    gtk_image_get_animation (GtkImage *image);

### gtk_image_get_icon_name ()

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

Since: 2.6

### gtk_image_get_gicon ()

    void
    gtk_image_get_gicon (GtkImage *image,
                         GIcon **gicon,
                         GtkIconSize *size);

Since: 2.14

### gtk_image_get_storage_type ()

    GtkImageType
    gtk_image_get_storage_type (GtkImage *image);

### gtk_image_new_from_icon_set ()

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

### gtk_image_new_from_image ()

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

### gtk_image_new_from_pixbuf ()

    GtkWidget *
    gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf);

### gtk_image_new_from_pixmap ()

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

### gtk_image_new_from_stock ()

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

### gtk_image_new_from_animation ()

    GtkWidget *
    gtk_image_new_from_animation (GdkPixbufAnimation *animation);

### gtk_image_new_from_icon_name ()

    GtkWidget *
    gtk_image_new_from_icon_name (const gchar *icon_name,
                                  GtkIconSize size);

Since: 2.6

### gtk_image_new_from_gicon ()

    GtkWidget *
    gtk_image_new_from_gicon (GIcon *icon,
                              GtkIconSize size);

Since: 2.14

### gtk_image_set_from_icon_set ()

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

### gtk_image_set_from_image ()

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

### gtk_image_set_from_pixbuf ()

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

### gtk_image_set_from_pixmap ()

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

### gtk_image_set_from_stock ()

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

### gtk_image_set_from_animation ()

    void
    gtk_image_set_from_animation (GtkImage *image,
                                  GdkPixbufAnimation *animation);

### gtk_image_set_from_icon_name ()

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

Since: 2.6

### gtk_image_set_from_gicon ()

    void
    gtk_image_set_from_gicon (GtkImage *image,
                              GIcon *icon,
                              GtkIconSize size);

Since: 2.14

### gtk_image_clear ()

    void
    gtk_image_clear (GtkImage *image);

Since: 2.8

### gtk_image_new ()

    GtkWidget *
    gtk_image_new (void);

### gtk_image_set ()

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

`gtk_image_set` has been deprecated since version 2.0 and should not be used in newly-written code.

Use `gtk_image_set_from_image()` instead.

### gtk_image_get ()

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

`gtk_image_get` has been deprecated since version 2.0 and should not be used in newly-written code.

Use `gtk_image_get_image()` instead.

### gtk_image_set_pixel_size ()

    void
    gtk_image_set_pixel_size (GtkImage *image,
                              gint pixel_size);

Since: 2.6

### gtk_image_get_pixel_size ()

    gint
    gtk_image_get_pixel_size (GtkImage *image);

Since: 2.6

## Types and Values

### struct GtkImage

    struct GtkImage;

### enum GtkImageType

#### Members

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 |  |
GTK_IMAGE_GICON |  |

### gtk_image_new_from_file

    #define gtk_image_new_from_file gtk_image_new_from_file_utf8

### gtk_image_set_from_file

    #define gtk_image_set_from_file gtk_image_set_from_file_utf8

## Property Details

### The `“file”` property

      “file”                     gchar *

Filename to load and display.

Flags: Read / Write

Default value: NULL

### The `“gicon”` property

      “gicon”                    GIcon *

The GIcon being displayed.

Flags: Read / Write

Since: 2.14

### The `“icon-name”` property

      “icon-name”                gchar *

The name of the icon from the icon theme.

Flags: Read / Write

Default value: NULL

Since: 2.6

### The `“icon-set”` property

      “icon-set”                 GtkIconSet *

Icon set to display.

Flags: Read / Write

### The `“icon-size”` property

      “icon-size”                gint

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

Flags: Read / Write

Allowed values: >= 0

Default value: 4

### The `“image”` property

      “image”                    GdkImage *

A GdkImage to display.

Flags: Read / Write

### The `“mask”` property

      “mask”                     GdkPixmap *

Mask bitmap to use with GdkImage or GdkPixmap.

Flags: Read / Write

### The `“pixbuf”` property

      “pixbuf”                   GdkPixbuf *

A GdkPixbuf to display.

Flags: Read / Write

### The `“pixbuf-animation”` property

      “pixbuf-animation”         GdkPixbufAnimation *

GdkPixbufAnimation to display.

Flags: Read / Write

### The `“pixel-size”` property

      “pixel-size”               gint

Pixel size to use for named icon.

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 2.6

### The `“pixmap”` property

      “pixmap”                   GdkPixmap *

A GdkPixmap to display.

Flags: Read / Write

### The `“stock”` property

      “stock”                    gchar *

Stock ID for a stock image to display.

Flags: Read / Write

Default value: NULL

### The `“storage-type”` property

      “storage-type”             GtkImageType

The representation being used for image data.

Flags: Read

Default value: GTK_IMAGE_EMPTY