forked from AuroraMiddleware/gtk
7a4c689387
2000-10-18 Havoc Pennington <hp@redhat.com> * gtk/gtk-sections.txt: Some updates * gdk/gdk-sections.txt: remove GdkPixbufAlphaMode * gdk-pixbuf/gdk-pixbuf-sections.txt: Add new API, remove GdkPixbufClass/GdkAnimationClass since those are private * gdk-pixbuf/Makefile.am (IGNORE_HFILES): ignore more headers 2000-10-18 Havoc Pennington <hp@redhat.com> * gtk/gtktextiter.c (gtk_text_iter_forward_to_newline): Fix a bug where any number of empty lines would get skipped * gtk/gtktextiter.h: Remove padding from GtkTextIter; live on the edge. * gtk/gtktextiter.c (gtk_text_iter_make_surreal): enhance the warning about invalid iterators (explain more thoroughly) (gtk_text_iter_in_region): rename gtk_text_iter_in_range * gtk/gtktextview.c (FOCUS_EDGE_WIDTH): Make focus rectangle less big * demos/*.c: Add error handling * gtk/gtktextbuffer.c: don't modify const iterators * gtk/gdk-pixbuf-loader.c: Add full error handling here * gtk/gtkimage.c (gtk_image_set_from_file): ignore errors on file load * gtk/gtkiconfactory.c: Update to reflect addition of error handling to gdk-pixbuf loaders 2000-10-16 Havoc Pennington <hp@redhat.com> * gdk-pixbuf-io.c (gdk_pixbuf_get_module) (gdk_pixbuf_get_named_module) (gdk_pixbuf_load_module): add error reporting here also * make-inline-pixbuf.c (main): use GError * io-xpm.c: include unistd.h * gdk-pixbuf-util.c: include string.h * io-*.c: add error reporting * gdk-pixbuf-animation.c (gdk_pixbuf_animation_new_from_file): add error reporting * gdk-pixbuf-io.c (gdk_pixbuf_new_from_file): Add error reporting * gdk-pixbuf-io.h: Add GError** to load_increment and load methods * gdk-pixbuf-io.c (gdk_pixbuf_save) (gdk_pixbuf_savev): return a G_FILE_ERROR if we fail to write or close the file. * gdk-pixbuf.h: remove GDK_PIXBUF_ERROR_IO, instead we'll use G_FILE_ERROR_*. Rename enum to GdkPixbufError, properly following the GError naming rules. Add GError** to load functions.
207 lines
6.3 KiB
Plaintext
207 lines
6.3 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GdkPixbufLoader
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Application-driven progressive image loading.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
#GdkPixbufLoader provides a way for applications to drive the
|
|
process of loading an image, by letting them send the image data
|
|
directly to the loader instead of having the loader read the data
|
|
from a file. Applications can use this functionality instead of
|
|
gdk_pixbuf_new_from_file() when they need to parse image data in
|
|
small chunks. For example, it should be used when reading an
|
|
image from a (potentially) slow network connection, or when
|
|
loading an extremely large file.
|
|
</para>
|
|
|
|
<para>
|
|
To use #GdkPixbufLoader to load an image, just create a new one,
|
|
and call gdk_pixbuf_loader_write() to send the data to it. When
|
|
done, gdk_pixbuf_loader_close() should be called to end the stream
|
|
and finalize everything. The loader will emit two important
|
|
signals throughout the process. The first, "<link
|
|
linkend="GdkPixbufLoader-area-prepared">area_prepared</link>",
|
|
will be called as soon as the image has enough information to
|
|
determine the size of the image to be used. It will pass a
|
|
@GdkPixbuf in. If you want to use it, you can simply ref it. In
|
|
addition, no actual information will be passed in yet, so the
|
|
pixbuf can be safely filled with any temporary graphics (or an
|
|
initial color) as needed. You can also call the
|
|
gdk_pixbuf_loader_get_pixbuf() once this signal has been emitted
|
|
and get the same pixbuf.
|
|
</para>
|
|
|
|
<para>
|
|
The other signal, "<link
|
|
linkend="GdkPixbufLoader-area-updated">area_updated</link>" gets
|
|
called every time a region is updated. This way you can update a
|
|
partially completed image. Note that you do not know anything
|
|
about the completeness of an image from the area updated. For
|
|
example, in an interlaced image, you need to make several passes
|
|
before the image is done loading.
|
|
</para>
|
|
|
|
<refsect2>
|
|
<title>Loading an animation</title>
|
|
|
|
<para>
|
|
Loading an animation is a little more complex then loading an
|
|
image. In addition to the above signals, there is also a "<link
|
|
linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal,
|
|
as well as an "<link
|
|
linkend="GdkPixbufLoader-animation-done">animation_done</link>"
|
|
signal. The first lets the application know that it is dealing
|
|
with an animation, instead of a static image. It also passes a
|
|
#GdkPixbufFrame in the signal. As before, if you want to keep
|
|
the frame, you need to ref it. Once the first "<link
|
|
linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal
|
|
has been emitted, you can call gdk_pixbuf_loader_get_animation()
|
|
to get the #GdkPixbufAnimation struct. Each subsequent frame
|
|
goes through a similar lifecycle. For example "<link
|
|
linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" is
|
|
re-emitted. Then "<link
|
|
linkend="GdkPixbufLoader-area-updated">area_updated</link>" is
|
|
emitted as many times as necessary. Finally, "<link
|
|
linkend="GdkPixbufLoader-animation-done">animation_done</link>"
|
|
is emitted as soon as all frames are done.
|
|
</para>
|
|
</refsect2>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
gdk_pixbuf_new_from_file()
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_new_with_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_type:
|
|
@error:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_write ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@loader:
|
|
@buf:
|
|
@count:
|
|
@error:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_get_pixbuf ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@loader:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_get_animation ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@loader:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixbuf_loader_close ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@loader:
|
|
|
|
|
|
<!-- ##### SIGNAL GdkPixbufLoader::area-updated ##### -->
|
|
<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:
|
|
<!-- # Unused Parameters # -->
|
|
@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>
|
|
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.
|
|
<!-- # Unused Parameters # -->
|
|
@loader: Loader which emitted the signal.
|
|
|
|
<!-- ##### SIGNAL GdkPixbufLoader::frame-done ##### -->
|
|
<para>
|
|
This signal is emitted when a frame is done loading. It will be
|
|
emitted for each frame in an animation data stream.
|
|
</para>
|
|
|
|
@gdkpixbufloader: the object which received the signal.
|
|
@arg1:
|
|
<!-- # Unused Parameters # -->
|
|
@loader: Loader which emitted the signal.
|
|
@frame: Frame which just completed loading.
|
|
|
|
<!-- ##### SIGNAL GdkPixbufLoader::animation-done ##### -->
|
|
<para>
|
|
This signal is emitted when an animation is done loading.
|
|
</para>
|
|
|
|
@gdkpixbufloader: the object which received the signal.
|
|
<!-- # Unused Parameters # -->
|
|
@loader: Loader which emitted the signal.
|
|
|
|
<!-- ##### SIGNAL GdkPixbufLoader::closed ##### -->
|
|
<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.
|
|
<!-- # Unused Parameters # -->
|
|
@loader: Loader which emitted the signal.
|
|
|
|
<!--
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
|
|
End:
|
|
-->
|
|
|