Handle

Lets you load SVG data and render it.

class Handle : ObjectG {}

Constructors

this
this(RsvgHandle* rsvgHandle, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Returns a new rsvg handle. Must be freed with @g_object_unref. This handle can be used to load an image.

this
this(ubyte[] data)

Loads the SVG specified by @data. Note that this function creates an #RsvgHandle without a base URL, and without any #RsvgHandleFlags. If you need these, use rsvg_handle_new_from_stream_sync() instead by creating a #GMemoryInputStream from your data.

this
this(string filename)

Loads the SVG specified by @file_name. Note that this function, like rsvg_handle_new(), does not specify any loading flags for the resulting handle. If you require the use of #RsvgHandleFlags, use rsvg_handle_new_from_gfile_sync().

this
this(FileIF file, RsvgHandleFlags flags, Cancellable cancellable)

Creates a new #RsvgHandle for @file.

this
this(InputStream inputStream, FileIF baseFile, RsvgHandleFlags flags, Cancellable cancellable)

Creates a new #RsvgHandle for @stream.

this
this(RsvgHandleFlags flags)

Creates a new #RsvgHandle with flags @flags. After calling this function, you can feed the resulting handle with SVG data by using rsvg_handle_read_stream_sync().

Members

Functions

close
bool close()

Closes @handle, to indicate that loading the image is complete. This will return %TRUE if the loader closed successfully and the SVG data was parsed correctly. Note that @handle isn't freed until @g_object_unref is called.

getBaseUri
string getBaseUri()

Gets the base uri for this #RsvgHandle.

getDimensions
void getDimensions(RsvgDimensionData dimensionData)

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

getDimensionsSub
bool getDimensionsSub(RsvgDimensionData dimensionData, string id)

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.

getGeometryForElement
bool getGeometryForElement(string id, RsvgRectangle outInkRect, RsvgRectangle outLogicalRect)

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

getGeometryForLayer
bool getGeometryForLayer(string id, RsvgRectangle* viewport, RsvgRectangle outInkRect, RsvgRectangle outLogicalRect)

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.

getHandleStruct
RsvgHandle* getHandleStruct(bool transferOwnership)

Get the main Gtk struct

getIntrinsicDimensions
void getIntrinsicDimensions(bool outHasWidth, RsvgLength outWidth, bool outHasHeight, RsvgLength outHeight, bool outHasViewbox, RsvgRectangle outViewbox)

Queries the <literal>width</literal>, <literal>height</literal>, and <literal>viewBox</literal> attributes in an SVG document.

getPixbuf
Pixbuf getPixbuf()

Returns the pixbuf loaded by @handle. The pixbuf returned will be reffed, so the caller of this function must assume that ref. If insufficient data has been read to create the pixbuf, or an error occurred in loading, then %NULL will be returned. Note that the pixbuf may not be complete until @rsvg_handle_close has been called.

getPixbufSub
Pixbuf getPixbufSub(string id)

Creates a #GdkPixbuf 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.

getPositionSub
bool getPositionSub(RsvgPositionData positionData, string id)

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.

getStruct
void* getStruct()

the main Gtk struct as a void*

hasSub
bool hasSub(string id)

Checks whether the element @id exists in the SVG document.

internalSetTesting
void internalSetTesting(bool testing)

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

readStreamSync
bool readStreamSync(InputStream stream, Cancellable cancellable)

Reads @stream and writes the data from it to @handle.

renderCairo
bool renderCairo(Context cr)

Draws a loaded SVG handle to a Cairo context. 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.

renderCairoSub
bool renderCairoSub(Context cr, string id)

Draws a subset of a loaded SVG handle to a Cairo context. 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.

renderDocument
bool renderDocument(Context cr, RsvgRectangle* viewport)

Renders the whole SVG document fitted to a viewport.

renderElement
bool renderElement(Context cr, string id, RsvgRectangle* elementViewport)

Renders a single SVG element to a given viewport

renderLayer
bool renderLayer(Context cr, string id, RsvgRectangle* viewport)

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

setBaseGfile
void setBaseGfile(FileIF baseFile)

Set the base URI for @handle from @file.

setBaseUri
void setBaseUri(string baseUri)

Set the base URI for this SVG.

setDpi
void setDpi(double dpi)

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

setDpiXY
void setDpiXY(double dpiX, double dpiY)

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

setStylesheet
bool setStylesheet(ubyte[] css)

Sets a CSS stylesheet to use for an SVG document.

write
bool write(char[] buf)

Loads the next @count bytes of the image.

Static functions

cleanup
void cleanup()
getType
GType getType()
setDefaultDpi
void setDefaultDpi(double dpi)

Do not use this function. Create an #RsvgHandle and call rsvg_handle_set_dpi() on it instead.

setDefaultDpiXY
void setDefaultDpiXY(double dpiX, double dpiY)

Do not use this function. Create an #RsvgHandle and call rsvg_handle_set_dpi_x_y() on it instead.

Variables

rsvgHandle
RsvgHandle* rsvgHandle;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.
getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
Undocumented in source.
signals
DClosure[gulong] signals;
Undocumented in source.
destroyNotify
void destroyNotify(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify
void toggleNotify(ObjectG obj, GObject* object, int isLastRef)
Undocumented in source. Be warned that the author may not have intended to support it.
~this
~this()
Undocumented in source.
opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef)

Gets a D Object from the objects table of associations.

removeGcRoot
void removeGcRoot()
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, T value)
unref
deprecated void unref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
doref
deprecated ObjectG doref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(void* weakPointerLocation)

Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance:

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom)

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.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

forceFloating
void forceFloating()

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 g_object_ref_sink().

freezeNotify
void freezeNotify()

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.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see g_object_set_data()).

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, Value[] values)

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.

isFloating
bool isFloating()

Checks whether @object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property @property_name on @object.

notifyByPspec
void notifyByPspec(ParamSpec pspec)

Emits a "notify" signal for the property specified by @pspec on @object.

doref
alias doref = ref_
Undocumented in source.
ref_
ObjectG ref_()

Increases the reference count of @object.

refSink
ObjectG refSink()

Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(void* weakPointerLocation)

Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() 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: |[<!-- language="C" --> void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrieve the old string list GList *list = g_object_steal_qdata (object, quark_string_list);

thawNotify
void thawNotify()

Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted.

unref
void unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(Closure closure)

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 g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a #GObject.

Meta