GtkImage

Name

GtkImage -- A widget displaying a graphical image

Synopsis


#include <gtk/gtk.h>


struct      GtkImage;
enum        GtkImageType;
void        gtk_image_get_icon_set          (GtkImage *image,
                                             GtkIconSet **icon_set,
                                             GtkIconSize *size);
void        gtk_image_get_image             (GtkImage *image,
                                             GdkImage **gdk_image,
                                             GdkBitmap **mask);
GdkPixbuf*  gtk_image_get_pixbuf            (GtkImage *image);
void        gtk_image_get_pixmap            (GtkImage *image,
                                             GdkPixmap **pixmap,
                                             GdkBitmap **mask);
void        gtk_image_get_stock             (GtkImage *image,
                                             gchar **stock_id,
                                             GtkIconSize *size);
GdkPixbufAnimation* gtk_image_get_animation (GtkImage *image);
GtkImageType gtk_image_get_storage_type     (GtkImage *image);
GtkWidget*  gtk_image_new_from_file         (const gchar *filename);
GtkWidget*  gtk_image_new_from_icon_set     (GtkIconSet *icon_set,
                                             GtkIconSize size);
GtkWidget*  gtk_image_new_from_image        (GdkImage *image,
                                             GdkBitmap *mask);
GtkWidget*  gtk_image_new_from_pixbuf       (GdkPixbuf *pixbuf);
GtkWidget*  gtk_image_new_from_pixmap       (GdkPixmap *pixmap,
                                             GdkBitmap *mask);
GtkWidget*  gtk_image_new_from_stock        (const gchar *stock_id,
                                             GtkIconSize size);
GtkWidget*  gtk_image_new_from_animation    (GdkPixbufAnimation *animation);
void        gtk_image_set_from_file         (GtkImage *image,
                                             const gchar *filename);
void        gtk_image_set_from_icon_set     (GtkImage *image,
                                             GtkIconSet *icon_set,
                                             GtkIconSize size);
void        gtk_image_set_from_image        (GtkImage *image,
                                             GdkImage *gdk_image,
                                             GdkBitmap *mask);
void        gtk_image_set_from_pixbuf       (GtkImage *image,
                                             GdkPixbuf *pixbuf);
void        gtk_image_set_from_pixmap       (GtkImage *image,
                                             GdkPixmap *pixmap,
                                             GdkBitmap *mask);
void        gtk_image_set_from_stock        (GtkImage *image,
                                             const gchar *stock_id,
                                             GtkIconSize size);
void        gtk_image_set_from_animation    (GtkImage *image,
                                             GdkPixbufAnimation *animation);
GtkWidget*  gtk_image_new                   (void);
void        gtk_image_set                   (GtkImage *image,
                                             GdkImage *val,
                                             GdkBitmap *mask);
void        gtk_image_get                   (GtkImage *image,
                                             GdkImage **val,
                                             GdkBitmap **mask);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkMisc
                     +----GtkImage

Properties


  "pixbuf"               GdkPixbuf            : Read / Write
  "pixmap"               GdkPixmap            : Read / Write
  "image"                GdkImage             : Read / Write
  "mask"                 GdkPixmap            : Read / Write
  "file"                 gchararray           : Write
  "stock"                gchararray           : Read / Write
  "icon-set"             GtkIconSet           : Read / Write
  "icon-size"            gint                 : Read / Write
  "pixbuf-animation"     GdkPixbufAnimation   : Read / Write
  "storage-type"         GtkImageType         : Read

Description

The GtkImage widget displays a graphical image. The image is typically created using gdk_image_new.

The pixels in a GtkImage may be manipulated by the application after creation, as GtkImage store the pixel data on the client side. If you wish to store the pixel data on the server side (thus not allowing manipulation of the data after creation) you should use GtkPixmap.

Details

struct GtkImage

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

