Rsvg.Handle¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_from_data` (data)
class	`new_from_file` (filename)
class	`new_from_gfile_sync` (file, flags, cancellable)
class	`new_from_stream_sync` (input_stream, base_file, flags, cancellable)
class	`new_with_flags` (flags)
	`close` ()
	`free` ()
	`get_base_uri` ()
	`get_desc` ()
	`get_dimensions` ()
	`get_dimensions_sub` (id)
	`get_geometry_for_element` (id)
	`get_geometry_for_layer` (id, viewport)
	`get_intrinsic_dimensions` ()
	`get_intrinsic_size_in_pixels` ()
	`get_metadata` ()
	`get_pixbuf` ()
	`get_pixbuf_sub` (id)
	`get_position_sub` (id)
	`get_title` ()
	`has_sub` (id)
	`internal_set_testing` (testing)
	`read_stream_sync` (stream, cancellable)
	`render_cairo` (cr)
	`render_cairo_sub` (cr, id)
	`render_document` (cr, viewport)
	`render_element` (cr, id, element_viewport)
	`render_layer` (cr, id, viewport)
	`set_base_gfile` (base_file)
	`set_base_uri` (base_uri)
	`set_dpi` (dpi)
	`set_dpi_x_y` (dpi_x, dpi_y)
	`set_size_callback` (size_func, *user_data)
	`set_stylesheet` (css)
	`write` (buf)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`base-uri`	`str`	r/w/c
`desc`	`str`	d/r	`deprecated`
`dpi-x`	`float`	r/w/c
`dpi-y`	`float`	r/w/c
`em`	`float`	r	`deprecated`
`ex`	`float`	r	`deprecated`
`flags`	`Rsvg.HandleFlags`	r/w/co
`height`	`int`	r	`deprecated`
`metadata`	`str`	d/r	`deprecated`
`title`	`str`	d/r	`deprecated`
`width`	`int`	r	`deprecated`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Rsvg.Handle(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Rsvg.HandleClass

[class`Rsvg`.Handle] loads an SVG document into memory.

This is the main entry point into the librsvg library. An [class`Rsvg`.Handle] is an object that represents SVG data in memory. Your program creates an [class`Rsvg`.Handle] from an SVG file, or from a memory buffer that contains SVG data, or in the most general form, from a GInputStream that will provide SVG data.

Librsvg can load SVG images and render them to Cairo surfaces, using a mixture of SVG’s [static mode] and [secure static mode]. Librsvg does not do animation nor scripting, and can load references to external data only in some situations; see below.

Librsvg supports reading SVG 1.1 data, and is gradually adding support for features in SVG 2. Librsvg also supports SVGZ files, which are just an SVG stream compressed with the GZIP algorithm.

[static mode]: https://www.w3.org/TR/SVG2/conform.html#static-mode [secure static mode]: https://www.w3.org/TR/SVG2/conform.html#secure-static-mode

The “base file” and resolving references to external files

When you load an SVG, librsvg needs to know the location of the “base file” for it. This is so that librsvg can determine the location of referenced entities. For example, say you have an SVG in /foo/bar/foo.svg and that it has an image element like this:

`` <image href=”resources/foo.png” …/> ``

In this case, librsvg needs to know the location of the toplevel /foo/bar/foo.svg so that it can generate the appropriate reference to /foo/bar/resources/foo.png.

Security and locations of referenced files

When processing an SVG, librsvg will only load referenced files if they are in the same directory as the base file, or in a subdirectory of it. That is, if the base file is /foo/bar/baz.svg, then librsvg will only try to load referenced files (from SVG’s <image> element, for example, or from content included through XML entities) if those files are in /foo/bar/<anything> or in /foo/bar/<anything>\/.../<anything>. This is so that malicious SVG files cannot include files that are in a directory above.

The full set of rules for deciding which URLs may be loaded is as follows; they are applied in order. A referenced URL will not be loaded as soon as one of these rules fails:

All data: URLs may be loaded. These are sometimes used to include raster image data, encoded as base-64, directly in an SVG file.

URLs with queries (“?”) or fragment identifiers (“#”) are not allowed.

All URL schemes other than data: in references require a base URL. For example, this means that if you load an SVG with [ctor`Rsvg`.Handle.new_from_data] without calling [method`Rsvg`.Handle.set_base_uri], then any referenced files will not be allowed (e.g. raster images to be loaded from other files will not work).

If referenced URLs are absolute, rather than relative, then they must have the same scheme as the base URL. For example, if the base URL has a file scheme, then all URL references inside the SVG must also have the file scheme, or be relative references which will be resolved against the base URL.

If referenced URLs have a resource scheme, that is, if they are included into your binary program with GLib’s resource mechanism, they are allowed to be loaded (provided that the base URL is also a resource, per the previous rule).

Otherwise, non-file schemes are not allowed. For example, librsvg will not load http resources, to keep malicious SVG data from “phoning home”.

A relative URL must resolve to the same directory as the base URL, or to one of its subdirectories. Librsvg will canonicalize filenames, by removing “..” path components and resolving symbolic links, to decide whether files meet these conditions.

Loading an SVG with GIO

This is the easiest and most resource-efficient way of loading SVG data into an [class`Rsvg`.Handle].

If you have a GFile that stands for an SVG file, you can simply call [ctor`Rsvg`.Handle.new_from_gfile_sync] to load an [class`Rsvg`.Handle] from it.

Alternatively, if you have a GInputStream, you can use [ctor`Rsvg`.Handle.new_from_stream_sync].

Both of those methods allow specifying a GCancellable, so the loading process can be cancelled from another thread.

Loading an SVG from memory

If you already have SVG data in a byte buffer in memory, you can create a memory input stream with [ctor`Gio`.MemoryInputStream.new_from_data] and feed that to [ctor`Rsvg`.Handle.new_from_stream_sync].

Note that in this case, it is important that you specify the base_file for the in-memory SVG data. Librsvg uses the base_file to resolve links to external content, like raster images.

Loading an SVG without GIO

You can load an [class`Rsvg`.Handle] from a simple filename or URI with [ctor`Rsvg`.Handle.new_from_file]. Note that this is a blocking operation; there is no way to cancel it if loading a remote URI takes a long time. Also, note that this method does not let you specify [flags`Rsvg`.HandleFlags].

Otherwise, loading an SVG without GIO is not recommended, since librsvg will need to buffer your entire data internally before actually being able to parse it. The deprecated way of doing this is by creating a handle with [ctor`Rsvg`.Handle.new] or [ctor`Rsvg`.Handle.new_with_flags], and then using [method`Rsvg`.Handle.write] and [method`Rsvg`.Handle.close] to feed the handle with SVG data. Still, please try to use the GIO stream functions instead.

Resolution of the rendered image (dots per inch, or DPI)

SVG images can contain dimensions like “5cm” or “2pt” that must be converted from physical units into device units. To do this, librsvg needs to know the actual dots per inch (DPI) of your target device. You can call [method`Rsvg`.Handle.set_dpi] or [method`Rsvg`.Handle.set_dpi_x_y] on an [class`Rsvg`.Handle] to set the DPI before rendering it.

Rendering

The preferred way to render a whole SVG document is to use [method`Rsvg`.Handle.render_document]. Please see its documentation for details.

API ordering

Due to the way the librsvg API evolved over time, an [class`Rsvg`.Handle] object is available for use as soon as it is constructed. However, not all of its methods can be called at any time. For example, an [class`Rsvg`.Handle] just constructed with [ctor`Rsvg`.Handle.new] is not loaded yet, and it does not make sense to call [method`Rsvg`.Handle.render_document] on it just at that point.

The documentation for the available methods in [class`Rsvg`.Handle] may mention that a particular method is only callable on a “fully loaded handle”. This means either:

The handle was loaded with [method`Rsvg`.Handle.write] and [method`Rsvg`.Handle.close], and those functions returned no errors.
The handle was loaded with [method`Rsvg`.Handle.read_stream_sync] and that function returned no errors.

Before librsvg 2.46, the library did not fully verify that a handle was in a fully loaded state for the methods that require it. To preserve compatibility with old code which inadvertently called the API without checking for errors, or which called some methods outside of the expected order, librsvg will just emit a g_critical() message in those cases.

New methods introduced in librsvg 2.46 and later will check for the correct ordering, and panic if they are called out of order. This will abort the program as if it had a failed assertion.

classmethod new()¶

Returns:: A new [class`Rsvg`.Handle] with no flags set.
Return type:: Rsvg.Handle

Returns a new rsvg handle. Must be freed with [method`GObject`.Object.unref]. This handle can be used to load an image.

The preferred way of loading SVG data into the returned [class`Rsvg`.Handle] is with [method`Rsvg`.Handle.read_stream_sync].

The deprecated way of loading SVG data is with [method`Rsvg`.Handle.write] and [method`Rsvg`.Handle.close]; note that these require buffering the entire file internally, and for this reason it is better to use the stream functions: [ctor`Rsvg`.Handle.new_from_stream_sync], [method`Rsvg`.Handle.read_stream_sync], or [ctor`Rsvg`.Handle.new_from_gfile_sync].

After loading the [class`Rsvg`.Handle] with data, you can render it using Cairo or get a GdkPixbuf.Pixbuf from it. When finished, free the handle with [method`GObject`.Object.unref]. No more than one image can be loaded with one handle.

Note that this function creates an [class`Rsvg`.Handle] with no flags set. If you require any of [flags`Rsvg`.HandleFlags] to be set, use any of [ctor`Rsvg`.Handle.new_with_flags], [ctor`Rsvg`.Handle.new_from_stream_sync], or [ctor`Rsvg`.Handle.new_from_gfile_sync].

classmethod new_from_data(data)¶

Parameters:: data (bytes) – The SVG data
Raises:: GLib.Error
Returns:: A [class`Rsvg`.Handle] or NULL if an error occurs.
Return type:: Rsvg.Handle or None

Loads the SVG specified by data. Note that this function creates an [class`Rsvg`.Handle] without a base URL, and without any [flags`Rsvg`.HandleFlags]. If you need these, use [ctor`Rsvg`.Handle.new_from_stream_sync] instead by creating a [class`Gio`.MemoryInputStream] from your data.

New in version 2.14.

classmethod new_from_file(filename)¶

Parameters:: filename (str) – The file name to load, or a URI.
Raises:: GLib.Error
Returns:: A [class`Rsvg`.Handle] or NULL if an error occurs.
Return type:: Rsvg.Handle or None

Loads the SVG specified by file_name. Note that this function, like [ctor`Rsvg`.Handle.new], does not specify any loading flags for the resulting handle. If you require the use of [flags`Rsvg`.HandleFlags], use [ctor`Rsvg`.Handle.new_from_gfile_sync].

New in version 2.14.

classmethod new_from_gfile_sync(file, flags, cancellable)¶

Parameters:

file (Gio.File) – a GFile
flags (Rsvg.HandleFlags) – flags from [flags`Rsvg`.HandleFlags]
cancellable (Gio.Cancellable or None) – a GCancellable, or NULL

Raises:

GLib.Error

Returns:

a new [class`Rsvg`.Handle] on success, or NULL with error filled in

Return type:

Rsvg.Handle or None

Creates a new [class`Rsvg`.Handle] for file.

This function sets the “base file” of the handle to be file itself, so SVG elements like <image> which reference external resources will be resolved relative to the location of file.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned in error.

New in version 2.32.

classmethod new_from_stream_sync(input_stream, base_file, flags, cancellable)¶

Parameters:

input_stream (Gio.InputStream) – a GInputStream
base_file (Gio.File or None) – a GFile, or NULL
flags (Rsvg.HandleFlags) – flags from [flags`Rsvg`.HandleFlags]
cancellable (Gio.Cancellable or None) – a GCancellable, or NULL

Raises:

GLib.Error

Returns:

a new [class`Rsvg`.Handle] on success, or NULL with error filled in

Return type:

Rsvg.Handle or None

Creates a new [class`Rsvg`.Handle] for stream.

This function sets the “base file” of the handle to be base_file if provided. SVG elements like <image> which reference external resources will be resolved relative to the location of base_file.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned in error.

New in version 2.32.

classmethod new_with_flags(flags)¶

Parameters:: flags (Rsvg.HandleFlags) – flags from [flags`Rsvg`.HandleFlags]
Returns:: a new [class`Rsvg`.Handle]
Return type:: Rsvg.Handle

Creates a new [class`Rsvg`.Handle] with flags flags. After calling this function, you can feed the resulting handle with SVG data by using [method`Rsvg`.Handle.read_stream_sync].

New in version 2.36.

close()¶

Raises:: GLib.Error
Returns:: TRUE on success, or FALSE on error.
Return type:: bool

This is used after calling [method`Rsvg`.Handle.write] to indicate that there is no more data to consume, and to start the actual parsing of the SVG document. The only reason to call this function is if you use use [method`Rsvg`.Handle.write] to feed data into the self; if you use the other methods like [ctor`Rsvg`.Handle.new_from_file] or [method`Rsvg`.Handle.read_stream_sync], then you do not need to call this function.

This will return TRUE if the loader closed successfully and the SVG data was parsed correctly. Note that self isn’t freed until [method`GObject`.Object.unref] is called.

Deprecated since version 2.46.: Use [method`Rsvg`.Handle.read_stream_sync] or the constructor functions [ctor`Rsvg`.Handle.new_from_gfile_sync] or [ctor`Rsvg`.Handle.new_from_stream_sync]. See the deprecation notes for [method`Rsvg`.Handle.write] for more information.

free()¶: Frees self.

Deprecated since version ???: Use [method`GObject`.Object.unref] instead.

get_base_uri()¶

Returns:: the base uri, possibly null
Return type:: str

Gets the base uri for this [class`Rsvg`.Handle].

New in version 2.8.

get_desc()¶

Returns:: This function always returns NULL.
Return type:: str or None

New in version 2.4.

Deprecated since version 2.36.: Librsvg does not read the metadata/desc/title elements; this function always returns NULL.

get_dimensions()¶

Returns:: A place to store the SVG’s size
Return type:: dimension_data: Rsvg.DimensionData

Get the SVG’s size. Do not call from within the size_func callback, because an infinite loop will occur.

This function depends on the [class`Rsvg`.Handle]’s DPI to compute dimensions in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

New in version 2.14.

Deprecated since version 2.52.: Use [method`Rsvg`.Handle.get_intrinsic_size_in_pixels] instead. This function is deprecated because it is not able to return exact fractional dimensions, only integer pixels.

get_dimensions_sub(id)¶

Parameters:

id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to use the whole SVG.

Returns:

TRUE if the dimensions could be obtained, FALSE if there was an error.

dimension_data:: A place to store the SVG’s size

Return type:

(bool, dimension_data: Rsvg.DimensionData)

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.

This function depends on the [class`Rsvg`.Handle]’s DPI to compute dimensions in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

New in version 2.22.

Deprecated since version 2.46.: Use [method`Rsvg`.Handle.get_geometry_for_layer] instead.

get_geometry_for_element(id)¶

Parameters:

id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to compute the geometry for the whole SVG.

Raises:

GLib.Error

Returns:

TRUE if the geometry could be obtained, or FALSE on error. Errors are returned in the error argument.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

out_ink_rect:: Place to store the ink rectangle of the element.
out_logical_rect:: Place to store the logical rectangle of the element.

Return type:

(bool, out_ink_rect: Rsvg.Rectangle, out_logical_rect: Rsvg.Rectangle)

Computes the ink rectangle and logical rectangle of a single SVG element.

While rsvg_handle_get_geometry_for_layer computes the geometry of an SVG element subtree with its transformation matrix, this other function will compute the element’s geometry as if it were being rendered under an identity transformation by itself. That is, the resulting geometry is as if the element got extracted by itself from the SVG.

This function is the counterpart to rsvg_handle_render_element.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

The “ink rectangle” is the bounding box that would be painted for fully- stroked and filled elements.

The “logical rectangle” just takes into account the unstroked paths and text outlines.

Note that these bounds are not minimum bounds; for example, clipping paths are not taken into account.

You can pass NULL for the id if you want to measure all the elements in the SVG, i.e. to measure everything from the root element.

This operation is not constant-time, as it involves going through all the child elements.

New in version 2.46.

get_geometry_for_layer(id, viewport)¶

Parameters:

id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to compute the geometry for the whole SVG.
viewport (Rsvg.Rectangle) – Viewport size at which the whole SVG would be fitted.

Raises:

GLib.Error

Returns:

TRUE if the geometry could be obtained, or FALSE on error. Errors are returned in the error argument.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

out_ink_rect:: Place to store the ink rectangle of the element.
out_logical_rect:: Place to store the logical rectangle of the element.

Return type:

(bool, out_ink_rect: Rsvg.Rectangle, out_logical_rect: Rsvg.Rectangle)

Computes the ink rectangle and logical rectangle of an SVG element, or the whole SVG, as if the whole SVG were rendered to a specific viewport.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

The “ink rectangle” is the bounding box that would be painted for fully-stroked and filled elements.

The “logical rectangle” just takes into account the unstroked paths and text outlines.

Note that these bounds are not minimum bounds; for example, clipping paths are not taken into account.

You can pass NULL for the id if you want to measure all the elements in the SVG, i.e. to measure everything from the root element.

This operation is not constant-time, as it involves going through all the child elements.

New in version 2.46.

get_intrinsic_dimensions()¶

Returns:

out_has_width:: Will be set to TRUE; see below.
out_width:: Will be set to the computed value of the width property in the toplevel SVG.
out_has_height:: Will be set to TRUE; see below.
out_height:: Will be set to the computed value of the height property in the toplevel SVG.
out_has_viewbox:: Will be set to TRUE if the toplevel SVG has a viewBox attribute
out_viewbox:: Will be set to the value of the viewBox attribute in the toplevel SVG

Return type:

(out_has_width: bool, out_width: Rsvg.Length, out_has_height: bool, out_height: Rsvg.Length, out_has_viewbox: bool, out_viewbox: Rsvg.Rectangle)

In simple terms, queries the width, height, and viewBox attributes in an SVG document.

If you are calling this function to compute a scaling factor to render the SVG, consider simply using [method`Rsvg`.Handle.render_document] instead; it will do the scaling computations automatically.

Before librsvg 2.54.0, the out_has_width and out_has_height arguments would be set to true or false depending on whether the SVG document actually had width and height attributes, respectively.

However, since librsvg 2.54.0, width and height are now geometry properties per the SVG2 specification; they are not plain attributes. SVG2 made it so that the initial value of those properties is auto, which is equivalent to specifing a value of 100%. In this sense, even SVG documents which lack width or height attributes semantically have to make them default to 100%. This is why since librsvg 2.54.0, out_has_width and out_has_heigth are always returned as TRUE, since with SVG2 all documents *have* a default width and height of 100%.

As an example, the following SVG element has a width of 100 pixels and a height of 400 pixels, but no viewBox. This function will return those sizes in out_width and out_height, and set out_has_viewbox to FALSE.

`` <svg xmlns=”http://www.w3.org/2000/svg” width=”100” height=”400”> ``

Conversely, the following element has a viewBox, but no width or height. This function will set out_has_viewbox to TRUE, and it will also set out_has_width and out_has_height to TRUE but return both length values as 100%.

`` <svg xmlns=”http://www.w3.org/2000/svg” viewBox=”0 0 100 400”> ``

Note that the RsvgLength return values have RsvgUnits in them; you should not assume that they are always in pixels. For example, the following SVG element will return width and height values whose units fields are RSVG_UNIT_MM.

`` <svg xmlns=”http://www.w3.org/2000/svg” width=”210mm” height=”297mm”> ``

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

New in version 2.46.

get_intrinsic_size_in_pixels()¶

Returns:

TRUE if the dimensions could be converted directly to pixels; in this case out_width and out_height will be set accordingly. Note that the dimensions are floating-point numbers, so your application can know the exact size of an SVG document. To get integer dimensions, you should use ceil() to round up to the nearest integer (just using round(), may may chop off pixels with fractional coverage). If the dimensions cannot be converted to pixels, returns FALSE and puts 0.0 in both out_width and out_height.

out_width:: Will be set to the computed width; you should round this up to get integer pixels.
out_height:: Will be set to the computed height; you should round this up to get integer pixels.

Return type:

(bool, out_width: float, out_height: float)

Converts an SVG document’s intrinsic dimensions to pixels, and returns the result.

This function is able to extract the size in pixels from an SVG document if the document has both width and height attributes with physical units (px, in, cm, mm, pt, pc) or font-based units (em, ex). For physical units, the dimensions are normalized to pixels using the dots-per-inch (DPI) value set previously with [method`Rsvg`.Handle.set_dpi]. For font-based units, this function uses the computed value of the font-size property for the toplevel <svg> element. In those cases, this function returns TRUE.

This function is not able to extract the size in pixels directly from the intrinsic dimensions of the SVG document if the width or height are in percentage units (or if they do not exist, in which case the SVG spec mandates that they default to 100%), as these require a <firstterm>viewport</firstterm> to be resolved to a final size. In this case, the function returns FALSE.

For example, the following document fragment has intrinsic dimensions that will resolve to 20x30 pixels.

`` <svg xmlns=”http://www.w3.org/2000/svg” width=”20” height=”30”/> ``

Similarly, if the DPI is set to 96, this document will resolve to 192×288 pixels (i.e. 96×2 × 96×3).

`` <svg xmlns=”http://www.w3.org/2000/svg” width=”2in” height=”3in”/> ``

The dimensions of the following documents cannot be resolved to pixels directly, and this function would return FALSE for them:

``` <!– Needs a viewport against which to compute the percentages. –> <svg xmlns=”http://www.w3.org/2000/svg” width=”100%” height=”100%”/>

