1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GtkImage
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
1999-09-20 15:46:35 +00:00
|
|
|
A widget displaying a graphical image
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
The #GtkImage widget displays a graphical image. The image is typically created
|
|
|
|
using gdk_image_new.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
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.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
#GtkPixmap, #GdkRgb
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GtkImage ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
This struct contain private data only and should be accessed by the functions
|
|
|
|
below.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2001-05-07 15:58:47 +00:00
|
|
|
<!-- ##### ENUM GtkImageType ##### -->
|
|
|
|
<para>
|
|
|
|
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.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@GTK_IMAGE_EMPTY: there is no image displayed by the widget
|
|
|
|
@GTK_IMAGE_PIXMAP: the widget contains a #GdkPixmap
|
|
|
|
@GTK_IMAGE_IMAGE: the widget contains a #GdkImage
|
|
|
|
@GTK_IMAGE_PIXBUF: the widget contains a #GdkPixbuf
|
|
|
|
@GTK_IMAGE_STOCK: the widget contains a stock icon name
|
|
|
|
@GTK_IMAGE_ICON_SET: the widget contains a #GtkIconSet
|
|
|
|
@GTK_IMAGE_ANIMATION:
|
|
|
|
|
2000-11-04 16:31:37 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_get_icon_set ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@icon_set:
|
|
|
|
@size:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_get_image ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@gdk_image:
|
|
|
|
@mask:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_get_pixbuf ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_get_pixmap ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@pixmap:
|
|
|
|
@mask:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_get_stock ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@stock_id:
|
|
|
|
@size:
|
|
|
|
|
|
|
|
|
2001-05-11 17:13:44 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_get_animation ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-11-04 16:31:37 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_get_storage_type ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_file ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@filename:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_icon_set ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@icon_set:
|
|
|
|
@size:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_image ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@mask:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_pixbuf ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pixbuf:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_pixmap ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@pixmap:
|
|
|
|
@mask:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_stock ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@stock_id:
|
|
|
|
@size:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-05-11 17:13:44 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_new_from_animation ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@animation:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-11-04 16:31:37 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_file ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@filename:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_icon_set ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@icon_set:
|
|
|
|
@size:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_image ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@gdk_image:
|
|
|
|
@mask:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_pixbuf ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@pixbuf:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_pixmap ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@pixmap:
|
|
|
|
@mask:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_stock ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@stock_id:
|
|
|
|
@size:
|
|
|
|
|
|
|
|
|
2001-05-11 17:13:44 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_set_from_animation ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@image:
|
|
|
|
@animation:
|
|
|
|
|
|
|
|
|
1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### FUNCTION gtk_image_new ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
Creates the new GtkImage using the value and the mask.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
2001-08-26 02:03:10 +00:00
|
|
|
@Returns: the GtkImage
|
|
|
|
<!-- # Unused Parameters # -->
|
1999-08-16 18:51:52 +00:00
|
|
|
@val:
|
1999-09-20 15:46:35 +00:00
|
|
|
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_set ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
Sets the GtkImage
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
1999-09-20 15:46:35 +00:00
|
|
|
@image: a #GdkPixmap
|
1999-08-16 18:51:52 +00:00
|
|
|
@val:
|
1999-09-20 15:46:35 +00:00
|
|
|
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_image_get ##### -->
|
|
|
|
<para>
|
1999-09-20 15:46:35 +00:00
|
|
|
Gets the GtkImage
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
1999-09-25 09:20:23 +00:00
|
|
|
@image: a #GdkPixmap
|
1999-08-16 18:51:52 +00:00
|
|
|
@val:
|
1999-09-20 15:46:35 +00:00
|
|
|
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
2001-08-29 02:20:02 +00:00
|
|
|
<!-- ##### ARG GtkImage:pixbuf ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:pixmap ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:image ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:mask ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:file ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:stock ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:icon-set ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:icon-size ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:pixbuf-animation ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG GtkImage:storage-type ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|