diff options
| -rw-r--r-- | docs/reference/gdk-pixbuf/Makefile.am | 1 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt | 9 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/gdk-pixbuf.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/creating.sgml | 3 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/file-loading.sgml | 3 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml | 70 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml | 3 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml | 121 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/refcounting.sgml | 1 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/rendering.sgml | 3 | ||||
| -rw-r--r-- | gdk-pixbuf/ChangeLog | 9 |
11 files changed, 169 insertions, 56 deletions
diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am index 0c43848f9b..9cd3f7eaa9 100644 --- a/docs/reference/gdk-pixbuf/Makefile.am +++ b/docs/reference/gdk-pixbuf/Makefile.am @@ -19,7 +19,6 @@ TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) tmpl_sources = \ tmpl/creating.sgml \ tmpl/file-loading.sgml \ - tmpl/gdk-pixbuf-io.sgml \ tmpl/gdk-pixbuf-loader.sgml \ tmpl/gdk-pixbuf-unused.sgml \ tmpl/gdk-pixbuf.sgml \ diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt index 13fda9c997..91f6364a0d 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt @@ -71,12 +71,3 @@ GDK_IS_PIXBUF_LOADER_CLASS <SUBSECTION Private> GdkPixbufLoader </SECTION> - -<SECTION> -<FILE>gdk-pixbuf-io</FILE> -ModulePreparedNotifyFunc -ModuleUpdatedNotifyFunc -GdkPixbufModule -gdk_pixbuf_get_module -gdk_pixbuf_load_module -</SECTION> diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml index 3efd4f9b83..bef6723c6b 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml @@ -6,7 +6,6 @@ <!entity gdk-pixbuf-rendering SYSTEM "sgml/rendering.sgml"> <!entity GnomeCanvasPixbuf SYSTEM "sgml/gnome-canvas-pixbuf.sgml"> <!entity GdkPixbufLoader SYSTEM "sgml/gdk-pixbuf-loader.sgml"> -<!entity gdk-pixbuf-gdk-pixbuf-io SYSTEM "sgml/gdk-pixbuf-io.sgml"> ]> <book> @@ -49,6 +48,5 @@ &gdk-pixbuf-rendering; &GnomeCanvasPixbuf; &GdkPixbufLoader; - &gdk-pixbuf-gdk-pixbuf-io; </reference> </book> diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml index 240e7567c0..ae55d3cc89 100644 --- a/docs/reference/gdk-pixbuf/tmpl/creating.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml @@ -86,8 +86,7 @@ Creating a pixbuf from image data that is already in memory. </para> @data: -@Returns: - +@Returns: <!-- Local variables: mode: sgml diff --git a/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml index 2546600e6a..a333df963a 100644 --- a/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml @@ -31,8 +31,7 @@ Loading a pixbuf from a file. </para> @filename: -@Returns: - +@Returns: <!-- Local variables: mode: sgml diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml index e69de29bb2..1ac20cb80b 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml @@ -0,0 +1,70 @@ +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gdk_pixbuf_load_module ##### --> +<para> + +</para> + +@image_module: + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### --> + + + +<!-- ##### STRUCT GdkPixbufModule ##### --> +<para> + +</para> + +@module_name: +@format_check: +@module: +@load: +@load_xpm_data: +@begin_load: +@stop_load: +@load_increment: + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### --> +<para> + +</para> + +@pixbuf: +@user_data: +@x: +@y: +@width: +@height: + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Title ##### --> +gdk-pixbuf-io + + +<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### --> +<para> + +</para> + +@pixbuf: +@user_data: + +<!-- ##### FUNCTION gdk_pixbuf_get_module ##### --> +<para> + +</para> + +@buffer: +@size: +@Returns: + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml index aac19face4..87c60ba360 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml @@ -98,8 +98,7 @@ the image data. </para> @pixbuf: -@Returns: - +@Returns: <!-- Local variables: mode: sgml diff --git a/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml index d2e37570f0..f225a0c2cf 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml @@ -45,63 +45,113 @@ Canvas item to display #GdkPixbuf images. <!-- ##### ARG GnomeCanvasPixbuf:width_set ##### --> <para> - Determines whether the + Determines whether the <link + linkend="GnomeCanvasPixbuf--width">width</link> argument is taken + into account when scaling the pixbuf item. If this argument is + %FALSE, then the width value of the pixbuf's #ArtPixBuf will be + used instead. This argument is %FALSE by default. </para> <!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### --> -<para> - -</para> + <para> + If this argument is %TRUE, then the width of the pixbuf will be + considered to be in pixels, that is, it will not be visually + scaled even if the item's affine transformation changes. If this + is %FALSE, then the width of the pixbuf will be considered to be + in canvas units, and so will be scaled normally by affine + transformations. The default is %FALSE. + </para> <!-- ##### ARG GnomeCanvasPixbuf:width ##### --> <para> - Contains the width of the image in the pixbuf canvas item. + Indicates the width the pixbuf will be scaled to. This argument + will only be used if the <link + linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument + is %TRUE. If the <link + linkend="GnomeCanvasPixbuf--width-pixels">width_pixels</link> + argument is %FALSE, the width will be taken to be in canvas units, + and thus will be scaled along with the canvas item's affine + transformation. If width_pixels is %TRUE, the width will be taken + to be in pixels, and will visually remain a constant size even if + the item's affine transformation changes. </para> -<!-- ##### ARG GnomeCanvasPixbuf:height ##### --> -<para> - -</para> - <!-- ##### ARG GnomeCanvasPixbuf:height_set ##### --> -<para> - -</para> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--height">height</link> argument is + taken into account when scaling the pixbuf item. Works in the + same way as the <link + linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument. + The default is %FALSE. + </para> <!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### --> -<para> - -</para> - -<!-- ##### ARG GnomeCanvasPixbuf:x ##### --> -<para> + <para> + Works in the same way as the <link + linkend="GnomeCanvasPixbuf--width-pixels">width_pixels</link> + argument. The default is %FALSE. + </para> -</para> +<!-- ##### ARG GnomeCanvasPixbuf:height ##### --> + <para> + Indicates the height the pixbuf will be scaled to. This argument + will only be used if the <link + linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument + is %TRUE. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--width">width</link> argument. + </para> <!-- ##### ARG GnomeCanvasPixbuf:x_set ##### --> -<para> - -</para> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--x">x</link> argument is used to + translate the pixbuf from its logical origin in item-relative + coordinates. + </para> <!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### --> -<para> - -</para> - -<!-- ##### ARG GnomeCanvasPixbuf:y ##### --> -<para> + <para> + If this argument is %TRUE, the pixbuf's translation with respect + to its logical origin in item-relative coordinates will be in + pixels, that is, the visible offset will not change even if the + item's affine transformation changes. If it is %FALSE, the + pixbuf's translation will be taken to be in canvas units, and thus + will change along with the item's affine transformation. + </para> -</para> +<!-- ##### ARG GnomeCanvasPixbuf:x ##### --> + <para> + Indicates the horizontal translation offset of the pixbuf item's + image. This argument will only be used if the <link + linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument is + %TRUE. This ‘horizontal’ offset will actually be + modified by the item's affine transformation. + </para> <!-- ##### ARG GnomeCanvasPixbuf:y_set ##### --> -<para> - -</para> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--y">y</link> argument is used to + translate the pixbuf from its logical origin in item-relative + coordinates. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The + default is %FALSE. + </para> <!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### --> -<para> + <para> + Works in the same way as the <link + linkend="GnomeCanvasPixbuf--x-pixels">x_pixels</link> argument. + The default is %FALSE. + </para> -</para> +<!-- ##### ARG GnomeCanvasPixbuf:y ##### --> + <para> + Indicates the vertical translation offset of the pixbuf item's + image. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--x">x</link> argument. + </para> <!-- @@ -110,3 +160,4 @@ mode: sgml sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") End: --> + diff --git a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml index 00b8723097..04ee946324 100644 --- a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml @@ -34,7 +34,6 @@ Functions to perform reference counting on a #GdkPixbuf. </para> @pixbuf: - <!-- Local variables: mode: sgml diff --git a/docs/reference/gdk-pixbuf/tmpl/rendering.sgml b/docs/reference/gdk-pixbuf/tmpl/rendering.sgml index f6b6d9eb47..1a65d54198 100644 --- a/docs/reference/gdk-pixbuf/tmpl/rendering.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/rendering.sgml @@ -96,8 +96,7 @@ In the future it will do full alpha compositing. @dest_y: @width: @height: -@alpha_threshold: - +@alpha_threshold: <!-- Local variables: mode: sgml diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog index 97068381fc..a5e02530bb 100644 --- a/gdk-pixbuf/ChangeLog +++ b/gdk-pixbuf/ChangeLog @@ -1,3 +1,12 @@ +1999-11-05 Federico Mena Quintero <federico@redhat.com> + + * doc/gdk-pixbuf-sections.txt: Removed gdk-pixbuf-io, since it is + for internal use only. + + * doc/gdk-pixbuf.sgml: Likewise. + + * doc/tmpl/gnome-canvas-pixbuf.sgml: Finished docs. + 1999-11-05 Michael Fulbright <drmike@redhat.com> * src/io-pnm.c: Implemented support for reading raw PBM/PGM/PPM |