<!– Does not have intrinsic width/height, just a 1:2 aspect ratio which needs to be fitted within a viewport. –> <svg xmlns=”http://www.w3.org/2000/svg” viewBox=”0 0 100 200”/> ```

Instead of querying an SVG document’s size, applications are encouraged to render SVG documents to a size chosen by the application, by passing a suitably-sized viewport to [method`Rsvg`.Handle.render_document].

New in version 2.52.

get_metadata()¶

Returns:: This function always returns NULL.
Return type:: str or None

New in version 2.9.

Deprecated since version 2.36.: Librsvg does not read the metadata/desc/title elements; this function always returns NULL.

get_pixbuf()¶

Returns:: A pixbuf, or None on error. during rendering.
Return type:: GdkPixbuf.Pixbuf or None

Returns the pixbuf loaded by self. The pixbuf returned will be reffed, so the caller of this function must assume that ref.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

This function depends on the [class`Rsvg`.Handle]’s dots-per-inch value (DPI) to compute the “natural size” of the document in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

get_pixbuf_sub(id)¶

Parameters:: id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to use the whole SVG.
Returns:: a pixbuf, or NULL if an error occurs during rendering.
Return type:: GdkPixbuf.Pixbuf or None

Creates a GdkPixbuf the same size as the entire SVG loaded into self, but only renders the sub-element that has the specified id (and all its sub-sub-elements recursively). If id is NULL, this function renders the whole SVG.