Describes the representation stored 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_EMPTYthere is no image displayed by the widget
GTK_IMAGE_PIXMAPthe widget contains a GdkPixmap
GTK_IMAGE_IMAGEthe widget contains a GdkImage
GTK_IMAGE_PIXBUFthe widget contains a GdkPixbuf
GTK_IMAGE_STOCKthe widget contains a stock icon name
GTK_IMAGE_ICON_SETthe widget contains a GtkIconSet
GTK_IMAGE_ANIMATION 


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

image : a GtkImage
icon_set : location to store a GtkIconSet
size : location to store a stock icon size


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.

image : a GtkImage
gdk_image : return location for a GtkImage
mask : return location for a GdkBitmap


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.

image : a GtkImage
Returns : the displayed pixbuf, or NULL if the image is empty


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.

image : a GtkImage
pixmap : location to store the pixmap, or NULL
mask : location to store the mask, or NULL


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.

image : a GtkImage
stock_id : place to store a stock icon name
size : place to store a stock icon size


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.

image : a GtkImage
Returns : the displayed animation, or NULL if the image is empty


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.

image : a GtkImage
Returns : image representation being used


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.

filename : a filename
Returns : a new GtkImage


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.

icon_set : a GtkIconSet
size : a stock icon size
Returns : a new GtkImage


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.

image : a GdkImage, or NULL
mask : a GdkBitmap, or NULL
Returns : a new GtkImage


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

pixbuf : a GdkPixbuf, or NULL
Returns : a new GtkImage


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 GdkImage 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.

pixmap : a GdkPixmap, or NULL
mask : a GdkBitmap, or NULL
Returns : a new GtkImage


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_EXIT. Sample stock sizes are GTK_ICON_SIZE_MENU, GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock icon name isn't known, a "broken image" icon will be displayed instead. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add().

stock_id : a stock icon name
size : a stock icon size
Returns : a new GtkImage displaying the stock icon


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.

animation : an animation
Returns : a new GtkImage widget


gtk_image_set_from_file ()

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

See gtk_image_new_from_file() for details.

image : a GtkImage
filename : a filename or NULL


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.

image : a GtkImage
icon_set : a GtkIconSet
size : a stock icon size


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.

image : a GtkImage
gdk_image : a GdkImage or NULL
mask : a GdkBitmap or NULL


gtk_image_set_from_pixbuf ()

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

See gtk_image_new_from_pixbuf() for details.

image : a GtkImage
pixbuf : a GdkPixbuf or NULL


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.

image : a GtkImage
pixmap : a GdkPixmap or NULL
mask : a GdkBitmap or NULL


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.

image : a GtkImage
stock_id : a stock icon name
size : a stock icon size


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

image : a GtkImage
animation : the GdkPixbufAnimation


gtk_image_new ()

GtkWidget*  gtk_image_new                   (void);

Creates a new empty GtkImage widget.

Creates the new GtkImage using the value and the mask.

Returns : a newly created GtkImage widget.


gtk_image_set ()

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

Warning

gtk_image_set is deprecated and should not be used in newly-written code.

Sets the GtkImage

image :a GdkPixmap
val : 
mask :a GDKBitmap that indicates which parts of the image should be transparent.


gtk_image_get ()

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

Warning

gtk_image_get is deprecated and should not be used in newly-written code.

Gets the GtkImage

image :a GdkPixmap
val : 
mask :a GDKBitmap that indicates which parts of the image should be transparent.

Properties

"pixbuf" (GdkPixbuf : Read / Write)

"pixmap" (GdkPixmap : Read / Write)

"image" (GdkImage : Read / Write)

"mask" (GdkPixmap : Read / Write)

"file" (gchararray : Write)

"stock" (gchararray : Read / Write)

"icon-set" (GtkIconSet : Read / Write)

"icon-size" (gint : Read / Write)

"pixbuf-animation" (GdkPixbufAnimation : Read / Write)

"storage-type" (GtkImageType : Read)

See Also

GtkPixmap, GdkRgb