Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GdkPixbufLoader
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Application-driven image loading.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8   <para>
   9     #GdkPixbufLoader provides a way for applications to drive the
  10     process of loading an image.  Applications can use this
  11     functionality instead of gdk_pixbuf_new_from_file() when they need
  12     to parse image data in small chunks, such as when reading it from
  13     a network connection.
  14   </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17   <para>
  18     gdk_pixbuf_new_from_file()
  19   </para>
  20
  21 <!-- ##### MACRO GDK_PIXBUF_LOADER ##### -->
  22   <para>
  23     Casts a #GtkObject to a #GdkPixbufLoader.
  24   </para>
  25
  26 @obj: A GTK+ object.
  27
  28
  29 <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
  30 <para>
  31
  32 </para>
  33
  34 @Returns:
  35
  36
  37 <!-- ##### FUNCTION gdk_pixbuf_loader_write ##### -->
  38 <para>
  39
  40 </para>
  41
  42 @loader:
  43 @buf:
  44 @count:
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION gdk_pixbuf_loader_get_pixbuf ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @loader:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION gdk_pixbuf_loader_close ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @loader:
  63
  64
  65 <!-- ##### SIGNAL GdkPixbufLoader::area-updated ##### -->
  66   <para>
  67     This signal is emitted when a significant area of the image being
  68     loaded has been updated.  Normally it means that a complete
  69     scanline has been read in, but it could be a different area as
  70     well.  Applications can use this signal to know when to repaint
  71     areas of an image that is being loaded.
  72   </para>
  73
  74 @gdkpixbufloader: the object which received the signal.
  75 @arg1:
  76 @arg2:
  77 @arg3:
  78 @arg4:
  79 <!-- # Unused Parameters # -->
  80 @loader: Loader which emitted the signal.
  81 @x: X offset of upper-left corner of the updated area.
  82 @y: Y offset of upper-left corner of the updated area.
  83 @width: Width of updated area.
  84 @height: Height of updated area.
  85
  86 <!-- ##### SIGNAL GdkPixbufLoader::area-prepared ##### -->
  87   <para>
  88     This signal is emitted when the pixbuf loader has been fed the
  89     initial amount of data that is required to figure out the size and
  90     format of the image that it will create.  After this signal is
  91     emitted, applications can call gdk_pixbuf_loader_get_pixbuf() to
  92     fetch the partially-loaded pixbuf.
  93   </para>
  94
  95 @gdkpixbufloader: the object which received the signal.
  96 <!-- # Unused Parameters # -->
  97 @loader: Loader which emitted the signal.
  98
  99 <!-- ##### SIGNAL GdkPixbufLoader::closed ##### -->
 100   <para>
 101     This signal is emitted when gdk_pixbuf_loader_close() is called.
 102     It can be used by different parts of an application to receive
 103     notification when an image loader is closed by the code that
 104     drives it.
 105   </para>
 106
 107 @gdkpixbufloader: the object which received the signal.
 108 <!-- # Unused Parameters # -->
 109 @loader: Loader which emitted the signal.
 110
 111 <!--
 112 Local variables:
 113 mode: sgml
 114 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
 115 End:
 116 -->
 117