Optionalproperties: Partial<Gtk.Svg.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeSince 4.22featuresEnabled features for this paintable.
Note that features have to be set before loading SVG data to take effect.
Since 4.22playingWhether the paintable is currently animating its content.
To set this property, use the Gtk.Svg.play and Gtk.Svg.pause functions.
Since 4.22resourceSince 4.22stateSince 4.22weightCreates 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:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
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.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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 the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Compute a concrete size for the Gdk.Paintable.
Applies the sizing algorithm outlined in the
CSS Image spec
to the given paintable. See that link for more details.
It is not necessary to call this function when both specified_width
and specified_height are known, but it is useful to call this
function in GtkWidget:measure implementations to compute the
other dimension when only one dimension is given.
the width paintable could be drawn into or 0.0 if unknown
the height paintable could be drawn into or 0.0 if unknown
the width paintable would be drawn into if no other constraints were given
the height paintable would be drawn into if no other constraints were given
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a floating 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().
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.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets an immutable paintable for the current contents displayed by paintable.
This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation.
If the paintable is already immutable, it will return itself.
An immutable paintable for the current contents of paintable
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Get flags for the paintable.
This is oftentimes useful for optimizations.
See Gdk.PaintableFlags for the flags and what they mean.
The Gdk.PaintableFlags for this paintable
Gets the preferred aspect ratio the paintable would like to be displayed at.
The aspect ratio is the width divided by the height, so a value of 0.5
means that the paintable prefers to be displayed twice as high as it
is wide. Consumers of this interface can use this to preserve aspect
ratio when displaying the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
Usually when a paintable returns nonzero values from
Gdk.Paintable.get_intrinsic_width and
Gdk.Paintable.get_intrinsic_height the aspect ratio
should conform to those values, though that is not required.
If the paintable does not have a preferred aspect ratio,
it returns 0. Negative values are never returned.
the intrinsic aspect ratio of paintable or 0 if none.
Gets the preferred height the paintable would like to be displayed at.
Consumers of this interface can use this to reserve enough space to draw the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
If the paintable does not have a preferred height, it returns 0.
Negative values are never returned.
the intrinsic height of paintable or 0 if none.
Gets the preferred width the paintable would like to be displayed at.
Consumers of this interface can use this to reserve enough space to draw the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
If the paintable does not have a preferred width, it returns 0.
Negative values are never returned.
the intrinsic width of paintable or 0 if none.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets the current state of the paintable.
the state
Returns a NULL-terminated array of
state names, if available.
Note that the returned array and the strings contained in it will only be valid until the Gtk.Svg is cleared or reloaded, so if you want to keep it around, you should make a copy.
the state names
Gets the value of the weight property.
the weight
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.
the names of each property to get
the values of each property to get
Called by implementations of Gdk.Paintable to invalidate their contents.
Unless the contents are invalidated, implementations must guarantee that multiple calls of Gdk.Paintable.snapshot produce the same output.
This function will emit the Gdk.Paintable::invalidate-contents
signal.
If a paintable reports the Gdk.PaintableFlags.STATIC_CONTENTS flag,
it must not call this function.
Called by implementations of Gdk.Paintable to invalidate their size.
As long as the size is not invalidated, paintable must return the same
values for its intrinsic width, height and aspect ratio.
This function will emit the Gdk.Paintable::invalidate-size
signal.
If a paintable reports the Gdk.PaintableFlags.STATIC_SIZE flag,
it must not call this function.
Checks whether object has a floating reference.
true if object has a floating reference
Loads SVG content into an existing SVG paintable.
To track errors while loading SVG content,
connect to the Gtk.Svg::error signal.
This clears any previously loaded content.
the resource path
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Stop any playing animations and state transitions.
Animations can be paused and started repeatedly.
Start playing animations and state transitions.
Animations can be paused and started repeatedly.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
floating reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Serializes the content of the renderer as SVG.
The SVG will be similar to the orignally loaded one, but is not guaranteed to be 100% identical.
This function serializes the DOM, i.e. the results of parsing the SVG. It does not reflect the effect of applying animations.
the serialized contents
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Enables or disables features of the SVG paintable.
By default, all features are enabled.
Note that this call only has an effect before the SVG is loaded.
features to enable
Sets a frame clock.
Without a frame clock, GtkSvg will not advance animations.
the frame clock
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets the state of the paintable.
If the paintable is currently playing, the state change will apply transitions that are defined in the SVG. If the paintable is not playing, the state change will take effect instantaneously.
the state to set, as a value between 0 and 63
Sets the weight that is used when rendering.
The weight affects the effective linewidth when stroking paths.
The default value of -1 means to use the font weight from CSS.
the font weight, as a value between -1 and 1000
Snapshots the given paintable with the given width and height.
The paintable is drawn at the current (0,0) offset of the snapshot.
If width and height are not larger than zero, this function will
do nothing.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
Snapshots the paintable with the given colors.
If less than 5 colors are provided, GTK will pad the array with default colors.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
a pointer to an array of colors
Snapshots the paintable with the given colors and weight.
If less than 5 colors are provided, GTK will pad the array with default colors.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
a pointer to an array of colors
The font weight to use (from 1 to 1000, with default 400)
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
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:
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);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Get flags for the paintable.
This is oftentimes useful for optimizations.
See Gdk.PaintableFlags for the flags and what they mean.
Virtualvfunc_Gets the preferred aspect ratio the paintable would like to be displayed at.
The aspect ratio is the width divided by the height, so a value of 0.5
means that the paintable prefers to be displayed twice as high as it
is wide. Consumers of this interface can use this to preserve aspect
ratio when displaying the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
Usually when a paintable returns nonzero values from
Gdk.Paintable.get_intrinsic_width and
Gdk.Paintable.get_intrinsic_height the aspect ratio
should conform to those values, though that is not required.
If the paintable does not have a preferred aspect ratio,
it returns 0. Negative values are never returned.
Virtualvfunc_Gets the preferred height the paintable would like to be displayed at.
Consumers of this interface can use this to reserve enough space to draw the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
If the paintable does not have a preferred height, it returns 0.
Negative values are never returned.
Virtualvfunc_Gets the preferred width the paintable would like to be displayed at.
Consumers of this interface can use this to reserve enough space to draw the paintable.
This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.
If the paintable does not have a preferred width, it returns 0.
Negative values are never returned.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_Snapshots the given paintable with the given width and height.
The paintable is drawn at the current (0,0) offset of the snapshot.
If width and height are not larger than zero, this function will
do nothing.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
Virtualvfunc_Snapshots the paintable with the given colors.
If less than 5 colors are provided, GTK will pad the array with default colors.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
a pointer to an array of colors
Virtualvfunc_Snapshots the paintable with the given colors and weight.
If less than 5 colors are provided, GTK will pad the array with default colors.
a Gdk.Snapshot to snapshot to
width to snapshot in
height to snapshot in
a pointer to an array of colors
The font weight to use (from 1 to 1000, with default 400)
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.
GObject.Closure to watch
Serializes the paintable, and saves the result to a file.
the file to save to
true, unless an error occurred
StaticnewStaticnew_Staticnew_Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec 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().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_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 GObject.ParamSpec, 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.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_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().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A paintable implementation that renders SVG, with animations.
Gtk.Svg objects are created by parsing a subset of SVG, including SVG animations.
Gtk.Svg fills or strokes paths with symbolic or fixed colors. It can have multiple states, and paths can be included in a subset of the states. States can have animations, and the transition between different states can also be animated.
To show a static SVG image, it is enough to load the the SVG and use it like any other paintable.
To play an SVG animation, use Gtk.Svg.set_frame_clock to connect the paintable to a frame clock, and call Gtk.Svg.play after loading the SVG. The animation can be paused using Gtk.Svg.pause.
To set the current state, use Gtk.Svg.set_state.
Error handling
Loading an SVG into Gtk.Svg will always produce a (possibly empty) paintable. GTK will drop things that it can't handle and try to make sense of the rest.
To track errors during parsing or rendering, connect to the
Gtk.Svg::errorsignal.For parsing errors in the
GTK_SVG_ERRORdomain, the functions Gtk.SvgError.get_start, Gtk.SvgError.get_end, Gtk.SvgError.get_element and Gtk.SvgError.get_attribute can be used to obtain information about where the error occurred.The supported subset of SVG
The paintable supports much of SVG 2, with some exceptions.
Among the graphical elements,
<textPath>and<foreignObject>are not supported.Among the structural elements,
<a>and<view>are not supported.In the
<filter>element, the following primitives are not supported: feConvolveMatrix, feDiffuseLighting, feMorphology, feSpecularLighting and feTurbulence.Support for the
maskattribute is limited to just a url referring to the<mask>element by ID.In animation elements, the parsing of
beginandendattributes is limited, and theminandmaxattributes are not supported.Lastly, there is only minimal CSS support (the style attribute, but not
<style>), and no interactivity.SVG Extensions
The paintable supports a number of custom attributes that offer a convenient way to define states, transitions and animations. For example,
defines the circle to be shown in states 0 and 1, and animates a segment of the circle.
Note that the generated animations are implemented using standard SVG attributes (
visibility,stroke-dasharray,stroke-dashoffset,pathLengthandfilter`). Setting these attributes in your SVG is therefore going to interfere with generated animations.To connect general SVG animations to the states of the paintable, use the custom
gpa:states(...)condition in thebeginandendattributes of SVG animation elements. For example,will make the fill color of path1 transition from black to magenta when the renderer enters state 0.
The
gpa:states(...)condition triggers for upcoming state changes as well, to support fade-out transitions. For example,will start a fade-out of path1 300ms before state 0 ends.
A variant of the
gpa:states(...)condition allows specifying both before and after states:will start the animation when the state changes from 0 to 1 or from 0 to 2, but not when it changes from 0 to 3.
In addition to the
gpa:fillandgpa:strokeattributes, symbolic colors can also be specified as a custom paint server reference, like this:url(#gpa:warning). This works infillandstrokeattributes, but also when specifying colors in SVG animation attributes liketoorvalues.Note that the SVG syntax allows for a fallback RGB color to be specified after the url, for compatibility with other SVG consumers:
In contrast to SVG 1.1 and 2.0, we allow the
transformattribute to be animated with<animate>.Since
4.22