diff options
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/creating.sgml | 13 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml | 74 | ||||
| -rw-r--r-- | docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml | 97 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/gdk-unused.sgml | 31 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/regions.sgml | 33 |
5 files changed, 125 insertions, 123 deletions
diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml index 0bbce5405a..b98b4024fa 100644 --- a/docs/reference/gdk-pixbuf/tmpl/creating.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml @@ -94,19 +94,6 @@ Creating a pixbuf from image data that is already in memory. @Returns: -<!-- ##### FUNCTION gdk_pixbuf_new_subpixbuf ##### --> -<para> - -</para> - -@src_pixbuf: -@src_x: -@src_y: -@width: -@height: -@Returns: - - <!-- ##### FUNCTION gdk_pixbuf_copy ##### --> <para> diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml index b9cea2ff9f..8d5ba404d1 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml @@ -130,3 +130,77 @@ Application-driven progressive image loading. @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: +--> + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml index 152dfaf4ec..e26790a569 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml @@ -1,3 +1,7 @@ +<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### --> +Drawables to Pixbufs + + <!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### --> <para> A function of this type can be used to override the default @@ -15,10 +19,6 @@ @pixbuf: The pixbuf that is losing its last reference. @data: User closure data. -<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### --> -Drawables to Pixbufs - - <!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### --> <para> @@ -65,34 +65,6 @@ End: </para> -<!-- ##### SIGNAL GdkPixbufLoader::animation-done ##### --> - <para> - This signal is emitted when an animation is done loading. - </para> - -@gdkpixbufloader: the object which received the signal. -@loader: Loader which emitted the signal. - -<!-- ##### 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: -@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. - <!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### --> <para> @@ -150,17 +122,6 @@ End: </para> -<!-- ##### 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: -@loader: Loader which emitted the signal. -@frame: Frame which just completed loading. - <!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### --> Initializing the &gdk-pixbuf; Xlib library. @@ -194,24 +155,6 @@ Initializing the &gdk-pixbuf; Xlib library. </para> -<!-- ##### 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. -@loader: Loader which emitted the signal. - -<!-- -Local variables: -mode: sgml -sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") -End: ---> - <!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### --> <para> Works in the same way as the <link @@ -452,17 +395,17 @@ Rendering a pixbuf to a GDK drawable. Getting parts of an X drawable's image data into a pixbuf. -<!-- ##### 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> +<!-- ##### FUNCTION gdk_pixbuf_new_subpixbuf ##### --> +<para> -@gdkpixbufloader: the object which received the signal. -@loader: Loader which emitted the signal. +</para> + +@src_pixbuf: +@src_x: +@src_y: +@width: +@height: +@Returns: <!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### --> XlibRGB @@ -484,18 +427,18 @@ XlibRGB </para> -<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### --> - <para> - gdk_image_get(). - </para> - - <!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### --> <para> </para> +<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### --> + <para> + gdk_image_get(). + </para> + + <!-- ##### STRUCT GdkPixbufAnimationClass ##### --> <para> diff --git a/docs/reference/gdk/tmpl/gdk-unused.sgml b/docs/reference/gdk/tmpl/gdk-unused.sgml index f455390216..f3f6612dbb 100644 --- a/docs/reference/gdk/tmpl/gdk-unused.sgml +++ b/docs/reference/gdk/tmpl/gdk-unused.sgml @@ -163,6 +163,15 @@ onto the predefined valuator types that GTK+ understands. @axes: an array of GdkAxisUse. This length of this array must match the number of axes for the device. +<!-- ##### STRUCT GdkSpan ##### --> +<para> + +</para> + +@x: +@y: +@width: + <!-- ##### FUNCTION gdk_input_set_source ##### --> <para> Sets the source type for a device. @@ -171,6 +180,20 @@ Sets the source type for a device. @deviceid: the device to configure @source: the new source type. +<!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### --> +<para> +Intersects a set of spans with a region and call a user specified +function for each resulting spanline. This function is a lot more effective +if the spans are sorted. +</para> + +@region: The region to intersect against. +@spans: Array of spans to intersect. +@n_spans: Number of spans. +@sorted: True if the spans are sorted in increasing y order. +@function: The function to call for each intersected spanline. +@data: Opaque user data passed to function. + <!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### --> Points, Rectangles and Regions @@ -184,6 +207,14 @@ Returns the intersection of two regions. @source2: a #GdkRegion. @Returns: the intersection of @source1 and @source2. +<!-- ##### USER_FUNCTION GdkSpanFunc ##### --> +<para> + +</para> + +@span: The intersected part of the span. +@data: Opaque data passed by user. + <!-- ##### FUNCTION gdk_input_set_mode ##### --> <para> Enables or disables a device, and determines how the diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml index 88e3e2d62e..387544c82b 100644 --- a/docs/reference/gdk/tmpl/regions.sgml +++ b/docs/reference/gdk/tmpl/regions.sgml @@ -266,36 +266,3 @@ Returns the union of a region and a rectangle. @source2: -<!-- ##### STRUCT GdkSpan ##### --> -<para> - -</para> - -@x: -@y: -@width: - -<!-- ##### USER_FUNCTION GdkSpanFunc ##### --> -<para> - -</para> - -@span: The intersected part of the span. -@data: Opaque data passed by user. - - -<!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### --> -<para> -Intersects a set of spans with a region and call a user specified -function for each resulting spanline. This function is a lot more effective -if the spans are sorted. -</para> - -@region: The region to intersect against. -@spans: Array of spans to intersect. -@n_spans: Number of spans. -@sorted: True if the spans are sorted in increasing y order. -@function: The function to call for each intersected spanline. -@data: Opaque user data passed to function. - - |