GNOME.org
 

[librsvgmm] Merge extracted C API documentation

commit 7a6368cfa56cf02ae3e59f0ff5289d23dc7b812b
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Thu Jun 18 01:57:07 2009 +0200

    Merge extracted C API documentation
    
    * librsvg/src/librsvg_docs.xml: New file, generated using the
    docextract_to_xml.py script.
    * librsvg/src/librsvg_docs_override.xml: New empty file for
    documentation overrides.
    * librsvg/src/Makefile.am (files_defs): Add the new files.

 librsvg/src/Makefile.am               |    9 +-
 librsvg/src/librsvg_docs.xml          | 1235 +++++++++++++++++++++++++++++++++
 librsvg/src/librsvg_docs_override.xml |    2 +
 3 files changed, 1245 insertions(+), 1 deletions(-)
---
diff --git a/librsvg/src/Makefile.am b/librsvg/src/Makefile.am
index 84f7995..c816a56 100644
--- a/librsvg/src/Makefile.am
+++ b/librsvg/src/Makefile.am
@@ -18,6 +18,13 @@
 sublib_name      = librsvgmm
 sublib_namespace = Rsvg
 sublib_parentdir = librsvgmm
-files_defs       = librsvg.defs librsvg_enum.defs librsvg_method.defs librsvg_extra.defs
+
+files_defs =			\
+	librsvg.defs		\
+	librsvg_enum.defs	\
+	librsvg_extra.defs	\
+	librsvg_method.defs	\
+	librsvg_docs.xml	\
+	librsvg_docs_override.xml
 
 include $(top_srcdir)/tools/build_gmmproc.am
