Returns a new rsvg handle. Must be freed with gobject.object.ObjectG.unref. This handle can be used to load an image.
This is used after calling rsvg.handle.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 rsvg.handle.Handle.write to feed data into the handle; if you use the other methods like rsvg.handle.Handle.newFromFile or rsvg.handle.Handle.readStreamSync, then you do not need to call this function.
Gets the base uri for this rsvg.handle.Handle.
Get the SVG's size. Do not call from within the size_func callback, because an infinite loop will occur.
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.
Computes the ink rectangle and logical rectangle of a single SVG element.
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.
In simple terms, queries the width, height, and viewBox attributes in an SVG document.
Converts an SVG document's intrinsic dimensions to pixels, and returns the result.
Returns the pixbuf loaded by handle. The pixbuf returned will be reffed, so the caller of this function must assume that ref.
Creates a gdkpixbuf.pixbuf.Pixbuf the same size as the entire SVG loaded into handle, 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.
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.
Checks whether the element id exists in the SVG document.
Do not call this function. This is intended for librsvg's internal test suite only.
Reads stream and writes the data from it to handle.
Draws a loaded SVG handle to a Cairo context. Please try to use rsvg.handle.Handle.renderDocument instead, which allows you to pick the size at which the document will be rendered.
Renders a single SVG element in the same place as for a whole SVG document (a "subset" of the document). Please try to use rsvg.handle.Handle.renderLayer instead, which allows you to pick the size at which the document with the layer will be rendered.
Renders the whole SVG document fitted to a viewport.
Renders a single SVG element to a given viewport.
Renders a single SVG element in the same place as for a whole SVG document.
Set the base URI for handle from file.
Set the base URI for this SVG.
Sets the DPI at which the handle will be rendered. Common values are 75, 90, and 300 DPI.
Sets the DPI at which the handle will be rendered. Common values are 75, 90, and 300 DPI.
Sets the sizing function for the handle, which can be used to override the size that librsvg computes for SVG images. The size_func is called from the following functions:
Sets a CSS stylesheet to use for an SVG document.
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 rsvg.handle.Handle.close to actually parse the document.
Loads the SVG specified by data. Note that this function creates an rsvg.handle.Handle without a base URL, and without any rsvg.types.HandleFlags. If you need these, use rsvg.handle.Handle.newFromStreamSync instead by creating a gio.memory_input_stream.MemoryInputStream from your data.
Loads the SVG specified by file_name. Note that this function, like rsvg.handle.Handle.new_, does not specify any loading flags for the resulting handle. If you require the use of rsvg.types.HandleFlags, use rsvg.handle.Handle.newFromGfileSync.
Creates a new rsvg.handle.Handle for file.
Creates a new rsvg.handle.Handle for stream.
Creates a new rsvg.handle.Handle with flags flags. After calling this function, you can feed the resulting handle with SVG data by using rsvg.handle.Handle.readStreamSync.
Set the GObject of a D ObjectG wrapper.
Get a pointer to the underlying C object.
Calls g_object_ref() on a GObject.
Calls g_object_unref() on a GObject.
Get the GType of an object.
GObject GType property.
Convenience method to return this cast to a type. For use in D with statements.
Template to get the D object from a C GObject and cast it to the given D object type.
Connect a D closure to an object signal.
Template for setting a GObject property.
Template for getting a GObject property.
Creates a binding between source_property on source and target_property on target.
Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
Gets a property of an object.
This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
Checks whether object has a floating[floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
Emits a "notify" signal for the property specified by pspec on object.
Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
Releases all references to other objects. This can be used to break reference cycles.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
Sets a property on an object.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
Connect to Notify signal.
rsvg.handle.Handle loads an SVG document into memory.
This is the main entry point into the librsvg library. An rsvg.handle.Handle is an object that represents SVG data in memory. Your program creates an rsvg.handle.Handle from an SVG file, or from a memory buffer that contains SVG data, or in the most general form, from a gio.input_stream.InputStream 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:
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:
1. All data: URLs may be loaded. These are sometimes used to include raster image data, encoded as base-64, directly in an SVG file.
2. URLs with queries ("?") or fragment identifiers ("#") are not allowed.
3. All URL schemes other than data: in references require a base URL. For example, this means that if you load an SVG with rsvg.handle.Handle.newFromData without calling rsvg.handle.Handle.setBaseUri, then any referenced files will not be allowed (e.g. raster images to be loaded from other files will not work).
4. 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.
5. 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).
6. Otherwise, non-file schemes are not allowed. For example, librsvg will not load http resources, to keep malicious SVG data from "phoning home".
7. 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 rsvg.handle.Handle.
If you have a gio.file.File that stands for an SVG file, you can simply call rsvg.handle.Handle.newFromGfileSync to load an rsvg.handle.Handle from it.
Alternatively, if you have a gio.input_stream.InputStream, you can use rsvg.handle.Handle.newFromStreamSync.
Both of those methods allow specifying a gio.cancellable.Cancellable, 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 gio.memory_input_stream.MemoryInputStream.newFromData and feed that to rsvg.handle.Handle.newFromStreamSync.
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 rsvg.handle.Handle from a simple filename or URI with rsvg.handle.Handle.newFromFile. 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 rsvg.types.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 rsvg.handle.Handle.new_ or rsvg.handle.Handle.newWithFlags, and then using rsvg.handle.Handle.write and rsvg.handle.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 rsvg.handle.Handle.setDpi or rsvg.handle.Handle.setDpiXY on an rsvg.handle.Handle to set the DPI before rendering it.
Rendering
The preferred way to render a whole SVG document is to use rsvg.handle.Handle.renderDocument. Please see its documentation for details.
API ordering
Due to the way the librsvg API evolved over time, an rsvg.handle.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 rsvg.handle.Handle just constructed with rsvg.handle.Handle.new_ is not loaded yet, and it does not make sense to call rsvg.handle.Handle.renderDocument on it just at that point.
The documentation for the available methods in rsvg.handle.Handle may mention that a particular method is only callable on a "fully loaded handle". This means either:
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.