This function depends on the [class`Rsvg`.Handle]’s dots-per-inch value (DPI) to compute the “natural size” of the document in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

If you need to render an image which is only big enough to fit a particular sub-element of the SVG, consider using [method`Rsvg`.Handle.render_element].

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

New in version 2.14.

get_position_sub(id)¶

Parameters:

id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass None to use the whole SVG.

Returns:

TRUE if the position could be obtained, FALSE if there was an error.

position_data:: A place to store the SVG fragment’s position.

Return type:

(bool, position_data: Rsvg.PositionData)

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.

This function depends on the [class`Rsvg`.Handle]’s DPI to compute dimensions in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

New in version 2.22.

Deprecated since version 2.46.: Use [method`Rsvg`.Handle.get_geometry_for_layer] instead. This function is deprecated since it is not able to return exact floating-point positions, only integer pixels.

get_title()¶

Returns:: This function always returns NULL.
Return type:: str or None

New in version 2.4.

Deprecated since version 2.36.: Librsvg does not read the metadata/desc/title elements; this function always returns NULL.

has_sub(id)¶

Parameters:: id (str) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID.
Returns:: TRUE if id exists in the SVG document, FALSE otherwise.
Return type:: bool

Checks whether the element id exists in the SVG document.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

New in version 2.22.

