gtk2/docs/reference/gtk/tmpl/gtkimage.sgml

331 lines
4.8 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkImage
<!-- ##### SECTION Short_Description ##### -->
A widget displaying a graphical image
1999-08-16 18:51:52 +00:00
<!-- ##### 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.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkPixmap, #GdkRgb
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### STRUCT GtkImage ##### -->
<para>
This struct contain private data only and should be accessed by the functions
below.
1999-08-16 18:51:52 +00:00
</para>
fix some shell typos 2001-05-04 Havoc Pennington <hp@redhat.com> * configure.in: fix some shell typos * gtk/gtkcolorsel.c (gtk_color_selection_destroy): warning fix * gtk/gtkimage.c: handle animations * gtk/gtkcheckbutton.c (gtk_check_button_size_request): request border_width * 2, not just border_width * gtk/gtkscale.c: add "format_value" signal to allow people to override the way values are drawn. (gtk_scale_get_value_size): fix width/height mistake, and compute size from actual displayed text, not from made-up text. * gtk/gtktexttag.c (gtk_text_tag_class_init): fix return type in signal registration * tests/testtext.c: Add "Remove all tags" menu item for testing * gtk/gtktextbuffer.c (gtk_text_buffer_remove_all_tags): implement * demos/gtk-demo/main.c (main): add hack so we can find modules without installing gtk * demos/gtk-demo/textview.c (insert_text): demo font scaling * gtk/gtkcellrenderertext.c: Add "scale" property (font scaling factor) (gtk_cell_renderer_text_set_property): remove some bogus g_object_notify * gtk/gtktexttag.c: add "scale" property which is a font scaling factor * gtk/gtktextlayout.c (add_text_attrs): add font scale attribute to layout * gtk/gtktextiter.c (gtk_text_iter_is_start): rename from gtk_text_iter_is_first 2001-05-04 Havoc Pennington <hp@redhat.com> * pixops/pixops.c (pixops_process): merge fix from stable: Patch from hoshem@mel.comcen.com.au to fix nonzero X offsets. Fixes bug #50371. * gdk-pixbuf/pixops/pixops.c (pixops_composite_nearest): merge from stable: Patch from OKADA Mitsuru <m-okada@fjb.co.jp> to fix confusion of using "src" instead of "p". (pixops_composite_color_nearest): Use a more accurate (and correct, to begin with) compositing method. This cures checks showing through on images with no alpha. * gdk-pixbuf.c (gdk_pixbuf_fill): fix bug that left some trailing bytes unfilled. * gdk-pixbuf-io.h: fix UpdatedNotifyFunc to use signed ints * gdk-pixbuf-loader.h (struct _GdkPixbufLoaderClass): Change area_updated signal to use signed ints. Removed animation-related signals. * io-gif.c, io-gif-animation.h, io-gif-animation.c: Massive rewrite action * gdk-pixbuf-animation.c: Add GdkPixbufAnimationIter to abstract all the pesky details. Remove old frame-based API. Make GdkPixbufAnimation an abstract base class, derived by the loaders.
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:
<!-- ##### 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:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_image_new ##### -->
<para>
Creates the new GtkImage using the value and the mask.
1999-08-16 18:51:52 +00:00
</para>
@Returns: the GtkImage
<!-- # Unused Parameters # -->
1999-08-16 18:51:52 +00:00
@val:
@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>
Sets the GtkImage
1999-08-16 18:51:52 +00:00
</para>
@image: a #GdkPixmap
1999-08-16 18:51:52 +00:00
@val:
@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>
Gets the GtkImage
1999-08-16 18:51:52 +00:00
</para>
@image: a #GdkPixmap
1999-08-16 18:51:52 +00:00
@val:
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
1999-08-16 18:51:52 +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>