gtk2/docs/reference/gtk/tmpl/gtkimage.sgml
Havoc Pennington 9df0074685 add default icon
2001-08-28  Havoc Pennington  <hp@pobox.com>

	* demos/gtk-demo/main.c (setup_default_icon): add default icon

	* gtk/gtkradiobutton.c (gtk_radio_button_new_with_mnemonic):
	warning fix
	(gtk_radio_button_new_with_label): warning fix

	* gtk/gtkdnd.c: used some random GtkImage private structs,
	update to reflect GtkImage changes

	* gdk/x11/gdkwindow-x11.c (gdk_window_set_icon_list): don't check
	whether the hint is supported, just always set the icon. A task
	list might want to use it even if the WM doesn't, and the WM may
	change over time. Also, XDeleteProperty() if list == NULL.

	* gtk/gtkwindow.c (gtk_window_set_icon_list)
	(gtk_window_get_icon_list)
	(gtk_window_set_icon)
	(gtk_window_get_icon)
	(gtk_window_set_default_icon_list)
	(gtk_window_get_default_icon_list):
	new functions

	* gtk/gtk-boxed.defs (GtkIconSet): add GtkIconSet

	* gtk/gtkimage.c: Implement property support, bug #59408

	* gtk/gtkcontainer.c (gtk_container_add): make the warning message
	on reparent-without-removing-first a bit more helpful.
	Let's just destroy this FAQ.
2001-08-29 02:20:02 +00:00

331 lines
4.8 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkImage
<!-- ##### SECTION Short_Description ##### -->
A widget displaying a graphical image
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkPixmap, #GdkRgb
</para>
<!-- ##### STRUCT GtkImage ##### -->
<para>
This struct contain private data only and should be accessed by the functions
below.
</para>
<!-- ##### 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:
<!-- ##### 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:
<!-- ##### FUNCTION gtk_image_get_animation ##### -->
<para>
</para>
@image:
@Returns:
<!-- ##### 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:
<!-- ##### FUNCTION gtk_image_new_from_animation ##### -->
<para>
</para>
@animation:
@Returns:
<!-- ##### 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:
<!-- ##### FUNCTION gtk_image_set_from_animation ##### -->
<para>
</para>
@image:
@animation:
<!-- ##### FUNCTION gtk_image_new ##### -->
<para>
Creates the new GtkImage using the value and the mask.
</para>
@Returns: the GtkImage
<!-- # Unused Parameters # -->
@val:
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
<!-- ##### FUNCTION gtk_image_set ##### -->
<para>
Sets the GtkImage
</para>
@image: a #GdkPixmap
@val:
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
<!-- ##### FUNCTION gtk_image_get ##### -->
<para>
Gets the GtkImage
</para>
@image: a #GdkPixmap
@val:
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
<!-- ##### 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>