internal_set_testing(testing)¶

Parameters:: testing (bool) – Whether to enable testing mode

Do not call this function. This is intended for librsvg’s internal test suite only.

read_stream_sync(stream, cancellable)¶

Parameters:

stream (Gio.InputStream) – a GInputStream
cancellable (Gio.Cancellable or None) – a GCancellable, or NULL

Raises:

GLib.Error

Returns:

TRUE if reading stream succeeded, or FALSE otherwise with error filled in

Return type:

bool

Reads stream and writes the data from it to self.

Before calling this function, you may need to call [method`Rsvg`.Handle.set_base_uri] or [method`Rsvg`.Handle.set_base_gfile] to set the “base file” for resolving references to external resources. SVG elements like <image> which reference external resources will be resolved relative to the location you specify with those functions.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned.

New in version 2.32.

render_cairo(cr)¶

Parameters:: cr (cairo.Context) – A Cairo context
Returns:: TRUE if drawing succeeded; FALSE otherwise. This function will emit a g_warning() if a rendering error occurs.
Return type:: bool

Draws a loaded SVG handle to a Cairo context. Please try to use [method`Rsvg`.Handle.render_document] instead, which allows you to pick the size at which the document will be rendered.

Historically this function has picked a size by itself, based on the following rules:

If the SVG document has both width and height attributes with physical units (px, in, cm, mm, pt, pc) or font-based units (em, ex), the function computes the size directly based on the dots-per-inch (DPI) you have configured with [method`Rsvg`.Handle.set_dpi]. This is the same approach as [method`Rsvg`.Handle.get_intrinsic_size_in_pixels].
Otherwise, if there is a viewBox attribute and both width and height are set to 100% (or if they don’t exist at all and thus default to 100%), the function uses the width and height of the viewBox as a pixel size. This produces a rendered document with the correct aspect ratio.
Otherwise, this function computes the extents of every graphical object in the SVG document to find the total extents. This is moderately expensive, but no more expensive than rendering the whole document, for example.
This function cannot deal with percentage-based units for width and height because there is no viewport against which they could be resolved; that is why it will compute the extents of objects in that case. This is why we recommend that you use [method`Rsvg`.Handle.render_document] instead, which takes in a viewport and follows the sizing policy from the web platform.