diff --git a/librsvg/src/librsvg_docs.xml b/librsvg/src/librsvg_docs.xml
new file mode 100644
index 0000000..30e88ed
--- /dev/null
+++ b/librsvg/src/librsvg_docs.xml
@@ -0,0 +1,1235 @@
+<root>
+<function name="rsvg_filter_parse">
+<description>
+
+</description>
+<parameters>
+<parameter name="defs">
+<parameter_description> a pointer to the hash of definitions
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> a string with the name of the filter to be looked up
+</parameter_description>
+</parameter>
+</parameters>
+<return>a pointer to the filter that the name refers to, or NULL
+if none was found
+</return>
+</function>
+
+<function name="_rsvg_affine_shear">
+<description>
+Sets up a shearing matrix. In the standard libart coordinate system
+and a small value for theta, || becomes \\. Horizontal lines remain
+unchanged.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the resulting affine transform.
+</parameter_description>
+</parameter>
+<parameter name="theta">
+<parameter_description> Shear angle in degrees.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_equal">
+<description>
+Determines whether @matrix1 and @matrix2 are equal, with
+epsilon-tolerance for roundoff errors.
+
+
+</description>
+<parameters>
+<parameter name="matrix1">
+<parameter_description> An affine transformation.
+</parameter_description>
+</parameter>
+<parameter name="matrix2">
+<parameter_description> Another affine transformation.
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if @matrix1 and @matrix2 are equal.
+</return>
+</function>
+
+<function name="rsvg_paint_server_parse">
+<description>
+Parses the paint specification @str, creating a new paint server
+object.
+
+
+</description>
+<parameters>
+<parameter name="defs">
+<parameter_description> Defs for looking up gradients.
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> The SVG paint specification string to parse.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The newly created paint server, or NULL on error.
+</return>
+</function>
+
+<function name="rsvg_parse_style_attrs">
+<description>
+Parses style and transform attributes and modifies state at top of
+stack.
+
+</description>
+<parameters>
+<parameter name="ctx">
+<parameter_description> Rsvg context.
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> Rsvg state
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> The SVG tag we're processing (eg: circle, ellipse), optionally %NULL
+</parameter_description>
+</parameter>
+<parameter name="klazz">
+<parameter_description> The space delimited class list, optionally %NULL
+</parameter_description>
+</parameter>
+<parameter name="atts">
+<parameter_description> Attributes in SAX style.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_get_base_uri">
+<description>
+Gets the base uri for this #RsvgHandle.
+
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return> the base uri, possibly null
+Since: 2.9 (really present in 2.8 as well)
+</return>
+</function>
+
+<function name="rsvg_init">
+<description>
+Initializes librsvg
+Since: 2.9
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_close">
+<description>
+Closes @handle, to indicate that loading the image is complete.  This will
+return #TRUE if the loader closed successfully.  Note that @handle isn't
+freed until @g_object_unref is called.
+
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> A #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> #TRUE if the loader closed successfully, or #FALSE if there was
+an error.
+</return>
+</function>
+
+<function name="rsvg_paint_server_unref">
+<description>
+
+</description>
+<parameters>
+<parameter name="ps">
+<parameter_description> The paint server object to unreference.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_filter_get_in">
+<description>
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> The name of the pixbuf
+</parameter_description>
+</parameter>
+<parameter name="ctx">
+<parameter_description> the context that this was called in
+</parameter_description>
+</parameter>
+</parameters>
+<return>a pointer to the result that the name refers to, a special
+Pixbuf if the name is a special keyword or NULL if nothing was found
+</return>
+</function>
+
+<function name="_rsvg_affine_invert">
+<description>
+All non-degenerate affine transforms are invertible. If the original
+affine is degenerate or nearly so, expect numerical instability and
+very likely core dumps on Alpha and other fp-picky architectures.
+Otherwise, @dst multiplied with @src, or @src multiplied with @dst
+will be (to within roundoff error) the identity affine.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where the resulting affine is stored.
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> The original affine transformation.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_set_default_dpi_x_y">
+<description>
+Sets the DPI for the all future outgoing pixbufs. Common values are
+75, 90, and 300 DPI. Passing a number &lt;= 0 to #dpi will 
+reset the DPI to whatever the default value happens to be.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="dpi_x">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+<parameter name="dpi_y">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_scale">
+<description>
+Sets up a scaling matrix.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the resulting affine transform.
+</parameter_description>
+</parameter>
+<parameter name="sx">
+<parameter_description> X scale factor.
+</parameter_description>
+</parameter>
+<parameter name="sy">
+<parameter_description> Y scale factor.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_multiply">
+<description>
+Multiplies two affine transforms together, i.e. the resulting @dst
+is equivalent to doing first @src1 then @src2. Note that the
+PostScript concat operator multiplies on the left, i.e.  &quot;M concat&quot;
+is equivalent to &quot;CTM = multiply (M, CTM)&quot;;
+
+It is safe to call this function with @dst equal to @src1 or @src2.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the result.
+</parameter_description>
+</parameter>
+<parameter name="src1">
+<parameter_description> The first affine transform to multiply.
+</parameter_description>
+</parameter>
+<parameter name="src2">
+<parameter_description> The second affine transform to multiply.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_rectilinear">
+<description>
+Determines whether @src is rectilinear, i.e.  grid-aligned
+rectangles are transformed to other grid-aligned rectangles.  The
+implementation has epsilon-tolerance for roundoff errors.
+
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> The original affine transformation.
+</parameter_description>
+</parameter>
+</parameters>
+<return> TRUE if @src is rectilinear.
+</return>
+</function>
+
+<function name="rsvg_new_filter">
+<description>
+Creates a blank filter and assigns default values to everything
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_identity">
+<description>
+Sets up an identity matrix.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the resulting affine transform.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_expansion">
+<description>
+Finds the expansion factor, i.e. the square root of the factor
+by which the affine transform affects area. In an affine transform
+composed of scaling, rotation, shearing, and translation, returns
+the amount of scaling.
+
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> The affine transformation.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the expansion factor.
+</return>
+</function>
+
+<function name="rsvg_handle_write">
+<description>
+Loads the next @count bytes of the image.  This will return #TRUE if the data
+was loaded successful, and #FALSE if an error occurred.  In the latter case,
+the loader will be closed, and will not accept further writes. If FALSE is
+returned, @error will be set to an error from the #RSVG_ERROR domain.
+
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="buf">
+<parameter_description> Pointer to svg data
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> length of the @buf buffer in bytes
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> #TRUE if the write was successful, or #FALSE if there was an
+error.
+</return>
+</function>
+
+<function name="rsvg_path_arc">
+<description>
+
+</description>
+<parameters>
+<parameter name="ctx">
+<parameter_description> Path context.
+</parameter_description>
+</parameter>
+<parameter name="rx">
+<parameter_description> Radius in x direction (before rotation).
+</parameter_description>
+</parameter>
+<parameter name="ry">
+<parameter_description> Radius in y direction (before rotation).
+</parameter_description>
+</parameter>
+<parameter name="x_axis_rotation">
+<parameter_description> Rotation angle for axes.
+</parameter_description>
+</parameter>
+<parameter name="large_arc_flag">
+<parameter_description> 0 for arc length &lt;= 180, 1 for arc &gt;= 180.
+</parameter_description>
+</parameter>
+<parameter name="sweep">
+<parameter_description> 0 for &quot;negative angle&quot;, 1 for &quot;positive angle&quot;.
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> New x coordinate.
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> New y coordinate.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_pixbuf_from_file">
+<description>
+Loads a new #GdkPixbuf from @file_name and returns it.  The caller must
+assume the reference to the reurned pixbuf. If an error occurred, @error is
+set and %NULL is returned.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> A file name
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GdkPixbuf, or %NULL
+Deprecated: Set up a cairo matrix and use rsvg_handle_new_from_file() + rsvg_handle_render_cairo() instead.
+</return>
+</function>
+
+<function name="rsvg_filter_render">
+<description>
+This function will create a context for itself, set up the coordinate systems
+execute all its little primatives and then clean up its own mess
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a pointer to the filter to use
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> a pointer to the source pixbuf
+</parameter_description>
+</parameter>
+<parameter name="bg">
+<parameter_description> the background pixbuf
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> the context
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_filter_store_result">
+<description>
+Puts the new result into the hash for easy finding later, also
+Stores it as the last result
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> The name of the result
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> The pointer to the result
+</parameter_description>
+</parameter>
+<parameter name="ctx">
+<parameter_description> the context that this was called in
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_set_dpi_x_y">
+<description>
+Sets the DPI for the outgoing pixbuf. Common values are
+75, 90, and 300 DPI. Passing a number &lt;= 0 to #dpi_x or #dpi_y will 
+reset the DPI to whatever the default value happens to be.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="dpi_x">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+<parameter name="dpi_y">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_set_default_dpi">
+<description>
+Sets the DPI for the all future outgoing pixbufs. Common values are
+75, 90, and 300 DPI. Passing a number &lt;= 0 to #dpi will 
+reset the DPI to whatever the default value happens to be.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="dpi">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_get_pixbuf_sub">
+<description>
+Returns: the pixbuf loaded by #handle, or %NULL.
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="id">
+<parameter_description> The id of an element inside the SVG, or %NULL to render the whole SVG. For
+example, if you have a layer called &quot;layer1&quot; that you wish to render, pass 
+&quot;##layer1&quot; as the id.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pixbuf loaded by #handle, or %NULL.
+
+Since: 2.14
+</return>
+</function>
+
+<function name="rsvg_handle_new_from_file">
+<description>
+Loads the SVG specified by #file_name.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> The file name to load. If built with gnome-vfs, can be a URI.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A RsvgHandle or %NULL if an error occurs.
+Since: 2.14
+</return>
+</function>
+
+<function name="rsvg_handle_get_pixbuf">
+<description>
+Returns: the pixbuf loaded by #handle, or %NULL.
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pixbuf loaded by #handle, or %NULL.
+</return>
+</function>
+
+<function name="rsvg_term">
+<description>
+De-initializes librsvg
+Since: 2.9
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_pixbuf_from_file_at_zoom_with_max">
+<description>
+Loads a new #GdkPixbuf from @file_name and returns it.  This pixbuf is scaled
+from the size indicated by the file by a factor of @x_zoom and @y_zoom. If the
+resulting pixbuf would be larger than max_width/max_heigh it is uniformly scaled
+down to fit in that rectangle. The caller must assume the reference to the
+returned pixbuf. If an error occurred, @error is set and %NULL is returned.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> A file name
+</parameter_description>
+</parameter>
+<parameter name="x_zoom">
+<parameter_description> The horizontal zoom factor
+</parameter_description>
+</parameter>
+<parameter name="y_zoom">
+<parameter_description> The vertical zoom factor
+</parameter_description>
+</parameter>
+<parameter name="max_width">
+<parameter_description> The requested max width
+</parameter_description>
+</parameter>
+<parameter name="max_height">
+<parameter_description> The requested max heigh
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GdkPixbuf, or %NULL
+Deprecated: Set up a cairo matrix and use rsvg_handle_new_from_file() + rsvg_handle_render_cairo() instead.
+</return>
+</function>
+
+<function name="rsvg_handle_get_dimensions_sub">
+<description>
+Get the size of a subelement of the SVG file. Do not call from within the size_func callback, because an infinite loop will occur.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="dimension_data">
+<parameter_description> A place to store the SVG's size
+</parameter_description>
+</parameter>
+<parameter name="id">
+<parameter_description> An element's id within the SVG, or NULL to get the dimension of the whole SVG. 
+For example, if you have a layer called &quot;layer1&quot; for that you want to get the dimension, 
+pass &quot;#layer1&quot; as the id.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_new_from_data">
+<description>
+Loads the SVG specified by #data.
+
+
+</description>
+<parameters>
+<parameter name="data">
+<parameter_description> The SVG data
+</parameter_description>
+</parameter>
+<parameter name="data_len">
+<parameter_description> The length of #data, in bytes
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A RsvgHandle or %NULL if an error occurs.
+Since: 2.14
+</return>
+</function>
+
+<function name="rsvg_handle_get_metadata">
+<description>
+Returns: The SVG's title
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return> The SVG's title
+
+Since: 2.9
+</return>
+</function>
+
+<function name="_rsvg_affine_flip">
+<description>
+Flips the affine transform. FALSE for both @horiz and @vert implements
+a simple copy operation. TRUE for both @horiz and @vert is a
+180 degree rotation. It is ok for @src_affine and @dst_affine to
+be equal pointers.
+
+</description>
+<parameters>
+<parameter name="dst_affine">
+<parameter_description> Where the resulting affine is stored.
+</parameter_description>
+</parameter>
+<parameter name="src_affine">
+<parameter_description> The original affine transformation.
+</parameter_description>
+</parameter>
+<parameter name="horiz">
+<parameter_description> Whether or not to flip horizontally.
+</parameter_description>
+</parameter>
+<parameter name="vert">
+<parameter_description> Whether or not to flip horizontally.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_has_sub">
+<description>
+Checks whether the element @id exists in the SVG document.
+
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> a #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="id">
+<parameter_description> an element's id within the SVG
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @id exists in the SVG document
+
+Since: 2.22
+</return>
+</function>
+
+<function name="rsvg_parse_transform_attr">
+<description>
+Parses the transform attribute in @str and applies it to @state.
+
+</description>
+<parameters>
+<parameter name="ctx">
+<parameter_description> Rsvg context.
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> State in which to apply the transform.
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> String containing transform.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_get_desc">
+<description>
+Returns: The SVG's description
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return> The SVG's description
+
+Since: 2.4
+</return>
+</function>
+
+<function name="rsvg_handle_new">
+<description>
+Returns: A new #RsvgHandle
+
+</description>
+<parameters>
+</parameters>
+<return> A new #RsvgHandle
+</return>
+</function>
+
+<function name="rsvg_handle_free">
+<description>
+Frees #handle.
+Deprecated: Use g_object_unref() instead.
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_set_size_callback">
+<description>
+Sets the sizing function for the @handle.  This function is called right
+after the size of the image has been loaded.  The size of the image is passed
+in to the function, which may then modify these values to set the real size
+of the generated pixbuf.  If the image has no associated size, then the size
+arguments are set to -1.
+
+Deprecated: Set up a cairo matrix and use rsvg_handle_render_cairo() instead.
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="size_func">
+<parameter_description> A sizing function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> User data to pass to @size_func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="user_data_destroy">
+<parameter_description> Destroy function for @user_data, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="_rsvg_affine_rotate">
+<description>
+Sets up a rotation matrix. In the standard libart coordinate
+system, in which increasing y moves downward, this is a
+counterclockwise rotation. In the standard PostScript coordinate
+system, which is reversed in the y direction, it is a clockwise
+rotation.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the resulting affine transform.
+</parameter_description>
+</parameter>
+<parameter name="theta">
+<parameter_description> Rotation angle in degrees.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_render_cairo_sub">
+<description>
+Draws a subset of a SVG to a Cairo surface
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="cr">
+<parameter_description> A Cairo renderer
+</parameter_description>
+</parameter>
+<parameter name="id">
+<parameter_description> An element's id within the SVG, or %NULL to render the whole SVG. For
+example, if you have a layer called &quot;layer1&quot; that you wish to render, pass 
+&quot;##layer1&quot; as the id.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_error_quark">
+<description>
+The error domain for RSVG
+
+
+</description>
+<parameters>
+</parameters>
+<return> The error domain
+</return>
+</function>
+
+<function name="rsvg_pixbuf_from_file_at_size">
+<description>
+Loads a new #GdkPixbuf from @file_name and returns it.  This pixbuf is scaled
+from the size indicated to the new size indicated by @width and @height.  If
+either of these are -1, then the default size of the image being loaded is
+used.  The caller must assume the reference to the returned pixbuf. If an
+error occurred, @error is set and %NULL is returned.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> A file name
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> The new width, or -1
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> The new height, or -1
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GdkPixbuf, or %NULL
+Deprecated: Set up a cairo matrix and use rsvg_handle_new_from_file() + rsvg_handle_render_cairo() instead.
+</return>
+</function>
+
+<function name="rsvg_paint_server_ref">
+<description>
+
+</description>
+<parameters>
+<parameter name="ps">
+<parameter_description> The paint server object to reference.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_get_position_sub">
+<description>
+Get the position of a subelement of the SVG file. Do not call from within
+the size_func callback, because an infinite loop will occur.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="position_data">
+<parameter_description> A place to store the SVG fragment's position.
+</parameter_description>
+</parameter>
+<parameter name="id">
+<parameter_description> An element's id within the SVG.
+For example, if you have a layer called &quot;layer1&quot; for that you want to get
+the position, pass &quot;#layer1&quot; as the id.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_pixbuf_from_file_at_zoom">
+<description>
+Loads a new #GdkPixbuf from @file_name and returns it.  This pixbuf is scaled
+from the size indicated by the file by a factor of @x_zoom and @y_zoom.  The
+caller must assume the reference to the returned pixbuf. If an error
+occurred, @error is set and %NULL is returned.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> A file name
+</parameter_description>
+</parameter>
+<parameter name="x_zoom">
+<parameter_description> The horizontal zoom factor
+</parameter_description>
+</parameter>
+<parameter name="y_zoom">
+<parameter_description> The vertical zoom factor
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GdkPixbuf, or %NULL
+Deprecated: Set up a cairo matrix and use rsvg_handle_new_from_file() + rsvg_handle_render_cairo() instead.
+</return>
+</function>
+
+<function name="rsvg_handle_set_dpi">
+<description>
+Sets the DPI for the outgoing pixbuf. Common values are
+75, 90, and 300 DPI. Passing a number &lt;= 0 to #dpi will 
+reset the DPI to whatever the default value happens to be.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="dpi">
+<parameter_description> Dots Per Inch (aka Pixels Per Inch)
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_get_title">
+<description>
+Returns: The SVG's title
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> An #RsvgHandle
+</parameter_description>
+</parameter>
+</parameters>
+<return> The SVG's title
+
+Since: 2.4
+</return>
+</function>
+
+<function name="Parse">
+<description>
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_css_parse_vbox">
+<description>
+
+</description>
+<parameters>
+<parameter name="vbox">
+<parameter_description> The CSS viewBox
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> The X output
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The Y output
+</parameter_description>
+</parameter>
+<parameter name="w">
+<parameter_description> The Width output
+</parameter_description>
+</parameter>
+<parameter name="h">
+<parameter_description> The Height output
+</parameter_description>
+</parameter>
+</parameters>
+<return> 
+</return>
+</function>
+
+<function name="_rsvg_affine_translate">
+<description>
+Sets up a translation matrix.
+
+</description>
+<parameters>
+<parameter name="dst">
+<parameter_description> Where to store the resulting affine transform.
+</parameter_description>
+</parameter>
+<parameter name="tx">
+<parameter_description> X translation amount.
+</parameter_description>
+</parameter>
+<parameter name="tx">
+<parameter_description> Y translation amount.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_pixbuf_from_file_at_max_size">
+<description>
+Loads a new #GdkPixbuf from @file_name and returns it.  This pixbuf is uniformly
+scaled so that the it fits into a rectangle of size max_width * max_height. The
+caller must assume the reference to the returned pixbuf. If an error occurred,
+ error is set and %NULL is returned.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> A file name
+</parameter_description>
+</parameter>
+<parameter name="max_width">
+<parameter_description> The requested max width
+</parameter_description>
+</parameter>
+<parameter name="max_height">
+<parameter_description> The requested max heigh
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> A newly allocated #GdkPixbuf, or %NULL
+Deprecated: Set up a cairo matrix and use rsvg_handle_new_from_file() + rsvg_handle_render_cairo() instead.
+</return>
+</function>
+
+<function name="rsvg_handle_get_dimensions">
+<description>
+Get the SVG's size. Do not call from within the size_func callback, because an infinite loop will occur.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="dimension_data">
+<parameter_description> A place to store the SVG's size
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_render_cairo">
+<description>
+Draws a SVG to a Cairo surface
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="cr">
+<parameter_description> A Cairo renderer
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="dpi">
+<description>
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="rsvg_handle_set_base_uri">
+<description>
+Set the base URI for this SVG. This can only be called before rsvg_handle_write()
+has been called.
+
+Since: 2.9
+
+</description>
+<parameters>
+<parameter name="handle">
+<parameter_description> A #RsvgHandle
+</parameter_description>
+</parameter>
+<parameter name="base_uri">
+<parameter_description> The base uri
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+</root>
diff --git a/librsvg/src/librsvg_docs_override.xml b/librsvg/src/librsvg_docs_override.xml
new file mode 100644
index 0000000..093d936
--- /dev/null
+++ b/librsvg/src/librsvg_docs_override.xml
@@ -0,0 +1,2 @@
+<root>
+</root>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]