diff options
author | Federico Mena Quintero <federico@redhat.com> | 1999-11-10 22:48:46 +0000 |
---|---|---|
committer | Arturo Espinosa <unammx@src.gnome.org> | 1999-11-10 22:48:46 +0000 |
commit | cfb026651878dde2b0af21ff8de470527ed5f825 (patch) | |
tree | c17bbded7dab6c3f2b14bccab6b2d9bb0fe90259 /docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml | |
parent | 23b50343c6230ff2fa3f28d76cc1371f116b1f24 (diff) | |
download | gdk-pixbuf-cfb026651878dde2b0af21ff8de470527ed5f825.tar.gz |
Populated.
1999-11-10 Federico Mena Quintero <federico@redhat.com>
* doc/tmpl/gdk-pixbuf-loader.sgml: Populated.
* doc/gdk-pixbuf.signals: Put in the real names of signal
arguments.
* src/gdk-pixbuf-loader.c: Improved documentation comments.
Diffstat (limited to 'docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml')
-rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml | 63 |
1 files changed, 39 insertions, 24 deletions
diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml index bed4d338d..930977219 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml @@ -7,20 +7,23 @@ Application-driven image loading. <!-- ##### SECTION Long_Description ##### --> <para> #GdkPIxbufLoader provides a way for applications to drive the - process of loading an image. + process of loading an image. Applications can use this + functionality instead of gdk_pixbuf_new_from_file() when they need + to parse image data in small chunks, such as when reading it from + a network connection. </para> <!-- ##### SECTION See_Also ##### --> -<para> - -</para> + <para> + gdk_pixbuf_new_from_file() + </para> <!-- ##### MACRO GDK_PIXBUF_LOADER ##### --> -<para> - -</para> + <para> + Casts a #GtkObject to a #GdkPixbufLoader. + </para> -@obj: +@obj: A GTK+ object. <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### --> @@ -60,29 +63,40 @@ Application-driven image loading. <!-- ##### SIGNAL GdkPixbufLoader::area-updated ##### --> -<para> - -</para> + <para> + This signal is emitted when a significant area of the image being + loaded has been updated. Normally it means that a complete + scanline has been read in, but it could be a different area as + well. Applications can use this signal to know when to repaint + areas of an image that is being loaded. + </para> -@gdkpixbufloader: the object which received the signal. -@arg1: -@arg2: -@arg3: -@arg4: +@loader: Loader which emitted the signal. +@x: X offset of upper-left corner of the updated area. +@y: Y offset of upper-left corner of the updated area. +@width: Width of updated area. +@height: Height of updated area. <!-- ##### SIGNAL GdkPixbufLoader::area-prepared ##### --> -<para> - -</para> + <para> + This signal is emitted when the pixbuf loader has been fed the + initial amount of data that is required to figure out the size and + format of the image that it will create. After this signal is + emitted, applications can call gdk_pixbuf_loader_get_pixbuf() to + fetch the partially-loaded pixbuf. + </para> -@gdkpixbufloader: the object which received the signal. +@loader: Loader which emitted the signal. <!-- ##### SIGNAL GdkPixbufLoader::closed ##### --> -<para> - -</para> + <para> + This signal is emitted when gdk_pixbuf_loader_close() is called. + It can be used by different parts of an application to receive + notification when an image loader is closed by the code that + drives it. + </para> -@gdkpixbufloader: the object which received the signal. +@loader: Loader which emitted the signal. <!-- Local variables: @@ -90,3 +104,4 @@ mode: sgml sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") End: --> + |