Drawing will occur with respect to the cr's current transformation: for example, if the cr has a rotated current transformation matrix, the whole SVG will be rotated in the rendered version.

This function depends on the [class`Rsvg`.Handle]’s DPI to compute dimensions in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

Note that cr must be a Cairo context that is not in an error state, that is, cairo_status() must return CAIRO_STATUS_SUCCESS for it. Cairo can set a context to be in an error state in various situations, for example, if it was passed an invalid matrix or if it was created for an invalid surface.

New in version 2.14.

Deprecated since version 2.52.: Please use [method`Rsvg`.Handle.render_document] instead; that function lets you pass a viewport and obtain a good error message.

render_cairo_sub(cr, id)¶

Parameters:

cr (cairo.Context) – A Cairo context
id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to render the whole SVG.

Returns:

TRUE if drawing succeeded; FALSE otherwise. This function will emit a g_warning() if a rendering error occurs.

Return type:

bool

Renders a single SVG element in the same place as for a whole SVG document (a “subset” of the document). Please try to use [method`Rsvg`.Handle.render_layer] instead, which allows you to pick the size at which the document with the layer will be rendered.

This is equivalent to [method`Rsvg`.Handle.render_cairo], but it renders only a single element and its children, as if they composed an individual layer in the SVG.

Historically this function has picked a size for the whole document by itself, based on the following rules:

