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
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_get_icon_set ()
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 ()
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 ()
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 ()
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 ()
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 ()
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_storage_type ()
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 ()
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 ()
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 ()
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 ()
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.
gtk_image_new_from_stock ()
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().
gtk_image_new_from_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.
gtk_image_set_from_stock ()
See gtk_image_new_from_stock for details.
gtk_image_set_from_animation ()
Causes the GtkImage to display the given animation (or display
nothing, if you set the animation to NULL).
gtk_image_new ()
Warning |
gtk_image_new is deprecated and should not be used in newly-written code. |
Creates the new GtkImage using the value and the mask.
gtk_image_set ()
Warning |
gtk_image_set is deprecated and should not be used in newly-written code. |
Sets the GtkImage
gtk_image_get ()
Warning |
gtk_image_get is deprecated and should not be used in newly-written code. |
Gets the GtkImage