If the SVG document has both width and height attributes with physical units (px, in, cm, mm, pt, pc) or font-based units (em, ex), the function computes the size directly based on the dots-per-inch (DPI) you have configured with [method`Rsvg`.Handle.set_dpi]. This is the same approach as [method`Rsvg`.Handle.get_intrinsic_size_in_pixels].
Otherwise, if there is a viewBox attribute and both width and height are set to 100% (or if they don’t exist at all and thus default to 100%), the function uses the width and height of the viewBox as a pixel size. This produces a rendered document with the correct aspect ratio.
Otherwise, this function computes the extents of every graphical object in the SVG document to find the total extents. This is moderately expensive, but no more expensive than rendering the whole document, for example.
This function cannot deal with percentage-based units for width and height because there is no viewport against which they could be resolved; that is why it will compute the extents of objects in that case. This is why we recommend that you use [method`Rsvg`.Handle.render_layer] instead, which takes in a viewport and follows the sizing policy from the web platform.

Drawing will occur with respect to the cr's current transformation: for example, if the cr has a rotated current transformation matrix, the whole SVG will be rotated in the rendered version.

This function depends on the [class`Rsvg`.Handle]’s DPI to compute dimensions in pixels, so you should call [method`Rsvg`.Handle.set_dpi] beforehand.

Note that cr must be a Cairo context that is not in an error state, that is, cairo_status() must return CAIRO_STATUS_SUCCESS for it. Cairo can set a context to be in an error state in various situations, for example, if it was passed an invalid matrix or if it was created for an invalid surface.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

New in version 2.14.

Deprecated since version 2.52.: Please use [method`Rsvg`.Handle.render_layer] instead; that function lets you pass a viewport and obtain a good error message.

render_document(cr, viewport)¶

Parameters:

cr (cairo.Context) – A Cairo context
viewport (Rsvg.Rectangle) – Viewport size at which the whole SVG would be fitted.

Raises:

GLib.Error

Returns:

TRUE on success, FALSE on error. Errors are returned in the error argument.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

Return type:

bool

Renders the whole SVG document fitted to a viewport.

The viewport gives the position and size at which the whole SVG document will be rendered. The document is scaled proportionally to fit into this viewport.

The cr must be in a CAIRO_STATUS_SUCCESS state, or this function will not render anything, and instead will return an error.

New in version 2.46.

render_element(cr, id, element_viewport)¶

Parameters:

cr (cairo.Context) – A Cairo context
id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to render the whole SVG document tree.
element_viewport (Rsvg.Rectangle) – Viewport size in which to fit the element

Raises:

GLib.Error

Returns:

TRUE on success, FALSE on error. Errors are returned in the error argument.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

Return type:

bool

Renders a single SVG element to a given viewport.

This function can be used to extract individual element subtrees and render them, scaled to a given element_viewport. This is useful for applications which have reusable objects in an SVG and want to render them individually; for example, an SVG full of icons that are meant to be be rendered independently of each other.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

You can pass NULL for the id if you want to render all the elements in the SVG, i.e. to render everything from the root element.

The element_viewport gives the position and size at which the named element will be rendered. FIXME: mention proportional scaling.

New in version 2.46.

render_layer(cr, id, viewport)¶

Parameters:

cr (cairo.Context) – A Cairo context
id (str or None) – An element’s id within the SVG, starting with “#” (a single hash character), for example, #layer1. This notation corresponds to a URL’s fragment ID. Alternatively, pass NULL to render the whole SVG document tree.
viewport (Rsvg.Rectangle) – Viewport size at which the whole SVG would be fitted.

Raises:

GLib.Error

Returns:

TRUE on success, FALSE on error. Errors are returned in the error argument.

API ordering: This function must be called on a fully-loaded self. See the section “API ordering” for details.

Panics: this function will panic if the self is not fully-loaded.

Return type:

bool

Renders a single SVG element in the same place as for a whole SVG document.

The viewport gives the position and size at which the whole SVG document would be rendered. The document is scaled proportionally to fit into this viewport; hence the individual layer may be smaller than this.

This is equivalent to [method`Rsvg`.Handle.render_document], but it renders only a single element and its children, as if they composed an individual layer in the SVG. The element is rendered with the same transformation matrix as it has within the whole SVG document. Applications can use this to re-render a single element and repaint it on top of a previously-rendered document, for example.

Element IDs should look like an URL fragment identifier; for example, pass #foo (hash foo) to get the geometry of the element that has an id="foo" attribute.

You can pass NULL for the id if you want to render all the elements in the SVG, i.e. to render everything from the root element.

New in version 2.46.

set_base_gfile(base_file)¶

Parameters:: base_file (Gio.File) – a GFile

Set the base URI for self from file.

Note: This function may only be called before [method`Rsvg`.Handle.write] or [method`Rsvg`.Handle.read_stream_sync] have been called.

New in version 2.32.

set_base_uri(base_uri)¶

Parameters:: base_uri (str) – The base uri

Set the base URI for this SVG.

Note: This function may only be called before [method`Rsvg`.Handle.write] or [method`Rsvg`.Handle.read_stream_sync] have been called.

New in version 2.9.

set_dpi(dpi)¶

Parameters:: dpi (float) – Dots Per Inch (i.e. as Pixels Per Inch)

Sets the DPI at which the self will be rendered. Common values are 75, 90, and 300 DPI.

Passing a number <= 0 to dpi will reset the DPI to whatever the default value happens to be, but since [id`rsvg_set_default_dpi`] is deprecated, please do not pass values <= 0 to this function.

New in version 2.8.

set_dpi_x_y(dpi_x, dpi_y)¶

Parameters:

dpi_x (float) – Dots Per Inch (i.e. Pixels Per Inch)
dpi_y (float) – Dots Per Inch (i.e. Pixels Per Inch)

Sets the DPI at which the self will be rendered. Common values are 75, 90, and 300 DPI.

Passing a number <= 0 to dpi will reset the DPI to whatever the default value happens to be, but since [id`rsvg_set_default_dpi_x_y`] is deprecated, please do not pass values <= 0 to this function.

New in version 2.8.

set_size_callback(size_func, *user_data)¶

Parameters:

size_func (Rsvg.SizeFunc or None) – A sizing function, or NULL
user_data (object or None) – User data to pass to size_func, or NULL

Sets the sizing function for the self, which can be used to override the size that librsvg computes for SVG images. The size_func is called from the following functions:

[method`Rsvg`.Handle.get_dimensions]
[method`Rsvg`.Handle.get_dimensions_sub]
[method`Rsvg`.Handle.get_position_sub]
[method`Rsvg`.Handle.render_cairo]
[method`Rsvg`.Handle.render_cairo_sub]

Librsvg computes the size of the SVG being rendered, and passes it to the size_func, which may then modify these values to set the final size of the generated image.

Deprecated since version 2.14.: Use [method`Rsvg`.Handle.render_document] instead. This function was deprecated because when the size_func is used, it makes it unclear when the librsvg functions which call the size_func will use the size computed originally, or the callback-specified size, or whether it refers to the whole SVG or to just a sub-element of it. It is easier, and unambiguous, to use code similar to the example above.

set_stylesheet(css)¶

Parameters:: css (bytes) – String with CSS data; must be valid UTF-8.
Raises:: GLib.Error
Returns:: TRUE on success, FALSE on error. Errors are returned in the error argument.
Return type:: bool

Sets a CSS stylesheet to use for an SVG document.

The css_len argument is mandatory; this function will not compute the length of the css string. This is because a provided stylesheet, which the calling program could read from a file, can have nul characters in it.

During the CSS cascade, the specified stylesheet will be used with a “User” origin.

Note that @import rules will not be resolved, except for data: URLs.

New in version 2.48.

write(buf)¶

Parameters:: buf (bytes) – pointer to svg data
Raises:: GLib.Error
Returns:: TRUE on success, or FALSE on error.
Return type:: bool

Loads the next count bytes of the image. You can call this function multiple times until the whole document is consumed; then you must call [method`Rsvg`.Handle.close] to actually parse the document.

Before calling this function for the first time, you may need to call [method`Rsvg`.Handle.set_base_uri] or [method`Rsvg`.Handle.set_base_gfile] to set the “base file” for resolving references to external resources. SVG elements like <image> which reference external resources will be resolved relative to the location you specify with those functions.

Deprecated since version 2.46.: Use [method`Rsvg`.Handle.read_stream_sync] or the constructor functions [ctor`Rsvg`.Handle.new_from_gfile_sync] or [ctor`Rsvg`.Handle.new_from_stream_sync]. This function is deprecated because it will accumulate data from the buf in memory until [method`Rsvg`.Handle.close] gets called. To avoid a big temporary buffer, use the suggested functions, which take a GFile or a GInputStream and do not require a temporary buffer.

Property Details¶

Rsvg.Handle.props.base_uri¶

Name:: base-uri
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Base URI, to be used to resolve relative references for resources. See the section “Security and locations of referenced files” for details.

Rsvg.Handle.props.desc¶

Name:: desc
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE

SVG’s description.

Deprecated since version 2.36.: Reading this property always returns NULL.

Rsvg.Handle.props.dpi_x¶

Name:: dpi-x
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT

Horizontal resolution in dots per inch.

Rsvg.Handle.props.dpi_y¶

Name:: dpi-y
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT

Horizontal resolution in dots per inch.

Rsvg.Handle.props.em¶

Name:: em
Type:: float
Default Value:: 0.0
Flags:: READABLE

Exact width, in pixels, of the rendered SVG before calling the size callback as specified by [method`Rsvg`.Handle.set_size_callback].

Deprecated since version 2.46.: Reading each of the size properties causes the size of the SVG to be recomputed, so reading both the em and ex properties will cause two such computations. Please use [method`Rsvg`.Handle.get_intrinsic_dimensions] instead.

Rsvg.Handle.props.ex¶

Name:: ex
Type:: float
Default Value:: 0.0
Flags:: READABLE

Exact height, in pixels, of the rendered SVG before calling the size callback as specified by [method`Rsvg`.Handle.set_size_callback].

Deprecated since version 2.46.: Reading each of the size properties causes the size of the SVG to be recomputed, so reading both the em and ex properties will cause two such computations. Please use [method`Rsvg`.Handle.get_intrinsic_dimensions] instead.

Rsvg.Handle.props.flags¶

Name:: flags
Type:: Rsvg.HandleFlags
Default Value:: Rsvg.HandleFlags.FLAGS_NONE
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Flags from [flags`Rsvg`.HandleFlags].

New in version 2.36.

Rsvg.Handle.props.height¶

Name:: height
Type:: int
Default Value:: 0
Flags:: READABLE

Height, in pixels, of the rendered SVG after calling the size callback as specified by [method`Rsvg`.Handle.set_size_callback].

Deprecated since version 2.46.: For historical reasons, this property is of integer type, which cannot give the exact size of SVG images that are not pixel-aligned. Moreover, reading each of the size properties causes the size of the SVG to be recomputed, so reading both the width and height properties will cause two such computations. Please use [method`Rsvg`.Handle.get_intrinsic_dimensions] instead.

Rsvg.Handle.props.metadata¶

Name:: metadata
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE

SVG’s metadata

Deprecated since version 2.36.: Reading this property always returns NULL.

Rsvg.Handle.props.title¶

Name:: title
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE

SVG’s title.

Deprecated since version 2.36.: Reading this property always returns NULL.

Rsvg.Handle.props.width¶

Name:: width
Type:: int
Default Value:: 0
Flags:: READABLE

Width, in pixels, of the rendered SVG after calling the size callback as specified by [method`Rsvg`.Handle.set_size_callback].

Deprecated since version 2.46.: For historical reasons, this property is of integer type, which cannot give the exact size of SVG images that are not pixel-aligned. Moreover, reading each of the size properties causes the size of the SVG to be recomputed, so reading both the width and height properties will cause two such computations. Please use [method`Rsvg`.Handle.get_intrinsic_dimensions] instead.