mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-04-24 16:16:52 +02:00
The files here are copied from the docs-gtk-org branch of gtk. This adds gi-docgen to the CI Dockerfiles and ensures the new versions (including the OS upgrades from the previous commit) are used during CI. Helps: #3037
27588 lines
1.1 MiB
27588 lines
1.1 MiB
<?xml version="1.0"?>
|
||
<!-- This file was automatically generated from C sources - DO NOT EDIT!
|
||
To affect the contents of this file, edit the original C definitions,
|
||
and/or use gtk-doc annotations. -->
|
||
<repository version="1.2"
|
||
xmlns="http://www.gtk.org/introspection/core/1.0"
|
||
xmlns:c="http://www.gtk.org/introspection/c/1.0"
|
||
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
|
||
<include name="GLib" version="2.0"/>
|
||
<package name="gobject-2.0"/>
|
||
<c:include name="glib-object.h"/>
|
||
<namespace name="GObject"
|
||
version="2.0"
|
||
shared-library="libgobject-2.0.so.0"
|
||
c:identifier-prefixes="G"
|
||
c:symbol-prefixes="g">
|
||
<alias name="SignalCMarshaller" c:type="GSignalCMarshaller">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="36">This is the signature of marshaller functions, required to marshall
|
||
arrays of parameter values to signal emissions into C language callback
|
||
invocations.
|
||
|
||
It is merely an alias to #GClosureMarshal since the #GClosure mechanism
|
||
takes over responsibility of actual function invocation for the signal
|
||
system.</doc>
|
||
<source-position filename="gsignal.h" line="47"/>
|
||
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
|
||
</alias>
|
||
<alias name="SignalCVaMarshaller" c:type="GSignalCVaMarshaller">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="48">This is the signature of va_list marshaller functions, an optional
|
||
marshaller that can be used in some situations to avoid
|
||
marshalling the signal argument into GValues.</doc>
|
||
<source-position filename="gsignal.h" line="55"/>
|
||
<type name="VaClosureMarshal" c:type="GVaClosureMarshal"/>
|
||
</alias>
|
||
<alias name="Type" c:type="GType">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="409">A numerical value which represents the unique identifier of a registered
|
||
type.</doc>
|
||
<source-position filename="gtype.h" line="416"/>
|
||
<type name="gsize" c:type="gsize"/>
|
||
</alias>
|
||
<function-macro name="ADD_PRIVATE"
|
||
c:identifier="G_ADD_PRIVATE"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1993">A convenience macro to ease adding private data to instances of a new type
|
||
in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or
|
||
G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
|
||
|
||
For instance:
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct _MyObject MyObject;
|
||
typedef struct _MyObjectClass MyObjectClass;
|
||
|
||
typedef struct {
|
||
gint foo;
|
||
gint bar;
|
||
} MyObjectPrivate;
|
||
|
||
G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT,
|
||
G_ADD_PRIVATE (MyObject))
|
||
]|
|
||
|
||
Will add `MyObjectPrivate` as the private data to any instance of the
|
||
`MyObject` type.
|
||
|
||
`G_DEFINE_TYPE_*` macros will automatically create a private function
|
||
based on the arguments to this macro, which can be used to safely
|
||
retrieve the private data from an instance of the type; for instance:
|
||
|
||
|[<!-- language="C" -->
|
||
gint
|
||
my_object_get_foo (MyObject *obj)
|
||
{
|
||
MyObjectPrivate *priv = my_object_get_instance_private (obj);
|
||
|
||
g_return_val_if_fail (MY_IS_OBJECT (obj), 0);
|
||
|
||
return priv->foo;
|
||
}
|
||
|
||
void
|
||
my_object_set_bar (MyObject *obj,
|
||
gint bar)
|
||
{
|
||
MyObjectPrivate *priv = my_object_get_instance_private (obj);
|
||
|
||
g_return_if_fail (MY_IS_OBJECT (obj));
|
||
|
||
if (priv->bar != bar)
|
||
priv->bar = bar;
|
||
}
|
||
]|
|
||
|
||
Since GLib 2.72, the returned `MyObjectPrivate` pointer is guaranteed to be
|
||
aligned to at least the alignment of the largest basic GLib type (typically
|
||
this is #guint64 or #gdouble). If you need larger alignment for an element in
|
||
the struct, you should allocate it on the heap (aligned), or arrange for your
|
||
`MyObjectPrivate` struct to be appropriately padded.
|
||
|
||
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
|
||
macros, since it depends on variable names from those macros.
|
||
|
||
Also note that private structs added with these macros must have a struct
|
||
name of the form `TypeNamePrivate`.
|
||
|
||
It is safe to call the `_get_instance_private` function on %NULL or invalid
|
||
objects since it's only adding an offset to the instance pointer. In that
|
||
case the returned pointer must not be dereferenced.</doc>
|
||
<source-position filename="gtype.h" line="2065"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1995">the name of the type in CamelCase</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="ADD_PRIVATE_DYNAMIC"
|
||
c:identifier="G_ADD_PRIVATE_DYNAMIC"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="252">A convenience macro to ease adding private data to instances of a new dynamic
|
||
type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED().
|
||
|
||
See G_ADD_PRIVATE() for details, it is similar but for static types.
|
||
|
||
Note that this macro can only be used together with the
|
||
G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable
|
||
names from that macro.</doc>
|
||
<source-position filename="gtypemodule.h" line="267"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="254">the name of the type in CamelCase</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="BINDING" c:identifier="G_BINDING" introspectable="0">
|
||
<source-position filename="gbinding.h" line="38"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="BINDING_GROUP"
|
||
c:identifier="G_BINDING_GROUP"
|
||
introspectable="0">
|
||
<source-position filename="gbindinggroup.h" line="35"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<callback name="BaseFinalizeFunc" c:type="GBaseFinalizeFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="815">A callback function used by the type system to finalize those portions
|
||
of a derived types class structure that were setup from the corresponding
|
||
GBaseInitFunc() function.
|
||
|
||
Class finalization basically works the inverse way in which class
|
||
initialization is performed.
|
||
|
||
See GClassInitFunc() for a discussion of the class initialization process.</doc>
|
||
<source-position filename="gtype.h" line="828"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="817">The #GTypeClass structure to finalize</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="BaseInitFunc" c:type="GBaseInitFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="798">A callback function used by the type system to do base initialization
|
||
of the class structures of derived types.
|
||
|
||
This function is called as part of the initialization process of all derived
|
||
classes and should reallocate or reset all dynamic class members copied over
|
||
from the parent class.
|
||
|
||
For example, class members (such as strings) that are not sufficiently
|
||
handled by a plain memory copy of the parent class into the derived class
|
||
have to be altered. See GClassInitFunc() for a discussion of the class
|
||
initialization process.</doc>
|
||
<source-position filename="gtype.h" line="814"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="800">The #GTypeClass structure to initialize</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<class name="Binding"
|
||
c:symbol-prefix="binding"
|
||
c:type="GBinding"
|
||
version="2.26"
|
||
parent="Object"
|
||
glib:type-name="GBinding"
|
||
glib:get-type="g_binding_get_type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="224">#GBinding is the representation of a binding between a property on a
|
||
#GObject instance (or source) and another property on another #GObject
|
||
instance (or target).
|
||
|
||
Whenever the source property changes, the same value is applied to the
|
||
target property; for instance, the following binding:
|
||
|
||
|[<!-- language="C" -->
|
||
g_object_bind_property (object1, "property-a",
|
||
object2, "property-b",
|
||
G_BINDING_DEFAULT);
|
||
]|
|
||
|
||
will cause the property named "property-b" of @object2 to be updated
|
||
every time g_object_set() or the specific accessor changes the value of
|
||
the property "property-a" of @object1.
|
||
|
||
It is possible to create a bidirectional binding between two properties
|
||
of two #GObject instances, so that if either property changes, the
|
||
other is updated as well, for instance:
|
||
|
||
|[<!-- language="C" -->
|
||
g_object_bind_property (object1, "property-a",
|
||
object2, "property-b",
|
||
G_BINDING_BIDIRECTIONAL);
|
||
]|
|
||
|
||
will keep the two properties in sync.
|
||
|
||
It is also possible to set a custom transformation function (in both
|
||
directions, in case of a bidirectional binding) to apply a custom
|
||
transformation from the source value to the target value before
|
||
applying it; for instance, the following binding:
|
||
|
||
|[<!-- language="C" -->
|
||
g_object_bind_property_full (adjustment1, "value",
|
||
adjustment2, "value",
|
||
G_BINDING_BIDIRECTIONAL,
|
||
celsius_to_fahrenheit,
|
||
fahrenheit_to_celsius,
|
||
NULL, NULL);
|
||
]|
|
||
|
||
will keep the "value" property of the two adjustments in sync; the
|
||
@celsius_to_fahrenheit function will be called whenever the "value"
|
||
property of @adjustment1 changes and will transform the current value
|
||
of the property before applying it to the "value" property of @adjustment2.
|
||
|
||
Vice versa, the @fahrenheit_to_celsius function will be called whenever
|
||
the "value" property of @adjustment2 changes, and will transform the
|
||
current value of the property before applying it to the "value" property
|
||
of @adjustment1.
|
||
|
||
Note that #GBinding does not resolve cycles by itself; a cycle like
|
||
|
||
|[
|
||
object1:propertyA -> object2:propertyB
|
||
object2:propertyB -> object3:propertyC
|
||
object3:propertyC -> object1:propertyA
|
||
]|
|
||
|
||
might lead to an infinite loop. The loop, in this particular case,
|
||
can be avoided if the objects emit the #GObject::notify signal only
|
||
if the value has effectively been changed. A binding is implemented
|
||
using the #GObject::notify signal, so it is susceptible to all the
|
||
various ways of blocking a signal emission, like g_signal_stop_emission()
|
||
or g_signal_handler_block().
|
||
|
||
A binding will be severed, and the resources it allocates freed, whenever
|
||
either one of the #GObject instances it refers to are finalized, or when
|
||
the #GBinding instance loses its last reference.
|
||
|
||
Bindings for languages with garbage collection can use
|
||
g_binding_unbind() to explicitly release a binding between the source
|
||
and target properties, instead of relying on the last reference on the
|
||
binding, source, and target instances to drop.
|
||
|
||
#GBinding is available since GObject 2.26</doc>
|
||
<method name="dup_source"
|
||
c:identifier="g_binding_dup_source"
|
||
version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="968">Retrieves the #GObject instance used as the source of the binding.
|
||
|
||
A #GBinding can outlive the source #GObject as the binding does not hold a
|
||
strong reference to the source. If the source is destroyed before the
|
||
binding then this function will return %NULL.</doc>
|
||
<source-position filename="gbinding.h" line="117"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="978">the source #GObject, or %NULL if the
|
||
source does not exist any more.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="970">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_target"
|
||
c:identifier="g_binding_dup_target"
|
||
version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="984">Retrieves the #GObject instance used as the target of the binding.
|
||
|
||
A #GBinding can outlive the target #GObject as the binding does not hold a
|
||
strong reference to the target. If the target is destroyed before the
|
||
binding then this function will return %NULL.</doc>
|
||
<source-position filename="gbinding.h" line="121"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="994">the target #GObject, or %NULL if the
|
||
target does not exist any more.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="986">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_flags"
|
||
c:identifier="g_binding_get_flags"
|
||
glib:get-property="flags"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1000">Retrieves the flags passed when constructing the #GBinding.</doc>
|
||
<source-position filename="gbinding.h" line="113"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1006">the #GBindingFlags used by the #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1002">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_source"
|
||
c:identifier="g_binding_get_source"
|
||
glib:get-property="source"
|
||
version="2.26"
|
||
deprecated="1"
|
||
deprecated-version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1011">Retrieves the #GObject instance used as the source of the binding.
|
||
|
||
A #GBinding can outlive the source #GObject as the binding does not hold a
|
||
strong reference to the source. If the source is destroyed before the
|
||
binding then this function will return %NULL.
|
||
|
||
Use g_binding_dup_source() if the source or binding are used from different
|
||
threads as otherwise the pointer returned from this function might become
|
||
invalid if the source is finalized from another thread in the meantime.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_binding_dup_source() for a safer version of this
|
||
function.</doc-deprecated>
|
||
<source-position filename="gbinding.h" line="115"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1025">the source #GObject, or %NULL if the
|
||
source does not exist any more.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1013">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_source_property"
|
||
c:identifier="g_binding_get_source_property"
|
||
glib:get-property="source-property"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1033">Retrieves the name of the property of #GBinding:source used as the source
|
||
of the binding.</doc>
|
||
<source-position filename="gbinding.h" line="123"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1040">the name of the source property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1035">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_target"
|
||
c:identifier="g_binding_get_target"
|
||
glib:get-property="target"
|
||
version="2.26"
|
||
deprecated="1"
|
||
deprecated-version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1045">Retrieves the #GObject instance used as the target of the binding.
|
||
|
||
A #GBinding can outlive the target #GObject as the binding does not hold a
|
||
strong reference to the target. If the target is destroyed before the
|
||
binding then this function will return %NULL.
|
||
|
||
Use g_binding_dup_target() if the target or binding are used from different
|
||
threads as otherwise the pointer returned from this function might become
|
||
invalid if the target is finalized from another thread in the meantime.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_binding_dup_target() for a safer version of this
|
||
function.</doc-deprecated>
|
||
<source-position filename="gbinding.h" line="119"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1059">the target #GObject, or %NULL if the
|
||
target does not exist any more.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1047">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_target_property"
|
||
c:identifier="g_binding_get_target_property"
|
||
glib:get-property="target-property"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1067">Retrieves the name of the property of #GBinding:target used as the target
|
||
of the binding.</doc>
|
||
<source-position filename="gbinding.h" line="125"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1074">the name of the target property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1069">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unbind" c:identifier="g_binding_unbind" version="2.38">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1191">Explicitly releases the binding between the source and the target
|
||
property expressed by @binding.
|
||
|
||
This function will release the reference that is being held on
|
||
the @binding instance if the binding is still bound; if you want to hold on
|
||
to the #GBinding instance after calling g_binding_unbind(), you will need
|
||
to hold a reference to it.
|
||
|
||
Note however that this function does not take ownership of @binding, it
|
||
only unrefs the reference that was initially created by
|
||
g_object_bind_property() and is owned by the binding.</doc>
|
||
<source-position filename="gbinding.h" line="127"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1193">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<property name="flags"
|
||
version="2.26"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none"
|
||
getter="get_flags"
|
||
default-value="G_BINDING_DEFAULT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5">Flags to be used to control the #GBinding</doc>
|
||
<type name="BindingFlags"/>
|
||
</property>
|
||
<property name="source"
|
||
version="2.26"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none"
|
||
getter="get_source">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="14">The #GObject that should be used as the source of the binding</doc>
|
||
<type name="Object"/>
|
||
</property>
|
||
<property name="source-property"
|
||
version="2.26"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none"
|
||
getter="get_source_property"
|
||
default-value="NULL">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="23">The name of the property of #GBinding:source that should be used
|
||
as the source of the binding.
|
||
|
||
This should be in [canonical form][canonical-parameter-names] to get the
|
||
best performance.</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</property>
|
||
<property name="target"
|
||
version="2.26"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none"
|
||
getter="get_target">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="36">The #GObject that should be used as the target of the binding</doc>
|
||
<type name="Object"/>
|
||
</property>
|
||
<property name="target-property"
|
||
version="2.26"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none"
|
||
getter="get_target_property"
|
||
default-value="NULL">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="45">The name of the property of #GBinding:target that should be used
|
||
as the target of the binding.
|
||
|
||
This should be in [canonical form][canonical-parameter-names] to get the
|
||
best performance.</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</property>
|
||
</class>
|
||
<bitfield name="BindingFlags"
|
||
version="2.26"
|
||
glib:type-name="GBindingFlags"
|
||
glib:get-type="g_binding_flags_get_type"
|
||
c:type="GBindingFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="76">Flags to be passed to g_object_bind_property() or
|
||
g_object_bind_property_full().
|
||
|
||
This enumeration can be extended at later date.</doc>
|
||
<member name="default"
|
||
value="0"
|
||
c:identifier="G_BINDING_DEFAULT"
|
||
glib:nick="default"
|
||
glib:name="G_BINDING_DEFAULT">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="78">The default binding; if the source property
|
||
changes, the target property is updated with its value.</doc>
|
||
</member>
|
||
<member name="bidirectional"
|
||
value="1"
|
||
c:identifier="G_BINDING_BIDIRECTIONAL"
|
||
glib:nick="bidirectional"
|
||
glib:name="G_BINDING_BIDIRECTIONAL">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="80">Bidirectional binding; if either the
|
||
property of the source or the property of the target changes,
|
||
the other is updated.</doc>
|
||
</member>
|
||
<member name="sync_create"
|
||
value="2"
|
||
c:identifier="G_BINDING_SYNC_CREATE"
|
||
glib:nick="sync-create"
|
||
glib:name="G_BINDING_SYNC_CREATE">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="83">Synchronize the values of the source and
|
||
target properties when creating the binding; the direction of
|
||
the synchronization is always from the source to the target.</doc>
|
||
</member>
|
||
<member name="invert_boolean"
|
||
value="4"
|
||
c:identifier="G_BINDING_INVERT_BOOLEAN"
|
||
glib:nick="invert-boolean"
|
||
glib:name="G_BINDING_INVERT_BOOLEAN">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="86">If the two properties being bound are
|
||
booleans, setting one to %TRUE will result in the other being
|
||
set to %FALSE and vice versa. This flag will only work for
|
||
boolean properties, and cannot be used when passing custom
|
||
transformation functions to g_object_bind_property_full().</doc>
|
||
</member>
|
||
</bitfield>
|
||
<class name="BindingGroup"
|
||
c:symbol-prefix="binding_group"
|
||
c:type="GBindingGroup"
|
||
version="2.72"
|
||
parent="Object"
|
||
glib:type-name="GBindingGroup"
|
||
glib:get-type="g_binding_group_get_type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="310">The #GBindingGroup can be used to bind multiple properties
|
||
from an object collectively.
|
||
|
||
Use the various methods to bind properties from a single source
|
||
object to multiple destination objects. Properties can be bound
|
||
bidirectionally and are connected when the source object is set
|
||
with g_binding_group_set_source().</doc>
|
||
<constructor name="new"
|
||
c:identifier="g_binding_group_new"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1165">Creates a new #GBindingGroup.</doc>
|
||
<source-position filename="gbindinggroup.h" line="52"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1170">a new #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</return-value>
|
||
</constructor>
|
||
<method name="bind" c:identifier="g_binding_group_bind" version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1079">Creates a binding between @source_property on the source object
|
||
and @target_property on @target. Whenever the @source_property
|
||
is changed the @target_property is updated using the same value.
|
||
The binding flag %G_BINDING_SYNC_CREATE is automatically specified.
|
||
|
||
See g_object_bind_property() for more information.</doc>
|
||
<source-position filename="gbindinggroup.h" line="59"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1081">the #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1082">the property on the source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1083">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1084">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1085">the flags used to create the #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="bind_full"
|
||
c:identifier="g_binding_group_bind_full"
|
||
shadowed-by="bind_with_closures"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1098">Creates a binding between @source_property on the source object and
|
||
@target_property on @target, allowing you to set the transformation
|
||
functions to be used by the binding. The binding flag
|
||
%G_BINDING_SYNC_CREATE is automatically specified.
|
||
|
||
See g_object_bind_property_full() for more information.</doc>
|
||
<source-position filename="gbindinggroup.h" line="65"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1100">the #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1101">the property on the source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1102">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1103">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1104">the flags used to create the #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
<parameter name="transform_to"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1105">the transformation function
|
||
from the source object to the @target, or %NULL to use the default</doc>
|
||
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
|
||
</parameter>
|
||
<parameter name="transform_from"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified"
|
||
closure="6"
|
||
destroy="7">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1107">the transformation function
|
||
from the @target to the source object, or %NULL to use the default</doc>
|
||
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1109">custom data to be passed to the transformation
|
||
functions, or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="user_data_destroy"
|
||
transfer-ownership="none"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1111">function to be called when disposing the binding,
|
||
to free the resources used by the transformation functions</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="bind_with_closures"
|
||
c:identifier="g_binding_group_bind_with_closures"
|
||
shadows="bind_full"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1125">Creates a binding between @source_property on the source object and
|
||
@target_property on @target, allowing you to set the transformation
|
||
functions to be used by the binding. The binding flag
|
||
%G_BINDING_SYNC_CREATE is automatically specified.
|
||
|
||
This function is the language bindings friendly version of
|
||
g_binding_group_bind_property_full(), using #GClosures
|
||
instead of function pointers.
|
||
|
||
See g_object_bind_property_with_closures() for more information.</doc>
|
||
<source-position filename="gbindinggroup.h" line="75"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1127">the #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1128">the property on the source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1129">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1130">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1131">the flags used to create the #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
<parameter name="transform_to"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1132">a #GClosure wrapping the
|
||
transformation function from the source object to the @target,
|
||
or %NULL to use the default</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="transform_from"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1135">a #GClosure wrapping the
|
||
transformation function from the @target to the source object,
|
||
or %NULL to use the default</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_source"
|
||
c:identifier="g_binding_group_dup_source"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1154">Gets the source object used for binding properties.</doc>
|
||
<source-position filename="gbindinggroup.h" line="54"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1160">a #GObject or %NULL.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1156">the #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_source"
|
||
c:identifier="g_binding_group_set_source"
|
||
glib:set-property="source"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1175">Sets @source as the source object used for creating property
|
||
bindings. If there is already a source object all bindings from it
|
||
will be removed.
|
||
|
||
Note that all properties that have been bound must exist on @source.</doc>
|
||
<source-position filename="gbindinggroup.h" line="56"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1177">the #GBindingGroup</doc>
|
||
<type name="BindingGroup" c:type="GBindingGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="source"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1178">the source #GObject,
|
||
or %NULL to clear it</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<property name="source"
|
||
version="2.72"
|
||
writable="1"
|
||
transfer-ownership="none"
|
||
setter="set_source">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="58">The source object used for binding properties.</doc>
|
||
<type name="Object"/>
|
||
</property>
|
||
</class>
|
||
<callback name="BindingTransformFunc"
|
||
c:type="GBindingTransformFunc"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="51">A function to be called to transform @from_value to @to_value.
|
||
|
||
If this is the @transform_to function of a binding, then @from_value
|
||
is the @source_property on the @source object, and @to_value is the
|
||
@target_property on the @target object. If this is the
|
||
@transform_from function of a %G_BINDING_BIDIRECTIONAL binding,
|
||
then those roles are reversed.</doc>
|
||
<source-position filename="gbinding.h" line="71"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="66">%TRUE if the transformation was successful, and %FALSE
|
||
otherwise</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="binding" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="53">a #GBinding</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</parameter>
|
||
<parameter name="from_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="54">the #GValue containing the value to transform</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="to_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="55">the #GValue in which to store the transformed value</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="3">
|
||
<doc xml:space="preserve"
|
||
filename="gbinding.h"
|
||
line="56">data passed to the transform function</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="BoxedCopyFunc" c:type="GBoxedCopyFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="49">This function is provided by the user and should produce a copy
|
||
of the passed in boxed structure.</doc>
|
||
<source-position filename="gboxed.h" line="58"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="56">The newly created copy of the boxed structure.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="boxed" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="51">The boxed structure to be copied.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="BoxedFreeFunc" c:type="GBoxedFreeFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="60">This function is provided by the user and should free the boxed
|
||
structure passed.</doc>
|
||
<source-position filename="gboxed.h" line="67"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="boxed" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="62">The boxed structure to be freed.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<function-macro name="CALLBACK"
|
||
c:identifier="G_CALLBACK"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="67">Cast a function pointer to a #GCallback.</doc>
|
||
<source-position filename="gclosure.h" line="73"/>
|
||
<parameters>
|
||
<parameter name="f">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="69">a function pointer.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="CCLOSURE_SWAP_DATA"
|
||
c:identifier="G_CCLOSURE_SWAP_DATA"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="57">Checks whether the user data of the #GCClosure should be passed as the
|
||
first parameter to the callback. See g_cclosure_new_swap().</doc>
|
||
<source-position filename="gclosure.h" line="66"/>
|
||
<parameters>
|
||
<parameter name="cclosure">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="59">a #GCClosure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<record name="CClosure" c:type="GCClosure">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="156">A #GCClosure is a specialization of #GClosure for C function callbacks.</doc>
|
||
<source-position filename="gclosure.h" line="226"/>
|
||
<field name="closure" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="158">the #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure"/>
|
||
</field>
|
||
<field name="callback" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="159">the callback function</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
<function name="marshal_BOOLEAN__BOXED_BOXED"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXED">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1252">A #GClosureMarshal function for use with signals with handlers that
|
||
take two boxed pointers as arguments and return a boolean. If you
|
||
have such a signal, you will probably also need to use an
|
||
accumulator, such as g_signal_accumulator_true_handled().</doc>
|
||
<source-position filename="gmarshal.h" line="399"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1254">A #GClosure.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1255">A #GValue to store the return value. May be %NULL
|
||
if the callback of closure doesn't return a value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1257">The length of the @param_values array.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1258">An array of #GValues holding the arguments
|
||
on which to invoke the callback of closure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1260">The invocation hint given as the last argument to
|
||
g_closure_invoke().</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1262">Additional data specified when registering the
|
||
marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_BOOLEAN__BOXED_BOXEDv"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXEDv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1273">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED().</doc>
|
||
<source-position filename="gmarshal.h" line="406"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1275">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1276">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1279">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1280">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1281">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1284">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1285">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_BOOLEAN__FLAGS"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__FLAGS">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1292">A marshaller for a #GCClosure with a callback of type
|
||
`gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter
|
||
denotes a flags type.</doc>
|
||
<source-position filename="gmarshal.h" line="347"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1294">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1295">a #GValue which can store the returned #gboolean</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1296">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1297">a #GValue array holding instance and arg1</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1298">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1300">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_BOOLEAN__FLAGSv"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__FLAGSv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1308">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS().</doc>
|
||
<source-position filename="gmarshal.h" line="354"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1310">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1311">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1314">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1315">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1316">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1319">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1320">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_STRING__OBJECT_POINTER"
|
||
c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1351">A marshaller for a #GCClosure with a callback of type
|
||
`gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="382"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1353">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1354">a #GValue, which can store the returned string</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1355">3</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1356">a #GValue array holding instance, arg1 and arg2</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1357">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1359">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_STRING__OBJECT_POINTERv"
|
||
c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTERv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1366">The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER().</doc>
|
||
<source-position filename="gmarshal.h" line="389"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1368">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1369">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1372">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1373">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1374">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1377">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1378">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__BOOLEAN"
|
||
c:identifier="g_cclosure_marshal_VOID__BOOLEAN">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1385">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="41"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1387">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1388">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1389">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1390">a #GValue array holding the instance and the #gboolean parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1391">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1393">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__BOOLEANv"
|
||
c:identifier="g_cclosure_marshal_VOID__BOOLEANv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1400">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN().</doc>
|
||
<source-position filename="gmarshal.h" line="48"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1402">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1403">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1406">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1407">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1408">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1411">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1412">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__BOXED"
|
||
c:identifier="g_cclosure_marshal_VOID__BOXED">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1419">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="262"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1421">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1422">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1423">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1424">a #GValue array holding the instance and the #GBoxed* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1425">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1427">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__BOXEDv"
|
||
c:identifier="g_cclosure_marshal_VOID__BOXEDv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1434">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED().</doc>
|
||
<source-position filename="gmarshal.h" line="269"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1436">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1437">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1440">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1441">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1442">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1445">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1446">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__CHAR"
|
||
c:identifier="g_cclosure_marshal_VOID__CHAR">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1453">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="58"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1455">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1456">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1457">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1458">a #GValue array holding the instance and the #gchar parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1459">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1461">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__CHARv"
|
||
c:identifier="g_cclosure_marshal_VOID__CHARv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1468">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR().</doc>
|
||
<source-position filename="gmarshal.h" line="65"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1470">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1471">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1474">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1475">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1476">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1479">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1480">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__DOUBLE"
|
||
c:identifier="g_cclosure_marshal_VOID__DOUBLE">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1487">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="211"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1489">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1490">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1491">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1492">a #GValue array holding the instance and the #gdouble parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1493">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1495">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__DOUBLEv"
|
||
c:identifier="g_cclosure_marshal_VOID__DOUBLEv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1502">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE().</doc>
|
||
<source-position filename="gmarshal.h" line="218"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1504">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1505">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1508">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1509">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1510">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1513">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1514">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__ENUM"
|
||
c:identifier="g_cclosure_marshal_VOID__ENUM">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1521">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type..</doc>
|
||
<source-position filename="gmarshal.h" line="160"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1523">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1524">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1525">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1526">a #GValue array holding the instance and the enumeration parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1527">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1529">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__ENUMv"
|
||
c:identifier="g_cclosure_marshal_VOID__ENUMv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1536">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM().</doc>
|
||
<source-position filename="gmarshal.h" line="167"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1538">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1539">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1542">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1543">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1544">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1547">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1548">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__FLAGS"
|
||
c:identifier="g_cclosure_marshal_VOID__FLAGS">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1555">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type.</doc>
|
||
<source-position filename="gmarshal.h" line="177"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1557">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1558">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1559">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1560">a #GValue array holding the instance and the flags parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1561">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1563">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__FLAGSv"
|
||
c:identifier="g_cclosure_marshal_VOID__FLAGSv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1570">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS().</doc>
|
||
<source-position filename="gmarshal.h" line="184"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1572">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1573">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1576">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1577">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1578">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1581">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1582">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__FLOAT"
|
||
c:identifier="g_cclosure_marshal_VOID__FLOAT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1589">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="194"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1591">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1592">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1593">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1594">a #GValue array holding the instance and the #gfloat parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1595">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1597">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__FLOATv"
|
||
c:identifier="g_cclosure_marshal_VOID__FLOATv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1604">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT().</doc>
|
||
<source-position filename="gmarshal.h" line="201"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1606">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1607">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1610">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1611">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1612">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1615">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1616">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__INT"
|
||
c:identifier="g_cclosure_marshal_VOID__INT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1623">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="92"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1625">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1626">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1627">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1628">a #GValue array holding the instance and the #gint parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1629">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1631">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__INTv"
|
||
c:identifier="g_cclosure_marshal_VOID__INTv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1638">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT().</doc>
|
||
<source-position filename="gmarshal.h" line="99"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1640">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1641">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1644">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1645">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1646">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1649">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1650">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__LONG"
|
||
c:identifier="g_cclosure_marshal_VOID__LONG">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1657">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, glong arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="126"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1659">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1660">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1661">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1662">a #GValue array holding the instance and the #glong parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1663">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1665">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__LONGv"
|
||
c:identifier="g_cclosure_marshal_VOID__LONGv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1672">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG().</doc>
|
||
<source-position filename="gmarshal.h" line="133"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1674">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1675">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1678">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1679">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1680">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1683">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1684">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__OBJECT"
|
||
c:identifier="g_cclosure_marshal_VOID__OBJECT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1691">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="296"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1693">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1694">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1695">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1696">a #GValue array holding the instance and the #GObject* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1697">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1699">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__OBJECTv"
|
||
c:identifier="g_cclosure_marshal_VOID__OBJECTv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1706">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT().</doc>
|
||
<source-position filename="gmarshal.h" line="303"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1708">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1709">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1712">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1713">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1714">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1717">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1718">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__PARAM"
|
||
c:identifier="g_cclosure_marshal_VOID__PARAM">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1725">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="245"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1727">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1728">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1729">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1730">a #GValue array holding the instance and the #GParamSpec* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1731">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1733">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__PARAMv"
|
||
c:identifier="g_cclosure_marshal_VOID__PARAMv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1740">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM().</doc>
|
||
<source-position filename="gmarshal.h" line="252"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1742">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1743">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1746">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1747">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1748">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1751">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1752">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__POINTER"
|
||
c:identifier="g_cclosure_marshal_VOID__POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1759">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="279"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1761">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1762">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1763">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1764">a #GValue array holding the instance and the #gpointer parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1765">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1767">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__POINTERv"
|
||
c:identifier="g_cclosure_marshal_VOID__POINTERv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1774">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER().</doc>
|
||
<source-position filename="gmarshal.h" line="286"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1776">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1777">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1780">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1781">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1782">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1785">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1786">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__STRING"
|
||
c:identifier="g_cclosure_marshal_VOID__STRING">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1793">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="228"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1795">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1796">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1797">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1798">a #GValue array holding the instance and the #gchar* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1799">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1801">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__STRINGv"
|
||
c:identifier="g_cclosure_marshal_VOID__STRINGv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1808">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING().</doc>
|
||
<source-position filename="gmarshal.h" line="235"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1810">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1811">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1814">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1815">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1816">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1819">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1820">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UCHAR"
|
||
c:identifier="g_cclosure_marshal_VOID__UCHAR">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1827">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="75"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1829">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1830">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1831">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1832">a #GValue array holding the instance and the #guchar parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1833">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1835">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UCHARv"
|
||
c:identifier="g_cclosure_marshal_VOID__UCHARv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1842">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR().</doc>
|
||
<source-position filename="gmarshal.h" line="82"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1844">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1845">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1848">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1849">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1850">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1853">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1854">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UINT"
|
||
c:identifier="g_cclosure_marshal_VOID__UINT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1861">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guint arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="109"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1863">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1864">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1865">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1866">a #GValue array holding the instance and the #guint parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1867">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1869">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UINT_POINTER"
|
||
c:identifier="g_cclosure_marshal_VOID__UINT_POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1876">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="330"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1878">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1879">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1880">3</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1881">a #GValue array holding instance, arg1 and arg2</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1882">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1884">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UINT_POINTERv"
|
||
c:identifier="g_cclosure_marshal_VOID__UINT_POINTERv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1891">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER().</doc>
|
||
<source-position filename="gmarshal.h" line="337"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1893">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1894">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1897">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1898">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1899">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1902">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1903">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__UINTv"
|
||
c:identifier="g_cclosure_marshal_VOID__UINTv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1910">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT().</doc>
|
||
<source-position filename="gmarshal.h" line="116"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1912">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1913">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1916">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1917">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1918">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1921">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1922">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__ULONG"
|
||
c:identifier="g_cclosure_marshal_VOID__ULONG">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1929">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="143"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1931">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1932">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1933">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1934">a #GValue array holding the instance and the #gulong parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1935">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1937">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__ULONGv"
|
||
c:identifier="g_cclosure_marshal_VOID__ULONGv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1944">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG().</doc>
|
||
<source-position filename="gmarshal.h" line="150"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1946">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1947">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1950">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1951">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1952">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1955">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1956">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__VARIANT"
|
||
c:identifier="g_cclosure_marshal_VOID__VARIANT"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1963">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="313"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1965">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1966">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1967">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1968">a #GValue array holding the instance and the #GVariant* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1969">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1971">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__VARIANTv"
|
||
c:identifier="g_cclosure_marshal_VOID__VARIANTv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1980">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT().</doc>
|
||
<source-position filename="gmarshal.h" line="320"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1982">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1983">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1986">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1987">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1988">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1991">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1992">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__VOID"
|
||
c:identifier="g_cclosure_marshal_VOID__VOID">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1999">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="24"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2001">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2002">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2003">1</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2004">a #GValue array holding only the instance</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2005">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2007">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_VOID__VOIDv"
|
||
c:identifier="g_cclosure_marshal_VOID__VOIDv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2014">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID().</doc>
|
||
<source-position filename="gmarshal.h" line="31"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2016">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2017">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2020">the instance on which the closure is invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2021">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2022">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2025">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2026">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_generic"
|
||
c:identifier="g_cclosure_marshal_generic"
|
||
version="2.30">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2033">A generic marshaller function implemented via
|
||
[libffi](http://sourceware.org/libffi/).
|
||
|
||
Normally this function is not passed explicitly to g_signal_new(),
|
||
but used automatically by GLib when specifying a %NULL marshaller.</doc>
|
||
<source-position filename="gclosure.h" line="304"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2035">A #GClosure.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_gvalue" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2036">A #GValue to store the return value. May be %NULL
|
||
if the callback of closure doesn't return a value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2038">The length of the @param_values array.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2039">An array of #GValues holding the arguments
|
||
on which to invoke the callback of closure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2041">The invocation hint given as the last argument to
|
||
g_closure_invoke().</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2043">Additional data specified when registering the
|
||
marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="marshal_generic_va"
|
||
c:identifier="g_cclosure_marshal_generic_va"
|
||
version="2.30"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2057">A generic #GVaClosureMarshal function implemented via
|
||
[libffi](http://sourceware.org/libffi/).</doc>
|
||
<source-position filename="gclosure.h" line="312"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2059">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2060">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2063">the instance on which the closure is
|
||
invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args_list" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2065">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2066">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2069">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2070">the #GType of each argument from
|
||
@args_list.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="new" c:identifier="g_cclosure_new" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2080">Creates a new closure which invokes @callback_func with @user_data as
|
||
the last parameter.
|
||
|
||
@destroy_data will be called as a finalize notifier on the #GClosure.</doc>
|
||
<source-position filename="gclosure.h" line="231"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2091">a floating reference to a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2082">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2083">user data to pass to @callback_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy_data" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2084">destroy notify to be called when @user_data is no longer used</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="new_object"
|
||
c:identifier="g_cclosure_new_object"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2095">A variant of g_cclosure_new() which uses @object as @user_data and
|
||
calls g_object_watch_closure() on @object and the created
|
||
closure. This function is useful when you have a callback closely
|
||
associated with a #GObject, and want the callback to no longer run
|
||
after the object is is freed.</doc>
|
||
<source-position filename="gobject.h" line="642"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2106">a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2097">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2098">a #GObject pointer to pass to @callback_func</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="new_object_swap"
|
||
c:identifier="g_cclosure_new_object_swap"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2110">A variant of g_cclosure_new_swap() which uses @object as @user_data
|
||
and calls g_object_watch_closure() on @object and the created
|
||
closure. This function is useful when you have a callback closely
|
||
associated with a #GObject, and want the callback to no longer run
|
||
after the object is is freed.</doc>
|
||
<source-position filename="gobject.h" line="645"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2121">a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2112">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2113">a #GObject pointer to pass to @callback_func</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="new_swap"
|
||
c:identifier="g_cclosure_new_swap"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2125">Creates a new closure which invokes @callback_func with @user_data as
|
||
the first parameter.
|
||
|
||
@destroy_data will be called as a finalize notifier on the #GClosure.</doc>
|
||
<source-position filename="gclosure.h" line="235"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2136">a floating reference to a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2127">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2128">user data to pass to @callback_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy_data" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2129">destroy notify to be called when @user_data is no longer used</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<function-macro name="CLOSURE_NEEDS_MARSHAL"
|
||
c:identifier="G_CLOSURE_NEEDS_MARSHAL"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="32">Check if the closure still needs a marshaller. See g_closure_set_marshal().</doc>
|
||
<source-position filename="gclosure.h" line="41"/>
|
||
<parameters>
|
||
<parameter name="closure">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="34">a #GClosure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="CLOSURE_N_NOTIFIERS"
|
||
c:identifier="G_CLOSURE_N_NOTIFIERS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="42">Get the total number of notifiers connected with the closure @cl.
|
||
|
||
The count includes the meta marshaller, the finalize and invalidate notifiers
|
||
and the marshal guards. Note that each guard counts as two notifiers.
|
||
See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(),
|
||
g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards().</doc>
|
||
<source-position filename="gclosure.h" line="55"/>
|
||
<parameters>
|
||
<parameter name="cl">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="44">a #GClosure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<callback name="Callback" c:type="GCallback">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="80">The type used for callback functions in structure definitions and function
|
||
signatures.
|
||
|
||
This doesn't mean that all callback functions must take no parameters and
|
||
return void. The required signature of a callback function is determined by
|
||
the context in which is used (e.g. the signal to which it is connected).
|
||
|
||
Use G_CALLBACK() to cast the callback function to a #GCallback.</doc>
|
||
<source-position filename="gclosure.h" line="92"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</callback>
|
||
<callback name="ClassFinalizeFunc" c:type="GClassFinalizeFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="934">A callback function used by the type system to finalize a class.
|
||
|
||
This function is rarely needed, as dynamically allocated class resources
|
||
should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
|
||
|
||
Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
|
||
structure of a static type is invalid, because classes of static types
|
||
will never be finalized (they are artificially kept alive when their
|
||
reference count drops to zero).</doc>
|
||
<source-position filename="gtype.h" line="949"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="936">The #GTypeClass structure to finalize</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="class_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="937">The @class_data member supplied via the #GTypeInfo structure</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="ClassInitFunc" c:type="GClassInitFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="829">A callback function used by the type system to initialize the class
|
||
of a specific type.
|
||
|
||
This function should initialize all static class members.
|
||
|
||
The initialization process of a class involves:
|
||
|
||
- Copying common members from the parent class over to the
|
||
derived class structure.
|
||
- Zero initialization of the remaining members not copied
|
||
over from the parent class.
|
||
- Invocation of the GBaseInitFunc() initializers of all parent
|
||
types and the class' type.
|
||
- Invocation of the class' GClassInitFunc() initializer.
|
||
|
||
Since derived classes are partially initialized through a memory copy
|
||
of the parent class, the general rule is that GBaseInitFunc() and
|
||
GBaseFinalizeFunc() should take care of necessary reinitialization
|
||
and release of those class members that were introduced by the type
|
||
that specified these GBaseInitFunc()/GBaseFinalizeFunc().
|
||
GClassInitFunc() should only care about initializing static
|
||
class members, while dynamic class members (such as allocated strings
|
||
or reference counted resources) are better handled by a GBaseInitFunc()
|
||
for this type, so proper initialization of the dynamic class members
|
||
is performed for class initialization of derived types as well.
|
||
|
||
An example may help to correspond the intend of the different class
|
||
initializers:
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct {
|
||
GObjectClass parent_class;
|
||
gint static_integer;
|
||
gchar *dynamic_string;
|
||
} TypeAClass;
|
||
static void
|
||
type_a_base_class_init (TypeAClass *class)
|
||
{
|
||
class->dynamic_string = g_strdup ("some string");
|
||
}
|
||
static void
|
||
type_a_base_class_finalize (TypeAClass *class)
|
||
{
|
||
g_free (class->dynamic_string);
|
||
}
|
||
static void
|
||
type_a_class_init (TypeAClass *class)
|
||
{
|
||
class->static_integer = 42;
|
||
}
|
||
|
||
typedef struct {
|
||
TypeAClass parent_class;
|
||
gfloat static_float;
|
||
GString *dynamic_gstring;
|
||
} TypeBClass;
|
||
static void
|
||
type_b_base_class_init (TypeBClass *class)
|
||
{
|
||
class->dynamic_gstring = g_string_new ("some other string");
|
||
}
|
||
static void
|
||
type_b_base_class_finalize (TypeBClass *class)
|
||
{
|
||
g_string_free (class->dynamic_gstring);
|
||
}
|
||
static void
|
||
type_b_class_init (TypeBClass *class)
|
||
{
|
||
class->static_float = 3.14159265358979323846;
|
||
}
|
||
]|
|
||
|
||
Initialization of TypeBClass will first cause initialization of
|
||
TypeAClass (derived classes reference their parent classes, see
|
||
g_type_class_ref() on this).
|
||
|
||
Initialization of TypeAClass roughly involves zero-initializing its fields,
|
||
then calling its GBaseInitFunc() type_a_base_class_init() to allocate
|
||
its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
|
||
type_a_class_init() to initialize its static members (static_integer).
|
||
The first step in the initialization process of TypeBClass is then
|
||
a plain memory copy of the contents of TypeAClass into TypeBClass and
|
||
zero-initialization of the remaining fields in TypeBClass.
|
||
The dynamic members of TypeAClass within TypeBClass now need
|
||
reinitialization which is performed by calling type_a_base_class_init()
|
||
with an argument of TypeBClass.
|
||
|
||
After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
|
||
is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
|
||
and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
|
||
is called to complete the initialization process with the static members
|
||
(static_float).
|
||
|
||
Corresponding finalization counter parts to the GBaseInitFunc() functions
|
||
have to be provided to release allocated resources at class finalization
|
||
time.</doc>
|
||
<source-position filename="gtype.h" line="932"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="831">The #GTypeClass structure to initialize.</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="class_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="832">The @class_data member supplied via the #GTypeInfo structure.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="Closure"
|
||
c:type="GClosure"
|
||
glib:type-name="GClosure"
|
||
glib:get-type="g_closure_get_type"
|
||
c:symbol-prefix="closure">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="357">A #GClosure represents a callback supplied by the programmer.
|
||
|
||
It will generally comprise a function of some kind and a marshaller
|
||
used to call it. It is the responsibility of the marshaller to
|
||
convert the arguments for the invocation from #GValues into
|
||
a suitable form, perform the callback on the converted arguments,
|
||
and transform the return value back into a #GValue.
|
||
|
||
In the case of C programs, a closure usually just holds a pointer
|
||
to a function and maybe a data argument, and the marshaller
|
||
converts between #GValue and native C types. The GObject
|
||
library provides the #GCClosure type for this purpose. Bindings for
|
||
other languages need marshallers which convert between #GValues
|
||
and suitable representations in the runtime of the language in
|
||
order to use functions written in that language as callbacks. Use
|
||
g_closure_set_marshal() to set the marshaller on such a custom
|
||
closure implementation.
|
||
|
||
Within GObject, closures play an important role in the
|
||
implementation of signals. When a signal is registered, the
|
||
@c_marshaller argument to g_signal_new() specifies the default C
|
||
marshaller for any closure which is connected to this
|
||
signal. GObject provides a number of C marshallers for this
|
||
purpose, see the g_cclosure_marshal_*() functions. Additional C
|
||
marshallers can be generated with the [glib-genmarshal][glib-genmarshal]
|
||
utility. Closures can be explicitly connected to signals with
|
||
g_signal_connect_closure(), but it usually more convenient to let
|
||
GObject create a closure automatically by using one of the
|
||
g_signal_connect_*() functions which take a callback function/user
|
||
data pair.
|
||
|
||
Using closures has a number of important advantages over a simple
|
||
callback function/data pointer combination:
|
||
|
||
- Closures allow the callee to get the types of the callback parameters,
|
||
which means that language bindings don't have to write individual glue
|
||
for each callback type.
|
||
|
||
- The reference counting of #GClosure makes it easy to handle reentrancy
|
||
right; if a callback is removed while it is being invoked, the closure
|
||
and its parameters won't be freed until the invocation finishes.
|
||
|
||
- g_closure_invalidate() and invalidation notifiers allow callbacks to be
|
||
automatically removed when the objects they point to go away.</doc>
|
||
<source-position filename="gclosure.h" line="219"/>
|
||
<field name="ref_count" readable="0" bits="15" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="meta_marshal_nouse" readable="0" bits="1" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="n_guards" readable="0" bits="1" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="n_fnotifiers" readable="0" bits="2" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="n_inotifiers" readable="0" bits="8" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="in_inotify" readable="0" bits="1" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="floating" readable="0" bits="1" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="derivative_flag" readable="0" bits="1" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="in_marshal" writable="1" bits="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="174">Indicates whether the closure is currently being invoked with
|
||
g_closure_invoke()</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="is_invalid" writable="1" bits="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="176">Indicates whether the closure has been invalidated by
|
||
g_closure_invalidate()</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="marshal">
|
||
<callback name="marshal">
|
||
<source-position filename="gclosure.h" line="199"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint" transfer-ownership="none">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data" transfer-ownership="none">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="data" readable="0" private="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
<field name="notifiers" readable="0" private="1">
|
||
<type name="ClosureNotifyData" c:type="GClosureNotifyData*"/>
|
||
</field>
|
||
<constructor name="new_object" c:identifier="g_closure_new_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2265">A variant of g_closure_new_simple() which stores @object in the
|
||
@data field of the closure and calls g_object_watch_closure() on
|
||
@object and the created closure. This function is mainly useful
|
||
when implementing new types of closures.</doc>
|
||
<source-position filename="gobject.h" line="648"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2277">a newly allocated #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="sizeof_closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2267">the size of the structure to allocate, must be at least
|
||
`sizeof (GClosure)`</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2269">a #GObject pointer to store in the @data field of the newly
|
||
allocated #GClosure</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<constructor name="new_simple" c:identifier="g_closure_new_simple">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2281">Allocates a struct of the given size and initializes the initial
|
||
part as a #GClosure.
|
||
|
||
This function is mainly useful when implementing new types of closures:
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct _MyClosure MyClosure;
|
||
struct _MyClosure
|
||
{
|
||
GClosure closure;
|
||
// extra data goes here
|
||
};
|
||
|
||
static void
|
||
my_closure_finalize (gpointer notify_data,
|
||
GClosure *closure)
|
||
{
|
||
MyClosure *my_closure = (MyClosure *)closure;
|
||
|
||
// free extra data here
|
||
}
|
||
|
||
MyClosure *my_closure_new (gpointer data)
|
||
{
|
||
GClosure *closure;
|
||
MyClosure *my_closure;
|
||
|
||
closure = g_closure_new_simple (sizeof (MyClosure), data);
|
||
my_closure = (MyClosure *) closure;
|
||
|
||
// initialize extra data here
|
||
|
||
g_closure_add_finalize_notifier (closure, notify_data,
|
||
my_closure_finalize);
|
||
return my_closure;
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gclosure.h" line="252"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2325">a floating reference to a new #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="sizeof_closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2283">the size of the structure to allocate, must be at least
|
||
`sizeof (GClosure)`</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2285">data to store in the @data field of the newly allocated #GClosure</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<method name="add_finalize_notifier"
|
||
c:identifier="g_closure_add_finalize_notifier"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2178">Registers a finalization notifier which will be called when the
|
||
reference count of @closure goes down to 0.
|
||
|
||
Multiple finalization notifiers on a single closure are invoked in
|
||
unspecified order. If a single call to g_closure_unref() results in
|
||
the closure being both invalidated and finalized, then the invalidate
|
||
notifiers will be run before the finalize notifiers.</doc>
|
||
<source-position filename="gclosure.h" line="255"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2180">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2181">data to pass to @notify_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2182">the callback function to register</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="add_invalidate_notifier"
|
||
c:identifier="g_closure_add_invalidate_notifier"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2194">Registers an invalidation notifier which will be called when the
|
||
@closure is invalidated with g_closure_invalidate().
|
||
|
||
Invalidation notifiers are invoked before finalization notifiers,
|
||
in an unspecified order.</doc>
|
||
<source-position filename="gclosure.h" line="263"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2196">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2197">data to pass to @notify_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2198">the callback function to register</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="add_marshal_guards"
|
||
c:identifier="g_closure_add_marshal_guards"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2208">Adds a pair of notifiers which get invoked before and after the
|
||
closure callback, respectively.
|
||
|
||
This is typically used to protect the extra arguments for the
|
||
duration of the callback. See g_object_watch_closure() for an
|
||
example of marshal guards.</doc>
|
||
<source-position filename="gclosure.h" line="271"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2210">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="pre_marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2211">data to pass
|
||
to @pre_marshal_notify</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="pre_marshal_notify"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2213">a function to call before the closure callback</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
<parameter name="post_marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="3">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2214">data to pass
|
||
to @post_marshal_notify</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="post_marshal_notify"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2216">a function to call after the closure callback</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="invalidate" c:identifier="g_closure_invalidate">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2227">Sets a flag on the closure to indicate that its calling
|
||
environment has become invalid, and thus causes any future
|
||
invocations of g_closure_invoke() on this @closure to be
|
||
ignored.
|
||
|
||
Also, invalidation notifiers installed on the closure will
|
||
be called at this point. Note that unless you are holding a
|
||
reference to the closure yourself, the invalidation notifiers may
|
||
unref the closure and cause it to be destroyed, so if you need to
|
||
access the closure after calling g_closure_invalidate(), make sure
|
||
that you've previously called g_closure_ref().
|
||
|
||
Note that g_closure_invalidate() will also be called when the
|
||
reference count of a closure drops to zero (unless it has already
|
||
been invalidated before).</doc>
|
||
<source-position filename="gclosure.h" line="284"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2229">#GClosure to invalidate</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="invoke" c:identifier="g_closure_invoke">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2249">Invokes the closure, i.e. executes the callback represented by the @closure.</doc>
|
||
<source-position filename="gclosure.h" line="286"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2251">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="return_value"
|
||
direction="out"
|
||
caller-allocates="1"
|
||
transfer-ownership="none"
|
||
optional="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2252">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure
|
||
doesn't return a value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2255">the length of the @param_values array</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2256">an array of
|
||
#GValues holding the arguments on which to
|
||
invoke the callback of @closure</doc>
|
||
<array length="1" zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2259">a context-dependent invocation hint</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="ref" c:identifier="g_closure_ref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2329">Increments the reference count on a closure to force it staying
|
||
alive while the caller holds a pointer to it.</doc>
|
||
<source-position filename="gclosure.h" line="245"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2336">The @closure passed in, for convenience</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2331">#GClosure to increment the reference count on</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove_finalize_notifier"
|
||
c:identifier="g_closure_remove_finalize_notifier"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2340">Removes a finalization notifier.
|
||
|
||
Notice that notifiers are automatically removed after they are run.</doc>
|
||
<source-position filename="gclosure.h" line="259"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2342">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2343">data which was passed to g_closure_add_finalize_notifier()
|
||
when registering @notify_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2345">the callback function to remove</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove_invalidate_notifier"
|
||
c:identifier="g_closure_remove_invalidate_notifier"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2353">Removes an invalidation notifier.
|
||
|
||
Notice that notifiers are automatically removed after they are run.</doc>
|
||
<source-position filename="gclosure.h" line="267"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2355">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2356">data which was passed to g_closure_add_invalidate_notifier()
|
||
when registering @notify_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2358">the callback function to remove</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_marshal"
|
||
c:identifier="g_closure_set_marshal"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2366">Sets the marshaller of @closure.
|
||
|
||
The `marshal_data` of @marshal provides a way for a meta marshaller to
|
||
provide additional information to the marshaller.
|
||
|
||
For GObject's C predefined marshallers (the `g_cclosure_marshal_*()`
|
||
functions), what it provides is a callback function to use instead of
|
||
@closure->callback.
|
||
|
||
See also: g_closure_set_meta_marshal()</doc>
|
||
<source-position filename="gclosure.h" line="277"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2368">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="marshal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2369">a #GClosureMarshal function</doc>
|
||
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_meta_marshal"
|
||
c:identifier="g_closure_set_meta_marshal"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2384">Sets the meta marshaller of @closure.
|
||
|
||
A meta marshaller wraps the @closure's marshal and modifies the way
|
||
it is called in some fashion. The most common use of this facility
|
||
is for C callbacks.
|
||
|
||
The same marshallers (generated by [glib-genmarshal][glib-genmarshal]),
|
||
are used everywhere, but the way that we get the callback function
|
||
differs. In most cases we want to use the @closure's callback, but in
|
||
other cases we want to use some different technique to retrieve the
|
||
callback function.
|
||
|
||
For example, class closures for signals (see
|
||
g_signal_type_cclosure_new()) retrieve the callback function from a
|
||
fixed offset in the class structure. The meta marshaller retrieves
|
||
the right callback and passes it to the marshaller as the
|
||
@marshal_data argument.</doc>
|
||
<source-position filename="gclosure.h" line="280"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2386">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2387">context-dependent data to pass
|
||
to @meta_marshal</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="meta_marshal"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2389">a #GClosureMarshal function</doc>
|
||
<type name="ClosureMarshal" c:type="GClosureMarshal"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="sink" c:identifier="g_closure_sink">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2411">Takes over the initial ownership of a closure.
|
||
|
||
Each closure is initially created in a "floating" state, which means
|
||
that the initial reference count is not owned by any caller.
|
||
|
||
This function checks to see if the object is still floating, and if so,
|
||
unsets the floating state and decreases the reference count. If the
|
||
closure is not floating, g_closure_sink() does nothing.
|
||
|
||
The reason for the existence of the floating state is to prevent
|
||
cumbersome code sequences like:
|
||
|
||
|[<!-- language="C" -->
|
||
closure = g_cclosure_new (cb_func, cb_data);
|
||
g_source_set_closure (source, closure);
|
||
g_closure_unref (closure); // GObject doesn't really need this
|
||
]|
|
||
|
||
Because g_source_set_closure() (and similar functions) take ownership of the
|
||
initial reference count, if it is unowned, we instead can write:
|
||
|
||
|[<!-- language="C" -->
|
||
g_source_set_closure (source, g_cclosure_new (cb_func, cb_data));
|
||
]|
|
||
|
||
Generally, this function is used together with g_closure_ref(). An example
|
||
of storing a closure for later notification looks like:
|
||
|
||
|[<!-- language="C" -->
|
||
static GClosure *notify_closure = NULL;
|
||
void
|
||
foo_notify_set_closure (GClosure *closure)
|
||
{
|
||
if (notify_closure)
|
||
g_closure_unref (notify_closure);
|
||
notify_closure = closure;
|
||
if (notify_closure)
|
||
{
|
||
g_closure_ref (notify_closure);
|
||
g_closure_sink (notify_closure);
|
||
}
|
||
}
|
||
]|
|
||
|
||
Because g_closure_sink() may decrement the reference count of a closure
|
||
(if it hasn't been called on @closure yet) just like g_closure_unref(),
|
||
g_closure_ref() should be called prior to this function.</doc>
|
||
<source-position filename="gclosure.h" line="247"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2413">#GClosure to decrement the initial reference count on, if it's
|
||
still being held</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unref" c:identifier="g_closure_unref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2466">Decrements the reference count of a closure after it was previously
|
||
incremented by the same caller.
|
||
|
||
If no other callers are using the closure, then the closure will be
|
||
destroyed and freed.</doc>
|
||
<source-position filename="gclosure.h" line="249"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2468">#GClosure to decrement the reference count on</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
</record>
|
||
<callback name="ClosureMarshal" c:type="GClosureMarshal">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="103">The type used for marshaller functions.</doc>
|
||
<source-position filename="gclosure.h" line="121"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="105">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="106">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="109">the length of the @param_values array</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="110">an array of
|
||
#GValues holding the arguments on which to invoke the
|
||
callback of @closure</doc>
|
||
<array length="2" zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="113">the invocation hint given as the
|
||
last argument to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="115">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="ClosureNotify" c:type="GClosureNotify">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="93">The type used for the various notification callbacks which can be registered
|
||
on closures.</doc>
|
||
<source-position filename="gclosure.h" line="101"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="95">data specified when registering the notification callback</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="96">the #GClosure on which the notification is emitted</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="ClosureNotifyData" c:type="GClosureNotifyData">
|
||
<source-position filename="gclosure.h" line="171"/>
|
||
<field name="data" writable="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
<field name="notify" writable="1">
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</field>
|
||
</record>
|
||
<bitfield name="ConnectFlags" c:type="GConnectFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="158">The connection flags are used to specify the behaviour of a signal's
|
||
connection.</doc>
|
||
<source-position filename="gsignal.h" line="175"/>
|
||
<member name="default" value="0" c:identifier="G_CONNECT_DEFAULT">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="160">Default behaviour (no special flags). Since: 2.74</doc>
|
||
</member>
|
||
<member name="after" value="1" c:identifier="G_CONNECT_AFTER">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="161">If set, the handler should be called after the
|
||
default handler of the signal. Normally, the handler is called before
|
||
the default handler.</doc>
|
||
</member>
|
||
<member name="swapped" value="2" c:identifier="G_CONNECT_SWAPPED">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="164">If set, the instance and data should be swapped when
|
||
calling the handler; see g_signal_connect_swapped() for an example.</doc>
|
||
</member>
|
||
</bitfield>
|
||
<function-macro name="DECLARE_DERIVABLE_TYPE"
|
||
c:identifier="G_DECLARE_DERIVABLE_TYPE"
|
||
version="2.44"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1494">A convenience macro for emitting the usual declarations in the
|
||
header file for a type which is intended to be subclassed.
|
||
|
||
You might use it in a header as follows:
|
||
|
||
|[<!-- language="C" -->
|
||
#ifndef _gtk_frobber_h_
|
||
#define _gtk_frobber_h_
|
||
|
||
#define GTK_TYPE_FROBBER gtk_frobber_get_type ()
|
||
GDK_AVAILABLE_IN_3_12
|
||
G_DECLARE_DERIVABLE_TYPE (GtkFrobber, gtk_frobber, GTK, FROBBER, GtkWidget)
|
||
|
||
struct _GtkFrobberClass
|
||
{
|
||
GtkWidgetClass parent_class;
|
||
|
||
void (* handle_frob) (GtkFrobber *frobber,
|
||
guint n_frobs);
|
||
|
||
gpointer padding[12];
|
||
};
|
||
|
||
GtkWidget * gtk_frobber_new (void);
|
||
|
||
...
|
||
|
||
#endif
|
||
]|
|
||
|
||
Since the instance structure is public it is often needed to declare a
|
||
private struct as follow in your C file:
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct _GtkFrobberPrivate GtkFrobberPrivate;
|
||
struct _GtkFrobberPrivate
|
||
{
|
||
...
|
||
};
|
||
G_DEFINE_TYPE_WITH_PRIVATE (GtkFrobber, gtk_frobber, GTK_TYPE_WIDGET)
|
||
]|
|
||
|
||
This results in the following things happening:
|
||
|
||
- the usual `gtk_frobber_get_type()` function is declared with a return type of #GType
|
||
|
||
- the `GtkFrobber` struct is created with `GtkWidget` as the first and only item. You are expected to use
|
||
a private structure from your .c file to store your instance variables.
|
||
|
||
- the `GtkFrobberClass` type is defined as a typedef to `struct _GtkFrobberClass`, which is left undefined.
|
||
You should do this from the header file directly after you use the macro.
|
||
|
||
- the `GTK_FROBBER()` and `GTK_FROBBER_CLASS()` casts are emitted as `static inline` functions along with
|
||
the `GTK_IS_FROBBER()` and `GTK_IS_FROBBER_CLASS()` type checking functions and `GTK_FROBBER_GET_CLASS()`
|
||
function.
|
||
|
||
- g_autoptr() support being added for your type, based on the type of your parent class
|
||
|
||
You can only use this function if your parent type also supports g_autoptr().
|
||
|
||
Because the type macro (`GTK_TYPE_FROBBER` in the above example) is not a callable, you must continue to
|
||
manually define this as a macro for yourself.
|
||
|
||
The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
|
||
to be used in the usual way with export control and API versioning macros.
|
||
|
||
If you are writing a library, it is important to note that it is possible to convert a type from using
|
||
G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you
|
||
should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be
|
||
subclassed. Once a class structure has been exposed it is not possible to change its size or remove or
|
||
reorder items without breaking the API and/or ABI. If you want to declare your own class structure, use
|
||
G_DECLARE_DERIVABLE_TYPE(). If you want to declare a class without exposing the class or instance
|
||
structures, use G_DECLARE_FINAL_TYPE().
|
||
|
||
If you must use G_DECLARE_DERIVABLE_TYPE() you should be sure to include some padding at the bottom of your
|
||
class structure to leave space for the addition of future virtual functions.</doc>
|
||
<source-position filename="gtype.h" line="1582"/>
|
||
<parameters>
|
||
<parameter name="ModuleObjName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1496">The name of the new type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
<parameter name="module_obj_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1497">The name of the new type in lowercase, with words
|
||
separated by `_` (like `gtk_widget`)</doc>
|
||
</parameter>
|
||
<parameter name="MODULE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1499">The name of the module, in all caps (like `GTK`)</doc>
|
||
</parameter>
|
||
<parameter name="OBJ_NAME">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1500">The bare name of the type, in all caps (like `WIDGET`)</doc>
|
||
</parameter>
|
||
<parameter name="ParentName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1501">the name of the parent type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DECLARE_FINAL_TYPE"
|
||
c:identifier="G_DECLARE_FINAL_TYPE"
|
||
version="2.44"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1402">A convenience macro for emitting the usual declarations in the header file
|
||
for a type which is not (at the present time) intended to be subclassed.
|
||
|
||
You might use it in a header as follows:
|
||
|
||
|[<!-- language="C" -->
|
||
#ifndef _myapp_window_h_
|
||
#define _myapp_window_h_
|
||
|
||
#include <gtk/gtk.h>
|
||
|
||
#define MY_APP_TYPE_WINDOW my_app_window_get_type ()
|
||
G_DECLARE_FINAL_TYPE (MyAppWindow, my_app_window, MY_APP, WINDOW, GtkWindow)
|
||
|
||
MyAppWindow * my_app_window_new (void);
|
||
|
||
...
|
||
|
||
#endif
|
||
]|
|
||
|
||
And use it as follow in your C file:
|
||
|
||
|[<!-- language="C" -->
|
||
struct _MyAppWindow
|
||
{
|
||
GtkWindow parent;
|
||
...
|
||
};
|
||
G_DEFINE_TYPE (MyAppWindow, my_app_window, GTK_TYPE_WINDOW)
|
||
]|
|
||
|
||
This results in the following things happening:
|
||
|
||
- the usual `my_app_window_get_type()` function is declared with a return type of #GType
|
||
|
||
- the `MyAppWindow` type is defined as a `typedef` of `struct _MyAppWindow`. The struct itself is not
|
||
defined and should be defined from the .c file before G_DEFINE_TYPE() is used.
|
||
|
||
- the `MY_APP_WINDOW()` cast is emitted as `static inline` function along with the `MY_APP_IS_WINDOW()` type
|
||
checking function
|
||
|
||
- the `MyAppWindowClass` type is defined as a struct containing `GtkWindowClass`. This is done for the
|
||
convenience of the person defining the type and should not be considered to be part of the ABI. In
|
||
particular, without a firm declaration of the instance structure, it is not possible to subclass the type
|
||
and therefore the fact that the size of the class structure is exposed is not a concern and it can be
|
||
freely changed at any point in the future.
|
||
|
||
- g_autoptr() support being added for your type, based on the type of your parent class
|
||
|
||
You can only use this function if your parent type also supports g_autoptr().
|
||
|
||
Because the type macro (`MY_APP_TYPE_WINDOW` in the above example) is not a callable, you must continue to
|
||
manually define this as a macro for yourself.
|
||
|
||
The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
|
||
to be used in the usual way with export control and API versioning macros.
|
||
|
||
If you want to declare your own class structure, use G_DECLARE_DERIVABLE_TYPE().
|
||
|
||
If you are writing a library, it is important to note that it is possible to convert a type from using
|
||
G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you
|
||
should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be
|
||
subclassed. Once a class structure has been exposed it is not possible to change its size or remove or
|
||
reorder items without breaking the API and/or ABI.</doc>
|
||
<source-position filename="gtype.h" line="1479"/>
|
||
<parameters>
|
||
<parameter name="ModuleObjName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1404">The name of the new type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
<parameter name="module_obj_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1405">The name of the new type in lowercase, with words
|
||
separated by `_` (like `gtk_widget`)</doc>
|
||
</parameter>
|
||
<parameter name="MODULE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1407">The name of the module, in all caps (like `GTK`)</doc>
|
||
</parameter>
|
||
<parameter name="OBJ_NAME">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1408">The bare name of the type, in all caps (like `WIDGET`)</doc>
|
||
</parameter>
|
||
<parameter name="ParentName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1409">the name of the parent type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DECLARE_INTERFACE"
|
||
c:identifier="G_DECLARE_INTERFACE"
|
||
version="2.44"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1604">A convenience macro for emitting the usual declarations in the header file for a #GInterface type.
|
||
|
||
You might use it in a header as follows:
|
||
|
||
|[<!-- language="C" -->
|
||
#ifndef _my_model_h_
|
||
#define _my_model_h_
|
||
|
||
#define MY_TYPE_MODEL my_model_get_type ()
|
||
GDK_AVAILABLE_IN_3_12
|
||
G_DECLARE_INTERFACE (MyModel, my_model, MY, MODEL, GObject)
|
||
|
||
struct _MyModelInterface
|
||
{
|
||
GTypeInterface g_iface;
|
||
|
||
gpointer (* get_item) (MyModel *model);
|
||
};
|
||
|
||
gpointer my_model_get_item (MyModel *model);
|
||
|
||
...
|
||
|
||
#endif
|
||
]|
|
||
|
||
And use it as follow in your C file:
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_INTERFACE (MyModel, my_model, G_TYPE_OBJECT);
|
||
|
||
static void
|
||
my_model_default_init (MyModelInterface *iface)
|
||
{
|
||
...
|
||
}
|
||
]|
|
||
|
||
This results in the following things happening:
|
||
|
||
- the usual `my_model_get_type()` function is declared with a return type of #GType
|
||
|
||
- the `MyModelInterface` type is defined as a typedef to `struct _MyModelInterface`,
|
||
which is left undefined. You should do this from the header file directly after
|
||
you use the macro.
|
||
|
||
- the `MY_MODEL()` cast is emitted as `static inline` functions along with
|
||
the `MY_IS_MODEL()` type checking function and `MY_MODEL_GET_IFACE()` function.
|
||
|
||
- g_autoptr() support being added for your type, based on your prerequisite type.
|
||
|
||
You can only use this function if your prerequisite type also supports g_autoptr().
|
||
|
||
Because the type macro (`MY_TYPE_MODEL` in the above example) is not a callable, you must continue to
|
||
manually define this as a macro for yourself.
|
||
|
||
The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
|
||
to be used in the usual way with export control and API versioning macros.</doc>
|
||
<source-position filename="gtype.h" line="1674"/>
|
||
<parameters>
|
||
<parameter name="ModuleObjName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1606">The name of the new type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
<parameter name="module_obj_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1607">The name of the new type in lowercase, with words
|
||
separated by `_` (like `gtk_widget`)</doc>
|
||
</parameter>
|
||
<parameter name="MODULE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1609">The name of the module, in all caps (like `GTK`)</doc>
|
||
</parameter>
|
||
<parameter name="OBJ_NAME">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1610">The bare name of the type, in all caps (like `WIDGET`)</doc>
|
||
</parameter>
|
||
<parameter name="PrerequisiteName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1611">the name of the prerequisite type, in camel case (like `GtkWidget`)</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_ABSTRACT_TYPE"
|
||
c:identifier="G_DEFINE_ABSTRACT_TYPE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1748">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE(), but defines an abstract type.
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1762"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1750">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1751">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1753">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_ABSTRACT_TYPE_WITH_CODE"
|
||
c:identifier="G_DEFINE_ABSTRACT_TYPE_WITH_CODE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1763">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and
|
||
allows you to insert custom code into the `*_get_type()` function, e.g.
|
||
interface implementations via G_IMPLEMENT_INTERFACE().
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1781"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1765">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1766">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1768">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1769">Custom code that gets inserted in the `type_name_get_type()` function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_ABSTRACT_TYPE_WITH_PRIVATE"
|
||
c:identifier="G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1782">Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1795"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1784">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1785">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1787">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_BOXED_TYPE"
|
||
c:identifier="G_DEFINE_BOXED_TYPE"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2238">A convenience macro for defining a new custom boxed type.
|
||
|
||
Using this macro is the recommended way of defining new custom boxed
|
||
types, over calling g_boxed_type_register_static() directly. It defines
|
||
a `type_name_get_type()` function which will return the newly defined
|
||
#GType, enabling lazy instantiation.
|
||
|
||
You might start by putting declarations in a header as follows:
|
||
|
||
|[<!-- language="C" -->
|
||
#define MY_TYPE_STRUCT my_struct_get_type ()
|
||
GType my_struct_get_type (void) G_GNUC_CONST;
|
||
|
||
MyStruct * my_struct_new (void);
|
||
void my_struct_free (MyStruct *self);
|
||
MyStruct * my_struct_copy (MyStruct *self);
|
||
]|
|
||
|
||
And then use this macro and define your implementation in the source file as
|
||
follows:
|
||
|
||
|[<!-- language="C" -->
|
||
MyStruct *
|
||
my_struct_new (void)
|
||
{
|
||
// ... your code to allocate a new MyStruct ...
|
||
}
|
||
|
||
void
|
||
my_struct_free (MyStruct *self)
|
||
{
|
||
// ... your code to free a MyStruct ...
|
||
}
|
||
|
||
MyStruct *
|
||
my_struct_copy (MyStruct *self)
|
||
{
|
||
// ... your code return a newly allocated copy of a MyStruct ...
|
||
}
|
||
|
||
G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free)
|
||
|
||
void
|
||
foo ()
|
||
{
|
||
MyStruct *ms;
|
||
|
||
ms = my_struct_new ();
|
||
// ... your code ...
|
||
my_struct_free (ms);
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gtype.h" line="2301"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2240">The name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2241">The name of the new type, in lowercase, with words
|
||
separated by `_`</doc>
|
||
</parameter>
|
||
<parameter name="copy_func">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2243">the #GBoxedCopyFunc for the new type</doc>
|
||
</parameter>
|
||
<parameter name="free_func">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2244">the #GBoxedFreeFunc for the new type</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_BOXED_TYPE_WITH_CODE"
|
||
c:identifier="G_DEFINE_BOXED_TYPE_WITH_CODE"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2302">A convenience macro for boxed type implementations.
|
||
|
||
Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the
|
||
`type_name_get_type()` function, e.g. to register value transformations with
|
||
g_value_register_transform_func(), for instance:
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_BOXED_TYPE_WITH_CODE (GdkRectangle, gdk_rectangle,
|
||
gdk_rectangle_copy,
|
||
gdk_rectangle_free,
|
||
register_rectangle_transform_funcs (g_define_type_id))
|
||
]|
|
||
|
||
Similarly to the `G_DEFINE_TYPE_*` family of macros, the #GType of the newly
|
||
defined boxed type is exposed in the `g_define_type_id` variable.</doc>
|
||
<source-position filename="gtype.h" line="2329"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2304">The name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2305">The name of the new type, in lowercase, with words
|
||
separated by `_`</doc>
|
||
</parameter>
|
||
<parameter name="copy_func">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2307">the #GBoxedCopyFunc for the new type</doc>
|
||
</parameter>
|
||
<parameter name="free_func">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2308">the #GBoxedFreeFunc for the new type</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2309">Custom code that gets inserted in the `*_get_type()` function</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_DYNAMIC_TYPE"
|
||
c:identifier="G_DEFINE_DYNAMIC_TYPE"
|
||
version="2.14"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="88">A convenience macro for dynamic type implementations, which declares a
|
||
class initialization function, an instance initialization function (see
|
||
#GTypeInfo for information about these) and a static variable named
|
||
`t_n`_parent_class pointing to the parent class.
|
||
|
||
Furthermore, it defines a `*_get_type()` and a static `*_register_type()`
|
||
functions for use in your `module_init()`.
|
||
|
||
See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtypemodule.h" line="107"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="90">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="91">The name of the new type, in lowercase, with words
|
||
separated by '_'.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="93">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_DYNAMIC_TYPE_EXTENDED"
|
||
c:identifier="G_DEFINE_DYNAMIC_TYPE_EXTENDED"
|
||
version="2.14"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="108">A more general version of G_DEFINE_DYNAMIC_TYPE() which
|
||
allows to specify #GTypeFlags and custom code.
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_DYNAMIC_TYPE_EXTENDED (GtkGadget,
|
||
gtk_gadget,
|
||
GTK_TYPE_THING,
|
||
0,
|
||
G_IMPLEMENT_INTERFACE_DYNAMIC (TYPE_GIZMO,
|
||
gtk_gadget_gizmo_init));
|
||
]|
|
||
|
||
expands to
|
||
|
||
|[<!-- language="C" -->
|
||
static void gtk_gadget_init (GtkGadget *self);
|
||
static void gtk_gadget_class_init (GtkGadgetClass *klass);
|
||
static void gtk_gadget_class_finalize (GtkGadgetClass *klass);
|
||
|
||
static gpointer gtk_gadget_parent_class = NULL;
|
||
static GType gtk_gadget_type_id = 0;
|
||
|
||
static void gtk_gadget_class_intern_init (gpointer klass)
|
||
{
|
||
gtk_gadget_parent_class = g_type_class_peek_parent (klass);
|
||
gtk_gadget_class_init ((GtkGadgetClass*) klass);
|
||
}
|
||
|
||
GType
|
||
gtk_gadget_get_type (void)
|
||
{
|
||
return gtk_gadget_type_id;
|
||
}
|
||
|
||
static void
|
||
gtk_gadget_register_type (GTypeModule *type_module)
|
||
{
|
||
const GTypeInfo g_define_type_info = {
|
||
sizeof (GtkGadgetClass),
|
||
(GBaseInitFunc) NULL,
|
||
(GBaseFinalizeFunc) NULL,
|
||
(GClassInitFunc) gtk_gadget_class_intern_init,
|
||
(GClassFinalizeFunc) gtk_gadget_class_finalize,
|
||
NULL, // class_data
|
||
sizeof (GtkGadget),
|
||
0, // n_preallocs
|
||
(GInstanceInitFunc) gtk_gadget_init,
|
||
NULL // value_table
|
||
};
|
||
gtk_gadget_type_id = g_type_module_register_type (type_module,
|
||
GTK_TYPE_THING,
|
||
"GtkGadget",
|
||
&g_define_type_info,
|
||
(GTypeFlags) flags);
|
||
{
|
||
const GInterfaceInfo g_implement_interface_info = {
|
||
(GInterfaceInitFunc) gtk_gadget_gizmo_init
|
||
};
|
||
g_type_module_add_interface (type_module, g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
|
||
}
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gtypemodule.h" line="182"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="110">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="111">The name of the new type, in lowercase, with words
|
||
separated by '_'.</doc>
|
||
</parameter>
|
||
<parameter name="TYPE_PARENT">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="113">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
<parameter name="flags">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="114">#GTypeFlags to pass to g_type_module_register_type()</doc>
|
||
</parameter>
|
||
<parameter name="CODE">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="115">Custom code that gets inserted in the *_get_type() function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_ENUM_TYPE"
|
||
c:identifier="G_DEFINE_ENUM_TYPE"
|
||
version="2.74"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="297">A convenience macro for defining enumeration types.
|
||
|
||
This macro will generate a `*_get_type()` function for the
|
||
given @TypeName, using @type_name as the function prefix.
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_ENUM_TYPE (GtkOrientation, gtk_orientation,
|
||
G_DEFINE_ENUM_VALUE (GTK_ORIENTATION_HORIZONTAL, "horizontal"),
|
||
G_DEFINE_ENUM_VALUE (GTK_ORIENTATION_VERTICAL, "vertical"))
|
||
]|
|
||
|
||
For projects that have multiple enumeration types, or enumeration
|
||
types with many values, you should consider using glib-mkenums to
|
||
generate the type function.</doc>
|
||
<source-position filename="genums.h" line="320"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="299">the enumeration type, in `CamelCase`</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="300">the enumeration type prefixed, in `snake_case`</doc>
|
||
</parameter>
|
||
<parameter name="...">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="301">a list of enumeration values, defined using G_DEFINE_ENUM_VALUE()</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_ENUM_VALUE"
|
||
c:identifier="G_DEFINE_ENUM_VALUE"
|
||
version="2.74"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="281">Defines an enumeration value, and maps it to a "nickname".
|
||
|
||
This macro can only be used with G_DEFINE_ENUM_TYPE() and
|
||
G_DEFINE_FLAGS_TYPE().</doc>
|
||
<source-position filename="genums.h" line="293"/>
|
||
<parameters>
|
||
<parameter name="EnumValue">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="283">an enumeration value</doc>
|
||
</parameter>
|
||
<parameter name="EnumNick">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="284">a short string representing the enumeration value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_FINAL_TYPE"
|
||
c:identifier="G_DEFINE_FINAL_TYPE"
|
||
version="2.70"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1796">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE(), but defines a final type.
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1811"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1798">the name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1799">the name of the new type, in lower case, with words
|
||
separated by `_` (snake case)</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1801">the #GType of the parent type</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_FINAL_TYPE_WITH_CODE"
|
||
c:identifier="G_DEFINE_FINAL_TYPE_WITH_CODE"
|
||
version="2.70"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1812">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE_WITH_CODE(), but defines a final type and
|
||
allows you to insert custom code into the `*_get_type()` function, e.g.
|
||
interface implementations via G_IMPLEMENT_INTERFACE().
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1830"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1814">the name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1815">the name of the new type, in lower case, with words
|
||
separated by `_` (snake case)</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1817">the #GType of the parent type</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1818">Custom code that gets inserted in the `type_name_get_type()` function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_FINAL_TYPE_WITH_PRIVATE"
|
||
c:identifier="G_DEFINE_FINAL_TYPE_WITH_PRIVATE"
|
||
version="2.70"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1831">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines a final type.
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1846"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1833">the name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1834">the name of the new type, in lower case, with words
|
||
separated by `_` (snake case)</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1836">the #GType of the parent type</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_FLAGS_TYPE"
|
||
c:identifier="G_DEFINE_FLAGS_TYPE"
|
||
version="2.74"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="336">A convenience macro for defining flag types.
|
||
|
||
This macro will generate a `*_get_type()` function for the
|
||
given @TypeName, using @type_name as the function prefix.
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_FLAGS_TYPE (GSettingsBindFlags, g_settings_bind_flags,
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_DEFAULT, "default"),
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_GET, "get"),
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_SET, "set"),
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_NO_SENSITIVITY, "no-sensitivity"),
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_GET_NO_CHANGES, "get-no-changes"),
|
||
G_DEFINE_ENUM_VALUE (G_SETTINGS_BIND_INVERT_BOOLEAN, "invert-boolean"))
|
||
]|
|
||
|
||
For projects that have multiple enumeration types, or enumeration
|
||
types with many values, you should consider using glib-mkenums to
|
||
generate the type function.</doc>
|
||
<source-position filename="genums.h" line="363"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="338">the enumeration type, in `CamelCase`</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="339">the enumeration type prefixed, in `snake_case`</doc>
|
||
</parameter>
|
||
<parameter name="...">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="340">a list of enumeration values, defined using G_DEFINE_ENUM_VALUE()</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_INTERFACE"
|
||
c:identifier="G_DEFINE_INTERFACE"
|
||
version="2.24"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1926">A convenience macro for #GTypeInterface definitions, which declares
|
||
a default vtable initialization function and defines a `*_get_type()`
|
||
function.
|
||
|
||
The macro expects the interface initialization function to have the
|
||
name `t_n ## _default_init`, and the interface structure to have the
|
||
name `TN ## Interface`.
|
||
|
||
The initialization function has signature
|
||
`static void t_n ## _default_init (TypeName##Interface *klass);`, rather than
|
||
the full #GInterfaceInitFunc signature, for brevity and convenience. If you
|
||
need to use an initialization function with an `iface_data` argument, you
|
||
must write the #GTypeInterface definitions manually.</doc>
|
||
<source-position filename="gtype.h" line="1949"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1928">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1929">The name of the new type, in lowercase, with words separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1930">The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID
|
||
for no prerequisite type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_INTERFACE_WITH_CODE"
|
||
c:identifier="G_DEFINE_INTERFACE_WITH_CODE"
|
||
version="2.24"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1951">A convenience macro for #GTypeInterface definitions.
|
||
|
||
Similar to G_DEFINE_INTERFACE(), but allows you to insert custom code
|
||
into the `*_get_type()` function, e.g. additional interface implementations
|
||
via G_IMPLEMENT_INTERFACE(), or additional prerequisite types.
|
||
|
||
See G_DEFINE_TYPE_EXTENDED() for a similar example using
|
||
G_DEFINE_TYPE_WITH_CODE().</doc>
|
||
<source-position filename="gtype.h" line="1970"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1953">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1954">The name of the new type, in lowercase, with words separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1955">The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID
|
||
for no prerequisite type.</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1957">Custom code that gets inserted in the `*_get_type()` function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_POINTER_TYPE"
|
||
c:identifier="G_DEFINE_POINTER_TYPE"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2399">A convenience macro for pointer type implementations, which defines a
|
||
`type_name_get_type()` function registering the pointer type.</doc>
|
||
<source-position filename="gtype.h" line="2410"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2401">The name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2402">The name of the new type, in lowercase, with words
|
||
separated by `_`</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_POINTER_TYPE_WITH_CODE"
|
||
c:identifier="G_DEFINE_POINTER_TYPE_WITH_CODE"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2411">A convenience macro for pointer type implementations.
|
||
Similar to G_DEFINE_POINTER_TYPE(), but allows to insert
|
||
custom code into the `type_name_get_type()` function.</doc>
|
||
<source-position filename="gtype.h" line="2424"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2413">The name of the new type, in Camel case</doc>
|
||
</parameter>
|
||
<parameter name="type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2414">The name of the new type, in lowercase, with words
|
||
separated by `_`</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2416">Custom code that gets inserted in the `*_get_type()` function</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_TYPE"
|
||
c:identifier="G_DEFINE_TYPE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1690">A convenience macro for type implementations, which declares a class
|
||
initialization function, an instance initialization function (see #GTypeInfo
|
||
for information about these) and a static variable named `t_n_parent_class`
|
||
pointing to the parent class. Furthermore, it defines a `*_get_type()` function.
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1705"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1692">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1693">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1695">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_TYPE_EXTENDED"
|
||
c:identifier="G_DEFINE_TYPE_EXTENDED"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1847">The most general convenience macro for type implementations, on which
|
||
G_DEFINE_TYPE(), etc are based.
|
||
|
||
|[<!-- language="C" -->
|
||
G_DEFINE_TYPE_EXTENDED (GtkGadget,
|
||
gtk_gadget,
|
||
GTK_TYPE_WIDGET,
|
||
0,
|
||
G_ADD_PRIVATE (GtkGadget)
|
||
G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
|
||
gtk_gadget_gizmo_init));
|
||
]|
|
||
|
||
expands to
|
||
|
||
|[<!-- language="C" -->
|
||
static void gtk_gadget_init (GtkGadget *self);
|
||
static void gtk_gadget_class_init (GtkGadgetClass *klass);
|
||
static gpointer gtk_gadget_parent_class = NULL;
|
||
static gint GtkGadget_private_offset;
|
||
static void gtk_gadget_class_intern_init (gpointer klass)
|
||
{
|
||
gtk_gadget_parent_class = g_type_class_peek_parent (klass);
|
||
if (GtkGadget_private_offset != 0)
|
||
g_type_class_adjust_private_offset (klass, &GtkGadget_private_offset);
|
||
gtk_gadget_class_init ((GtkGadgetClass*) klass);
|
||
}
|
||
static inline gpointer gtk_gadget_get_instance_private (GtkGadget *self)
|
||
{
|
||
return (G_STRUCT_MEMBER_P (self, GtkGadget_private_offset));
|
||
}
|
||
|
||
GType
|
||
gtk_gadget_get_type (void)
|
||
{
|
||
static gsize static_g_define_type_id = 0;
|
||
if (g_once_init_enter (&static_g_define_type_id))
|
||
{
|
||
GType g_define_type_id =
|
||
g_type_register_static_simple (GTK_TYPE_WIDGET,
|
||
g_intern_static_string ("GtkGadget"),
|
||
sizeof (GtkGadgetClass),
|
||
(GClassInitFunc) gtk_gadget_class_intern_init,
|
||
sizeof (GtkGadget),
|
||
(GInstanceInitFunc) gtk_gadget_init,
|
||
0);
|
||
{
|
||
GtkGadget_private_offset =
|
||
g_type_add_instance_private (g_define_type_id, sizeof (GtkGadgetPrivate));
|
||
}
|
||
{
|
||
const GInterfaceInfo g_implement_interface_info = {
|
||
(GInterfaceInitFunc) gtk_gadget_gizmo_init
|
||
};
|
||
g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
|
||
}
|
||
g_once_init_leave (&static_g_define_type_id, g_define_type_id);
|
||
}
|
||
return static_g_define_type_id;
|
||
}
|
||
]|
|
||
|
||
The only pieces which have to be manually provided are the definitions of
|
||
the instance and class structure and the definitions of the instance and
|
||
class init functions.</doc>
|
||
<source-position filename="gtype.h" line="1924"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1849">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1850">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1852">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
<parameter name="_f_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1853">#GTypeFlags to pass to g_type_register_static()</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1854">Custom code that gets inserted in the `*_get_type()` function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_TYPE_WITH_CODE"
|
||
c:identifier="G_DEFINE_TYPE_WITH_CODE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1706">A convenience macro for type implementations.
|
||
|
||
Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the
|
||
`*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.</doc>
|
||
<source-position filename="gtype.h" line="1721"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1708">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1709">The name of the new type in lowercase, with words separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1710">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
<parameter name="_C_">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1711">Custom code that gets inserted in the `*_get_type()` function.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="DEFINE_TYPE_WITH_PRIVATE"
|
||
c:identifier="G_DEFINE_TYPE_WITH_PRIVATE"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1722">A convenience macro for type implementations, which declares a class
|
||
initialization function, an instance initialization function (see #GTypeInfo
|
||
for information about these), a static variable named `t_n_parent_class`
|
||
pointing to the parent class, and adds private instance data to the type.
|
||
|
||
Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED()
|
||
for an example.
|
||
|
||
Note that private structs added with this macros must have a struct
|
||
name of the form `TN ## Private`.
|
||
|
||
The private instance data can be retrieved using the automatically generated
|
||
getter function `t_n_get_instance_private()`.
|
||
|
||
See also: G_ADD_PRIVATE()</doc>
|
||
<source-position filename="gtype.h" line="1747"/>
|
||
<parameters>
|
||
<parameter name="TN">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1724">The name of the new type, in Camel case.</doc>
|
||
</parameter>
|
||
<parameter name="t_n">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1725">The name of the new type, in lowercase, with words
|
||
separated by `_`.</doc>
|
||
</parameter>
|
||
<parameter name="T_P">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1727">The #GType of the parent type.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="ENUM_CLASS"
|
||
c:identifier="G_ENUM_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="40">Casts a derived #GEnumClass structure into a #GEnumClass structure.</doc>
|
||
<source-position filename="genums.h" line="46"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="42">a valid #GEnumClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="ENUM_CLASS_TYPE"
|
||
c:identifier="G_ENUM_CLASS_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="55">Get the type identifier from a given #GEnumClass structure.</doc>
|
||
<source-position filename="genums.h" line="63"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="57">a #GEnumClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="ENUM_CLASS_TYPE_NAME"
|
||
c:identifier="G_ENUM_CLASS_TYPE_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="64">Get the static type name from a given #GEnumClass structure.</doc>
|
||
<source-position filename="genums.h" line="72"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="66">a #GEnumClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<record name="EnumClass" c:type="GEnumClass">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="145">The class of an enumeration type holds information about its
|
||
possible values.</doc>
|
||
<source-position filename="genums.h" line="166"/>
|
||
<field name="g_type_class" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="147">the parent class</doc>
|
||
<type name="TypeClass" c:type="GTypeClass"/>
|
||
</field>
|
||
<field name="minimum" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="148">the smallest possible value.</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="maximum" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="149">the largest possible value.</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="n_values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="150">the number of possible values.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="151">an array of #GEnumValue structs describing the
|
||
individual values.</doc>
|
||
<type name="EnumValue" c:type="GEnumValue*"/>
|
||
</field>
|
||
</record>
|
||
<record name="EnumValue" c:type="GEnumValue">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="187">A structure which contains a single enum value, its name, and its
|
||
nickname.</doc>
|
||
<source-position filename="genums.h" line="201"/>
|
||
<field name="value" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="189">the enum value</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="value_name" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="190">the name of the value</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="value_nick" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="191">the nickname of the value</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
</record>
|
||
<function-macro name="FLAGS_CLASS"
|
||
c:identifier="G_FLAGS_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="84">Casts a derived #GFlagsClass structure into a #GFlagsClass structure.</doc>
|
||
<source-position filename="genums.h" line="90"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="86">a valid #GFlagsClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="FLAGS_CLASS_TYPE"
|
||
c:identifier="G_FLAGS_CLASS_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="99">Get the type identifier from a given #GFlagsClass structure.</doc>
|
||
<source-position filename="genums.h" line="107"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="101">a #GFlagsClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="FLAGS_CLASS_TYPE_NAME"
|
||
c:identifier="G_FLAGS_CLASS_TYPE_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="108">Get the static type name from a given #GFlagsClass structure.</doc>
|
||
<source-position filename="genums.h" line="116"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="110">a #GFlagsClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<record name="FlagsClass" c:type="GFlagsClass">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="167">The class of a flags type holds information about its
|
||
possible values.</doc>
|
||
<source-position filename="genums.h" line="186"/>
|
||
<field name="g_type_class" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="169">the parent class</doc>
|
||
<type name="TypeClass" c:type="GTypeClass"/>
|
||
</field>
|
||
<field name="mask" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="170">a mask covering all possible values.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="n_values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="171">the number of possible values.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="172">an array of #GFlagsValue structs describing the
|
||
individual values.</doc>
|
||
<type name="FlagsValue" c:type="GFlagsValue*"/>
|
||
</field>
|
||
</record>
|
||
<record name="FlagsValue" c:type="GFlagsValue">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="202">A structure which contains a single flags value, its name, and its
|
||
nickname.</doc>
|
||
<source-position filename="genums.h" line="216"/>
|
||
<field name="value" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="204">the flags value</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="value_name" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="205">the name of the value</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="value_nick" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="206">the nickname of the value</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
</record>
|
||
<function-macro name="IMPLEMENT_INTERFACE"
|
||
c:identifier="G_IMPLEMENT_INTERFACE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1972">A convenience macro to ease interface addition in the `_C_` section
|
||
of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
|
||
See G_DEFINE_TYPE_EXTENDED() for an example.
|
||
|
||
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
|
||
macros, since it depends on variable names from those macros.</doc>
|
||
<source-position filename="gtype.h" line="1986"/>
|
||
<parameters>
|
||
<parameter name="TYPE_IFACE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1974">The #GType of the interface to add</doc>
|
||
</parameter>
|
||
<parameter name="iface_init">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1975">The interface init function, of type #GInterfaceInitFunc</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IMPLEMENT_INTERFACE_DYNAMIC"
|
||
c:identifier="G_IMPLEMENT_INTERFACE_DYNAMIC"
|
||
version="2.24"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="229">A convenience macro to ease interface addition in the @_C_ section
|
||
of G_DEFINE_DYNAMIC_TYPE_EXTENDED().
|
||
|
||
See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example.
|
||
|
||
Note that this macro can only be used together with the
|
||
G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable
|
||
names from that macro.</doc>
|
||
<source-position filename="gtypemodule.h" line="245"/>
|
||
<parameters>
|
||
<parameter name="TYPE_IFACE">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="231">The #GType of the interface to add</doc>
|
||
</parameter>
|
||
<parameter name="iface_init">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="232">The interface init function</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="INITIALLY_UNOWNED"
|
||
c:identifier="G_INITIALLY_UNOWNED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="145">Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
|
||
pointer.
|
||
|
||
Depending on the current debugging level, this function may invoke
|
||
certain runtime checks to identify invalid casts.</doc>
|
||
<source-position filename="gobject.h" line="155"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="147">Object which is subject to casting.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="INITIALLY_UNOWNED_CLASS"
|
||
c:identifier="G_INITIALLY_UNOWNED_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="156">Casts a derived #GInitiallyUnownedClass structure into a
|
||
#GInitiallyUnownedClass structure.</doc>
|
||
<source-position filename="gobject.h" line="163"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="158">a valid #GInitiallyUnownedClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="INITIALLY_UNOWNED_GET_CLASS"
|
||
c:identifier="G_INITIALLY_UNOWNED_GET_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="179">Get the class structure associated to a #GInitiallyUnowned instance.</doc>
|
||
<source-position filename="gobject.h" line="187"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="181">a #GInitiallyUnowned instance.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_BINDING"
|
||
c:identifier="G_IS_BINDING"
|
||
introspectable="0">
|
||
<source-position filename="gbinding.h" line="39"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_BINDING_GROUP"
|
||
c:identifier="G_IS_BINDING_GROUP"
|
||
introspectable="0">
|
||
<source-position filename="gbindinggroup.h" line="36"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_ENUM_CLASS"
|
||
c:identifier="G_IS_ENUM_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="47">Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM
|
||
or derived.</doc>
|
||
<source-position filename="genums.h" line="54"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="49">a #GEnumClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_FLAGS_CLASS"
|
||
c:identifier="G_IS_FLAGS_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="91">Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS
|
||
or derived.</doc>
|
||
<source-position filename="genums.h" line="98"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="93">a #GFlagsClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_INITIALLY_UNOWNED"
|
||
c:identifier="G_IS_INITIALLY_UNOWNED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="164">Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED.</doc>
|
||
<source-position filename="gobject.h" line="170"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="166">Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_INITIALLY_UNOWNED_CLASS"
|
||
c:identifier="G_IS_INITIALLY_UNOWNED_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="171">Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
|
||
%G_TYPE_INITIALLY_UNOWNED or derived.</doc>
|
||
<source-position filename="gobject.h" line="178"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="173">a #GInitiallyUnownedClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_OBJECT"
|
||
c:identifier="G_IS_OBJECT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="62">Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT.</doc>
|
||
<source-position filename="gobject.h" line="69"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="64">Instance to check for being a %G_TYPE_OBJECT.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_OBJECT_CLASS"
|
||
c:identifier="G_IS_OBJECT_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="73">Checks whether @class "is a" valid #GObjectClass structure of type
|
||
%G_TYPE_OBJECT or derived.</doc>
|
||
<source-position filename="gobject.h" line="80"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="75">a #GObjectClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC"
|
||
c:identifier="G_IS_PARAM_SPEC"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="48">Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM
|
||
or derived.</doc>
|
||
<source-position filename="gparam.h" line="56"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="50">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_BOOLEAN"
|
||
c:identifier="G_IS_PARAM_SPEC_BOOLEAN"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="88">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN.</doc>
|
||
<source-position filename="gparamspecs.h" line="96"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="90">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_BOXED"
|
||
c:identifier="G_IS_PARAM_SPEC_BOXED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="410">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED.</doc>
|
||
<source-position filename="gparamspecs.h" line="418"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="412">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_CHAR"
|
||
c:identifier="G_IS_PARAM_SPEC_CHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="42">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR.</doc>
|
||
<source-position filename="gparamspecs.h" line="50"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="44">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_CLASS"
|
||
c:identifier="G_IS_PARAM_SPEC_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="67">Checks whether @pclass "is a" valid #GParamSpecClass structure of type
|
||
%G_TYPE_PARAM or derived.</doc>
|
||
<source-position filename="gparam.h" line="74"/>
|
||
<parameters>
|
||
<parameter name="pclass">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="69">a #GParamSpecClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_DOUBLE"
|
||
c:identifier="G_IS_PARAM_SPEC_DOUBLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="341">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE.</doc>
|
||
<source-position filename="gparamspecs.h" line="349"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="343">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_ENUM"
|
||
c:identifier="G_IS_PARAM_SPEC_ENUM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="272">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM.</doc>
|
||
<source-position filename="gparamspecs.h" line="280"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="274">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_FLAGS"
|
||
c:identifier="G_IS_PARAM_SPEC_FLAGS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="295">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS.</doc>
|
||
<source-position filename="gparamspecs.h" line="303"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="297">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_FLOAT"
|
||
c:identifier="G_IS_PARAM_SPEC_FLOAT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="318">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT.</doc>
|
||
<source-position filename="gparamspecs.h" line="326"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="320">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_GTYPE"
|
||
c:identifier="G_IS_PARAM_SPEC_GTYPE"
|
||
version="2.10"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="538">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE.</doc>
|
||
<source-position filename="gparamspecs.h" line="547"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="540">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_INT"
|
||
c:identifier="G_IS_PARAM_SPEC_INT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="111">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT.</doc>
|
||
<source-position filename="gparamspecs.h" line="119"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="113">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_INT64"
|
||
c:identifier="G_IS_PARAM_SPEC_INT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="203">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64.</doc>
|
||
<source-position filename="gparamspecs.h" line="211"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="205">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_LONG"
|
||
c:identifier="G_IS_PARAM_SPEC_LONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="157">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG.</doc>
|
||
<source-position filename="gparamspecs.h" line="165"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="159">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_OBJECT"
|
||
c:identifier="G_IS_PARAM_SPEC_OBJECT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="485">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT.</doc>
|
||
<source-position filename="gparamspecs.h" line="493"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="487">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_OVERRIDE"
|
||
c:identifier="G_IS_PARAM_SPEC_OVERRIDE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="510">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE.</doc>
|
||
<source-position filename="gparamspecs.h" line="519"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="512">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_PARAM"
|
||
c:identifier="G_IS_PARAM_SPEC_PARAM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="387">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM.</doc>
|
||
<source-position filename="gparamspecs.h" line="395"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="389">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_POINTER"
|
||
c:identifier="G_IS_PARAM_SPEC_POINTER"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="433">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER.</doc>
|
||
<source-position filename="gparamspecs.h" line="441"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="435">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_STRING"
|
||
c:identifier="G_IS_PARAM_SPEC_STRING"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="364">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING.</doc>
|
||
<source-position filename="gparamspecs.h" line="372"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="366">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_UCHAR"
|
||
c:identifier="G_IS_PARAM_SPEC_UCHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="65">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR.</doc>
|
||
<source-position filename="gparamspecs.h" line="73"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="67">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_UINT"
|
||
c:identifier="G_IS_PARAM_SPEC_UINT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="134">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT.</doc>
|
||
<source-position filename="gparamspecs.h" line="142"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="136">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_UINT64"
|
||
c:identifier="G_IS_PARAM_SPEC_UINT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="226">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64.</doc>
|
||
<source-position filename="gparamspecs.h" line="234"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="228">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_ULONG"
|
||
c:identifier="G_IS_PARAM_SPEC_ULONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="180">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG.</doc>
|
||
<source-position filename="gparamspecs.h" line="188"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="182">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_UNICHAR"
|
||
c:identifier="G_IS_PARAM_SPEC_UNICHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="256">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR.</doc>
|
||
<source-position filename="gparamspecs.h" line="264"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="258">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_VALUE_ARRAY"
|
||
c:identifier="G_IS_PARAM_SPEC_VALUE_ARRAY"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="458">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray instead of #GValueArray</doc-deprecated>
|
||
<source-position filename="gparamspecs.h" line="468"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="460">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_PARAM_SPEC_VARIANT"
|
||
c:identifier="G_IS_PARAM_SPEC_VARIANT"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="566">Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT.</doc>
|
||
<source-position filename="gparamspecs.h" line="576"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="568">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_SIGNAL_GROUP"
|
||
c:identifier="G_IS_SIGNAL_GROUP"
|
||
introspectable="0">
|
||
<source-position filename="gsignalgroup.h" line="36"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_TYPE_MODULE"
|
||
c:identifier="G_IS_TYPE_MODULE"
|
||
introspectable="0">
|
||
<source-position filename="gtypemodule.h" line="37"/>
|
||
<parameters>
|
||
<parameter name="module">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_TYPE_MODULE_CLASS"
|
||
c:identifier="G_IS_TYPE_MODULE_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypemodule.h" line="38"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_TYPE_PLUGIN"
|
||
c:identifier="G_IS_TYPE_PLUGIN"
|
||
introspectable="0">
|
||
<source-position filename="gtypeplugin.h" line="34"/>
|
||
<parameters>
|
||
<parameter name="inst">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_TYPE_PLUGIN_CLASS"
|
||
c:identifier="G_IS_TYPE_PLUGIN_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypeplugin.h" line="35"/>
|
||
<parameters>
|
||
<parameter name="vtable">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="IS_VALUE"
|
||
c:identifier="G_IS_VALUE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="45">Checks if @value is a valid and initialized #GValue structure.</doc>
|
||
<source-position filename="gvalue.h" line="53"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="47">A #GValue structure.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<class name="InitiallyUnowned"
|
||
c:symbol-prefix="initially_unowned"
|
||
c:type="GInitiallyUnowned"
|
||
parent="Object"
|
||
glib:type-name="GInitiallyUnowned"
|
||
glib:get-type="g_initially_unowned_get_type"
|
||
glib:type-struct="InitiallyUnownedClass">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="397">A type for objects that have an initially floating reference.
|
||
|
||
All the fields in the `GInitiallyUnowned` structure are private to the
|
||
implementation and should never be accessed directly.</doc>
|
||
<source-position filename="gobject.h" line="195"/>
|
||
<field name="g_type_instance">
|
||
<type name="TypeInstance" c:type="GTypeInstance"/>
|
||
</field>
|
||
<field name="ref_count" readable="0" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="qdata" readable="0" private="1">
|
||
<type name="GLib.Data" c:type="GData*"/>
|
||
</field>
|
||
</class>
|
||
<record name="InitiallyUnownedClass"
|
||
c:type="GInitiallyUnownedClass"
|
||
glib:is-gtype-struct-for="InitiallyUnowned">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="405">The class structure for the GInitiallyUnowned type.</doc>
|
||
<source-position filename="gobject.h" line="195"/>
|
||
<field name="g_type_class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="277">the parent class</doc>
|
||
<type name="TypeClass" c:type="GTypeClass"/>
|
||
</field>
|
||
<field name="construct_properties" readable="0" private="1">
|
||
<type name="GLib.SList" c:type="GSList*">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</type>
|
||
</field>
|
||
<field name="constructor" introspectable="0">
|
||
<callback name="constructor" introspectable="0">
|
||
<source-position filename="gobject.h" line="346"/>
|
||
<return-value>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_construct_properties" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="construct_properties" transfer-ownership="none">
|
||
<type name="ObjectConstructParam"
|
||
c:type="GObjectConstructParam*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="set_property">
|
||
<callback name="set_property">
|
||
<source-position filename="gobject.h" line="350"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="get_property">
|
||
<callback name="get_property">
|
||
<source-position filename="gobject.h" line="354"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="dispose">
|
||
<callback name="dispose">
|
||
<source-position filename="gobject.h" line="358"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="finalize">
|
||
<callback name="finalize">
|
||
<source-position filename="gobject.h" line="359"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="dispatch_properties_changed">
|
||
<callback name="dispatch_properties_changed">
|
||
<source-position filename="gobject.h" line="361"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="n_pspecs" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="pspecs" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec**"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="notify">
|
||
<callback name="notify">
|
||
<source-position filename="gobject.h" line="365"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3424">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="constructed">
|
||
<callback name="constructed">
|
||
<source-position filename="gobject.h" line="369"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="flags" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="n_construct_properties" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="pspecs" readable="0" private="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
<field name="n_pspecs" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="pdummy" readable="0" private="1">
|
||
<array zero-terminated="0" fixed-size="3">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</array>
|
||
</field>
|
||
</record>
|
||
<callback name="InstanceInitFunc" c:type="GInstanceInitFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="951">A callback function used by the type system to initialize a new
|
||
instance of a type.
|
||
|
||
This function initializes all instance members and allocates any resources
|
||
required by it.
|
||
|
||
Initialization of a derived instance involves calling all its parent
|
||
types instance initializers, so the class member of the instance
|
||
is altered during its initialization to always point to the class that
|
||
belongs to the type the current initializer was introduced for.
|
||
|
||
The extended members of @instance are guaranteed to have been filled with
|
||
zeros before this function is called.</doc>
|
||
<source-position filename="gtype.h" line="971"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="953">The instance to initialize</doc>
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="954">The class of the type the instance is
|
||
created for</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="InterfaceFinalizeFunc" c:type="GInterfaceFinalizeFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="989">A callback function used by the type system to finalize an interface.
|
||
|
||
This function should destroy any internal data and release any resources
|
||
allocated by the corresponding GInterfaceInitFunc() function.</doc>
|
||
<source-position filename="gtype.h" line="999"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="991">The interface structure to finalize</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="iface_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="992">The @interface_data supplied via the #GInterfaceInfo structure</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="InterfaceInfo" c:type="GInterfaceInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1143">A structure that provides information to the type system which is
|
||
used specifically for managing interface types.</doc>
|
||
<source-position filename="gtype.h" line="1157"/>
|
||
<field name="interface_init" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1145">location of the interface initialization function</doc>
|
||
<type name="InterfaceInitFunc" c:type="GInterfaceInitFunc"/>
|
||
</field>
|
||
<field name="interface_finalize" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1146">location of the interface finalization function</doc>
|
||
<type name="InterfaceFinalizeFunc" c:type="GInterfaceFinalizeFunc"/>
|
||
</field>
|
||
<field name="interface_data" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1147">user-supplied data passed to the interface init/finalize functions</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
</record>
|
||
<callback name="InterfaceInitFunc" c:type="GInterfaceInitFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="973">A callback function used by the type system to initialize a new
|
||
interface.
|
||
|
||
This function should initialize all internal data and* allocate any
|
||
resources required by the interface.
|
||
|
||
The members of @iface_data are guaranteed to have been filled with
|
||
zeros before this function is called.</doc>
|
||
<source-position filename="gtype.h" line="987"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="975">The interface structure to initialize</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="iface_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="976">The @interface_data supplied via the #GInterfaceInfo structure</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<function-macro name="OBJECT" c:identifier="G_OBJECT" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="45">Casts a #GObject or derived pointer into a (GObject*) pointer.
|
||
|
||
Depending on the current debugging level, this function may invoke
|
||
certain runtime checks to identify invalid casts.</doc>
|
||
<source-position filename="gobject.h" line="54"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="47">Object which is subject to casting.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_CLASS"
|
||
c:identifier="G_OBJECT_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="55">Casts a derived #GObjectClass structure into a #GObjectClass structure.</doc>
|
||
<source-position filename="gobject.h" line="61"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="57">a valid #GObjectClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_CLASS_NAME"
|
||
c:identifier="G_OBJECT_CLASS_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="118">Return the name of a class structure's type.</doc>
|
||
<source-position filename="gobject.h" line="127"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="120">a valid #GObjectClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_CLASS_TYPE"
|
||
c:identifier="G_OBJECT_CLASS_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="109">Get the type id of a class structure.</doc>
|
||
<source-position filename="gobject.h" line="117"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="111">a valid #GObjectClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_GET_CLASS"
|
||
c:identifier="G_OBJECT_GET_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="81">Get the class structure associated to a #GObject instance.</doc>
|
||
<source-position filename="gobject.h" line="89"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="83">a #GObject instance.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_TYPE"
|
||
c:identifier="G_OBJECT_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="90">Get the type id of an object.</doc>
|
||
<source-position filename="gobject.h" line="98"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="92">Object to return the type id for.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_TYPE_NAME"
|
||
c:identifier="G_OBJECT_TYPE_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="99">Get the name of an object's type.</doc>
|
||
<source-position filename="gobject.h" line="108"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="101">Object to return the type name for.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_WARN_INVALID_PROPERTY_ID"
|
||
c:identifier="G_OBJECT_WARN_INVALID_PROPERTY_ID"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="696">This macro should be used to emit a standard warning about unexpected
|
||
properties in set_property() and get_property() implementations.</doc>
|
||
<source-position filename="gobject.h" line="705"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="698">the #GObject on which set_property() or get_property() was called</doc>
|
||
</parameter>
|
||
<parameter name="property_id">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="699">the numeric id of the property</doc>
|
||
</parameter>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="700">the #GParamSpec of the property</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="OBJECT_WARN_INVALID_PSPEC"
|
||
c:identifier="G_OBJECT_WARN_INVALID_PSPEC"
|
||
introspectable="0">
|
||
<source-position filename="gobject.h" line="683"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
</parameter>
|
||
<parameter name="pname">
|
||
</parameter>
|
||
<parameter name="property_id">
|
||
</parameter>
|
||
<parameter name="pspec">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<class name="Object"
|
||
c:symbol-prefix="object"
|
||
c:type="GObject"
|
||
glib:type-name="GObject"
|
||
glib:get-type="g_object_get_type"
|
||
glib:type-struct="ObjectClass">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="251">The base object type.
|
||
|
||
All the fields in the `GObject` structure are private to the implementation
|
||
and should never be accessed directly.
|
||
|
||
Since GLib 2.72, all #GObjects are guaranteed to be aligned to at least the
|
||
alignment of the largest basic GLib type (typically this is #guint64 or
|
||
#gdouble). If you need larger alignment for an element in a #GObject, you
|
||
should allocate it on the heap (aligned), or arrange for your #GObject to be
|
||
appropriately padded. This guarantee applies to the #GObject (or derived)
|
||
struct, the #GObjectClass (or derived) struct, and any private data allocated
|
||
by G_ADD_PRIVATE().</doc>
|
||
<source-position filename="gobject.h" line="381"/>
|
||
<constructor name="new" c:identifier="g_object_new" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3329">Creates a new instance of a #GObject subtype and sets its properties.
|
||
|
||
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY)
|
||
which are not explicitly specified are set to their default values. Any
|
||
private data for the object is guaranteed to be initialized with zeros, as
|
||
per g_type_create_instance().
|
||
|
||
Note that in C, small integer types in variable argument lists are promoted
|
||
up to `gint` or `guint` as appropriate, and read back accordingly. `gint` is
|
||
32 bits on every platform on which GLib is currently supported. This means that
|
||
you can use C expressions of type `gint` with g_object_new() and properties of
|
||
type `gint` or `guint` or smaller. Specifically, you can use integer literals
|
||
with these property types.
|
||
|
||
When using property types of `gint64` or `guint64`, you must ensure that the
|
||
value that you provide is 64 bit. This means that you should use a cast or
|
||
make use of the %G_GINT64_CONSTANT or %G_GUINT64_CONSTANT macros.
|
||
|
||
Similarly, `gfloat` is promoted to `gdouble`, so you must ensure that the value
|
||
you provide is a `gdouble`, even for a property of type `gfloat`.
|
||
|
||
Since GLib 2.72, all #GObjects are guaranteed to be aligned to at least the
|
||
alignment of the largest basic GLib type (typically this is `guint64` or
|
||
`gdouble`). If you need larger alignment for an element in a #GObject, you
|
||
should allocate it on the heap (aligned), or arrange for your #GObject to be
|
||
appropriately padded.</doc>
|
||
<source-position filename="gobject.h" line="447"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3363">a new instance of
|
||
@object_type</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3331">the type id of the #GObject subtype to instantiate</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3332">the name of the first property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3333">the value of the first property, followed optionally by more
|
||
name/value pairs, followed by %NULL</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<constructor name="new_valist"
|
||
c:identifier="g_object_new_valist"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3368">Creates a new instance of a #GObject subtype and sets its properties.
|
||
|
||
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY)
|
||
which are not explicitly specified are set to their default values.</doc>
|
||
<source-position filename="gobject.h" line="466"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3380">a new instance of @object_type</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3370">the type id of the #GObject subtype to instantiate</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3371">the name of the first property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="var_args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3372">the value of the first property, followed optionally by more
|
||
name/value pairs, followed by %NULL</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<constructor name="new_with_properties"
|
||
c:identifier="g_object_new_with_properties"
|
||
version="2.54"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3384">Creates a new instance of a #GObject subtype and sets its properties using
|
||
the provided arrays. Both arrays must have exactly @n_properties elements,
|
||
and the names and values correspond by index.
|
||
|
||
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY)
|
||
which are not explicitly specified are set to their default values.</doc>
|
||
<source-position filename="gobject.h" line="451"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3398">a new instance of
|
||
@object_type</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3386">the object type to instantiate</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_properties" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3387">the number of properties</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="names" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3388">the names of each property to be set</doc>
|
||
<array length="1" zero-terminated="0" c:type="const char**">
|
||
<type name="utf8" c:type="char*"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3389">the values of each property to be set</doc>
|
||
<array length="1" zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<constructor name="newv"
|
||
c:identifier="g_object_newv"
|
||
deprecated="1"
|
||
deprecated-version="2.54">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3404">Creates a new instance of a #GObject subtype and sets its properties.
|
||
|
||
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY)
|
||
which are not explicitly specified are set to their default values.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_object_new_with_properties() instead.
|
||
deprecated. See #GParameter for more information.</doc-deprecated>
|
||
<source-position filename="gobject.h" line="459"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3415">a new instance of
|
||
@object_type</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3406">the type id of the #GObject subtype to instantiate</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_parameters" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3407">the length of the @parameters array</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="parameters" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3408">an array of #GParameter</doc>
|
||
<array length="1" zero-terminated="0" c:type="GParameter*">
|
||
<type name="Parameter" c:type="GParameter"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<function name="compat_control" c:identifier="g_object_compat_control">
|
||
<source-position filename="gobject.h" line="679"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="what" transfer-ownership="none">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="interface_find_property"
|
||
c:identifier="g_object_interface_find_property"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3251">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().</doc>
|
||
<source-position filename="gobject.h" line="438"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3264">the #GParamSpec for the property of the
|
||
interface with the name @property_name, or %NULL if no
|
||
such property exists.</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3253">any interface vtable for the
|
||
interface, or the default vtable for the interface</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3255">name of a property to look up.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="interface_install_property"
|
||
c:identifier="g_object_interface_install_property"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3270">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.
|
||
|
||
This function is meant to be called from the interface's default
|
||
vtable initialization function (the @class_init member of
|
||
#GTypeInfo.) 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.</doc>
|
||
<source-position filename="gobject.h" line="435"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3272">any interface vtable for the
|
||
interface, or the default
|
||
vtable for the interface.</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3275">the #GParamSpec for the new property</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="interface_list_properties"
|
||
c:identifier="g_object_interface_list_properties"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3298">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().</doc>
|
||
<source-position filename="gobject.h" line="441"/>
|
||
<return-value transfer-ownership="container">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3310">a
|
||
pointer to an array of pointers to #GParamSpec
|
||
structures. The paramspecs are owned by GLib, but the
|
||
array should be freed with g_free() when you are done with
|
||
it.</doc>
|
||
<array length="1" zero-terminated="0" c:type="GParamSpec**">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3300">any interface vtable for the
|
||
interface, or the default vtable for the interface</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_properties_p"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3302">location to store number of properties returned.</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<virtual-method name="constructed">
|
||
<source-position filename="gobject.h" line="369"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="dispatch_properties_changed">
|
||
<source-position filename="gobject.h" line="361"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="n_pspecs" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="pspecs" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec**"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="dispose">
|
||
<source-position filename="gobject.h" line="358"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="finalize">
|
||
<source-position filename="gobject.h" line="359"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="get_property">
|
||
<source-position filename="gobject.h" line="354"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="notify" invoker="notify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3422">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.</doc>
|
||
<source-position filename="gobject.h" line="365"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3424">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="set_property">
|
||
<source-position filename="gobject.h" line="350"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<method name="add_toggle_ref"
|
||
c:identifier="g_object_add_toggle_ref"
|
||
version="2.8"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2663">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.
|
||
|
||
This functionality is intended for binding @object to a proxy
|
||
object managed by another memory manager. This is done with two
|
||
paired references: the strong reference added by
|
||
g_object_add_toggle_ref() and a reverse reference to the proxy
|
||
object which is either a strong reference or weak reference.
|
||
|
||
The setup is that when there are no other references to @object,
|
||
only a weak reference is held in the reverse direction from @object
|
||
to the proxy object, but when there are other references held to
|
||
@object, a strong reference is held. The @notify callback is called
|
||
when the reference from @object to the proxy object should be
|
||
"toggled" from strong to weak (@is_last_ref true) or weak to strong
|
||
(@is_last_ref false).
|
||
|
||
Since a (normal) reference must be held to the object before
|
||
calling g_object_add_toggle_ref(), the initial state of the reverse
|
||
link is always strong.
|
||
|
||
Multiple toggle references may be added to the same gobject,
|
||
however if there are multiple toggle references to an object, none
|
||
of them will ever be notified until all but one are removed. For
|
||
this reason, you should only ever use a toggle reference if there
|
||
is important state in the proxy object.</doc>
|
||
<source-position filename="gobject.h" line="571"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2665">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify" transfer-ownership="none" closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2666">a function to call when this reference is the
|
||
last reference to the object, or is no longer
|
||
the last reference.</doc>
|
||
<type name="ToggleNotify" c:type="GToggleNotify"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2669">data to pass to @notify</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="add_weak_pointer"
|
||
c:identifier="g_object_add_weak_pointer"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2704">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.
|
||
|
||
Note that as with g_object_weak_ref(), the weak references created by
|
||
this method are not thread-safe: they cannot safely be used in one
|
||
thread if the object's last g_object_unref() might happen in another
|
||
thread. Use #GWeakRef if thread-safety is required.</doc>
|
||
<source-position filename="gobject.h" line="540"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2706">The object that should be weak referenced.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="weak_pointer_location"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2707">The memory address
|
||
of a pointer.</doc>
|
||
<type name="gpointer" c:type="gpointer*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="bind_property"
|
||
c:identifier="g_object_bind_property"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2722">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:
|
||
|
||
|[<!-- language="C" -->
|
||
g_object_bind_property (action, "active", widget, "sensitive", 0);
|
||
]|
|
||
|
||
Will result in the "sensitive" property of the widget #GObject instance to be
|
||
updated with the same value of the "active" property of the action #GObject
|
||
instance.
|
||
|
||
If @flags contains %G_BINDING_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
|
||
#GBinding 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 can have multiple bindings.</doc>
|
||
<source-position filename="gbinding.h" line="130"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2762">the #GBinding instance representing the
|
||
binding between the two #GObject instances. The binding is released
|
||
whenever the #GBinding reference count reaches zero.</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="source" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2724">the source #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2725">the property on @source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2726">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2727">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2728">flags to pass to #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="bind_property_full"
|
||
c:identifier="g_object_bind_property_full"
|
||
shadowed-by="bind_property_with_closures"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2769">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 %G_BINDING_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 #GBinding instance; if you want to hold on to the
|
||
#GBinding instance, you will need to hold a reference to it.
|
||
|
||
To remove the binding, call g_binding_unbind().
|
||
|
||
A #GObject 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.</doc>
|
||
<source-position filename="gbinding.h" line="136"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2811">the #GBinding instance representing the
|
||
binding between the two #GObject instances. The binding is released
|
||
whenever the #GBinding reference count reaches zero.</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="source" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2771">the source #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2772">the property on @source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2773">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2774">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2775">flags to pass to #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
<parameter name="transform_to"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2776">the transformation function
|
||
from the @source to the @target, or %NULL to use the default</doc>
|
||
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
|
||
</parameter>
|
||
<parameter name="transform_from"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified"
|
||
closure="6"
|
||
destroy="7">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2778">the transformation function
|
||
from the @target to the @source, or %NULL to use the default</doc>
|
||
<type name="BindingTransformFunc" c:type="GBindingTransformFunc"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2780">custom data to be passed to the transformation functions,
|
||
or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2782">a function to call when disposing the binding, to free
|
||
resources used by the transformation functions, or %NULL if not required</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="bind_property_with_closures"
|
||
c:identifier="g_object_bind_property_with_closures"
|
||
shadows="bind_property_full"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2818">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.</doc>
|
||
<source-position filename="gbinding.h" line="146"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2838">the #GBinding instance representing the
|
||
binding between the two #GObject instances. The binding is released
|
||
whenever the #GBinding reference count reaches zero.</doc>
|
||
<type name="Binding" c:type="GBinding*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="source" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2820">the source #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="source_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2821">the property on @source to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="target" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2822">the target #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="target_property" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2823">the property on @target to bind</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2824">flags to pass to #GBinding</doc>
|
||
<type name="BindingFlags" c:type="GBindingFlags"/>
|
||
</parameter>
|
||
<parameter name="transform_to" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2825">a #GClosure wrapping the transformation function
|
||
from the @source to the @target, or %NULL to use the default</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="transform_from" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2827">a #GClosure wrapping the transformation function
|
||
from the @target to the @source, or %NULL to use the default</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect"
|
||
c:identifier="g_object_connect"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2991">A convenience function to connect multiple signals at once.
|
||
|
||
The signal specs expected by this function have the form
|
||
"modifier::signal_name", where modifier can be one of the following:
|
||
- signal: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_DEFAULT)
|
||
- object-signal, object_signal: equivalent to g_signal_connect_object (..., G_CONNECT_DEFAULT)
|
||
- swapped-signal, swapped_signal: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)
|
||
- swapped_object_signal, swapped-object-signal: equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED)
|
||
- signal_after, signal-after: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_AFTER)
|
||
- object_signal_after, object-signal-after: equivalent to g_signal_connect_object (..., G_CONNECT_AFTER)
|
||
- swapped_signal_after, swapped-signal-after: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)
|
||
- swapped_object_signal_after, swapped-object-signal-after: equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)
|
||
|
||
|[<!-- language="C" -->
|
||
menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
|
||
"type", GTK_WINDOW_POPUP,
|
||
"child", menu,
|
||
NULL),
|
||
"signal::event", gtk_menu_window_event, menu,
|
||
"signal::size_request", gtk_menu_window_size_request, menu,
|
||
"signal::destroy", gtk_widget_destroyed, &menu->toplevel,
|
||
NULL);
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="478"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3023">@object</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2993">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="signal_spec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2994">the spec for the first signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2995">#GCallback for the first signal, followed by data for the
|
||
first signal, followed optionally by more signal
|
||
spec/callback/data triples, followed by %NULL</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="disconnect"
|
||
c:identifier="g_object_disconnect"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3027">A convenience function to disconnect multiple signals at once.
|
||
|
||
The signal specs expected by this function have the form
|
||
"any_signal", which means to disconnect any signal with matching
|
||
callback and data, or "any_signal::signal_name", which only
|
||
disconnects the signal named "signal_name".</doc>
|
||
<source-position filename="gobject.h" line="482"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3029">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="signal_spec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3030">the spec for the first signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3031">#GCallback for the first signal, followed by data for the first signal,
|
||
followed optionally by more signal spec/callback/data triples,
|
||
followed by %NULL</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_data"
|
||
c:identifier="g_object_dup_data"
|
||
version="2.34"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3044">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.
|
||
|
||
If the @key is not set on the object then @dup_func
|
||
will be called with a %NULL argument.
|
||
|
||
Note that @dup_func is called while user data of @object
|
||
is locked.
|
||
|
||
This function can be useful to avoid races when multiple
|
||
threads are using object data on the same key on the same
|
||
object.</doc>
|
||
<source-position filename="gobject.h" line="625"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3066">the result of calling @dup_func on the value
|
||
associated with @key on @object, or %NULL if not set.
|
||
If @dup_func is %NULL, the value is returned
|
||
unmodified.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3046">the #GObject to store user data on</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3047">a string, naming the user data pointer</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="dup_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3048">function to dup the value</doc>
|
||
<type name="GLib.DuplicateFunc" c:type="GDuplicateFunc"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3049">passed as user_data to @dup_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_qdata"
|
||
c:identifier="g_object_dup_qdata"
|
||
version="2.34"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3074">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.
|
||
|
||
If the @quark is not set on the object then @dup_func
|
||
will be called with a %NULL argument.
|
||
|
||
Note that @dup_func is called while user data of @object
|
||
is locked.
|
||
|
||
This function can be useful to avoid races when multiple
|
||
threads are using object data on the same key on the same
|
||
object.</doc>
|
||
<source-position filename="gobject.h" line="596"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3096">the result of calling @dup_func on the value
|
||
associated with @quark on @object, or %NULL if not set.
|
||
If @dup_func is %NULL, the value is returned
|
||
unmodified.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3076">the #GObject to store user data on</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3077">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="dup_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3078">function to dup the value</doc>
|
||
<type name="GLib.DuplicateFunc" c:type="GDuplicateFunc"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3079">passed as user_data to @dup_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="force_floating"
|
||
c:identifier="g_object_force_floating"
|
||
version="2.10">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3104">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().</doc>
|
||
<source-position filename="gobject.h" line="666"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3106">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="freeze_notify" c:identifier="g_object_freeze_notify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3117">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.
|
||
|
||
This is necessary for accessors that modify multiple properties to prevent
|
||
premature notification while the object is still being modified.</doc>
|
||
<source-position filename="gobject.h" line="512"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3119">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get" c:identifier="g_object_get" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3133">Gets properties of an object.
|
||
|
||
In general, a copy is made of the property contents and the caller
|
||
is responsible for freeing the memory in the appropriate manner for
|
||
the type, for instance by calling g_free() or g_object_unref().
|
||
|
||
Here is an example of using g_object_get() to get the contents
|
||
of three properties: an integer, a string and an object:
|
||
|[<!-- language="C" -->
|
||
gint intval;
|
||
guint64 uint64val;
|
||
gchar *strval;
|
||
GObject *objval;
|
||
|
||
g_object_get (my_object,
|
||
"int-property", &intval,
|
||
"uint64-property", &uint64val,
|
||
"str-property", &strval,
|
||
"obj-property", &objval,
|
||
NULL);
|
||
|
||
// Do something with intval, uint64val, strval, objval
|
||
|
||
g_free (strval);
|
||
g_object_unref (objval);
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="474"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3135">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3136">name of the first property to get</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3137">return location for the first property, followed optionally by more
|
||
name/return location pairs, followed by %NULL</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_data" c:identifier="g_object_get_data">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3169">Gets a named field from the objects table of associations (see g_object_set_data()).</doc>
|
||
<source-position filename="gobject.h" line="609"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3176">the data if found,
|
||
or %NULL if no such data exists.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3171">#GObject containing the associations</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3172">name of the key for that association</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_property" c:identifier="g_object_get_property">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3181">Gets a property of an object.
|
||
|
||
The @value can be:
|
||
|
||
- an empty #GValue initialized by %G_VALUE_INIT, which will be
|
||
automatically initialized with the expected type of the property
|
||
(since GLib 2.60)
|
||
- a #GValue initialized with the expected type of the property
|
||
- a #GValue initialized with a type to which the expected type
|
||
of the property can be transformed
|
||
|
||
In general, a copy is made of the property contents and the caller is
|
||
responsible for freeing the memory by calling g_value_unset().
|
||
|
||
Note that g_object_get_property() is really intended for language
|
||
bindings, g_object_get() is much more convenient for C programming.</doc>
|
||
<source-position filename="gobject.h" line="508"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3183">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3184">the name of the property to get</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3185">return location for the property value</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_qdata" c:identifier="g_object_get_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3206">This function gets back user data pointers stored via
|
||
g_object_set_qdata().</doc>
|
||
<source-position filename="gobject.h" line="580"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3214">The user data pointer set, or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3208">The GObject to get a stored user data pointer from</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3209">A #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_valist"
|
||
c:identifier="g_object_get_valist"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3218">Gets properties of an object.
|
||
|
||
In general, a copy is made of the property contents and the caller
|
||
is responsible for freeing the memory in the appropriate manner for
|
||
the type, for instance by calling g_free() or g_object_unref().
|
||
|
||
See g_object_get().</doc>
|
||
<source-position filename="gobject.h" line="500"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3220">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3221">name of the first property to get</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="var_args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3222">return location for the first property, followed optionally by more
|
||
name/return location pairs, followed by %NULL</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="getv" c:identifier="g_object_getv" version="2.54">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3235">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.</doc>
|
||
<source-position filename="gobject.h" line="495"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3237">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="n_properties" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3238">the number of properties</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="names" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3239">the names of each property to get</doc>
|
||
<array length="0" zero-terminated="0" c:type="const gchar**">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3240">the values of each property to get</doc>
|
||
<array length="0" zero-terminated="0" c:type="GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="is_floating"
|
||
c:identifier="g_object_is_floating"
|
||
version="2.10">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3318">Checks whether @object has a [floating][floating-ref] reference.</doc>
|
||
<source-position filename="gobject.h" line="522"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3325">%TRUE if @object has a floating reference</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3320">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="notify" c:identifier="g_object_notify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3422">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.</doc>
|
||
<source-position filename="gobject.h" line="514"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3424">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3425">the name of a property installed on the class of @object.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="notify_by_pspec"
|
||
c:identifier="g_object_notify_by_pspec"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3440">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.:
|
||
|
||
|[<!-- language="C" -->
|
||
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", "Foo", "The foo",
|
||
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:
|
||
|
||
|[<!-- language="C" -->
|
||
g_object_notify_by_pspec (self, properties[PROP_FOO]);
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="517"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3442">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3443">the #GParamSpec of a property installed on the class of @object.</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="ref" c:identifier="g_object_ref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3487">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.</doc>
|
||
<source-position filename="gobject.h" line="528"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3498">the same @object</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3489">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="ref_sink" c:identifier="g_object_ref_sink" version="2.10">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3502">Increase the reference count of @object, and possibly remove the
|
||
[floating][floating-ref] 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().</doc>
|
||
<source-position filename="gobject.h" line="524"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3519">@object</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3504">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove_toggle_ref"
|
||
c:identifier="g_object_remove_toggle_ref"
|
||
version="2.8"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3523">Removes a reference added with g_object_add_toggle_ref(). The
|
||
reference count of the object is decreased by one.</doc>
|
||
<source-position filename="gobject.h" line="575"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3525">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify" transfer-ownership="none" closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3526">a function to call when this reference is the
|
||
last reference to the object, or is no longer
|
||
the last reference.</doc>
|
||
<type name="ToggleNotify" c:type="GToggleNotify"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3529">data to pass to @notify, or %NULL to
|
||
match any toggle refs with the @notify argument.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove_weak_pointer"
|
||
c:identifier="g_object_remove_weak_pointer"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3539">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().</doc>
|
||
<source-position filename="gobject.h" line="543"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3541">The object that is weak referenced.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="weak_pointer_location"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3542">The memory address
|
||
of a pointer.</doc>
|
||
<type name="gpointer" c:type="gpointer*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="replace_data"
|
||
c:identifier="g_object_replace_data"
|
||
version="2.34"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3551">Compares the user data for the key @key on @object with
|
||
@oldval, and if they are the same, replaces @oldval with
|
||
@newval.
|
||
|
||
This is like a typical atomic compare-and-exchange
|
||
operation, for user data on an object.
|
||
|
||
If the previous value was replaced then ownership of the
|
||
old value (@oldval) is passed to the caller, including
|
||
the registered destroy notify for it (passed out in @old_destroy).
|
||
It’s up to the caller to free this as needed, which may
|
||
or may not include using @old_destroy as sometimes replacement
|
||
should not destroy the object in the normal way.
|
||
|
||
See g_object_set_data() for guidance on using a small, bounded set of values
|
||
for @key.</doc>
|
||
<source-position filename="gobject.h" line="630"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3577">%TRUE if the existing value for @key was replaced
|
||
by @newval, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3553">the #GObject to store user data on</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3554">a string, naming the user data pointer</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="oldval"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3555">the old value to compare against</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="newval"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3556">the new value</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3557">a destroy notify for the new value</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
<parameter name="old_destroy"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="none"
|
||
optional="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3558">destroy notify for the existing value</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="replace_qdata"
|
||
c:identifier="g_object_replace_qdata"
|
||
version="2.34"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3583">Compares the user data for the key @quark on @object with
|
||
@oldval, and if they are the same, replaces @oldval with
|
||
@newval.
|
||
|
||
This is like a typical atomic compare-and-exchange
|
||
operation, for user data on an object.
|
||
|
||
If the previous value was replaced then ownership of the
|
||
old value (@oldval) is passed to the caller, including
|
||
the registered destroy notify for it (passed out in @old_destroy).
|
||
It’s up to the caller to free this as needed, which may
|
||
or may not include using @old_destroy as sometimes replacement
|
||
should not destroy the object in the normal way.</doc>
|
||
<source-position filename="gobject.h" line="601"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3606">%TRUE if the existing value for @quark was replaced
|
||
by @newval, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3585">the #GObject to store user data on</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3586">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="oldval"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3587">the old value to compare against</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="newval"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3588">the new value</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3589">a destroy notify for the new value</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
<parameter name="old_destroy"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="none"
|
||
optional="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3590">destroy notify for the existing value</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="run_dispose" c:identifier="g_object_run_dispose">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3612">Releases all references to other objects. This can be used to break
|
||
reference cycles.
|
||
|
||
This function should only be called from object system implementations.</doc>
|
||
<source-position filename="gobject.h" line="668"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3614">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set" c:identifier="g_object_set" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3623">Sets properties on an object.
|
||
|
||
The same caveats about passing integer literals as varargs apply as with
|
||
g_object_new(). In particular, any integer literals set as the values for
|
||
properties of type #gint64 or #guint64 must be 64 bits wide, using the
|
||
%G_GINT64_CONSTANT or %G_GUINT64_CONSTANT macros.
|
||
|
||
Note that the "notify" signals are queued and only emitted (in
|
||
reverse order) after all properties have been set. See
|
||
g_object_freeze_notify().</doc>
|
||
<source-position filename="gobject.h" line="470"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3625">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3626">name of the first property to set</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3627">value for the first property, followed optionally by more
|
||
name/value pairs, followed by %NULL</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_data" c:identifier="g_object_set_data">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3643">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 #GQuark 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 #GQuark storage growing unbounded.</doc>
|
||
<source-position filename="gobject.h" line="612"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3645">#GObject containing the associations.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3646">name of the key</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3647">data to associate with that key</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_data_full"
|
||
c:identifier="g_object_set_data_full"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3662">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.
|
||
|
||
Note that the @destroy callback is not called if @data is %NULL.</doc>
|
||
<source-position filename="gobject.h" line="616"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3664">#GObject containing the associations</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3665">name of the key</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3666">data to associate with that key</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3667">function to call when the association is destroyed</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_property" c:identifier="g_object_set_property">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3677">Sets a property on an object.</doc>
|
||
<source-position filename="gobject.h" line="504"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3679">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3680">the name of the property to set</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3681">the value</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_qdata"
|
||
c:identifier="g_object_set_qdata"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3687">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.</doc>
|
||
<source-position filename="gobject.h" line="583"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3689">The GObject to set store a user data pointer</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3690">A #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3691">An opaque user data pointer</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_qdata_full"
|
||
c:identifier="g_object_set_qdata_full"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3704">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.</doc>
|
||
<source-position filename="gobject.h" line="587"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3706">The GObject to set store a user data pointer</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3707">A #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3708">An opaque user data pointer</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3709">Function to invoke with @data as argument, when @data
|
||
needs to be freed</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_valist"
|
||
c:identifier="g_object_set_valist"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3720">Sets properties on an object.</doc>
|
||
<source-position filename="gobject.h" line="491"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3722">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="first_property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3723">name of the first property to set</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="var_args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3724">value for the first property, followed optionally by more
|
||
name/value pairs, followed by %NULL</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="setv"
|
||
c:identifier="g_object_setv"
|
||
version="2.54"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3731">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.</doc>
|
||
<source-position filename="gobject.h" line="486"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3733">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="n_properties" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3734">the number of properties</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="names" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3735">the names of each property to be set</doc>
|
||
<array length="0" zero-terminated="0" c:type="const gchar**">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3736">the values of each property to be set</doc>
|
||
<array length="0" zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="steal_data" c:identifier="g_object_steal_data">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3747">Remove a specified datum from the object's data associations,
|
||
without invoking the association's destroy handler.</doc>
|
||
<source-position filename="gobject.h" line="621"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3755">the data if found, or %NULL
|
||
if no such data exists.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3749">#GObject containing the associations</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="key" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3750">name of the key</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="steal_qdata" c:identifier="g_object_steal_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3760">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);
|
||
|
||
// 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().</doc>
|
||
<source-position filename="gobject.h" line="592"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3801">The user data pointer set, or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3762">The GObject to get a stored user data pointer from</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3763">A #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_ref"
|
||
c:identifier="g_object_take_ref"
|
||
version="2.70"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3805">If @object is floating, sink it. Otherwise, do nothing.
|
||
|
||
In other words, this function will convert a floating reference (if
|
||
present) into a full reference.
|
||
|
||
Typically you want to use g_object_ref_sink() in order to
|
||
automatically do the correct thing with respect to floating or
|
||
non-floating references, but there is one specific scenario where
|
||
this function is helpful.
|
||
|
||
The situation where this function is helpful is when creating an API
|
||
that allows the user to provide a callback function that returns a
|
||
GObject. We certainly want to allow the user the flexibility to
|
||
return a non-floating reference from this callback (for the case
|
||
where the object that is being returned already exists).
|
||
|
||
At the same time, the API style of some popular GObject-based
|
||
libraries (such as Gtk) make it likely that for newly-created GObject
|
||
instances, the user can be saved some typing if they are allowed to
|
||
return a floating reference.
|
||
|
||
Using this function on the return value of the user's callback allows
|
||
the user to do whichever is more convenient for them. The caller will
|
||
alway receives exactly one full reference to the value: either the
|
||
one that was returned in the first place, or a floating reference
|
||
that has been converted to a full reference.
|
||
|
||
This function has an odd interaction when combined with
|
||
g_object_ref_sink() running at the same time in another thread on
|
||
the same #GObject instance. If g_object_ref_sink() runs first then
|
||
the result will be that the floating reference is converted to a hard
|
||
reference. If g_object_take_ref() runs first then the result will be
|
||
that the floating reference is converted to a hard reference and an
|
||
additional reference on top of that one is added. It is best to avoid
|
||
this situation.</doc>
|
||
<source-position filename="gobject.h" line="526"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3846">@object</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3807">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="thaw_notify" c:identifier="g_object_thaw_notify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3850">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::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.</doc>
|
||
<source-position filename="gobject.h" line="520"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3852">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unref" c:identifier="g_object_unref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3866">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 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 instance. Use g_clear_object() for this.</doc>
|
||
<source-position filename="gobject.h" line="530"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3868">a #GObject</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="watch_closure" c:identifier="g_object_watch_closure">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3880">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.</doc>
|
||
<source-position filename="gobject.h" line="639"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3882">#GObject restricting lifetime of @closure</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3883">#GClosure to watch</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="weak_ref"
|
||
c:identifier="g_object_weak_ref"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3897">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).
|
||
|
||
Note that the weak references created by this method are not
|
||
thread-safe: they cannot safely be used in one thread if the
|
||
object's last g_object_unref() might happen in another thread.
|
||
Use #GWeakRef if thread-safety is required.</doc>
|
||
<source-position filename="gobject.h" line="532"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3899">#GObject to reference weakly</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify" transfer-ownership="none" closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3900">callback to invoke before the object is freed</doc>
|
||
<type name="WeakNotify" c:type="GWeakNotify"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3901">extra data to pass to notify</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="weak_unref"
|
||
c:identifier="g_object_weak_unref"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3916">Removes a weak reference callback to an object.</doc>
|
||
<source-position filename="gobject.h" line="536"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3918">#GObject to remove a weak reference from</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</instance-parameter>
|
||
<parameter name="notify" transfer-ownership="none" closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3919">callback to search for</doc>
|
||
<type name="WeakNotify" c:type="GWeakNotify"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3920">data to search for</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<field name="g_type_instance">
|
||
<type name="TypeInstance" c:type="GTypeInstance"/>
|
||
</field>
|
||
<field name="ref_count" readable="0" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="qdata" readable="0" private="1">
|
||
<type name="GLib.Data" c:type="GData*"/>
|
||
</field>
|
||
<glib:signal name="notify"
|
||
when="first"
|
||
no-recurse="1"
|
||
detailed="1"
|
||
action="1"
|
||
no-hooks="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="67">The notify signal is emitted on an object when one of its properties has
|
||
its value set through g_object_set_property(), g_object_set(), et al.
|
||
|
||
Note that getting this signal doesn’t itself guarantee that the value of
|
||
the property has actually changed. When it is emitted is determined by the
|
||
derived GObject class. If the implementor did not create the property with
|
||
%G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results
|
||
in ::notify being emitted, even if the new value is the same as the old.
|
||
If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only
|
||
when they explicitly call g_object_notify() or g_object_notify_by_pspec(),
|
||
and common practice is to do that only when the value has actually changed.
|
||
|
||
This signal is typically used to obtain change notification for a
|
||
single property, by specifying the property name as a detail in the
|
||
g_signal_connect() call, like this:
|
||
|
||
|[<!-- language="C" -->
|
||
g_signal_connect (text_view->buffer, "notify::paste-target-list",
|
||
G_CALLBACK (gtk_text_view_target_list_notify),
|
||
text_view)
|
||
]|
|
||
|
||
It is important to note that you must use
|
||
[canonical parameter names][canonical-parameter-names] as
|
||
detail strings for the notify signal.</doc>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="70">the #GParamSpec of the property which changed.</doc>
|
||
<type name="ParamSpec"/>
|
||
</parameter>
|
||
</parameters>
|
||
</glib:signal>
|
||
</class>
|
||
<record name="ObjectClass"
|
||
c:type="GObjectClass"
|
||
glib:is-gtype-struct-for="Object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="275">The class structure for the GObject type.
|
||
|
||
|[<!-- language="C" -->
|
||
// Example of implementing a singleton using a constructor.
|
||
static MySingleton *the_singleton = NULL;
|
||
|
||
static GObject*
|
||
my_singleton_constructor (GType type,
|
||
guint n_construct_params,
|
||
GObjectConstructParam *construct_params)
|
||
{
|
||
GObject *object;
|
||
|
||
if (!the_singleton)
|
||
{
|
||
object = G_OBJECT_CLASS (parent_class)->constructor (type,
|
||
n_construct_params,
|
||
construct_params);
|
||
the_singleton = MY_SINGLETON (object);
|
||
}
|
||
else
|
||
object = g_object_ref (G_OBJECT (the_singleton));
|
||
|
||
return object;
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="381"/>
|
||
<field name="g_type_class">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="277">the parent class</doc>
|
||
<type name="TypeClass" c:type="GTypeClass"/>
|
||
</field>
|
||
<field name="construct_properties" readable="0" private="1">
|
||
<type name="GLib.SList" c:type="GSList*">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</type>
|
||
</field>
|
||
<field name="constructor" introspectable="0">
|
||
<callback name="constructor" introspectable="0">
|
||
<source-position filename="gobject.h" line="346"/>
|
||
<return-value>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_construct_properties" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="construct_properties" transfer-ownership="none">
|
||
<type name="ObjectConstructParam"
|
||
c:type="GObjectConstructParam*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="set_property">
|
||
<callback name="set_property">
|
||
<source-position filename="gobject.h" line="350"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="get_property">
|
||
<callback name="get_property">
|
||
<source-position filename="gobject.h" line="354"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="dispose">
|
||
<callback name="dispose">
|
||
<source-position filename="gobject.h" line="358"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="finalize">
|
||
<callback name="finalize">
|
||
<source-position filename="gobject.h" line="359"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="dispatch_properties_changed">
|
||
<callback name="dispatch_properties_changed">
|
||
<source-position filename="gobject.h" line="361"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="n_pspecs" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="pspecs" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec**"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="notify">
|
||
<callback name="notify">
|
||
<source-position filename="gobject.h" line="365"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3424">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="constructed">
|
||
<callback name="constructed">
|
||
<source-position filename="gobject.h" line="369"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="flags" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="n_construct_properties" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="pspecs" readable="0" private="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
<field name="n_pspecs" readable="0" private="1">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</field>
|
||
<field name="pdummy" readable="0" private="1">
|
||
<array zero-terminated="0" fixed-size="3">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</array>
|
||
</field>
|
||
<method name="find_property" c:identifier="g_object_class_find_property">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2845">Looks up the #GParamSpec for a property of a class.</doc>
|
||
<source-position filename="gobject.h" line="420"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2852">the #GParamSpec for the property, or
|
||
%NULL if the class doesn't have a property of that name</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="oclass" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2847">a #GObjectClass</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2848">the name of the property to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="install_properties"
|
||
c:identifier="g_object_class_install_properties"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2857">Installs new properties from an array of #GParamSpecs.
|
||
|
||
All properties should be installed during the class initializer. It
|
||
is possible to install properties after that, but doing so is not
|
||
recommend, and specifically, is not guaranteed to be thread-safe vs.
|
||
use of properties on the same type on other threads.
|
||
|
||
The property id of each property is the index of each #GParamSpec in
|
||
the @pspecs array.
|
||
|
||
The property id of 0 is treated specially by #GObject and it should not
|
||
be used to store a #GParamSpec.
|
||
|
||
This function should be used if you plan to use a static array of
|
||
#GParamSpecs and g_object_notify_by_pspec(). For instance, this
|
||
class initialization:
|
||
|
||
|[<!-- language="C" -->
|
||
typedef enum {
|
||
PROP_FOO = 1,
|
||
PROP_BAR,
|
||
N_PROPERTIES
|
||
} MyObjectProperty;
|
||
|
||
static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
|
||
|
||
static void
|
||
my_object_class_init (MyObjectClass *klass)
|
||
{
|
||
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
|
||
|
||
obj_properties[PROP_FOO] =
|
||
g_param_spec_int ("foo", "Foo", "Foo",
|
||
-1, G_MAXINT,
|
||
0,
|
||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
||
|
||
obj_properties[PROP_BAR] =
|
||
g_param_spec_string ("bar", "Bar", "Bar",
|
||
NULL,
|
||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
||
|
||
gobject_class->set_property = my_object_set_property;
|
||
gobject_class->get_property = my_object_get_property;
|
||
g_object_class_install_properties (gobject_class,
|
||
G_N_ELEMENTS (obj_properties),
|
||
obj_properties);
|
||
}
|
||
]|
|
||
|
||
allows calling g_object_notify_by_pspec() to notify of property changes:
|
||
|
||
|[<!-- language="C" -->
|
||
void
|
||
my_object_set_foo (MyObject *self, gint foo)
|
||
{
|
||
if (self->foo != foo)
|
||
{
|
||
self->foo = foo;
|
||
g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
|
||
}
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="430"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="oclass" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2859">a #GObjectClass</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="n_pspecs" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2860">the length of the #GParamSpecs array</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="pspecs" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2861">the #GParamSpecs array
|
||
defining the new properties</doc>
|
||
<array length="0" zero-terminated="0" c:type="GParamSpec**">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="install_property"
|
||
c:identifier="g_object_class_install_property">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2932">Installs a new property.
|
||
|
||
All properties should be installed during the class initializer. It
|
||
is possible to install properties after that, but doing so is not
|
||
recommend, and specifically, is not guaranteed to be thread-safe vs.
|
||
use of properties on the same type on other threads.
|
||
|
||
Note that it is possible to redefine a property in a derived class,
|
||
by installing a property with the same name. This can be useful at times,
|
||
e.g. to change the range of allowed values or the default value.</doc>
|
||
<source-position filename="gobject.h" line="416"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="oclass" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2934">a #GObjectClass</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2935">the id for the new property</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2936">the #GParamSpec for the new property</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="list_properties"
|
||
c:identifier="g_object_class_list_properties">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2951">Get an array of #GParamSpec* for all properties of a class.</doc>
|
||
<source-position filename="gobject.h" line="423"/>
|
||
<return-value transfer-ownership="container">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2958">an array of
|
||
#GParamSpec* which should be freed after use</doc>
|
||
<array length="0" zero-terminated="0" c:type="GParamSpec**">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="oclass" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2953">a #GObjectClass</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="n_properties"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2954">return location for the length of the returned array</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="override_property"
|
||
c:identifier="g_object_class_override_property"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2963">Registers @property_id as referring to a property with the name
|
||
@name in a parent class or in an interface implemented by @oclass.
|
||
This allows this class to "override" a property implementation in
|
||
a parent class or to provide the implementation of a property from
|
||
an interface.
|
||
|
||
Internally, overriding is implemented by creating a property of type
|
||
#GParamSpecOverride; generally operations that query the properties of
|
||
the object class, such as g_object_class_find_property() or
|
||
g_object_class_list_properties() will return the overridden
|
||
property. However, in one case, the @construct_properties argument of
|
||
the @constructor virtual function, the #GParamSpecOverride is passed
|
||
instead, so that the @param_id field of the #GParamSpec will be
|
||
correct. For virtually all uses, this makes no difference. If you
|
||
need to get the overridden property, you can call
|
||
g_param_spec_get_redirect_target().</doc>
|
||
<source-position filename="gobject.h" line="426"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="oclass" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2965">a #GObjectClass</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2966">the new property ID</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2967">the name of a property registered in a parent class or
|
||
in an interface of this class.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
</record>
|
||
<record name="ObjectConstructParam" c:type="GObjectConstructParam">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="383">The GObjectConstructParam struct is an auxiliary structure used to hand
|
||
#GParamSpec/#GValue pairs to the @constructor of a #GObjectClass.</doc>
|
||
<source-position filename="gobject.h" line="395"/>
|
||
<field name="pspec" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="385">the #GParamSpec of the construct parameter</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</field>
|
||
<field name="value" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="386">the value to set the parameter to</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</field>
|
||
</record>
|
||
<callback name="ObjectFinalizeFunc" c:type="GObjectFinalizeFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="225">The type of the @finalize function of #GObjectClass.</doc>
|
||
<source-position filename="gobject.h" line="231"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="227">the #GObject being finalized</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="ObjectGetPropertyFunc" c:type="GObjectGetPropertyFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="197">The type of the @get_property function of #GObjectClass.</doc>
|
||
<source-position filename="gobject.h" line="207"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="199">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="200">the numeric id under which the property was registered with
|
||
g_object_class_install_property().</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="202">a #GValue to return the property value in</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="203">the #GParamSpec describing the property</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="ObjectSetPropertyFunc" c:type="GObjectSetPropertyFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="211">The type of the @set_property function of #GObjectClass.</doc>
|
||
<source-position filename="gobject.h" line="221"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="213">a #GObject</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="property_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="214">the numeric id under which the property was registered with
|
||
g_object_class_install_property().</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="216">the new value for the property</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="217">the #GParamSpec describing the property</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<constant name="PARAM_MASK" value="255" c:type="G_PARAM_MASK">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="187">Mask containing the bits of #GParamSpec.flags which are reserved for GLib.</doc>
|
||
<source-position filename="gparam.h" line="192"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="PARAM_SPEC"
|
||
c:identifier="G_PARAM_SPEC"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="40">Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into
|
||
a #GParamSpec object.</doc>
|
||
<source-position filename="gparam.h" line="47"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="42">a valid #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_BOOLEAN"
|
||
c:identifier="G_PARAM_SPEC_BOOLEAN"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="97">Cast a #GParamSpec instance into a #GParamSpecBoolean.</doc>
|
||
<source-position filename="gparamspecs.h" line="103"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="99">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_BOXED"
|
||
c:identifier="G_PARAM_SPEC_BOXED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="419">Cast a #GParamSpec instance into a #GParamSpecBoxed.</doc>
|
||
<source-position filename="gparamspecs.h" line="425"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="421">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_CHAR"
|
||
c:identifier="G_PARAM_SPEC_CHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="51">Cast a #GParamSpec instance into a #GParamSpecChar.</doc>
|
||
<source-position filename="gparamspecs.h" line="57"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="53">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_CLASS"
|
||
c:identifier="G_PARAM_SPEC_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="60">Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure.</doc>
|
||
<source-position filename="gparam.h" line="66"/>
|
||
<parameters>
|
||
<parameter name="pclass">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="62">a valid #GParamSpecClass</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_DOUBLE"
|
||
c:identifier="G_PARAM_SPEC_DOUBLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="350">Cast a #GParamSpec instance into a #GParamSpecDouble.</doc>
|
||
<source-position filename="gparamspecs.h" line="356"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="352">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_ENUM"
|
||
c:identifier="G_PARAM_SPEC_ENUM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="281">Cast a #GParamSpec instance into a #GParamSpecEnum.</doc>
|
||
<source-position filename="gparamspecs.h" line="287"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="283">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_FLAGS"
|
||
c:identifier="G_PARAM_SPEC_FLAGS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="304">Cast a #GParamSpec instance into a #GParamSpecFlags.</doc>
|
||
<source-position filename="gparamspecs.h" line="310"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="306">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_FLOAT"
|
||
c:identifier="G_PARAM_SPEC_FLOAT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="327">Cast a #GParamSpec instance into a #GParamSpecFloat.</doc>
|
||
<source-position filename="gparamspecs.h" line="333"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="329">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_GET_CLASS"
|
||
c:identifier="G_PARAM_SPEC_GET_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="75">Retrieves the #GParamSpecClass of a #GParamSpec.</doc>
|
||
<source-position filename="gparam.h" line="81"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="77">a valid #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_GTYPE"
|
||
c:identifier="G_PARAM_SPEC_GTYPE"
|
||
version="2.10"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="548">Casts a #GParamSpec into a #GParamSpecGType.</doc>
|
||
<source-position filename="gparamspecs.h" line="556"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="550">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_INT"
|
||
c:identifier="G_PARAM_SPEC_INT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="120">Cast a #GParamSpec instance into a #GParamSpecInt.</doc>
|
||
<source-position filename="gparamspecs.h" line="126"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="122">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_INT64"
|
||
c:identifier="G_PARAM_SPEC_INT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="212">Cast a #GParamSpec instance into a #GParamSpecInt64.</doc>
|
||
<source-position filename="gparamspecs.h" line="218"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="214">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_LONG"
|
||
c:identifier="G_PARAM_SPEC_LONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="166">Cast a #GParamSpec instance into a #GParamSpecLong.</doc>
|
||
<source-position filename="gparamspecs.h" line="172"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="168">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_OBJECT"
|
||
c:identifier="G_PARAM_SPEC_OBJECT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="494">Casts a #GParamSpec instance into a #GParamSpecObject.</doc>
|
||
<source-position filename="gparamspecs.h" line="500"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="496">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_OVERRIDE"
|
||
c:identifier="G_PARAM_SPEC_OVERRIDE"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="520">Casts a #GParamSpec into a #GParamSpecOverride.</doc>
|
||
<source-position filename="gparamspecs.h" line="528"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="522">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_PARAM"
|
||
c:identifier="G_PARAM_SPEC_PARAM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="396">Casts a #GParamSpec instance into a #GParamSpecParam.</doc>
|
||
<source-position filename="gparamspecs.h" line="402"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="398">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_POINTER"
|
||
c:identifier="G_PARAM_SPEC_POINTER"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="442">Casts a #GParamSpec instance into a #GParamSpecPointer.</doc>
|
||
<source-position filename="gparamspecs.h" line="448"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="444">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_STRING"
|
||
c:identifier="G_PARAM_SPEC_STRING"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="373">Casts a #GParamSpec instance into a #GParamSpecString.</doc>
|
||
<source-position filename="gparamspecs.h" line="379"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="375">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_TYPE"
|
||
c:identifier="G_PARAM_SPEC_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="85">Retrieves the #GType of this @pspec.</doc>
|
||
<source-position filename="gparam.h" line="91"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="87">a valid #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_TYPE_NAME"
|
||
c:identifier="G_PARAM_SPEC_TYPE_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="92">Retrieves the #GType name of this @pspec.</doc>
|
||
<source-position filename="gparam.h" line="98"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="94">a valid #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_UCHAR"
|
||
c:identifier="G_PARAM_SPEC_UCHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="74">Cast a #GParamSpec instance into a #GParamSpecUChar.</doc>
|
||
<source-position filename="gparamspecs.h" line="80"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="76">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_UINT"
|
||
c:identifier="G_PARAM_SPEC_UINT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="143">Cast a #GParamSpec instance into a #GParamSpecUInt.</doc>
|
||
<source-position filename="gparamspecs.h" line="149"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="145">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_UINT64"
|
||
c:identifier="G_PARAM_SPEC_UINT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="235">Cast a #GParamSpec instance into a #GParamSpecUInt64.</doc>
|
||
<source-position filename="gparamspecs.h" line="241"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="237">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_ULONG"
|
||
c:identifier="G_PARAM_SPEC_ULONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="189">Cast a #GParamSpec instance into a #GParamSpecULong.</doc>
|
||
<source-position filename="gparamspecs.h" line="195"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="191">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_UNICHAR"
|
||
c:identifier="G_PARAM_SPEC_UNICHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="249">Cast a #GParamSpec instance into a #GParamSpecUnichar.</doc>
|
||
<source-position filename="gparamspecs.h" line="255"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="251">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_VALUE_ARRAY"
|
||
c:identifier="G_PARAM_SPEC_VALUE_ARRAY"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="469">Cast a #GParamSpec instance into a #GParamSpecValueArray.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray instead of #GValueArray</doc-deprecated>
|
||
<source-position filename="gparamspecs.h" line="477"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="471">a valid #GParamSpec instance</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_VALUE_TYPE"
|
||
c:identifier="G_PARAM_SPEC_VALUE_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="99">Retrieves the #GType to initialize a #GValue for this parameter.</doc>
|
||
<source-position filename="gparam.h" line="105"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="101">a valid #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PARAM_SPEC_VARIANT"
|
||
c:identifier="G_PARAM_SPEC_VARIANT"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="577">Casts a #GParamSpec into a #GParamSpecVariant.</doc>
|
||
<source-position filename="gparamspecs.h" line="585"/>
|
||
<parameters>
|
||
<parameter name="pspec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="579">a #GParamSpec</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="PARAM_STATIC_STRINGS"
|
||
value="224"
|
||
c:type="G_PARAM_STATIC_STRINGS">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="172">#GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB.
|
||
|
||
It is recommended to use this for all properties by default, as it allows for
|
||
internal performance improvements in GObject.
|
||
|
||
It is very rare that a property would have a dynamically constructed name,
|
||
nickname or blurb.
|
||
|
||
Since 2.13.0</doc>
|
||
<source-position filename="gparam.h" line="185"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="PARAM_USER_SHIFT" value="8" c:type="G_PARAM_USER_SHIFT">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="193">Minimum shift count to be used for user defined flags, to be stored in
|
||
#GParamSpec.flags. The maximum allowed is 10.</doc>
|
||
<source-position filename="gparam.h" line="199"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="PRIVATE_FIELD"
|
||
c:identifier="G_PRIVATE_FIELD"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2105">Evaluates to the @field_name inside the @inst private data
|
||
structure for @TypeName.
|
||
|
||
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
|
||
and G_ADD_PRIVATE() macros, since it depends on variable names from
|
||
those macros.</doc>
|
||
<source-position filename="gtype.h" line="2121"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2107">the name of the type in CamelCase</doc>
|
||
</parameter>
|
||
<parameter name="inst">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2108">the instance of @TypeName you wish to access</doc>
|
||
</parameter>
|
||
<parameter name="field_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2109">the type of the field in the private data structure</doc>
|
||
</parameter>
|
||
<parameter name="field_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2110">the name of the field in the private data structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PRIVATE_FIELD_P"
|
||
c:identifier="G_PRIVATE_FIELD_P"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2087">Evaluates to a pointer to the @field_name inside the @inst private data
|
||
structure for @TypeName.
|
||
|
||
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
|
||
and G_ADD_PRIVATE() macros, since it depends on variable names from
|
||
those macros.</doc>
|
||
<source-position filename="gtype.h" line="2102"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2089">the name of the type in CamelCase</doc>
|
||
</parameter>
|
||
<parameter name="inst">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2090">the instance of @TypeName you wish to access</doc>
|
||
</parameter>
|
||
<parameter name="field_name">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2091">the name of the field in the private data structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="PRIVATE_OFFSET"
|
||
c:identifier="G_PRIVATE_OFFSET"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2070">Evaluates to the offset of the @field inside the instance private data
|
||
structure for @TypeName.
|
||
|
||
Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
|
||
and G_ADD_PRIVATE() macros, since it depends on variable names from
|
||
those macros.</doc>
|
||
<source-position filename="gtype.h" line="2084"/>
|
||
<parameters>
|
||
<parameter name="TypeName">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2072">the name of the type in CamelCase</doc>
|
||
</parameter>
|
||
<parameter name="field">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2073">the name of the field in the private data structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<bitfield name="ParamFlags" c:type="GParamFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="118">Through the #GParamFlags flag values, certain aspects of parameters
|
||
can be configured.
|
||
|
||
See also: %G_PARAM_STATIC_STRINGS</doc>
|
||
<source-position filename="gparam.h" line="170"/>
|
||
<member name="readable" value="1" c:identifier="G_PARAM_READABLE">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="120">the parameter is readable</doc>
|
||
</member>
|
||
<member name="writable" value="2" c:identifier="G_PARAM_WRITABLE">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="121">the parameter is writable</doc>
|
||
</member>
|
||
<member name="readwrite" value="3" c:identifier="G_PARAM_READWRITE">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="122">alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE</doc>
|
||
</member>
|
||
<member name="construct" value="4" c:identifier="G_PARAM_CONSTRUCT">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="123">the parameter will be set upon object construction</doc>
|
||
</member>
|
||
<member name="construct_only"
|
||
value="8"
|
||
c:identifier="G_PARAM_CONSTRUCT_ONLY">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="124">the parameter can only be set upon object construction</doc>
|
||
</member>
|
||
<member name="lax_validation"
|
||
value="16"
|
||
c:identifier="G_PARAM_LAX_VALIDATION">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="125">upon parameter conversion (see g_param_value_convert())
|
||
strict validation is not required</doc>
|
||
</member>
|
||
<member name="static_name" value="32" c:identifier="G_PARAM_STATIC_NAME">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="127">the string used as name when constructing the
|
||
parameter is guaranteed to remain valid and
|
||
unmodified for the lifetime of the parameter.
|
||
Since 2.8</doc>
|
||
</member>
|
||
<member name="private" value="32" c:identifier="G_PARAM_PRIVATE">
|
||
<doc xml:space="preserve" filename="gparam.h" line="143">internal</doc>
|
||
</member>
|
||
<member name="static_nick" value="64" c:identifier="G_PARAM_STATIC_NICK">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="131">the string used as nick when constructing the
|
||
parameter is guaranteed to remain valid and
|
||
unmmodified for the lifetime of the parameter.
|
||
Since 2.8</doc>
|
||
</member>
|
||
<member name="static_blurb"
|
||
value="128"
|
||
c:identifier="G_PARAM_STATIC_BLURB">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="135">the string used as blurb when constructing the
|
||
parameter is guaranteed to remain valid and
|
||
unmodified for the lifetime of the parameter.
|
||
Since 2.8</doc>
|
||
</member>
|
||
<member name="explicit_notify"
|
||
value="1073741824"
|
||
c:identifier="G_PARAM_EXPLICIT_NOTIFY">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="139">calls to g_object_set_property() for this
|
||
property will not automatically result in a "notify" signal being
|
||
emitted: the implementation must call g_object_notify() themselves
|
||
in case the property actually changes. Since: 2.42.</doc>
|
||
</member>
|
||
<member name="deprecated"
|
||
value="2147483648"
|
||
c:identifier="G_PARAM_DEPRECATED">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="144">the parameter is deprecated and will be removed
|
||
in a future version. A warning will be generated if it is used
|
||
while running with G_ENABLE_DIAGNOSTIC=1.
|
||
Since 2.26</doc>
|
||
</member>
|
||
</bitfield>
|
||
<class name="ParamSpec"
|
||
c:symbol-prefix="param_spec"
|
||
c:type="GParamSpec"
|
||
abstract="1"
|
||
glib:type-name="GParam"
|
||
glib:get-type="intern"
|
||
glib:type-struct="ParamSpecClass"
|
||
glib:fundamental="1"
|
||
glib:ref-func="g_param_spec_ref_sink"
|
||
glib:unref-func="g_param_spec_unref"
|
||
glib:set-value-func="g_value_set_param"
|
||
glib:get-value-func="g_value_get_param">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="525">#GParamSpec is an object structure that encapsulates the metadata
|
||
required to specify parameters, such as e.g. #GObject properties.
|
||
|
||
## Parameter names # {#canonical-parameter-names}
|
||
|
||
A property name consists of one or more segments consisting of ASCII letters
|
||
and digits, separated by either the `-` or `_` character. The first
|
||
character of a property name must be a letter. These are the same rules as
|
||
for signal naming (see g_signal_new()).
|
||
|
||
When creating and looking up a #GParamSpec, either separator can be
|
||
used, but they cannot be mixed. Using `-` is considerably more
|
||
efficient, and is the ‘canonical form’. Using `_` is discouraged.</doc>
|
||
<source-position filename="gparam.h" line="277"/>
|
||
<function name="internal"
|
||
c:identifier="g_param_spec_internal"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4193">Creates a new #GParamSpec instance.
|
||
|
||
See [canonical parameter names][canonical-parameter-names] for details of
|
||
the rules for @name. Names which violate these rules lead to undefined
|
||
behaviour.
|
||
|
||
Beyond the name, #GParamSpecs have two more descriptive strings, the
|
||
@nick and @blurb, which may be used as a localized label and description.
|
||
For GTK and related libraries these are considered deprecated and may be
|
||
omitted, while for other libraries such as GStreamer and its plugins they
|
||
are essential. When in doubt, follow the conventions used in the
|
||
surrounding code and supporting libraries.</doc>
|
||
<source-position filename="gparam.h" line="430"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4214">(transfer floating): a newly allocated
|
||
#GParamSpec instance, which is initially floating</doc>
|
||
<type name="ParamSpec" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="param_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4195">the #GType for the property; must be derived from %G_TYPE_PARAM</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4196">the canonical name of the property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4197">the nickname of the property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4198">a short description of the property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4199">a combination of #GParamFlags</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="is_valid_name"
|
||
c:identifier="g_param_spec_is_valid_name"
|
||
version="2.66">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4219">Validate a property name for a #GParamSpec. This can be useful for
|
||
dynamically-generated properties which need to be validated at run-time
|
||
before actually trying to create them.
|
||
|
||
See [canonical parameter names][canonical-parameter-names] for details of
|
||
the rules for valid names.</doc>
|
||
<source-position filename="gparam.h" line="420"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4230">%TRUE if @name is a valid property name, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4221">the canonical name of the property</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<virtual-method name="finalize">
|
||
<source-position filename="gparam.h" line="261"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="value_is_valid">
|
||
<source-position filename="gparam.h" line="272"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="value_set_default">
|
||
<source-position filename="gparam.h" line="264"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="value_validate">
|
||
<source-position filename="gparam.h" line="266"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="values_cmp">
|
||
<source-position filename="gparam.h" line="268"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="value1" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="value2" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<method name="get_blurb" c:identifier="g_param_spec_get_blurb">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4052">Get the short description of a #GParamSpec.</doc>
|
||
<source-position filename="gparam.h" line="348"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4058">the short description of @pspec.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4054">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_default_value"
|
||
c:identifier="g_param_spec_get_default_value"
|
||
version="2.38">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4062">Gets the default value of @pspec as a pointer to a #GValue.
|
||
|
||
The #GValue will remain valid for the life of @pspec.</doc>
|
||
<source-position filename="gparam.h" line="365"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4070">a pointer to a #GValue which must not be modified</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4064">a #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_name" c:identifier="g_param_spec_get_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4075">Get the name of a #GParamSpec.
|
||
|
||
The name is always an "interned" string (as per g_intern_string()).
|
||
This allows for pointer-value comparisons.</doc>
|
||
<source-position filename="gparam.h" line="344"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4084">the name of @pspec.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4077">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_name_quark"
|
||
c:identifier="g_param_spec_get_name_quark"
|
||
version="2.46">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4088">Gets the GQuark for the name.</doc>
|
||
<source-position filename="gparam.h" line="368"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4094">the GQuark for @pspec->name.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4090">a #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_nick" c:identifier="g_param_spec_get_nick">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4099">Get the nickname of a #GParamSpec.</doc>
|
||
<source-position filename="gparam.h" line="346"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4105">the nickname of @pspec.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4101">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_qdata" c:identifier="g_param_spec_get_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4109">Gets back user data pointers stored via g_param_spec_set_qdata().</doc>
|
||
<source-position filename="gparam.h" line="305"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4116">the user data pointer set, or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4111">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4112">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_redirect_target"
|
||
c:identifier="g_param_spec_get_redirect_target"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4120">If the paramspec redirects operations to another paramspec,
|
||
returns that paramspec. Redirect is used typically for
|
||
providing a new implementation of a property in a derived
|
||
type while preserving all the properties from the parent
|
||
type. Redirection is established by creating a property
|
||
of type #GParamSpecOverride. See g_object_class_override_property()
|
||
for an example of the use of this capability.</doc>
|
||
<source-position filename="gparam.h" line="320"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4133">paramspec to which requests on this
|
||
paramspec should be redirected, or %NULL if none.</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4122">a #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="ref" c:identifier="g_param_spec_ref" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4396">Increments the reference count of @pspec.</doc>
|
||
<source-position filename="gparam.h" line="297"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4402">the #GParamSpec that was passed into this function</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4398">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="ref_sink"
|
||
c:identifier="g_param_spec_ref_sink"
|
||
version="2.10"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4406">Convenience function to ref and sink a #GParamSpec.</doc>
|
||
<source-position filename="gparam.h" line="303"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4413">the #GParamSpec that was passed into this function</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4408">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_qdata" c:identifier="g_param_spec_set_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4417">Sets an opaque, named pointer on a #GParamSpec. 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 @pspec with g_param_spec_get_qdata(). Setting a
|
||
previously set user data pointer, overrides (frees) the old pointer
|
||
set, using %NULL as pointer essentially removes the data stored.</doc>
|
||
<source-position filename="gparam.h" line="308"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4419">the #GParamSpec to set store a user data pointer</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4420">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4421">an opaque user data pointer</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_qdata_full"
|
||
c:identifier="g_param_spec_set_qdata_full"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4432">This function works like g_param_spec_set_qdata(), but in addition,
|
||
a `void (*destroy) (gpointer)` function may be
|
||
specified which is called with @data as argument when the @pspec is
|
||
finalized, or the data is being overwritten by a call to
|
||
g_param_spec_set_qdata() with the same @quark.</doc>
|
||
<source-position filename="gparam.h" line="312"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4434">the #GParamSpec to set store a user data pointer</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4435">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4436">an opaque user data pointer</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4437">function to invoke with @data as argument, when @data needs to
|
||
be freed</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="sink" c:identifier="g_param_spec_sink">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4448">The initial reference count of a newly created #GParamSpec is 1,
|
||
even though no one has explicitly called g_param_spec_ref() on it
|
||
yet. So the initial reference count is flagged as "floating", until
|
||
someone calls `g_param_spec_ref (pspec); g_param_spec_sink
|
||
(pspec);` in sequence on it, taking over the initial
|
||
reference count (thus ending up with a @pspec that has a reference
|
||
count of 1 still, but is not flagged "floating" anymore).</doc>
|
||
<source-position filename="gparam.h" line="301"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4450">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="steal_qdata" c:identifier="g_param_spec_steal_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4462">Gets back user data pointers stored via g_param_spec_set_qdata()
|
||
and removes the @data from @pspec 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.</doc>
|
||
<source-position filename="gparam.h" line="317"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4472">the user data pointer set, or %NULL</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4464">the #GParamSpec to get a stored user data pointer from</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4465">a #GQuark, naming the user data pointer</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unref"
|
||
c:identifier="g_param_spec_unref"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4582">Decrements the reference count of a @pspec.</doc>
|
||
<source-position filename="gparam.h" line="299"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4584">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<field name="g_type_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="208">private #GTypeInstance portion</doc>
|
||
<type name="TypeInstance" c:type="GTypeInstance"/>
|
||
</field>
|
||
<field name="name">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="209">name of this parameter: always an interned string</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="flags">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="210">#GParamFlags flags for this parameter</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</field>
|
||
<field name="value_type">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="211">the #GValue type for this parameter</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="owner_type">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="212">#GType type that uses (introduces) this parameter</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="_nick" readable="0" private="1">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
<field name="_blurb" readable="0" private="1">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
<field name="qdata" readable="0" private="1">
|
||
<type name="GLib.Data" c:type="GData*"/>
|
||
</field>
|
||
<field name="ref_count" readable="0" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="param_id" readable="0" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecBoolean"
|
||
c:symbol-prefix="param_spec_boolean"
|
||
c:type="GParamSpecBoolean"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamBoolean"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="646">A #GParamSpec derived structure that contains the meta data for boolean properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="648">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="649">default value for the property specified</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecBoxed"
|
||
c:symbol-prefix="param_spec_boxed"
|
||
c:type="GParamSpecBoxed"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamBoxed"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="881">A #GParamSpec derived structure that contains the meta data for boxed properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="883">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecChar"
|
||
c:symbol-prefix="param_spec_char"
|
||
c:type="GParamSpecChar"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamChar"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="612">A #GParamSpec derived structure that contains the meta data for character properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="614">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="615">minimum value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="616">maximum value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="617">default value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</field>
|
||
</class>
|
||
<record name="ParamSpecClass"
|
||
c:type="GParamSpecClass"
|
||
glib:is-gtype-struct-for="ParamSpec">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="233">The class structure for the GParamSpec type.
|
||
Normally, GParamSpec classes are filled by
|
||
g_param_type_register_static().</doc>
|
||
<source-position filename="gparam.h" line="277"/>
|
||
<field name="g_type_class">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="235">the parent class</doc>
|
||
<type name="TypeClass" c:type="GTypeClass"/>
|
||
</field>
|
||
<field name="value_type">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="236">the #GValue type for this parameter</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="finalize">
|
||
<callback name="finalize">
|
||
<source-position filename="gparam.h" line="261"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_set_default">
|
||
<callback name="value_set_default">
|
||
<source-position filename="gparam.h" line="264"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_validate">
|
||
<callback name="value_validate">
|
||
<source-position filename="gparam.h" line="266"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="values_cmp">
|
||
<callback name="values_cmp">
|
||
<source-position filename="gparam.h" line="268"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value1" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="value2" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_is_valid">
|
||
<callback name="value_is_valid">
|
||
<source-position filename="gparam.h" line="272"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="dummy" readable="0" private="1">
|
||
<array zero-terminated="0" fixed-size="3">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</array>
|
||
</field>
|
||
</record>
|
||
<class name="ParamSpecDouble"
|
||
c:symbol-prefix="param_spec_double"
|
||
c:type="GParamSpecDouble"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamDouble"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="826">A #GParamSpec derived structure that contains the meta data for double properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="828">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="829">minimum value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="830">maximum value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="831">default value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</field>
|
||
<field name="epsilon">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="832">values closer than @epsilon will be considered identical
|
||
by g_param_values_cmp(); the default value is 1e-90.</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecEnum"
|
||
c:symbol-prefix="param_spec_enum"
|
||
c:type="GParamSpecEnum"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamEnum"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="774">A #GParamSpec derived structure that contains the meta data for enum
|
||
properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="776">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="enum_class">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="777">the #GEnumClass for the enum</doc>
|
||
<type name="EnumClass" c:type="GEnumClass*"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="778">default value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecFlags"
|
||
c:symbol-prefix="param_spec_flags"
|
||
c:type="GParamSpecFlags"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamFlags"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="790">A #GParamSpec derived structure that contains the meta data for flags
|
||
properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="792">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="flags_class">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="793">the #GFlagsClass for the flags</doc>
|
||
<type name="FlagsClass" c:type="GFlagsClass*"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="794">default value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecFloat"
|
||
c:symbol-prefix="param_spec_float"
|
||
c:type="GParamSpecFloat"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamFloat"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="806">A #GParamSpec derived structure that contains the meta data for float properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="808">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="809">minimum value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="810">maximum value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="811">default value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</field>
|
||
<field name="epsilon">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="812">values closer than @epsilon will be considered identical
|
||
by g_param_values_cmp(); the default value is 1e-30.</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecGType"
|
||
c:symbol-prefix="param_spec_gtype"
|
||
c:type="GParamSpecGType"
|
||
version="2.10"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamGType"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="948">A #GParamSpec derived structure that contains the meta data for #GType properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="950">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="is_a_type">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="951">a #GType whose subtypes can occur as values</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecInt"
|
||
c:symbol-prefix="param_spec_int"
|
||
c:type="GParamSpecInt"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamInt"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="659">A #GParamSpec derived structure that contains the meta data for integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="661">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="662">minimum value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="663">maximum value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="664">default value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecInt64"
|
||
c:symbol-prefix="param_spec_int64"
|
||
c:type="GParamSpecInt64"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamInt64"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="727">A #GParamSpec derived structure that contains the meta data for 64bit integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="729">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="730">minimum value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="731">maximum value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="732">default value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecLong"
|
||
c:symbol-prefix="param_spec_long"
|
||
c:type="GParamSpecLong"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamLong"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="693">A #GParamSpec derived structure that contains the meta data for long integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="695">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="696">minimum value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="697">maximum value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="698">default value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecObject"
|
||
c:symbol-prefix="param_spec_object"
|
||
c:type="GParamSpecObject"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamObject"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="915">A #GParamSpec derived structure that contains the meta data for object properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="917">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecOverride"
|
||
c:symbol-prefix="param_spec_override"
|
||
c:type="GParamSpecOverride"
|
||
version="2.4"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamOverride"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="925">A #GParamSpec derived structure that redirects operations to
|
||
other types of #GParamSpec.
|
||
|
||
All operations other than getting or setting the value are redirected,
|
||
including accessing the nick and blurb, validating a value, and so
|
||
forth.
|
||
|
||
See g_param_spec_get_redirect_target() for retrieving the overridden
|
||
property. #GParamSpecOverride is used in implementing
|
||
g_object_class_override_property(), and will not be directly useful
|
||
unless you are implementing a new base type similar to GObject.</doc>
|
||
<field name="parent_instance" readable="0" private="1">
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="overridden" readable="0" private="1">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecParam"
|
||
c:symbol-prefix="param_spec_param"
|
||
c:type="GParamSpecParam"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamParam"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="870">A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM
|
||
properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="872">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecPointer"
|
||
c:symbol-prefix="param_spec_pointer"
|
||
c:type="GParamSpecPointer"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamPointer"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="891">A #GParamSpec derived structure that contains the meta data for pointer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="893">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
</class>
|
||
<record name="ParamSpecPool"
|
||
c:type="GParamSpecPool"
|
||
disguised="1"
|
||
opaque="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="100">A #GParamSpecPool maintains a collection of #GParamSpecs which can be
|
||
quickly accessed by owner and name.
|
||
|
||
The implementation of the #GObject property system uses such a pool to
|
||
store the #GParamSpecs of the properties all object types.</doc>
|
||
<source-position filename="gparam.h" line="205"/>
|
||
<method name="insert" c:identifier="g_param_spec_pool_insert">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4318">Inserts a #GParamSpec in the pool.</doc>
|
||
<source-position filename="gparam.h" line="438"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pool" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4320">a #GParamSpecPool.</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</instance-parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4321">the #GParamSpec to insert</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="owner_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4322">a #GType identifying the owner of @pspec</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="list" c:identifier="g_param_spec_pool_list">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4328">Gets an array of all #GParamSpecs owned by @owner_type in
|
||
the pool.</doc>
|
||
<source-position filename="gparam.h" line="453"/>
|
||
<return-value transfer-ownership="container">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4337">a newly
|
||
allocated array containing pointers to all #GParamSpecs
|
||
owned by @owner_type in the pool</doc>
|
||
<array length="1" zero-terminated="0" c:type="GParamSpec**">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pool" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4330">a #GParamSpecPool</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</instance-parameter>
|
||
<parameter name="owner_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4331">the owner to look for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_pspecs_p"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4332">return location for the length of the returned array</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="list_owned" c:identifier="g_param_spec_pool_list_owned">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4343">Gets an #GList of all #GParamSpecs owned by @owner_type in
|
||
the pool.</doc>
|
||
<source-position filename="gparam.h" line="450"/>
|
||
<return-value transfer-ownership="container">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4351">a
|
||
#GList of all #GParamSpecs owned by @owner_type in
|
||
the pool#GParamSpecs.</doc>
|
||
<type name="GLib.List" c:type="GList*">
|
||
<type name="ParamSpec"/>
|
||
</type>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pool" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4345">a #GParamSpecPool</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</instance-parameter>
|
||
<parameter name="owner_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4346">the owner to look for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="lookup" c:identifier="g_param_spec_pool_lookup">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4357">Looks up a #GParamSpec in the pool.</doc>
|
||
<source-position filename="gparam.h" line="445"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4367">The found #GParamSpec, or %NULL if no
|
||
matching #GParamSpec was found.</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pool" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4359">a #GParamSpecPool</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</instance-parameter>
|
||
<parameter name="param_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4360">the name to look for</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="owner_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4361">the owner to look for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="walk_ancestors" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4362">If %TRUE, also try to find a #GParamSpec with @param_name
|
||
owned by an ancestor of @owner_type.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove" c:identifier="g_param_spec_pool_remove">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4387">Removes a #GParamSpec from the pool.</doc>
|
||
<source-position filename="gparam.h" line="442"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="pool" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4389">a #GParamSpecPool</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</instance-parameter>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4390">the #GParamSpec to remove</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<function name="new"
|
||
c:identifier="g_param_spec_pool_new"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4372">Creates a new #GParamSpecPool.
|
||
|
||
If @type_prefixing is %TRUE, lookups in the newly created pool will
|
||
allow to specify the owner as a colon-separated prefix of the
|
||
property name, like "GtkContainer:border-width". This feature is
|
||
deprecated, so you should always set @type_prefixing to %FALSE.</doc>
|
||
<source-position filename="gparam.h" line="436"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4383">a newly allocated #GParamSpecPool.</doc>
|
||
<type name="ParamSpecPool" c:type="GParamSpecPool*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type_prefixing" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4374">Whether the pool will support type-prefixed property names.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<class name="ParamSpecString"
|
||
c:symbol-prefix="param_spec_string"
|
||
c:type="GParamSpecString"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamString"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="846">A #GParamSpec derived structure that contains the meta data for string
|
||
properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="848">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="849">default value for the property specified</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
<field name="cset_first">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="850">a string containing the allowed values for the first byte</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
<field name="cset_nth">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="851">a string containing the allowed values for the subsequent bytes</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
<field name="substitutor">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="852">the replacement byte for bytes which don't match @cset_first or @cset_nth.</doc>
|
||
<type name="gchar" c:type="gchar"/>
|
||
</field>
|
||
<field name="null_fold_if_empty" bits="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="853">replace empty string by %NULL</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="ensure_non_null" bits="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="854">replace %NULL strings by an empty string</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</class>
|
||
<record name="ParamSpecTypeInfo" c:type="GParamSpecTypeInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="372">This structure is used to provide the type system with the information
|
||
required to initialize and destruct (finalize) a parameter's class and
|
||
instances thereof.
|
||
|
||
The initialized structure is passed to the g_param_type_register_static()
|
||
The type system will perform a deep copy of this structure, so its memory
|
||
does not need to be persistent across invocation of
|
||
g_param_type_register_static().</doc>
|
||
<source-position filename="gparam.h" line="414"/>
|
||
<field name="instance_size" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="374">Size of the instance (object) structure.</doc>
|
||
<type name="guint16" c:type="guint16"/>
|
||
</field>
|
||
<field name="n_preallocs" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="375">Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now.</doc>
|
||
<type name="guint16" c:type="guint16"/>
|
||
</field>
|
||
<field name="instance_init">
|
||
<callback name="instance_init">
|
||
<source-position filename="gparam.h" line="402"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_type" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="377">The #GType of values conforming to this #GParamSpec</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="finalize">
|
||
<callback name="finalize">
|
||
<source-position filename="gparam.h" line="406"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_set_default">
|
||
<callback name="value_set_default">
|
||
<source-position filename="gparam.h" line="407"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_validate">
|
||
<callback name="value_validate">
|
||
<source-position filename="gparam.h" line="409"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="values_cmp">
|
||
<callback name="values_cmp">
|
||
<source-position filename="gparam.h" line="411"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value1" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="value2" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
</record>
|
||
<class name="ParamSpecUChar"
|
||
c:symbol-prefix="param_spec_uchar"
|
||
c:type="GParamSpecUChar"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamUChar"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="629">A #GParamSpec derived structure that contains the meta data for unsigned character properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="631">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="632">minimum value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="633">maximum value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="634">default value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecUInt"
|
||
c:symbol-prefix="param_spec_uint"
|
||
c:type="GParamSpecUInt"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamUInt"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="676">A #GParamSpec derived structure that contains the meta data for unsigned integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="678">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="679">minimum value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="680">maximum value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="681">default value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecUInt64"
|
||
c:symbol-prefix="param_spec_uint64"
|
||
c:type="GParamSpecUInt64"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamUInt64"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="744">A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="746">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="747">minimum value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="748">maximum value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="749">default value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecULong"
|
||
c:symbol-prefix="param_spec_ulong"
|
||
c:type="GParamSpecULong"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamULong"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="710">A #GParamSpec derived structure that contains the meta data for unsigned long integer properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="712">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="minimum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="713">minimum value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</field>
|
||
<field name="maximum">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="714">maximum value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="715">default value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecUnichar"
|
||
c:symbol-prefix="param_spec_unichar"
|
||
c:type="GParamSpecUnichar"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamUnichar"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="761">A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="763">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="764">default value for the property specified</doc>
|
||
<type name="gunichar" c:type="gunichar"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecValueArray"
|
||
c:symbol-prefix="param_spec_value_array"
|
||
c:type="GParamSpecValueArray"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamValueArray"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="901">A #GParamSpec derived structure that contains the meta data for #GValueArray properties.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="903">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="element_spec">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="904">a #GParamSpec describing the elements contained in arrays of this property, may be %NULL</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</field>
|
||
<field name="fixed_n_elements">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="905">if greater than 0, arrays of this property will always have this many elements</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</class>
|
||
<class name="ParamSpecVariant"
|
||
c:symbol-prefix="param_spec_variant"
|
||
c:type="GParamSpecVariant"
|
||
version="2.26"
|
||
parent="ParamSpec"
|
||
glib:type-name="GParamVariant"
|
||
glib:get-type="intern"
|
||
glib:fundamental="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="962">A #GParamSpec derived structure that contains the meta data for #GVariant properties.
|
||
|
||
When comparing values with g_param_values_cmp(), scalar values with the same
|
||
type will be compared with g_variant_compare(). Other non-%NULL variants will
|
||
be checked for equality with g_variant_equal(), and their sort order is
|
||
otherwise undefined. %NULL is ordered before non-%NULL variants. Two %NULL
|
||
values compare equal.</doc>
|
||
<field name="parent_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="964">private #GParamSpec portion</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec"/>
|
||
</field>
|
||
<field name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="965">a #GVariantType, or %NULL</doc>
|
||
<type name="GLib.VariantType" c:type="GVariantType*"/>
|
||
</field>
|
||
<field name="default_value">
|
||
<doc xml:space="preserve"
|
||
filename="gparamspecs.h"
|
||
line="966">a #GVariant, or %NULL</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</field>
|
||
<field name="padding" readable="0" private="1">
|
||
<array zero-terminated="0" fixed-size="4">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</array>
|
||
</field>
|
||
</class>
|
||
<record name="Parameter"
|
||
c:type="GParameter"
|
||
deprecated="1"
|
||
deprecated-version="2.54">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="278">The GParameter struct is an auxiliary structure used
|
||
to hand parameter name/value pairs to g_object_newv().</doc>
|
||
<doc-deprecated xml:space="preserve">This type is not introspectable.</doc-deprecated>
|
||
<source-position filename="gparam.h" line="292"/>
|
||
<field name="name" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="280">the parameter name</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="value" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="281">the parameter value</doc>
|
||
<type name="Value" c:type="GValue"/>
|
||
</field>
|
||
</record>
|
||
<constant name="SIGNAL_FLAGS_MASK"
|
||
value="511"
|
||
c:type="G_SIGNAL_FLAGS_MASK">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="152">A mask for all #GSignalFlags bits.</doc>
|
||
<source-position filename="gsignal.h" line="157"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="SIGNAL_GROUP"
|
||
c:identifier="G_SIGNAL_GROUP"
|
||
introspectable="0">
|
||
<source-position filename="gsignalgroup.h" line="35"/>
|
||
<parameters>
|
||
<parameter name="obj">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="SIGNAL_MATCH_MASK" value="63" c:type="G_SIGNAL_MATCH_MASK">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="198">A mask for all #GSignalMatchType bits.</doc>
|
||
<source-position filename="gsignal.h" line="203"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<callback name="SignalAccumulator" c:type="GSignalAccumulator">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="79">The signal accumulator is a special callback function that can be used
|
||
to collect return values of the various callbacks that are called
|
||
during a signal emission.
|
||
|
||
The signal accumulator is specified at signal creation time, if it is
|
||
left %NULL, no accumulation of callback return values is performed.
|
||
The return value of signal emissions is then the value returned by the
|
||
last callback.</doc>
|
||
<source-position filename="gsignal.h" line="103"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="96">The accumulator function returns whether the signal emission
|
||
should be aborted. Returning %TRUE will continue with
|
||
the signal emission. Returning %FALSE will abort the current emission.
|
||
Since 2.62, returning %FALSE will skip to the CLEANUP stage. In this case,
|
||
emission will occur as normal in the CLEANUP stage and the handler's
|
||
return value will be accumulated.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="ihint" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="81">Signal invocation hint, see #GSignalInvocationHint.</doc>
|
||
<type name="SignalInvocationHint" c:type="GSignalInvocationHint*"/>
|
||
</parameter>
|
||
<parameter name="return_accu" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="82">Accumulator to collect callback return values in, this
|
||
is the return value of the current signal emission.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="handler_return" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="84">A #GValue holding the return value of the signal handler.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="85">Callback data that was specified when creating the signal.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="SignalEmissionHook" c:type="GSignalEmissionHook">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="56">A simple function pointer to get invoked when the signal is emitted.
|
||
|
||
Emission hooks allow you to tie a hook to the signal type, so that it will
|
||
trap all emissions of that signal, from any object.
|
||
|
||
You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag.</doc>
|
||
<source-position filename="gsignal.h" line="75"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="72">whether it wants to stay connected. If it returns %FALSE, the signal
|
||
hook is disconnected (and destroyed).</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="ihint" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="58">Signal invocation hint, see #GSignalInvocationHint.</doc>
|
||
<type name="SignalInvocationHint" c:type="GSignalInvocationHint*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="59">the number of parameters to the function, including
|
||
the instance on which the signal was emitted.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="61">the instance on which
|
||
the signal was emitted, followed by the parameters of the emission.</doc>
|
||
<array length="1" zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="63">user data associated with the hook.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<bitfield name="SignalFlags" c:type="GSignalFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="110">The signal flags are used to specify a signal's behaviour.</doc>
|
||
<source-position filename="gsignal.h" line="151"/>
|
||
<member name="run_first" value="1" c:identifier="G_SIGNAL_RUN_FIRST">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="112">Invoke the object method handler in the first emission stage.</doc>
|
||
</member>
|
||
<member name="run_last" value="2" c:identifier="G_SIGNAL_RUN_LAST">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="113">Invoke the object method handler in the third emission stage.</doc>
|
||
</member>
|
||
<member name="run_cleanup" value="4" c:identifier="G_SIGNAL_RUN_CLEANUP">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="114">Invoke the object method handler in the last emission stage.</doc>
|
||
</member>
|
||
<member name="no_recurse" value="8" c:identifier="G_SIGNAL_NO_RECURSE">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="115">Signals being emitted for an object while currently being in
|
||
emission for this very object will not be emitted recursively,
|
||
but instead cause the first emission to be restarted.</doc>
|
||
</member>
|
||
<member name="detailed" value="16" c:identifier="G_SIGNAL_DETAILED">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="118">This signal supports "::detail" appendices to the signal name
|
||
upon handler connections and emissions.</doc>
|
||
</member>
|
||
<member name="action" value="32" c:identifier="G_SIGNAL_ACTION">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="120">Action signals are signals that may freely be emitted on alive
|
||
objects from user code via g_signal_emit() and friends, without
|
||
the need of being embedded into extra code that performs pre or
|
||
post emission adjustments on the object. They can also be thought
|
||
of as object methods which can be called generically by
|
||
third-party code.</doc>
|
||
</member>
|
||
<member name="no_hooks" value="64" c:identifier="G_SIGNAL_NO_HOOKS">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="126">No emissions hooks are supported for this signal.</doc>
|
||
</member>
|
||
<member name="must_collect"
|
||
value="128"
|
||
c:identifier="G_SIGNAL_MUST_COLLECT">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="127">Varargs signal emission will always collect the
|
||
arguments, even if there are no signal handlers connected. Since 2.30.</doc>
|
||
</member>
|
||
<member name="deprecated" value="256" c:identifier="G_SIGNAL_DEPRECATED">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="129">The signal is deprecated and will be removed
|
||
in a future version. A warning will be generated if it is connected while
|
||
running with G_ENABLE_DIAGNOSTIC=1. Since 2.32.</doc>
|
||
</member>
|
||
<member name="accumulator_first_run"
|
||
value="131072"
|
||
c:identifier="G_SIGNAL_ACCUMULATOR_FIRST_RUN">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="132">Only used in #GSignalAccumulator accumulator
|
||
functions for the #GSignalInvocationHint::run_type field to mark the first
|
||
call to the accumulator function for a signal emission. Since 2.68.</doc>
|
||
</member>
|
||
</bitfield>
|
||
<class name="SignalGroup"
|
||
c:symbol-prefix="signal_group"
|
||
c:type="GSignalGroup"
|
||
version="2.72"
|
||
parent="Object"
|
||
glib:type-name="GSignalGroup"
|
||
glib:get-type="g_signal_group_get_type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="549">#GSignalGroup manages to simplify the process of connecting
|
||
many signals to a #GObject as a group. As such there is no API
|
||
to disconnect a signal from the group.
|
||
|
||
In particular, this allows you to:
|
||
|
||
- Change the target instance, which automatically causes disconnection
|
||
of the signals from the old instance and connecting to the new instance.
|
||
- Block and unblock signals as a group
|
||
- Ensuring that blocked state transfers across target instances.
|
||
|
||
One place you might want to use such a structure is with #GtkTextView and
|
||
#GtkTextBuffer. Often times, you'll need to connect to many signals on
|
||
#GtkTextBuffer from a #GtkTextView subclass. This allows you to create a
|
||
signal group during instance construction, simply bind the
|
||
#GtkTextView:buffer property to #GSignalGroup:target and connect
|
||
all the signals you need. When the #GtkTextView:buffer property changes
|
||
all of the signals will be transitioned correctly.</doc>
|
||
<constructor name="new" c:identifier="g_signal_group_new" version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5125">Creates a new #GSignalGroup for target instances of @target_type.</doc>
|
||
<source-position filename="gsignalgroup.h" line="52"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5131">a new #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="target_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5127">the #GType of the target instance.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<method name="block" c:identifier="g_signal_group_block" version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4993">Blocks all signal handlers managed by @self so they will not
|
||
be called during any signal emissions. Must be unblocked exactly
|
||
the same number of times it has been blocked to become active again.
|
||
|
||
This blocked state will be kept across changes of the target instance.</doc>
|
||
<source-position filename="gsignalgroup.h" line="59"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4995">the #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect"
|
||
c:identifier="g_signal_group_connect"
|
||
version="2.72"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5007">Connects @c_handler to the signal @detailed_signal
|
||
on the target instance of @self.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="81"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5009">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5010">a string of the form "signal-name::detail"</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler"
|
||
transfer-ownership="none"
|
||
scope="notified"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5011">the #GCallback to connect</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5012">the data to pass to @c_handler calls</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect_after"
|
||
c:identifier="g_signal_group_connect_after"
|
||
version="2.72"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5023">Connects @c_handler to the signal @detailed_signal
|
||
on the target instance of @self.
|
||
|
||
The @c_handler will be called after the default handler of the signal.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="86"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5025">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5026">a string of the form "signal-name::detail"</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler"
|
||
transfer-ownership="none"
|
||
scope="notified"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5027">the #GCallback to connect</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5028">the data to pass to @c_handler calls</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect_closure"
|
||
c:identifier="g_signal_group_connect_closure"
|
||
version="2.74">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5041">Connects @closure to the signal @detailed_signal on #GSignalGroup:target.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="63"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5043">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5044">a string of the form `signal-name` with optional `::signal-detail`</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5045">the closure to connect.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="after" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5046">whether the handler should be called before or after the
|
||
default handler of the signal.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect_data"
|
||
c:identifier="g_signal_group_connect_data"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5057">Connects @c_handler to the signal @detailed_signal
|
||
on the target instance of @self.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="74"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5059">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5060">a string of the form "signal-name::detail"</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler"
|
||
transfer-ownership="none"
|
||
scope="notified"
|
||
closure="2"
|
||
destroy="3">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5061">the #GCallback to connect</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5062">the data to pass to @c_handler calls</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="notify" transfer-ownership="none" scope="notified">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5063">function to be called when disposing of @self</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5064">the flags used to create the signal connection</doc>
|
||
<type name="ConnectFlags" c:type="GConnectFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect_object"
|
||
c:identifier="g_signal_group_connect_object"
|
||
version="2.72"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5075">Connects @c_handler to the signal @detailed_signal on #GSignalGroup:target.
|
||
|
||
Ensures that the @object stays alive during the call to @c_handler
|
||
by temporarily adding a reference count. When the @object is destroyed
|
||
the signal handler will automatically be removed.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="68"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5077">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5078">a string of the form `signal-name` with optional `::signal-detail`</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler"
|
||
transfer-ownership="none"
|
||
scope="notified">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5079">the #GCallback to connect</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5080">the #GObject to pass as data to @c_handler calls</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5081">#GConnectFlags for the signal connection</doc>
|
||
<type name="ConnectFlags" c:type="GConnectFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="connect_swapped"
|
||
c:identifier="g_signal_group_connect_swapped"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5095">Connects @c_handler to the signal @detailed_signal
|
||
on the target instance of @self.
|
||
|
||
The instance on which the signal is emitted and @data
|
||
will be swapped when calling @c_handler.
|
||
|
||
You cannot connect a signal handler after #GSignalGroup:target has been set.</doc>
|
||
<source-position filename="gsignalgroup.h" line="91"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5097">a #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5098">a string of the form "signal-name::detail"</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler"
|
||
transfer-ownership="none"
|
||
scope="async"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5099">the #GCallback to connect</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5100">the data to pass to @c_handler calls</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_target"
|
||
c:identifier="g_signal_group_dup_target"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5114">Gets the target instance used when connecting signals.</doc>
|
||
<source-position filename="gsignalgroup.h" line="57"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5120">The target instance</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5116">the #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_target"
|
||
c:identifier="g_signal_group_set_target"
|
||
glib:set-property="target"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5136">Sets the target instance used when connecting signals. Any signal
|
||
that has been registered with g_signal_group_connect_object() or
|
||
similar functions will be connected to this object.
|
||
|
||
If the target instance was previously set, signals will be
|
||
disconnected from that object prior to connecting to @target.</doc>
|
||
<source-position filename="gsignalgroup.h" line="54"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5138">the #GSignalGroup.</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
<parameter name="target"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5139">The target instance used
|
||
when connecting signals.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unblock"
|
||
c:identifier="g_signal_group_unblock"
|
||
version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5153">Unblocks all signal handlers managed by @self so they will be
|
||
called again during any signal emissions unless it is blocked
|
||
again. Must be unblocked exactly the same number of times it
|
||
has been blocked to become active again.</doc>
|
||
<source-position filename="gsignalgroup.h" line="61"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="self" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5155">the #GSignalGroup</doc>
|
||
<type name="SignalGroup" c:type="GSignalGroup*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<property name="target"
|
||
version="2.72"
|
||
writable="1"
|
||
transfer-ownership="none"
|
||
setter="set_target">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="139">The target instance used when connecting signals.</doc>
|
||
<type name="Object"/>
|
||
</property>
|
||
<property name="target-type"
|
||
version="2.72"
|
||
writable="1"
|
||
construct-only="1"
|
||
transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="148">The #GType of the target property.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</property>
|
||
<glib:signal name="bind" when="last" version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="111">This signal is emitted when #GSignalGroup:target is set to a new value
|
||
other than %NULL. It is similar to #GObject::notify on `target` except it
|
||
will not emit when #GSignalGroup:target is %NULL and also allows for
|
||
receiving the #GObject without a data-race.</doc>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="114">a #GObject containing the new value for #GSignalGroup:target</doc>
|
||
<type name="Object"/>
|
||
</parameter>
|
||
</parameters>
|
||
</glib:signal>
|
||
<glib:signal name="unbind" when="last" version="2.72">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="125">This signal is emitted when the target instance of @self is set to a
|
||
new #GObject.
|
||
|
||
This signal will only be emitted if the previous target of @self is
|
||
non-%NULL.</doc>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</glib:signal>
|
||
</class>
|
||
<record name="SignalInvocationHint" c:type="GSignalInvocationHint">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="228">The #GSignalInvocationHint structure is used to pass on additional information
|
||
to callbacks during a signal emission.</doc>
|
||
<source-position filename="gsignal.h" line="246"/>
|
||
<field name="signal_id" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="230">The signal id of the signal invoking the callback</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="detail" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="231">The detail passed on for this emission</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</field>
|
||
<field name="run_type" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="232">The stage the signal emission is currently in, this
|
||
field will contain one of %G_SIGNAL_RUN_FIRST,
|
||
%G_SIGNAL_RUN_LAST or %G_SIGNAL_RUN_CLEANUP and %G_SIGNAL_ACCUMULATOR_FIRST_RUN.
|
||
%G_SIGNAL_ACCUMULATOR_FIRST_RUN is only set for the first run of the accumulator
|
||
function for a signal emission.</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</field>
|
||
</record>
|
||
<bitfield name="SignalMatchType" c:type="GSignalMatchType">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="176">The match types specify what g_signal_handlers_block_matched(),
|
||
g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched()
|
||
match signals by.</doc>
|
||
<source-position filename="gsignal.h" line="197"/>
|
||
<member name="id" value="1" c:identifier="G_SIGNAL_MATCH_ID">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="178">The signal id must be equal.</doc>
|
||
</member>
|
||
<member name="detail" value="2" c:identifier="G_SIGNAL_MATCH_DETAIL">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="179">The signal detail must be equal.</doc>
|
||
</member>
|
||
<member name="closure" value="4" c:identifier="G_SIGNAL_MATCH_CLOSURE">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="180">The closure must be the same.</doc>
|
||
</member>
|
||
<member name="func" value="8" c:identifier="G_SIGNAL_MATCH_FUNC">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="181">The C closure callback must be the same.</doc>
|
||
</member>
|
||
<member name="data" value="16" c:identifier="G_SIGNAL_MATCH_DATA">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="182">The closure data must be the same.</doc>
|
||
</member>
|
||
<member name="unblocked"
|
||
value="32"
|
||
c:identifier="G_SIGNAL_MATCH_UNBLOCKED">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="183">Only unblocked signals may be matched.</doc>
|
||
</member>
|
||
</bitfield>
|
||
<record name="SignalQuery" c:type="GSignalQuery">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="247">A structure holding in-depth information for a specific signal.
|
||
|
||
See also: g_signal_query()</doc>
|
||
<source-position filename="gsignal.h" line="277"/>
|
||
<field name="signal_id" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="249">The signal id of the signal being queried, or 0 if the
|
||
signal to be queried was unknown.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="signal_name" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="251">The signal name.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="itype" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="252">The interface/instance type that this signal can be emitted for.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="signal_flags" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="253">The signal flags as passed in to g_signal_new().</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</field>
|
||
<field name="return_type" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="254">The return type for user callbacks.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="n_params" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="255">The number of parameters that user callbacks take.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="param_types" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="256">The individual parameter types for
|
||
user callbacks, note that the effective callback signature is:
|
||
|[<!-- language="C" -->
|
||
@return_type callback (#gpointer data1,
|
||
[param_types param_names,]
|
||
gpointer data2);
|
||
]|</doc>
|
||
<array length="5" zero-terminated="0" c:type="const GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</field>
|
||
</record>
|
||
<function-macro name="TYPE_CHECK_CLASS_CAST"
|
||
c:identifier="G_TYPE_CHECK_CLASS_CAST"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="574">Checks that @g_class is a class structure of the type identified by @g_type
|
||
and issues a warning if this is not the case. Returns @g_class casted
|
||
to a pointer to @c_type. %NULL is not a valid class structure.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="586"/>
|
||
<parameters>
|
||
<parameter name="g_class">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="576">Location of a #GTypeClass structure</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="577">The type to be returned</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="578">The corresponding C type of class structure of @g_type</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_CLASS_TYPE"
|
||
c:identifier="G_TYPE_CHECK_CLASS_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="587">Checks if @g_class is a class structure of the type identified by
|
||
@g_type. If @g_class is %NULL, %FALSE will be returned.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="599"/>
|
||
<parameters>
|
||
<parameter name="g_class">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="589">Location of a #GTypeClass structure</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="590">The type to be checked</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_INSTANCE"
|
||
c:identifier="G_TYPE_CHECK_INSTANCE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="490">Checks if @instance is a valid #GTypeInstance structure,
|
||
otherwise issues a warning and returns %FALSE. %NULL is not a valid
|
||
#GTypeInstance.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="502"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="492">Location of a #GTypeInstance structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_INSTANCE_CAST"
|
||
c:identifier="G_TYPE_CHECK_INSTANCE_CAST"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="503">Checks that @instance is an instance of the type identified by @g_type
|
||
and issues a warning if this is not the case. Returns @instance casted
|
||
to a pointer to @c_type.
|
||
|
||
No warning will be issued if @instance is %NULL, and %NULL will be returned.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="517"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="505">Location of a #GTypeInstance structure</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="506">The type to be returned</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="507">The corresponding C type of @g_type</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE"
|
||
c:identifier="G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="531">Checks if @instance is an instance of the fundamental type identified by @g_type.
|
||
If @instance is %NULL, %FALSE will be returned.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="543"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="533">Location of a #GTypeInstance structure.</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="534">The fundamental type to be checked</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_INSTANCE_TYPE"
|
||
c:identifier="G_TYPE_CHECK_INSTANCE_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="518">Checks if @instance is an instance of the type identified by @g_type. If
|
||
@instance is %NULL, %FALSE will be returned.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="530"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="520">Location of a #GTypeInstance structure.</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="521">The type to be checked</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_VALUE"
|
||
c:identifier="G_TYPE_CHECK_VALUE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="600">Checks if @value has been initialized to hold values
|
||
of a value type.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="611"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="602">a #GValue</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CHECK_VALUE_TYPE"
|
||
c:identifier="G_TYPE_CHECK_VALUE_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="612">Checks if @value has been initialized to hold values
|
||
of type @g_type.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="624"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="614">a #GValue</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="615">The type to be checked</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_CLASS_GET_PRIVATE"
|
||
c:identifier="G_TYPE_CLASS_GET_PRIVATE"
|
||
version="2.24"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="679">Gets the private class structure for a particular type.
|
||
|
||
The private structure must have been registered in the
|
||
get_type() function with g_type_add_class_private().
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="695"/>
|
||
<parameters>
|
||
<parameter name="klass">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="681">the class of a type deriving from @private_type</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="682">the type identifying which private data to retrieve</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="683">The C type for the private structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="TYPE_FLAG_RESERVED_ID_BIT"
|
||
value="1"
|
||
c:type="G_TYPE_FLAG_RESERVED_ID_BIT">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="2573">A bit in the type number that's supposed to be left untouched.</doc>
|
||
<source-position filename="gtype.h" line="2578"/>
|
||
<type name="GLib.Type" c:type="GType"/>
|
||
</constant>
|
||
<function-macro name="TYPE_FROM_CLASS"
|
||
c:identifier="G_TYPE_FROM_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="636">Get the type identifier from a given @class structure.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="646"/>
|
||
<parameters>
|
||
<parameter name="g_class">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="638">Location of a valid #GTypeClass structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_FROM_INSTANCE"
|
||
c:identifier="G_TYPE_FROM_INSTANCE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="625">Get the type identifier from a given @instance structure.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="635"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="627">Location of a valid #GTypeInstance structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_FROM_INTERFACE"
|
||
c:identifier="G_TYPE_FROM_INTERFACE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="647">Get the type identifier from a given @interface structure.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="657"/>
|
||
<parameters>
|
||
<parameter name="g_iface">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="649">Location of a valid #GTypeInterface structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_FUNDAMENTAL"
|
||
c:identifier="G_TYPE_FUNDAMENTAL"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="33">The fundamental type which is the ancestor of @type.
|
||
|
||
Fundamental types are types that serve as ultimate bases for the derived types,
|
||
thus they are the roots of distinct inheritance hierarchies.</doc>
|
||
<source-position filename="gtype.h" line="42"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="35">A #GType value.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="TYPE_FUNDAMENTAL_MAX"
|
||
value="255"
|
||
c:type="G_TYPE_FUNDAMENTAL_MAX">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="43">An integer constant that represents the number of identifiers reserved
|
||
for types that are assigned at compile-time.</doc>
|
||
<source-position filename="gtype.h" line="49"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="TYPE_FUNDAMENTAL_SHIFT"
|
||
value="2"
|
||
c:type="G_TYPE_FUNDAMENTAL_SHIFT">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="210">Shift value used in converting numbers to type IDs.</doc>
|
||
<source-position filename="gtype.h" line="215"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="TYPE_HAS_VALUE_TABLE"
|
||
c:identifier="G_TYPE_HAS_VALUE_TABLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="371">Checks if @type has a #GTypeValueTable.</doc>
|
||
<source-position filename="gtype.h" line="379"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="373">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_INSTANCE_GET_CLASS"
|
||
c:identifier="G_TYPE_INSTANCE_GET_CLASS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="544">Get the class structure of a given @instance, casted
|
||
to a specified ancestor type @g_type of the instance.
|
||
|
||
Note that while calling a GInstanceInitFunc(), the class pointer
|
||
gets modified, so it might not always return the expected pointer.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="560"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="546">Location of the #GTypeInstance structure</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="547">The #GType of the class to be returned</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="548">The C type of the class structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_INSTANCE_GET_INTERFACE"
|
||
c:identifier="G_TYPE_INSTANCE_GET_INTERFACE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="561">Get the interface structure for interface @g_type of a given @instance.
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<source-position filename="gtype.h" line="573"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="563">Location of the #GTypeInstance structure</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="564">The #GType of the interface to be returned</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="565">The C type of the interface structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_INSTANCE_GET_PRIVATE"
|
||
c:identifier="G_TYPE_INSTANCE_GET_PRIVATE"
|
||
version="2.4"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.58">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="659">Gets the private structure for a particular type.
|
||
|
||
The private structure must have been registered in the
|
||
class_init function with g_type_class_add_private().
|
||
|
||
This macro should only be used in type implementations.</doc>
|
||
<doc-deprecated xml:space="preserve">Use G_ADD_PRIVATE() and the generated
|
||
`your_type_get_instance_private()` function instead</doc-deprecated>
|
||
<source-position filename="gtype.h" line="677"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="661">the instance of a type deriving from @private_type</doc>
|
||
</parameter>
|
||
<parameter name="g_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="662">the type identifying which private data to retrieve</doc>
|
||
</parameter>
|
||
<parameter name="c_type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="663">The C type for the private structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_ABSTRACT"
|
||
c:identifier="G_TYPE_IS_ABSTRACT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="340">Checks if @type is an abstract type. An abstract type cannot be
|
||
instantiated and is normally used as an abstract base class for
|
||
derived classes.</doc>
|
||
<source-position filename="gtype.h" line="350"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="342">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_BOXED"
|
||
c:identifier="G_TYPE_IS_BOXED"
|
||
introspectable="0">
|
||
<source-position filename="gboxed.h" line="35"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_CLASSED"
|
||
c:identifier="G_TYPE_IS_CLASSED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="301">Checks if @type is a classed type.</doc>
|
||
<source-position filename="gtype.h" line="309"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="303">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_DEEP_DERIVABLE"
|
||
c:identifier="G_TYPE_IS_DEEP_DERIVABLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="330">Checks if @type is a deep derivable type. A deep derivable type
|
||
can be used as the base class of a deep (multi-level) class hierarchy.</doc>
|
||
<source-position filename="gtype.h" line="339"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="332">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_DEPRECATED"
|
||
c:identifier="G_TYPE_IS_DEPRECATED"
|
||
version="2.76"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="393">Checks if @type is deprecated. Instantiating a deprecated type will
|
||
trigger a warning if running with `G_ENABLE_DIAGNOSTIC=1`.</doc>
|
||
<source-position filename="gtype.h" line="404"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="395">a #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_DERIVABLE"
|
||
c:identifier="G_TYPE_IS_DERIVABLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="320">Checks if @type is a derivable type. A derivable type can
|
||
be used as the base class of a flat (single-level) class hierarchy.</doc>
|
||
<source-position filename="gtype.h" line="329"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="322">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_DERIVED"
|
||
c:identifier="G_TYPE_IS_DERIVED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="274">Checks if @type is derived (or in object-oriented terminology:
|
||
inherited) from another type (this holds true for all non-fundamental
|
||
types).</doc>
|
||
<source-position filename="gtype.h" line="284"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="276">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_ENUM"
|
||
c:identifier="G_TYPE_IS_ENUM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="31">Checks whether @type "is a" %G_TYPE_ENUM.</doc>
|
||
<source-position filename="genums.h" line="39"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="33">a #GType ID.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_FINAL"
|
||
c:identifier="G_TYPE_IS_FINAL"
|
||
version="2.70"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="380">Checks if @type is a final type. A final type cannot be derived any
|
||
further.</doc>
|
||
<source-position filename="gtype.h" line="391"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="382">a #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_FLAGS"
|
||
c:identifier="G_TYPE_IS_FLAGS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="75">Checks whether @type "is a" %G_TYPE_FLAGS.</doc>
|
||
<source-position filename="genums.h" line="83"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="77">a #GType ID.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_FUNDAMENTAL"
|
||
c:identifier="G_TYPE_IS_FUNDAMENTAL"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="265">Checks if @type is a fundamental type.</doc>
|
||
<source-position filename="gtype.h" line="273"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="267">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_INSTANTIATABLE"
|
||
c:identifier="G_TYPE_IS_INSTANTIATABLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="310">Checks if @type can be instantiated. Instantiation is the
|
||
process of creating an instance (object) of this type.</doc>
|
||
<source-position filename="gtype.h" line="319"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="312">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_INTERFACE"
|
||
c:identifier="G_TYPE_IS_INTERFACE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="285">Checks if @type is an interface type.
|
||
|
||
An interface type provides a pure API, the implementation
|
||
of which is provided by another type (which is then said to conform
|
||
to the interface). GLib interfaces are somewhat analogous to Java
|
||
interfaces and C++ classes containing only pure virtual functions,
|
||
with the difference that GType interfaces are not derivable (but see
|
||
g_type_interface_add_prerequisite() for an alternative).</doc>
|
||
<source-position filename="gtype.h" line="300"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="287">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_OBJECT"
|
||
c:identifier="G_TYPE_IS_OBJECT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="36">Check if the passed in type id is a %G_TYPE_OBJECT or derived from it.</doc>
|
||
<source-position filename="gobject.h" line="44"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="38">Type id to check</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_PARAM"
|
||
c:identifier="G_TYPE_IS_PARAM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="33">Checks whether @type "is a" %G_TYPE_PARAM.</doc>
|
||
<source-position filename="gparam.h" line="39"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="35">a #GType ID</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_VALUE"
|
||
c:identifier="G_TYPE_IS_VALUE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="33">Checks whether the passed in type ID can be used for g_value_init().
|
||
|
||
That is, this macro checks whether this type provides an implementation
|
||
of the #GTypeValueTable functions required for a type to create a #GValue of.</doc>
|
||
<source-position filename="gvalue.h" line="44"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="35">A #GType value.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_VALUE_ABSTRACT"
|
||
c:identifier="G_TYPE_IS_VALUE_ABSTRACT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="351">Checks if @type is an abstract value type. An abstract value type introduces
|
||
a value table, but can't be used for g_value_init() and is normally used as
|
||
an abstract base type for derived value types.</doc>
|
||
<source-position filename="gtype.h" line="361"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="353">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_IS_VALUE_TYPE"
|
||
c:identifier="G_TYPE_IS_VALUE_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="362">Checks if @type is a value type and can be used with g_value_init().</doc>
|
||
<source-position filename="gtype.h" line="370"/>
|
||
<parameters>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="364">A #GType value</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_MAKE_FUNDAMENTAL"
|
||
c:identifier="G_TYPE_MAKE_FUNDAMENTAL"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="216">Get the type ID for the fundamental type number @x.
|
||
|
||
Use g_type_fundamental_next() instead of this macro to create new fundamental
|
||
types.</doc>
|
||
<source-position filename="gtype.h" line="227"/>
|
||
<parameters>
|
||
<parameter name="x">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="218">the fundamental type number.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_MODULE"
|
||
c:identifier="G_TYPE_MODULE"
|
||
introspectable="0">
|
||
<source-position filename="gtypemodule.h" line="35"/>
|
||
<parameters>
|
||
<parameter name="module">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_MODULE_CLASS"
|
||
c:identifier="G_TYPE_MODULE_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypemodule.h" line="36"/>
|
||
<parameters>
|
||
<parameter name="class">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_MODULE_GET_CLASS"
|
||
c:identifier="G_TYPE_MODULE_GET_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypemodule.h" line="39"/>
|
||
<parameters>
|
||
<parameter name="module">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_PLUGIN"
|
||
c:identifier="G_TYPE_PLUGIN"
|
||
introspectable="0">
|
||
<source-position filename="gtypeplugin.h" line="32"/>
|
||
<parameters>
|
||
<parameter name="inst">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_PLUGIN_CLASS"
|
||
c:identifier="G_TYPE_PLUGIN_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypeplugin.h" line="33"/>
|
||
<parameters>
|
||
<parameter name="vtable">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="TYPE_PLUGIN_GET_CLASS"
|
||
c:identifier="G_TYPE_PLUGIN_GET_CLASS"
|
||
introspectable="0">
|
||
<source-position filename="gtypeplugin.h" line="36"/>
|
||
<parameters>
|
||
<parameter name="inst">
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="TYPE_RESERVED_BSE_FIRST"
|
||
value="32"
|
||
c:type="G_TYPE_RESERVED_BSE_FIRST">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="241">First fundamental type number to create a new fundamental type id with
|
||
G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.</doc>
|
||
<source-position filename="gtype.h" line="247"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="TYPE_RESERVED_BSE_LAST"
|
||
value="48"
|
||
c:type="G_TYPE_RESERVED_BSE_LAST">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="248">Last fundamental type number reserved for BSE.</doc>
|
||
<source-position filename="gtype.h" line="253"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="TYPE_RESERVED_GLIB_FIRST"
|
||
value="22"
|
||
c:type="G_TYPE_RESERVED_GLIB_FIRST">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="228">First fundamental type number to create a new fundamental type id with
|
||
G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.</doc>
|
||
<source-position filename="gtype.h" line="234"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="TYPE_RESERVED_GLIB_LAST"
|
||
value="31"
|
||
c:type="G_TYPE_RESERVED_GLIB_LAST">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="235">Last fundamental type number reserved for GLib.</doc>
|
||
<source-position filename="gtype.h" line="240"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<constant name="TYPE_RESERVED_USER_FIRST"
|
||
value="49"
|
||
c:type="G_TYPE_RESERVED_USER_FIRST">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="254">First available fundamental type number to create new fundamental
|
||
type id with G_TYPE_MAKE_FUNDAMENTAL().</doc>
|
||
<source-position filename="gtype.h" line="260"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<callback name="ToggleNotify" c:type="GToggleNotify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="552">A callback function used for notification when the state
|
||
of a toggle reference changes.
|
||
|
||
See also: g_object_add_toggle_ref()</doc>
|
||
<source-position filename="gobject.h" line="566"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="554">Callback data passed to g_object_add_toggle_ref()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="555">The object on which g_object_add_toggle_ref() was called.</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
<parameter name="is_last_ref" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="556">%TRUE if the toggle reference is now the
|
||
last reference to the object. %FALSE if the toggle
|
||
reference was the last reference and there are now other
|
||
references.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<union name="TypeCValue" c:type="GTypeCValue">
|
||
<source-position filename="gtype.h" line="421"/>
|
||
</union>
|
||
<record name="TypeClass" c:type="GTypeClass">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="435">An opaque structure used as the base of all classes.</doc>
|
||
<source-position filename="gtype.h" line="444"/>
|
||
<field name="g_type" readable="0" private="1">
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<method name="add_private"
|
||
c:identifier="g_type_class_add_private"
|
||
version="2.4"
|
||
deprecated="1"
|
||
deprecated-version="2.58">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5855">Registers a private structure for an instantiatable type.
|
||
|
||
When an object is allocated, the private structures for
|
||
the type and all of its parent types are allocated
|
||
sequentially in the same memory block as the public
|
||
structures, and are zero-filled.
|
||
|
||
Note that the accumulated size of the private structures of
|
||
a type and all its parent types cannot exceed 64 KiB.
|
||
|
||
This function should be called in the type's class_init() function.
|
||
The private structure can be retrieved using the
|
||
G_TYPE_INSTANCE_GET_PRIVATE() macro.
|
||
|
||
The following example shows attaching a private structure
|
||
MyObjectPrivate to an object MyObject defined in the standard
|
||
GObject fashion in the type's class_init() function.
|
||
|
||
Note the use of a structure member "priv" to avoid the overhead
|
||
of repeatedly calling MY_OBJECT_GET_PRIVATE().
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct _MyObject MyObject;
|
||
typedef struct _MyObjectPrivate MyObjectPrivate;
|
||
|
||
struct _MyObject {
|
||
GObject parent;
|
||
|
||
MyObjectPrivate *priv;
|
||
};
|
||
|
||
struct _MyObjectPrivate {
|
||
int some_field;
|
||
};
|
||
|
||
static void
|
||
my_object_class_init (MyObjectClass *klass)
|
||
{
|
||
g_type_class_add_private (klass, sizeof (MyObjectPrivate));
|
||
}
|
||
|
||
static void
|
||
my_object_init (MyObject *my_object)
|
||
{
|
||
my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
|
||
MY_TYPE_OBJECT,
|
||
MyObjectPrivate);
|
||
// my_object->priv->some_field will be automatically initialised to 0
|
||
}
|
||
|
||
static int
|
||
my_object_get_some_field (MyObject *my_object)
|
||
{
|
||
MyObjectPrivate *priv;
|
||
|
||
g_return_val_if_fail (MY_IS_OBJECT (my_object), 0);
|
||
|
||
priv = my_object->priv;
|
||
|
||
return priv->some_field;
|
||
}
|
||
]|</doc>
|
||
<doc-deprecated xml:space="preserve">Use the G_ADD_PRIVATE() macro with the `G_DEFINE_*`
|
||
family of macros to add instance private data to a type</doc-deprecated>
|
||
<source-position filename="gtype.h" line="1374"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5857">class structure for an instantiatable
|
||
type</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
<parameter name="private_size" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5859">size of private structure</doc>
|
||
<type name="gsize" c:type="gsize"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_instance_private_offset"
|
||
c:identifier="g_type_class_get_instance_private_offset"
|
||
version="2.38"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5930">Gets the offset of the private data for instances of @g_class.
|
||
|
||
This is how many bytes you should add to the instance pointer of a
|
||
class in order to get the private data for the type represented by
|
||
@g_class.
|
||
|
||
You can only call this function after you have registered a private
|
||
data area for @g_class using g_type_class_add_private().</doc>
|
||
<source-position filename="gtype.h" line="1393"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5943">the offset, in bytes</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5932">a #GTypeClass</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_private" c:identifier="g_type_class_get_private">
|
||
<source-position filename="gtype.h" line="1390"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="klass" transfer-ownership="none">
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</instance-parameter>
|
||
<parameter name="private_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="peek_parent" c:identifier="g_type_class_peek_parent">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5964">This is a convenience function often needed in class initializers.
|
||
It returns the class structure of the immediate parent type of the
|
||
class passed in. Since derived classes hold a reference count on
|
||
their parent classes as long as they are instantiated, the returned
|
||
class will always exist.
|
||
|
||
This function is essentially equivalent to:
|
||
g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)))</doc>
|
||
<source-position filename="gtype.h" line="760"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5978">the parent class
|
||
of @g_class</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5966">the #GTypeClass structure to
|
||
retrieve the parent class for</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unref" c:identifier="g_type_class_unref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6010">Decrements the reference count of the class structure being passed in.
|
||
Once the last reference count of a class has been released, classes
|
||
may be finalized by the type system, so further dereferencing of a
|
||
class pointer after g_type_class_unref() are invalid.</doc>
|
||
<source-position filename="gtype.h" line="758"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6012">a #GTypeClass structure to unref</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unref_uncached"
|
||
c:identifier="g_type_class_unref_uncached"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6021">A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
|
||
implementations. It unreferences a class without consulting the chain
|
||
of #GTypeClassCacheFuncs, avoiding the recursion which would occur
|
||
otherwise.</doc>
|
||
<source-position filename="gtype.h" line="2471"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6023">a #GTypeClass structure to unref</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<function name="adjust_private_offset"
|
||
c:identifier="g_type_class_adjust_private_offset">
|
||
<source-position filename="gtype.h" line="1383"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="private_size_or_offset" transfer-ownership="none">
|
||
<type name="gint" c:type="gint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="peek" c:identifier="g_type_class_peek">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5948">This function is essentially the same as g_type_class_ref(),
|
||
except that the classes reference count isn't incremented.
|
||
As a consequence, this function may return %NULL if the class
|
||
of the type passed in does not currently exist (hasn't been
|
||
referenced before).</doc>
|
||
<source-position filename="gtype.h" line="754"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5958">the #GTypeClass
|
||
structure for the given type ID or %NULL if the class does not
|
||
currently exist</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5950">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="peek_static"
|
||
c:identifier="g_type_class_peek_static"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5983">A more efficient version of g_type_class_peek() which works only for
|
||
static types.</doc>
|
||
<source-position filename="gtype.h" line="756"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5990">the #GTypeClass
|
||
structure for the given type ID or %NULL if the class does not
|
||
currently exist or is dynamically loaded</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5985">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="ref" c:identifier="g_type_class_ref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5997">Increments the reference count of the class structure belonging to
|
||
@type. This function will demand-create the class if it doesn't
|
||
exist already.</doc>
|
||
<source-position filename="gtype.h" line="752"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6005">the #GTypeClass
|
||
structure for the given type ID</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5999">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<callback name="TypeClassCacheFunc" c:type="GTypeClassCacheFunc">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1001">A callback function which is called when the reference count of a class
|
||
drops to zero.
|
||
|
||
It may use g_type_class_ref() to prevent the class from being freed. You
|
||
should not call g_type_class_unref() from a #GTypeClassCacheFunc function
|
||
to prevent infinite recursion, use g_type_class_unref_uncached() instead.
|
||
|
||
The functions have to check the class id passed in to figure
|
||
whether they actually want to cache the class of this type, since all
|
||
classes are routed through the same #GTypeClassCacheFunc chain.</doc>
|
||
<source-position filename="gtype.h" line="1021"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1018">%TRUE to stop further #GTypeClassCacheFuncs from being
|
||
called, %FALSE to continue</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="cache_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1003">data that was given to the g_type_add_class_cache_func() call</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1004">The #GTypeClass structure which is
|
||
unreferenced</doc>
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<bitfield name="TypeDebugFlags"
|
||
deprecated="1"
|
||
deprecated-version="2.36"
|
||
c:type="GTypeDebugFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="697">These flags used to be passed to g_type_init_with_debug_flags() which
|
||
is now deprecated.
|
||
|
||
If you need to enable debugging features, use the GOBJECT_DEBUG
|
||
environment variable.</doc>
|
||
<doc-deprecated xml:space="preserve">g_type_init() is now done automatically</doc-deprecated>
|
||
<source-position filename="gtype.h" line="720"/>
|
||
<member name="none" value="0" c:identifier="G_TYPE_DEBUG_NONE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="699">Print no messages</doc>
|
||
</member>
|
||
<member name="objects" value="1" c:identifier="G_TYPE_DEBUG_OBJECTS">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="700">Print messages about object bookkeeping</doc>
|
||
</member>
|
||
<member name="signals" value="2" c:identifier="G_TYPE_DEBUG_SIGNALS">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="701">Print messages about signal emissions</doc>
|
||
</member>
|
||
<member name="instance_count"
|
||
value="4"
|
||
c:identifier="G_TYPE_DEBUG_INSTANCE_COUNT">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="703">Keep a count of instances of each type</doc>
|
||
</member>
|
||
<member name="mask" value="7" c:identifier="G_TYPE_DEBUG_MASK">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="702">Mask covering all debug flags</doc>
|
||
</member>
|
||
</bitfield>
|
||
<bitfield name="TypeFlags" c:type="GTypeFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1056">Bit masks used to check or determine characteristics of a type.</doc>
|
||
<source-position filename="gtype.h" line="1079"/>
|
||
<member name="none" value="0" c:identifier="G_TYPE_FLAG_NONE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1058">No special flags. Since: 2.74</doc>
|
||
</member>
|
||
<member name="abstract" value="16" c:identifier="G_TYPE_FLAG_ABSTRACT">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1059">Indicates an abstract type. No instances can be
|
||
created for an abstract type</doc>
|
||
</member>
|
||
<member name="value_abstract"
|
||
value="32"
|
||
c:identifier="G_TYPE_FLAG_VALUE_ABSTRACT">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1061">Indicates an abstract value type, i.e. a type
|
||
that introduces a value table, but can't be used for
|
||
g_value_init()</doc>
|
||
</member>
|
||
<member name="final" value="64" c:identifier="G_TYPE_FLAG_FINAL">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1064">Indicates a final type. A final type is a non-derivable
|
||
leaf node in a deep derivable type hierarchy tree. Since: 2.70</doc>
|
||
</member>
|
||
<member name="deprecated"
|
||
value="128"
|
||
c:identifier="G_TYPE_FLAG_DEPRECATED">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1066">The type is deprecated and may be removed in a
|
||
future version. A warning will be emitted if it is instantiated while
|
||
running with `G_ENABLE_DIAGNOSTIC=1`. Since 2.76</doc>
|
||
</member>
|
||
</bitfield>
|
||
<bitfield name="TypeFundamentalFlags" c:type="GTypeFundamentalFlags">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1037">Bit masks used to check or determine specific characteristics of a
|
||
fundamental type.</doc>
|
||
<source-position filename="gtype.h" line="1055"/>
|
||
<member name="classed" value="1" c:identifier="G_TYPE_FLAG_CLASSED">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1039">Indicates a classed type</doc>
|
||
</member>
|
||
<member name="instantiatable"
|
||
value="2"
|
||
c:identifier="G_TYPE_FLAG_INSTANTIATABLE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1040">Indicates an instantiatable type (implies classed)</doc>
|
||
</member>
|
||
<member name="derivable" value="4" c:identifier="G_TYPE_FLAG_DERIVABLE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1041">Indicates a flat derivable type</doc>
|
||
</member>
|
||
<member name="deep_derivable"
|
||
value="8"
|
||
c:identifier="G_TYPE_FLAG_DEEP_DERIVABLE">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1042">Indicates a deep derivable type (implies derivable)</doc>
|
||
</member>
|
||
</bitfield>
|
||
<record name="TypeFundamentalInfo" c:type="GTypeFundamentalInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1132">A structure that provides information to the type system which is
|
||
used specifically for managing fundamental types.</doc>
|
||
<source-position filename="gtype.h" line="1142"/>
|
||
<field name="type_flags" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1134">#GTypeFundamentalFlags describing the characteristics of the fundamental type</doc>
|
||
<type name="TypeFundamentalFlags" c:type="GTypeFundamentalFlags"/>
|
||
</field>
|
||
</record>
|
||
<record name="TypeInfo" c:type="GTypeInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1080">This structure is used to provide the type system with the information
|
||
required to initialize and destruct (finalize) a type's class and
|
||
its instances.
|
||
|
||
The initialized structure is passed to the g_type_register_static() function
|
||
(or is copied into the provided #GTypeInfo structure in the
|
||
g_type_plugin_complete_type_info()). The type system will perform a deep
|
||
copy of this structure, so its memory does not need to be persistent
|
||
across invocation of g_type_register_static().</doc>
|
||
<source-position filename="gtype.h" line="1131"/>
|
||
<field name="class_size" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1082">Size of the class structure (required for interface, classed and instantiatable types)</doc>
|
||
<type name="guint16" c:type="guint16"/>
|
||
</field>
|
||
<field name="base_init" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1083">Location of the base initialization function (optional)</doc>
|
||
<type name="BaseInitFunc" c:type="GBaseInitFunc"/>
|
||
</field>
|
||
<field name="base_finalize" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1084">Location of the base finalization function (optional)</doc>
|
||
<type name="BaseFinalizeFunc" c:type="GBaseFinalizeFunc"/>
|
||
</field>
|
||
<field name="class_init" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1085">Location of the class initialization function for
|
||
classed and instantiatable types. Location of the default vtable
|
||
inititalization function for interface types. (optional) This function
|
||
is used both to fill in virtual functions in the class or default vtable,
|
||
and to do type-specific setup such as registering signals and object
|
||
properties.</doc>
|
||
<type name="ClassInitFunc" c:type="GClassInitFunc"/>
|
||
</field>
|
||
<field name="class_finalize" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1091">Location of the class finalization function for
|
||
classed and instantiatable types. Location of the default vtable
|
||
finalization function for interface types. (optional)</doc>
|
||
<type name="ClassFinalizeFunc" c:type="GClassFinalizeFunc"/>
|
||
</field>
|
||
<field name="class_data" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1094">User-supplied data passed to the class init/finalize functions</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</field>
|
||
<field name="instance_size" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1095">Size of the instance (object) structure (required for instantiatable types only)</doc>
|
||
<type name="guint16" c:type="guint16"/>
|
||
</field>
|
||
<field name="n_preallocs" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1096">Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10 this field is ignored.</doc>
|
||
<type name="guint16" c:type="guint16"/>
|
||
</field>
|
||
<field name="instance_init" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1097">Location of the instance initialization function (optional, for instantiatable types only)</doc>
|
||
<type name="InstanceInitFunc" c:type="GInstanceInitFunc"/>
|
||
</field>
|
||
<field name="value_table" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1098">A #GTypeValueTable function table for generic handling of GValues
|
||
of this type (usually only useful for fundamental types)</doc>
|
||
<type name="TypeValueTable" c:type="const GTypeValueTable*"/>
|
||
</field>
|
||
</record>
|
||
<record name="TypeInstance" c:type="GTypeInstance">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="445">An opaque structure used as the base of all type instances.</doc>
|
||
<source-position filename="gtype.h" line="454"/>
|
||
<field name="g_class" readable="0" private="1">
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</field>
|
||
<method name="get_private" c:identifier="g_type_instance_get_private">
|
||
<source-position filename="gtype.h" line="1380"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="instance" transfer-ownership="none">
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</instance-parameter>
|
||
<parameter name="private_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
</record>
|
||
<record name="TypeInterface" c:type="GTypeInterface">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="455">An opaque structure used as the base of all interface types.</doc>
|
||
<source-position filename="gtype.h" line="465"/>
|
||
<field name="g_type" readable="0" private="1">
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="g_instance_type" readable="0" private="1">
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<method name="peek_parent" c:identifier="g_type_interface_peek_parent">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6331">Returns the corresponding #GTypeInterface structure of the parent type
|
||
of the instance type to which @g_iface belongs. This is useful when
|
||
deriving the implementation of an interface from the parent type and
|
||
then possibly overriding some methods.</doc>
|
||
<source-position filename="gtype.h" line="765"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6340">the
|
||
corresponding #GTypeInterface structure of the parent type of the
|
||
instance type to which @g_iface belongs, or %NULL if the parent
|
||
type doesn't conform to the interface</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6333">a #GTypeInterface structure</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<function name="add_prerequisite"
|
||
c:identifier="g_type_interface_add_prerequisite">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6273">Adds @prerequisite_type to the list of prerequisites of @interface_type.
|
||
This means that any type implementing @interface_type must also implement
|
||
@prerequisite_type. Prerequisites can be thought of as an alternative to
|
||
interface derivation (which GType doesn't support). An interface can have
|
||
at most one instantiatable prerequisite type.</doc>
|
||
<source-position filename="gtype.h" line="1365"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6275">#GType value of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="prerequisite_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6276">#GType value of an interface or instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="get_plugin" c:identifier="g_type_interface_get_plugin">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6286">Returns the #GTypePlugin structure for the dynamic interface
|
||
@interface_type which has been added to @instance_type, or %NULL
|
||
if @interface_type has not been added to @instance_type or does
|
||
not have a #GTypePlugin structure. See g_type_add_interface_dynamic().</doc>
|
||
<source-position filename="gtype.h" line="2453"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6296">the #GTypePlugin for the dynamic
|
||
interface @interface_type of @instance_type</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6288">#GType of an instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6289">#GType of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="instantiatable_prerequisite"
|
||
c:identifier="g_type_interface_instantiatable_prerequisite"
|
||
version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6301">Returns the most specific instantiatable prerequisite of an
|
||
interface type. If the interface type has no instantiatable
|
||
prerequisite, %G_TYPE_INVALID is returned.
|
||
|
||
See g_type_interface_add_prerequisite() for more information
|
||
about prerequisites.</doc>
|
||
<source-position filename="gtype.h" line="1371"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6312">the instantiatable prerequisite type or %G_TYPE_INVALID if none</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6303">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="peek" c:identifier="g_type_interface_peek">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6317">Returns the #GTypeInterface structure of an interface to which the
|
||
passed in class conforms.</doc>
|
||
<source-position filename="gtype.h" line="762"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6325">the #GTypeInterface
|
||
structure of @iface_type if implemented by @instance_class, %NULL
|
||
otherwise</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6319">a #GTypeClass structure</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="iface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6320">an interface ID which this class conforms to</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="prerequisites"
|
||
c:identifier="g_type_interface_prerequisites"
|
||
version="2.2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6347">Returns the prerequisites of an interfaces type.</doc>
|
||
<source-position filename="gtype.h" line="1368"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6356">a
|
||
newly-allocated zero-terminated array of #GType containing
|
||
the prerequisites of @interface_type</doc>
|
||
<array length="1" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6349">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_prerequisites"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full"
|
||
optional="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6350">location to return the number
|
||
of prerequisites, or %NULL</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<callback name="TypeInterfaceCheckFunc"
|
||
c:type="GTypeInterfaceCheckFunc"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1023">A callback called after an interface vtable is initialized.
|
||
|
||
See g_type_add_interface_check().</doc>
|
||
<source-position filename="gtype.h" line="1035"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="check_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1025">data passed to g_type_add_interface_check()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1026">the interface that has been
|
||
initialized</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<class name="TypeModule"
|
||
c:symbol-prefix="type_module"
|
||
c:type="GTypeModule"
|
||
parent="Object"
|
||
abstract="1"
|
||
glib:type-name="GTypeModule"
|
||
glib:get-type="g_type_module_get_type"
|
||
glib:type-struct="TypeModuleClass">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="623">#GTypeModule provides a simple implementation of the #GTypePlugin
|
||
interface.
|
||
|
||
The model of #GTypeModule is a dynamically loaded module which
|
||
implements some number of types and interface implementations.
|
||
|
||
When the module is loaded, it registers its types and interfaces
|
||
using g_type_module_register_type() and g_type_module_add_interface().
|
||
As long as any instances of these types and interface implementations
|
||
are in use, the module is kept loaded. When the types and interfaces
|
||
are gone, the module may be unloaded. If the types and interfaces
|
||
become used again, the module will be reloaded. Note that the last
|
||
reference cannot be released from within the module code, since that
|
||
would lead to the caller's code being unloaded before g_object_unref()
|
||
returns to it.
|
||
|
||
Keeping track of whether the module should be loaded or not is done by
|
||
using a use count - it starts at zero, and whenever it is greater than
|
||
zero, the module is loaded. The use count is maintained internally by
|
||
the type system, but also can be explicitly controlled by
|
||
g_type_module_use() and g_type_module_unuse(). Typically, when loading
|
||
a module for the first type, g_type_module_use() will be used to load
|
||
it so that it can initialize its types. At some later point, when the
|
||
module no longer needs to be loaded except for the type
|
||
implementations it contains, g_type_module_unuse() is called.
|
||
|
||
#GTypeModule does not actually provide any implementation of module
|
||
loading and unloading. To create a particular module type you must
|
||
derive from #GTypeModule and implement the load and unload functions
|
||
in #GTypeModuleClass.</doc>
|
||
<source-position filename="gtypemodule.h" line="86"/>
|
||
<implements name="TypePlugin"/>
|
||
<virtual-method name="load">
|
||
<source-position filename="gtypemodule.h" line="77"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module" transfer-ownership="none">
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<virtual-method name="unload">
|
||
<source-position filename="gtypemodule.h" line="78"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module" transfer-ownership="none">
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</virtual-method>
|
||
<method name="add_interface" c:identifier="g_type_module_add_interface">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6390">Registers an additional interface for a type, whose interface lives
|
||
in the given type plugin. If the interface was already registered
|
||
for the type in this plugin, nothing will be done.
|
||
|
||
As long as any instances of the type exist, the type plugin will
|
||
not be unloaded.
|
||
|
||
Since 2.56 if @module is %NULL this will call g_type_add_interface_static()
|
||
instead. This can be used when making a static build of the module.</doc>
|
||
<source-position filename="gtypemodule.h" line="287"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6392">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6393">type to which to add the interface.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6394">interface type to add</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6395">type information structure</doc>
|
||
<type name="InterfaceInfo" c:type="const GInterfaceInfo*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="register_enum"
|
||
c:identifier="g_type_module_register_enum"
|
||
version="2.6">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6409">Looks up or registers an enumeration that is implemented with a particular
|
||
type plugin. If a type with name @type_name was previously registered,
|
||
the #GType identifier for the type is returned, otherwise the type
|
||
is newly registered, and the resulting #GType identifier returned.
|
||
|
||
As long as any instances of the type exist, the type plugin will
|
||
not be unloaded.
|
||
|
||
Since 2.56 if @module is %NULL this will call g_type_register_static()
|
||
instead. This can be used when making a static build of the module.</doc>
|
||
<source-position filename="gtypemodule.h" line="292"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6430">the new or existing type ID</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6411">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6412">name for the type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="const_static_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6413">an array of #GEnumValue structs for the
|
||
possible enumeration values. The array is
|
||
terminated by a struct with all members being
|
||
0.</doc>
|
||
<type name="EnumValue" c:type="const GEnumValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="register_flags"
|
||
c:identifier="g_type_module_register_flags"
|
||
version="2.6">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6434">Looks up or registers a flags type that is implemented with a particular
|
||
type plugin. If a type with name @type_name was previously registered,
|
||
the #GType identifier for the type is returned, otherwise the type
|
||
is newly registered, and the resulting #GType identifier returned.
|
||
|
||
As long as any instances of the type exist, the type plugin will
|
||
not be unloaded.
|
||
|
||
Since 2.56 if @module is %NULL this will call g_type_register_static()
|
||
instead. This can be used when making a static build of the module.</doc>
|
||
<source-position filename="gtypemodule.h" line="296"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6455">the new or existing type ID</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6436">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6437">name for the type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="const_static_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6438">an array of #GFlagsValue structs for the
|
||
possible flags values. The array is
|
||
terminated by a struct with all members being
|
||
0.</doc>
|
||
<type name="FlagsValue" c:type="const GFlagsValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="register_type" c:identifier="g_type_module_register_type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6459">Looks up or registers a type that is implemented with a particular
|
||
type plugin. If a type with name @type_name was previously registered,
|
||
the #GType identifier for the type is returned, otherwise the type
|
||
is newly registered, and the resulting #GType identifier returned.
|
||
|
||
When reregistering a type (typically because a module is unloaded
|
||
then reloaded, and reinitialized), @module and @parent_type must
|
||
be the same as they were previously.
|
||
|
||
As long as any instances of the type exist, the type plugin will
|
||
not be unloaded.
|
||
|
||
Since 2.56 if @module is %NULL this will call g_type_register_static()
|
||
instead. This can be used when making a static build of the module.</doc>
|
||
<source-position filename="gtypemodule.h" line="281"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6482">the new or existing type ID</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6461">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
<parameter name="parent_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6462">the type for the parent class</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="type_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6463">name for the type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="type_info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6464">type information structure</doc>
|
||
<type name="TypeInfo" c:type="const GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6465">flags field providing details about the type</doc>
|
||
<type name="TypeFlags" c:type="GTypeFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_name" c:identifier="g_type_module_set_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6486">Sets the name for a #GTypeModule</doc>
|
||
<source-position filename="gtypemodule.h" line="278"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6488">a #GTypeModule.</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6489">a human-readable name to use in error messages.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unuse" c:identifier="g_type_module_unuse">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6495">Decreases the use count of a #GTypeModule by one. If the
|
||
result is zero, the module will be unloaded. (However, the
|
||
#GTypeModule will not be freed, and types associated with the
|
||
#GTypeModule are not unregistered. Once a #GTypeModule is
|
||
initialized, it must exist forever.)</doc>
|
||
<source-position filename="gtypemodule.h" line="276"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6497">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="use" c:identifier="g_type_module_use">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6507">Increases the use count of a #GTypeModule by one. If the
|
||
use count was zero before, the plugin will be loaded.
|
||
If loading the plugin fails, the use count is reset to
|
||
its prior value.</doc>
|
||
<source-position filename="gtypemodule.h" line="274"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6516">%FALSE if the plugin needed to be loaded and
|
||
loading the plugin failed.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="module" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6509">a #GTypeModule</doc>
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<field name="parent_instance">
|
||
<type name="Object" c:type="GObject"/>
|
||
</field>
|
||
<field name="use_count">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="type_infos">
|
||
<type name="GLib.SList" c:type="GSList*">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</type>
|
||
</field>
|
||
<field name="interface_infos">
|
||
<type name="GLib.SList" c:type="GSList*">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</type>
|
||
</field>
|
||
<field name="name">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="45">the name of the module</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</field>
|
||
</class>
|
||
<record name="TypeModuleClass"
|
||
c:type="GTypeModuleClass"
|
||
glib:is-gtype-struct-for="TypeModule">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="62">In order to implement dynamic loading of types based on #GTypeModule,
|
||
the @load and @unload functions in #GTypeModuleClass must be implemented.</doc>
|
||
<source-position filename="gtypemodule.h" line="86"/>
|
||
<field name="parent_class">
|
||
<doc xml:space="preserve"
|
||
filename="gtypemodule.h"
|
||
line="64">the parent class</doc>
|
||
<type name="ObjectClass" c:type="GObjectClass"/>
|
||
</field>
|
||
<field name="load">
|
||
<callback name="load">
|
||
<source-position filename="gtypemodule.h" line="77"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="module" transfer-ownership="none">
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="unload">
|
||
<callback name="unload">
|
||
<source-position filename="gtypemodule.h" line="78"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="module" transfer-ownership="none">
|
||
<type name="TypeModule" c:type="GTypeModule*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="reserved1">
|
||
<callback name="reserved1">
|
||
<source-position filename="gtypemodule.h" line="82"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</callback>
|
||
</field>
|
||
<field name="reserved2">
|
||
<callback name="reserved2">
|
||
<source-position filename="gtypemodule.h" line="83"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</callback>
|
||
</field>
|
||
<field name="reserved3">
|
||
<callback name="reserved3">
|
||
<source-position filename="gtypemodule.h" line="84"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</callback>
|
||
</field>
|
||
<field name="reserved4">
|
||
<callback name="reserved4">
|
||
<source-position filename="gtypemodule.h" line="85"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</callback>
|
||
</field>
|
||
</record>
|
||
<interface name="TypePlugin"
|
||
c:symbol-prefix="type_plugin"
|
||
c:type="GTypePlugin"
|
||
glib:type-name="GTypePlugin"
|
||
glib:get-type="g_type_plugin_get_type">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="662">An interface that handles the lifecycle of dynamically loaded types.
|
||
|
||
The GObject type system supports dynamic loading of types.
|
||
It goes as follows:
|
||
|
||
1. The type is initially introduced (usually upon loading the module
|
||
the first time, or by your main application that knows what modules
|
||
introduces what types), like this:
|
||
|[<!-- language="C" -->
|
||
new_type_id = g_type_register_dynamic (parent_type_id,
|
||
"TypeName",
|
||
new_type_plugin,
|
||
type_flags);
|
||
]|
|
||
where @new_type_plugin is an implementation of the
|
||
#GTypePlugin interface.
|
||
|
||
2. The type's implementation is referenced, e.g. through
|
||
g_type_class_ref() or through g_type_create_instance() (this is
|
||
being called by g_object_new()) or through one of the above done on
|
||
a type derived from @new_type_id.
|
||
|
||
3. This causes the type system to load the type's implementation by
|
||
calling g_type_plugin_use() and g_type_plugin_complete_type_info()
|
||
on @new_type_plugin.
|
||
|
||
4. At some point the type's implementation isn't required anymore,
|
||
e.g. after g_type_class_unref() or g_type_free_instance() (called
|
||
when the reference count of an instance drops to zero).
|
||
|
||
5. This causes the type system to throw away the information retrieved
|
||
from g_type_plugin_complete_type_info() and then it calls
|
||
g_type_plugin_unuse() on @new_type_plugin.
|
||
|
||
6. Things may repeat from the second step.
|
||
|
||
So basically, you need to implement a #GTypePlugin type that
|
||
carries a use_count, once use_count goes from zero to one, you need
|
||
to load the implementation to successfully handle the upcoming
|
||
g_type_plugin_complete_type_info() call. Later, maybe after
|
||
succeeding use/unuse calls, once use_count drops to zero, you can
|
||
unload the implementation again. The type system makes sure to call
|
||
g_type_plugin_use() and g_type_plugin_complete_type_info() again
|
||
when the type is needed again.
|
||
|
||
#GTypeModule is an implementation of #GTypePlugin that already
|
||
implements most of this except for the actual module loading and
|
||
unloading. It even handles multiple registered types per module.</doc>
|
||
<method name="complete_interface_info"
|
||
c:identifier="g_type_plugin_complete_interface_info">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6563">Calls the @complete_interface_info function from the
|
||
#GTypePluginClass of @plugin. There should be no need to use this
|
||
function outside of the GObject type system itself.</doc>
|
||
<source-position filename="gtypeplugin.h" line="129"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6565">the #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</instance-parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6566">the #GType of an instantiatable type to which the interface
|
||
is added</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6568">the #GType of the interface whose info is completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6569">the #GInterfaceInfo to fill in</doc>
|
||
<type name="InterfaceInfo" c:type="GInterfaceInfo*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="complete_type_info"
|
||
c:identifier="g_type_plugin_complete_type_info">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6577">Calls the @complete_type_info function from the #GTypePluginClass of @plugin.
|
||
There should be no need to use this function outside of the GObject
|
||
type system itself.</doc>
|
||
<source-position filename="gtypeplugin.h" line="124"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6579">a #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</instance-parameter>
|
||
<parameter name="g_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6580">the #GType whose info is completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6581">the #GTypeInfo struct to fill in</doc>
|
||
<type name="TypeInfo" c:type="GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="value_table" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6582">the #GTypeValueTable to fill in</doc>
|
||
<type name="TypeValueTable" c:type="GTypeValueTable*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unuse" c:identifier="g_type_plugin_unuse">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6590">Calls the @unuse_plugin function from the #GTypePluginClass of
|
||
@plugin. There should be no need to use this function outside of
|
||
the GObject type system itself.</doc>
|
||
<source-position filename="gtypeplugin.h" line="122"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6592">a #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="use" c:identifier="g_type_plugin_use">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6600">Calls the @use_plugin function from the #GTypePluginClass of
|
||
@plugin. There should be no need to use this function outside of
|
||
the GObject type system itself.</doc>
|
||
<source-position filename="gtypeplugin.h" line="120"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6602">a #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
</interface>
|
||
<record name="TypePluginClass" c:type="GTypePluginClass">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="89">The #GTypePlugin interface is used by the type system in order to handle
|
||
the lifecycle of dynamically loaded types.</doc>
|
||
<source-position filename="gtypeplugin.h" line="113"/>
|
||
<field name="base_iface" readable="0" private="1">
|
||
<type name="TypeInterface" c:type="GTypeInterface"/>
|
||
</field>
|
||
<field name="use_plugin" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="91">Increases the use count of the plugin.</doc>
|
||
<type name="TypePluginUse" c:type="GTypePluginUse"/>
|
||
</field>
|
||
<field name="unuse_plugin" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="92">Decreases the use count of the plugin.</doc>
|
||
<type name="TypePluginUnuse" c:type="GTypePluginUnuse"/>
|
||
</field>
|
||
<field name="complete_type_info" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="93">Fills in the #GTypeInfo and
|
||
#GTypeValueTable structs for the type. The structs are initialized
|
||
with `memset(s, 0, sizeof (s))` before calling this function.</doc>
|
||
<type name="TypePluginCompleteTypeInfo"
|
||
c:type="GTypePluginCompleteTypeInfo"/>
|
||
</field>
|
||
<field name="complete_interface_info" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="96">Fills in missing parts of the #GInterfaceInfo
|
||
for the interface. The structs is initialized with
|
||
`memset(s, 0, sizeof (s))` before calling this function.</doc>
|
||
<type name="TypePluginCompleteInterfaceInfo"
|
||
c:type="GTypePluginCompleteInterfaceInfo"/>
|
||
</field>
|
||
</record>
|
||
<callback name="TypePluginCompleteInterfaceInfo"
|
||
c:type="GTypePluginCompleteInterfaceInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="69">The type of the @complete_interface_info function of #GTypePluginClass.</doc>
|
||
<source-position filename="gtypeplugin.h" line="79"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="71">the #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="72">the #GType of an instantiatable type to which the interface
|
||
is added</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="74">the #GType of the interface whose info is completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="75">the #GInterfaceInfo to fill in</doc>
|
||
<type name="InterfaceInfo" c:type="GInterfaceInfo*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="TypePluginCompleteTypeInfo"
|
||
c:type="GTypePluginCompleteTypeInfo">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="56">The type of the @complete_type_info function of #GTypePluginClass.</doc>
|
||
<source-position filename="gtypeplugin.h" line="65"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="58">the #GTypePlugin</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
<parameter name="g_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="59">the #GType whose info is completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="60">the #GTypeInfo struct to fill in</doc>
|
||
<type name="TypeInfo" c:type="GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="value_table" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="61">the #GTypeValueTable to fill in</doc>
|
||
<type name="TypeValueTable" c:type="GTypeValueTable*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="TypePluginUnuse" c:type="GTypePluginUnuse">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="49">The type of the @unuse_plugin function of #GTypePluginClass.</doc>
|
||
<source-position filename="gtypeplugin.h" line="55"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="51">the #GTypePlugin whose use count should be decreased</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="TypePluginUse" c:type="GTypePluginUse">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="41">The type of the @use_plugin function of #GTypePluginClass, which gets called
|
||
to increase the use count of @plugin.</doc>
|
||
<source-position filename="gtypeplugin.h" line="48"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gtypeplugin.h"
|
||
line="43">the #GTypePlugin whose use count should be increased</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="TypeQuery" c:type="GTypeQuery">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="466">A structure holding information for a specific type.
|
||
|
||
See also: g_type_query()</doc>
|
||
<source-position filename="gtype.h" line="483"/>
|
||
<field name="type" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="468">the #GType value of the type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="type_name" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="469">the name of the type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="class_size" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="470">the size of the class structure</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="instance_size" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="471">the size of the instance structure</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
</record>
|
||
<record name="TypeValueTable" c:type="GTypeValueTable">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1158">The #GTypeValueTable provides the functions required by the #GValue
|
||
implementation, to serve as a container for values of a type.</doc>
|
||
<source-position filename="gtype.h" line="1330"/>
|
||
<field name="value_init">
|
||
<callback name="value_init">
|
||
<source-position filename="gtype.h" line="1314"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_free">
|
||
<callback name="value_free">
|
||
<source-position filename="gtype.h" line="1315"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_copy">
|
||
<callback name="value_copy">
|
||
<source-position filename="gtype.h" line="1316"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="dest_value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="value_peek_pointer">
|
||
<callback name="value_peek_pointer">
|
||
<source-position filename="gtype.h" line="1319"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="collect_format" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1195">A string format describing how to collect the contents of
|
||
this value bit-by-bit. Each character in the format represents
|
||
an argument to be collected, and the characters themselves indicate
|
||
the type of the argument. Currently supported arguments are:
|
||
- 'i' - Integers. passed as collect_values[].v_int.
|
||
- 'l' - Longs. passed as collect_values[].v_long.
|
||
- 'd' - Doubles. passed as collect_values[].v_double.
|
||
- 'p' - Pointers. passed as collect_values[].v_pointer.
|
||
It should be noted that for variable argument list construction,
|
||
ANSI C promotes every type smaller than an integer to an int, and
|
||
floats to doubles. So for collection of short int or char, 'i'
|
||
needs to be used, and for collection of floats 'd'.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="collect_value">
|
||
<callback name="collect_value">
|
||
<source-position filename="gtype.h" line="1321"/>
|
||
<return-value transfer-ownership="full">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_collect_values" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="collect_values" transfer-ownership="none">
|
||
<type name="TypeCValue" c:type="GTypeCValue*"/>
|
||
</parameter>
|
||
<parameter name="collect_flags" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<field name="lcopy_format" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gtype.h"
|
||
line="1271">Format description of the arguments to collect for @lcopy_value,
|
||
analogous to @collect_format. Usually, @lcopy_format string consists
|
||
only of 'p's to provide lcopy_value() with pointers to storage locations.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</field>
|
||
<field name="lcopy_value">
|
||
<callback name="lcopy_value">
|
||
<source-position filename="gtype.h" line="1326"/>
|
||
<return-value transfer-ownership="full">
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_collect_values" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="collect_values" transfer-ownership="none">
|
||
<type name="TypeCValue" c:type="GTypeCValue*"/>
|
||
</parameter>
|
||
<parameter name="collect_flags" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
</field>
|
||
<function name="peek"
|
||
c:identifier="g_type_value_table_peek"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6742">Returns the location of the #GTypeValueTable associated with @type.
|
||
|
||
Note that this function should only be used from source code
|
||
that implements or has internal knowledge of the implementation of
|
||
@type.</doc>
|
||
<source-position filename="gtype.h" line="2481"/>
|
||
<return-value>
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6752">location of the #GTypeValueTable associated with @type or
|
||
%NULL if there is no #GTypeValueTable associated with @type</doc>
|
||
<type name="TypeValueTable" c:type="GTypeValueTable*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6744">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<function-macro name="VALUE_HOLDS"
|
||
c:identifier="G_VALUE_HOLDS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="72">Checks if @value holds (or contains) a value of @type.
|
||
This macro will also check for @value != %NULL and issue a
|
||
warning if the check fails.</doc>
|
||
<source-position filename="gvalue.h" line="83"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="74">A #GValue structure.</doc>
|
||
</parameter>
|
||
<parameter name="type">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="75">A #GType value.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_BOOLEAN"
|
||
c:identifier="G_VALUE_HOLDS_BOOLEAN"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="51">Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN.</doc>
|
||
<source-position filename="gvaluetypes.h" line="59"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="53">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_BOXED"
|
||
c:identifier="G_VALUE_HOLDS_BOXED"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="36">Checks whether the given #GValue can hold values derived
|
||
from type %G_TYPE_BOXED.</doc>
|
||
<source-position filename="gboxed.h" line="45"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gboxed.h"
|
||
line="38">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_CHAR"
|
||
c:identifier="G_VALUE_HOLDS_CHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="33">Checks whether the given #GValue can hold values of type %G_TYPE_CHAR.</doc>
|
||
<source-position filename="gvaluetypes.h" line="41"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="35">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_DOUBLE"
|
||
c:identifier="G_VALUE_HOLDS_DOUBLE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="123">Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE.</doc>
|
||
<source-position filename="gvaluetypes.h" line="131"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="125">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_ENUM"
|
||
c:identifier="G_VALUE_HOLDS_ENUM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="119">Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM.</doc>
|
||
<source-position filename="genums.h" line="127"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="121">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_FLAGS"
|
||
c:identifier="G_VALUE_HOLDS_FLAGS"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="128">Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS.</doc>
|
||
<source-position filename="genums.h" line="136"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="genums.h"
|
||
line="130">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_FLOAT"
|
||
c:identifier="G_VALUE_HOLDS_FLOAT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="114">Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT.</doc>
|
||
<source-position filename="gvaluetypes.h" line="122"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="116">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_GTYPE"
|
||
c:identifier="G_VALUE_HOLDS_GTYPE"
|
||
version="2.12"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="169">Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE.</doc>
|
||
<source-position filename="gvaluetypes.h" line="178"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="171">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_INT"
|
||
c:identifier="G_VALUE_HOLDS_INT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="60">Checks whether the given #GValue can hold values of type %G_TYPE_INT.</doc>
|
||
<source-position filename="gvaluetypes.h" line="68"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="62">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_INT64"
|
||
c:identifier="G_VALUE_HOLDS_INT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="96">Checks whether the given #GValue can hold values of type %G_TYPE_INT64.</doc>
|
||
<source-position filename="gvaluetypes.h" line="104"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="98">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_LONG"
|
||
c:identifier="G_VALUE_HOLDS_LONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="78">Checks whether the given #GValue can hold values of type %G_TYPE_LONG.</doc>
|
||
<source-position filename="gvaluetypes.h" line="86"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="80">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_OBJECT"
|
||
c:identifier="G_VALUE_HOLDS_OBJECT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="128">Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT.</doc>
|
||
<source-position filename="gobject.h" line="136"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="130">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_PARAM"
|
||
c:identifier="G_VALUE_HOLDS_PARAM"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="106">Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM.</doc>
|
||
<source-position filename="gparam.h" line="114"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gparam.h"
|
||
line="108">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_POINTER"
|
||
c:identifier="G_VALUE_HOLDS_POINTER"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="154">Checks whether the given #GValue can hold values of type %G_TYPE_POINTER.</doc>
|
||
<source-position filename="gvaluetypes.h" line="162"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="156">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_STRING"
|
||
c:identifier="G_VALUE_HOLDS_STRING"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="132">Checks whether the given #GValue can hold values of type %G_TYPE_STRING.</doc>
|
||
<source-position filename="gvaluetypes.h" line="140"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="134">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_UCHAR"
|
||
c:identifier="G_VALUE_HOLDS_UCHAR"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="42">Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR.</doc>
|
||
<source-position filename="gvaluetypes.h" line="50"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="44">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_UINT"
|
||
c:identifier="G_VALUE_HOLDS_UINT"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="69">Checks whether the given #GValue can hold values of type %G_TYPE_UINT.</doc>
|
||
<source-position filename="gvaluetypes.h" line="77"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="71">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_UINT64"
|
||
c:identifier="G_VALUE_HOLDS_UINT64"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="105">Checks whether the given #GValue can hold values of type %G_TYPE_UINT64.</doc>
|
||
<source-position filename="gvaluetypes.h" line="113"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="107">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_ULONG"
|
||
c:identifier="G_VALUE_HOLDS_ULONG"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="87">Checks whether the given #GValue can hold values of type %G_TYPE_ULONG.</doc>
|
||
<source-position filename="gvaluetypes.h" line="95"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="89">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_HOLDS_VARIANT"
|
||
c:identifier="G_VALUE_HOLDS_VARIANT"
|
||
version="2.26"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="179">Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT.</doc>
|
||
<source-position filename="gvaluetypes.h" line="189"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="181">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="VALUE_INTERNED_STRING"
|
||
value="268435456"
|
||
c:type="G_VALUE_INTERNED_STRING"
|
||
version="2.66">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="184">For string values, indicates that the string contained is canonical and will
|
||
exist for the duration of the process. See g_value_set_interned_string().</doc>
|
||
<source-position filename="gvalue.h" line="192"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="VALUE_IS_INTERNED_STRING"
|
||
c:identifier="G_VALUE_IS_INTERNED_STRING"
|
||
version="2.66"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="141">Checks whether @value contains a string which is canonical.</doc>
|
||
<source-position filename="gvaluetypes.h" line="153"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluetypes.h"
|
||
line="143">a valid #GValue structure</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<constant name="VALUE_NOCOPY_CONTENTS"
|
||
value="134217728"
|
||
c:type="G_VALUE_NOCOPY_CONTENTS">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="174">If passed to G_VALUE_COLLECT(), allocated data won't be copied
|
||
but used verbatim. This does not affect ref-counted types like
|
||
objects. This does not affect usage of g_value_copy(), the data will
|
||
be copied if it is not ref-counted.</doc>
|
||
<source-position filename="gvalue.h" line="182"/>
|
||
<type name="gint" c:type="gint"/>
|
||
</constant>
|
||
<function-macro name="VALUE_TYPE"
|
||
c:identifier="G_VALUE_TYPE"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="54">Get the type identifier of @value.</doc>
|
||
<source-position filename="gvalue.h" line="62"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="56">A #GValue structure.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="VALUE_TYPE_NAME"
|
||
c:identifier="G_VALUE_TYPE_NAME"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="63">Gets the type name of @value.</doc>
|
||
<source-position filename="gvalue.h" line="71"/>
|
||
<parameters>
|
||
<parameter name="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="65">A #GValue structure.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<callback name="VaClosureMarshal"
|
||
c:type="GVaClosureMarshal"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="128">This is the signature of va_list marshaller functions, an optional
|
||
marshaller that can be used in some situations to avoid
|
||
marshalling the signal argument into GValues.</doc>
|
||
<source-position filename="gclosure.h" line="148"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="130">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="131">a #GValue to store the return
|
||
value. May be %NULL if the callback of @closure doesn't return a
|
||
value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="134">the instance on which the closure is
|
||
invoked.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="136">va_list of arguments to be passed to the closure.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="137">additional data specified when
|
||
registering the marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="140">the length of the @param_types array</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</parameter>
|
||
<parameter name="param_types" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gclosure.h"
|
||
line="141">the #GType of each argument from
|
||
@args.</doc>
|
||
<array length="5" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="Value"
|
||
c:type="GValue"
|
||
glib:type-name="GValue"
|
||
glib:get-type="g_value_get_type"
|
||
c:symbol-prefix="value">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="99">An opaque structure used to hold different types of values.
|
||
|
||
The data within the structure has protected scope: it is accessible only
|
||
to functions within a #GTypeValueTable structure, or implementations of
|
||
the g_value_*() API. That is, code portions which implement new fundamental
|
||
types.
|
||
|
||
#GValue users cannot make any assumptions about how data is stored
|
||
within the 2 element @data union, and the @g_type member should
|
||
only be accessed through the G_VALUE_TYPE() macro.</doc>
|
||
<source-position filename="gvalue.h" line="130"/>
|
||
<field name="g_type" readable="0" private="1">
|
||
<type name="GType" c:type="GType"/>
|
||
</field>
|
||
<field name="data" writable="1">
|
||
<array zero-terminated="0" fixed-size="2">
|
||
<type name="_Value__data__union"/>
|
||
</array>
|
||
</field>
|
||
<method name="copy" c:identifier="g_value_copy">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6890">Copies the value of @src_value into @dest_value.</doc>
|
||
<source-position filename="gvalue.h" line="138"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="src_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6892">An initialized #GValue structure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="dest_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6893">An initialized #GValue structure of the same type as @src_value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_boxed"
|
||
c:identifier="g_value_dup_boxed"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6899">Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting,
|
||
the boxed value is duplicated and needs to be later freed with
|
||
g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
|
||
return_value);</doc>
|
||
<source-position filename="gboxed.h" line="92"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6908">boxed contents of @value</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6901">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_object" c:identifier="g_value_dup_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6912">Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
|
||
its reference count. If the contents of the #GValue are %NULL, then
|
||
%NULL will be returned.</doc>
|
||
<source-position filename="gobject.h" line="656"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6920">object content of @value,
|
||
should be unreferenced when no longer needed.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6914">a valid #GValue whose type is derived from %G_TYPE_OBJECT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_param"
|
||
c:identifier="g_value_dup_param"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6925">Get the contents of a %G_TYPE_PARAM #GValue, increasing its
|
||
reference count.</doc>
|
||
<source-position filename="gparam.h" line="355"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6932">#GParamSpec content of @value, should be
|
||
unreferenced when no longer needed.</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6927">a valid #GValue whose type is derived from %G_TYPE_PARAM</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_string" c:identifier="g_value_dup_string">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6937">Get a copy the contents of a %G_TYPE_STRING #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="265"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6943">a newly allocated copy of the string content of @value</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6939">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="dup_variant"
|
||
c:identifier="g_value_dup_variant"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6947">Get the contents of a variant #GValue, increasing its refcount. The returned
|
||
#GVariant is never floating.</doc>
|
||
<source-position filename="gvaluetypes.h" line="287"/>
|
||
<return-value transfer-ownership="full" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6954">variant contents of @value (may be %NULL);
|
||
should be unreffed using g_variant_unref() when no longer needed</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6949">a valid #GValue of type %G_TYPE_VARIANT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="fits_pointer" c:identifier="g_value_fits_pointer">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6960">Determines if @value will fit inside the size of a pointer value.
|
||
This is an internal function introduced mainly for C marshallers.</doc>
|
||
<source-position filename="gvalue.h" line="154"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6967">%TRUE if @value will fit inside a pointer value.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6962">An initialized #GValue structure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_boolean" c:identifier="g_value_get_boolean">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6971">Get the contents of a %G_TYPE_BOOLEAN #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="212"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6977">boolean contents of @value</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6973">a valid #GValue of type %G_TYPE_BOOLEAN</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_boxed" c:identifier="g_value_get_boxed">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6981">Get the contents of a %G_TYPE_BOXED derived #GValue.</doc>
|
||
<source-position filename="gboxed.h" line="90"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6987">boxed contents of @value</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6983">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_char"
|
||
c:identifier="g_value_get_char"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6991">Do not use this function; it is broken on platforms where the %char
|
||
type is unsigned, such as ARM and PowerPC. See g_value_get_schar().
|
||
|
||
Get the contents of a %G_TYPE_CHAR #GValue.</doc>
|
||
<doc-deprecated xml:space="preserve">This function's return type is broken, see g_value_get_schar()</doc-deprecated>
|
||
<source-position filename="gvaluetypes.h" line="197"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7000">character contents of @value</doc>
|
||
<type name="gchar" c:type="gchar"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6993">a valid #GValue of type %G_TYPE_CHAR</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_double" c:identifier="g_value_get_double">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7005">Get the contents of a %G_TYPE_DOUBLE #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="252"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7011">double contents of @value</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7007">a valid #GValue of type %G_TYPE_DOUBLE</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_enum" c:identifier="g_value_get_enum">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7015">Get the contents of a %G_TYPE_ENUM #GValue.</doc>
|
||
<source-position filename="genums.h" line="248"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7021">enum contents of @value</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7017">a valid #GValue whose type is derived from %G_TYPE_ENUM</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_flags" c:identifier="g_value_get_flags">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7025">Get the contents of a %G_TYPE_FLAGS #GValue.</doc>
|
||
<source-position filename="genums.h" line="253"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7031">flags contents of @value</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7027">a valid #GValue whose type is derived from %G_TYPE_FLAGS</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_float" c:identifier="g_value_get_float">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7035">Get the contents of a %G_TYPE_FLOAT #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="247"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7041">float contents of @value</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7037">a valid #GValue of type %G_TYPE_FLOAT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_gtype" c:identifier="g_value_get_gtype" version="2.12">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7045">Get the contents of a %G_TYPE_GTYPE #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="277"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7052">the #GType stored in @value</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7047">a valid #GValue of type %G_TYPE_GTYPE</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_int" c:identifier="g_value_get_int">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7056">Get the contents of a %G_TYPE_INT #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="217"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7062">integer contents of @value</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7058">a valid #GValue of type %G_TYPE_INT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_int64" c:identifier="g_value_get_int64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7066">Get the contents of a %G_TYPE_INT64 #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="237"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7072">64bit integer contents of @value</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7068">a valid #GValue of type %G_TYPE_INT64</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_long" c:identifier="g_value_get_long">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7076">Get the contents of a %G_TYPE_LONG #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="227"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7082">long integer contents of @value</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7078">a valid #GValue of type %G_TYPE_LONG</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_object" c:identifier="g_value_get_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7086">Get the contents of a %G_TYPE_OBJECT derived #GValue.</doc>
|
||
<source-position filename="gobject.h" line="654"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7092">object contents of @value</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7088">a valid #GValue of %G_TYPE_OBJECT derived type</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_param" c:identifier="g_value_get_param">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7096">Get the contents of a %G_TYPE_PARAM #GValue.</doc>
|
||
<source-position filename="gparam.h" line="353"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7102">#GParamSpec content of @value</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7098">a valid #GValue whose type is derived from %G_TYPE_PARAM</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_pointer" c:identifier="g_value_get_pointer">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7106">Get the contents of a pointer #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="270"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7112">pointer contents of @value</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7108">a valid #GValue of %G_TYPE_POINTER</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_schar" c:identifier="g_value_get_schar" version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7116">Get the contents of a %G_TYPE_CHAR #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="202"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7122">signed 8 bit integer contents of @value</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7118">a valid #GValue of type %G_TYPE_CHAR</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_string" c:identifier="g_value_get_string">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7127">Get the contents of a %G_TYPE_STRING #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="263"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7133">string content of @value</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7129">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_uchar" c:identifier="g_value_get_uchar">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7137">Get the contents of a %G_TYPE_UCHAR #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="207"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7143">unsigned character contents of @value</doc>
|
||
<type name="guint8" c:type="guchar"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7139">a valid #GValue of type %G_TYPE_UCHAR</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_uint" c:identifier="g_value_get_uint">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7147">Get the contents of a %G_TYPE_UINT #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="222"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7153">unsigned integer contents of @value</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7149">a valid #GValue of type %G_TYPE_UINT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_uint64" c:identifier="g_value_get_uint64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7157">Get the contents of a %G_TYPE_UINT64 #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="242"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7163">unsigned 64bit integer contents of @value</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7159">a valid #GValue of type %G_TYPE_UINT64</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_ulong" c:identifier="g_value_get_ulong">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7167">Get the contents of a %G_TYPE_ULONG #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="232"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7173">unsigned long integer contents of @value</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7169">a valid #GValue of type %G_TYPE_ULONG</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_variant"
|
||
c:identifier="g_value_get_variant"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7177">Get the contents of a variant #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="285"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7183">variant contents of @value (may be %NULL)</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7179">a valid #GValue of type %G_TYPE_VARIANT</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="init" c:identifier="g_value_init">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7188">Initializes @value with the default value of @type.</doc>
|
||
<source-position filename="gvalue.h" line="135"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7195">the #GValue structure that has been passed in</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7190">A zero-filled (uninitialized) #GValue structure.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="g_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7191">Type the #GValue should hold values of.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="init_from_instance"
|
||
c:identifier="g_value_init_from_instance"
|
||
version="2.42">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7199">Initializes and sets @value from an instantiatable type via the
|
||
value_table's collect_value() function.
|
||
|
||
Note: The @value will be initialised with the exact type of
|
||
@instance. If you wish to set the @value's type to a different GType
|
||
(such as a parent class GType), you need to manually call
|
||
g_value_init() and g_value_set_instance().</doc>
|
||
<source-position filename="gvalue.h" line="148"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7201">An uninitialized #GValue structure.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7202">the instance</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="peek_pointer" c:identifier="g_value_peek_pointer">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7216">Returns the value contents as pointer. This function asserts that
|
||
g_value_fits_pointer() returned %TRUE for the passed in value.
|
||
This is an internal function introduced mainly for C marshallers.</doc>
|
||
<source-position filename="gvalue.h" line="156"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7224">the value contents as pointer</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7218">An initialized #GValue structure</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="reset" c:identifier="g_value_reset">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7241">Clears the current value in @value and resets it to the default value
|
||
(as if the value had just been initialized).</doc>
|
||
<source-position filename="gvalue.h" line="141"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7248">the #GValue structure that has been passed in</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7243">An initialized #GValue structure.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_boolean" c:identifier="g_value_set_boolean">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7252">Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean.</doc>
|
||
<source-position filename="gvaluetypes.h" line="209"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7254">a valid #GValue of type %G_TYPE_BOOLEAN</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_boolean" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7255">boolean value to be set</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_boxed" c:identifier="g_value_set_boxed">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7261">Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.</doc>
|
||
<source-position filename="gboxed.h" line="78"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7263">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_boxed"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7264">boxed value to be set</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_boxed_take_ownership"
|
||
c:identifier="g_value_set_boxed_take_ownership"
|
||
deprecated="1"
|
||
deprecated-version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7270">This is an internal function introduced mainly for C marshallers.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_value_take_boxed() instead.</doc-deprecated>
|
||
<source-position filename="gboxed.h" line="87"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7272">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_boxed"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7273">duplicated unowned boxed value to be set</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_char"
|
||
c:identifier="g_value_set_char"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7281">Set the contents of a %G_TYPE_CHAR #GValue to @v_char.</doc>
|
||
<doc-deprecated xml:space="preserve">This function's input type is broken, see g_value_set_schar()</doc-deprecated>
|
||
<source-position filename="gvaluetypes.h" line="194"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7283">a valid #GValue of type %G_TYPE_CHAR</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_char" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7284">character value to be set</doc>
|
||
<type name="gchar" c:type="gchar"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_double" c:identifier="g_value_set_double">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7292">Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double.</doc>
|
||
<source-position filename="gvaluetypes.h" line="249"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7294">a valid #GValue of type %G_TYPE_DOUBLE</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_double" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7295">double value to be set</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_enum" c:identifier="g_value_set_enum">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7301">Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.</doc>
|
||
<source-position filename="genums.h" line="245"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7303">a valid #GValue whose type is derived from %G_TYPE_ENUM</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_enum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7304">enum value to be set</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_flags" c:identifier="g_value_set_flags">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7310">Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.</doc>
|
||
<source-position filename="genums.h" line="250"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7312">a valid #GValue whose type is derived from %G_TYPE_FLAGS</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7313">flags value to be set</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_float" c:identifier="g_value_set_float">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7319">Set the contents of a %G_TYPE_FLOAT #GValue to @v_float.</doc>
|
||
<source-position filename="gvaluetypes.h" line="244"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7321">a valid #GValue of type %G_TYPE_FLOAT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_float" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7322">float value to be set</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_gtype" c:identifier="g_value_set_gtype" version="2.12">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7328">Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.</doc>
|
||
<source-position filename="gvaluetypes.h" line="274"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7330">a valid #GValue of type %G_TYPE_GTYPE</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_gtype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7331">#GType to be set</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_instance" c:identifier="g_value_set_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7339">Sets @value from an instantiatable type via the
|
||
value_table's collect_value() function.</doc>
|
||
<source-position filename="gvalue.h" line="145"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7341">An initialized #GValue structure.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="instance"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7342">the instance</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_int" c:identifier="g_value_set_int">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7349">Set the contents of a %G_TYPE_INT #GValue to @v_int.</doc>
|
||
<source-position filename="gvaluetypes.h" line="214"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7351">a valid #GValue of type %G_TYPE_INT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_int" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7352">integer value to be set</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_int64" c:identifier="g_value_set_int64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7358">Set the contents of a %G_TYPE_INT64 #GValue to @v_int64.</doc>
|
||
<source-position filename="gvaluetypes.h" line="234"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7360">a valid #GValue of type %G_TYPE_INT64</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_int64" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7361">64bit integer value to be set</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_interned_string"
|
||
c:identifier="g_value_set_interned_string"
|
||
version="2.66">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7367">Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is
|
||
assumed to be static and interned (canonical, for example from
|
||
g_intern_string()), and is thus not duplicated when setting the #GValue.</doc>
|
||
<source-position filename="gvaluetypes.h" line="260"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7369">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_string"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7370">static string to be set</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_long" c:identifier="g_value_set_long">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7380">Set the contents of a %G_TYPE_LONG #GValue to @v_long.</doc>
|
||
<source-position filename="gvaluetypes.h" line="224"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7382">a valid #GValue of type %G_TYPE_LONG</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_long" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7383">long integer value to be set</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_object" c:identifier="g_value_set_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7389">Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
|
||
|
||
g_value_set_object() increases the reference count of @v_object
|
||
(the #GValue holds a reference to @v_object). If you do not wish
|
||
to increase the reference count of the object (i.e. you wish to
|
||
pass your current reference to the #GValue because you no longer
|
||
need it), use g_value_take_object() instead.
|
||
|
||
It is important that your #GValue holds a reference to @v_object (either its
|
||
own, or one it has taken) to ensure that the object won't be destroyed while
|
||
the #GValue still exists).</doc>
|
||
<source-position filename="gobject.h" line="651"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7391">a valid #GValue of %G_TYPE_OBJECT derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_object"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7392">object value to be set</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_object_take_ownership"
|
||
c:identifier="g_value_set_object_take_ownership"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7408">This is an internal function introduced mainly for C marshallers.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_value_take_object() instead.</doc-deprecated>
|
||
<source-position filename="gobject.h" line="675"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7410">a valid #GValue of %G_TYPE_OBJECT derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_object"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7411">object value to be set</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_param" c:identifier="g_value_set_param">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7419">Set the contents of a %G_TYPE_PARAM #GValue to @param.</doc>
|
||
<source-position filename="gparam.h" line="350"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7421">a valid #GValue of type %G_TYPE_PARAM</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="param"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7422">the #GParamSpec to be set</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_param_take_ownership"
|
||
c:identifier="g_value_set_param_take_ownership"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7428">This is an internal function introduced mainly for C marshallers.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_value_take_param() instead.</doc-deprecated>
|
||
<source-position filename="gparam.h" line="362"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7430">a valid #GValue of type %G_TYPE_PARAM</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="param"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7431">the #GParamSpec to be set</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_pointer" c:identifier="g_value_set_pointer">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7439">Set the contents of a pointer #GValue to @v_pointer.</doc>
|
||
<source-position filename="gvaluetypes.h" line="267"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7441">a valid #GValue of %G_TYPE_POINTER</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_pointer"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7442">pointer value to be set</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_schar" c:identifier="g_value_set_schar" version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7448">Set the contents of a %G_TYPE_CHAR #GValue to @v_char.</doc>
|
||
<source-position filename="gvaluetypes.h" line="199"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7450">a valid #GValue of type %G_TYPE_CHAR</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_char" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7451">signed 8 bit integer to be set</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_static_boxed" c:identifier="g_value_set_static_boxed">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7459">Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
|
||
|
||
The boxed value is assumed to be static, and is thus not duplicated
|
||
when setting the #GValue.</doc>
|
||
<source-position filename="gboxed.h" line="81"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7461">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_boxed"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7462">static boxed value to be set</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_static_string"
|
||
c:identifier="g_value_set_static_string">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7471">Set the contents of a %G_TYPE_STRING #GValue to @v_string.
|
||
The string is assumed to be static, and is thus not duplicated
|
||
when setting the #GValue.
|
||
|
||
If the the string is a canonical string, using g_value_set_interned_string()
|
||
is more appropriate.</doc>
|
||
<source-position filename="gvaluetypes.h" line="257"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7473">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_string"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7474">static string to be set</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_string" c:identifier="g_value_set_string">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7485">Set the contents of a %G_TYPE_STRING #GValue to a copy of @v_string.</doc>
|
||
<source-position filename="gvaluetypes.h" line="254"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7487">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_string"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7488">caller-owned string to be duplicated for the #GValue</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_string_take_ownership"
|
||
c:identifier="g_value_set_string_take_ownership"
|
||
deprecated="1"
|
||
deprecated-version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7494">This is an internal function introduced mainly for C marshallers.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_value_take_string() instead.</doc-deprecated>
|
||
<source-position filename="gvaluetypes.h" line="303"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7496">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_string"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7497">duplicated unowned string to be set</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_uchar" c:identifier="g_value_set_uchar">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7505">Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar.</doc>
|
||
<source-position filename="gvaluetypes.h" line="204"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7507">a valid #GValue of type %G_TYPE_UCHAR</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_uchar" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7508">unsigned character value to be set</doc>
|
||
<type name="guint8" c:type="guchar"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_uint" c:identifier="g_value_set_uint">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7514">Set the contents of a %G_TYPE_UINT #GValue to @v_uint.</doc>
|
||
<source-position filename="gvaluetypes.h" line="219"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7516">a valid #GValue of type %G_TYPE_UINT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_uint" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7517">unsigned integer value to be set</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_uint64" c:identifier="g_value_set_uint64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7523">Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64.</doc>
|
||
<source-position filename="gvaluetypes.h" line="239"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7525">a valid #GValue of type %G_TYPE_UINT64</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_uint64" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7526">unsigned 64bit integer value to be set</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_ulong" c:identifier="g_value_set_ulong">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7532">Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong.</doc>
|
||
<source-position filename="gvaluetypes.h" line="229"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7534">a valid #GValue of type %G_TYPE_ULONG</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_ulong" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7535">unsigned long integer value to be set</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set_variant"
|
||
c:identifier="g_value_set_variant"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7541">Set the contents of a variant #GValue to @variant.
|
||
If the variant is floating, it is consumed.</doc>
|
||
<source-position filename="gvaluetypes.h" line="279"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7543">a valid #GValue of type %G_TYPE_VARIANT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="variant"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7544">a #GVariant, or %NULL</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_boxed"
|
||
c:identifier="g_value_take_boxed"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7553">Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed
|
||
and takes over the ownership of the caller’s reference to @v_boxed;
|
||
the caller doesn’t have to unref it any more.</doc>
|
||
<source-position filename="gboxed.h" line="84"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7555">a valid #GValue of %G_TYPE_BOXED derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_boxed"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7556">duplicated unowned boxed value to be set</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_object"
|
||
c:identifier="g_value_take_object"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7566">Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
|
||
and takes over the ownership of the caller’s reference to @v_object;
|
||
the caller doesn’t have to unref it any more (i.e. the reference
|
||
count of the object is not increased).
|
||
|
||
If you want the #GValue to hold its own reference to @v_object, use
|
||
g_value_set_object() instead.</doc>
|
||
<source-position filename="gobject.h" line="672"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7568">a valid #GValue of %G_TYPE_OBJECT derived type</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_object"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7569">object value to be set</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_param"
|
||
c:identifier="g_value_take_param"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7583">Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes
|
||
over the ownership of the caller’s reference to @param; the caller
|
||
doesn’t have to unref it any more.</doc>
|
||
<source-position filename="gparam.h" line="359"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7585">a valid #GValue of type %G_TYPE_PARAM</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="param"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7586">the #GParamSpec to be set</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_string"
|
||
c:identifier="g_value_take_string"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7596">Sets the contents of a %G_TYPE_STRING #GValue to @v_string.</doc>
|
||
<source-position filename="gvaluetypes.h" line="300"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7598">a valid #GValue of type %G_TYPE_STRING</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="v_string"
|
||
transfer-ownership="full"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7599">string to take ownership of</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="take_variant"
|
||
c:identifier="g_value_take_variant"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7607">Set the contents of a variant #GValue to @variant, and takes over
|
||
the ownership of the caller's reference to @variant;
|
||
the caller doesn't have to unref it any more (i.e. the reference
|
||
count of the variant is not increased).
|
||
|
||
If @variant was floating then its floating reference is converted to
|
||
a hard reference.
|
||
|
||
If you want the #GValue to hold its own reference to @variant, use
|
||
g_value_set_variant() instead.
|
||
|
||
This is an internal function introduced mainly for C marshallers.</doc>
|
||
<source-position filename="gvaluetypes.h" line="282"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7609">a valid #GValue of type %G_TYPE_VARIANT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="variant"
|
||
transfer-ownership="full"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7610">a #GVariant, or %NULL</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="transform" c:identifier="g_value_transform">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7629">Tries to cast the contents of @src_value into a type appropriate
|
||
to store in @dest_value, e.g. to transform a %G_TYPE_INT value
|
||
into a %G_TYPE_FLOAT value. Performing transformations between
|
||
value types might incur precision lossage. Especially
|
||
transformations into strings might reveal seemingly arbitrary
|
||
results and shouldn't be relied upon for production code (such
|
||
as rcfile value or object property serialization).</doc>
|
||
<source-position filename="gvalue.h" line="167"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7642">Whether a transformation rule was found and could be applied.
|
||
Upon failing transformations, @dest_value is left untouched.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="src_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7631">Source value.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</instance-parameter>
|
||
<parameter name="dest_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7632">Target value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="unset" c:identifier="g_value_unset">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7673">Clears the current value in @value (if any) and "unsets" the type,
|
||
this releases all resources associated with this GValue. An unset
|
||
value is the same as an uninitialized (zero-filled) #GValue
|
||
structure.</doc>
|
||
<source-position filename="gvalue.h" line="143"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7675">An initialized #GValue structure.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<function name="register_transform_func"
|
||
c:identifier="g_value_register_transform_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7228">Registers a value transformation function for use in g_value_transform().
|
||
A previously registered transformation function for @src_type and @dest_type
|
||
will be replaced.</doc>
|
||
<source-position filename="gvalue.h" line="170"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7230">Source type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7231">Target type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="transform_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7232">a function which transforms values of type @src_type
|
||
into value of type @dest_type</doc>
|
||
<type name="ValueTransform" c:type="GValueTransform"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_compatible" c:identifier="g_value_type_compatible">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7647">Returns whether a #GValue of type @src_type can be copied into
|
||
a #GValue of type @dest_type.</doc>
|
||
<source-position filename="gvalue.h" line="161"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7655">%TRUE if g_value_copy() is possible with @src_type and @dest_type.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7649">source type to be copied.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7650">destination type for copying.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_transformable"
|
||
c:identifier="g_value_type_transformable">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7659">Check whether g_value_transform() is able to transform values
|
||
of type @src_type into values of type @dest_type. Note that for
|
||
the types to be transformable, they must be compatible or a
|
||
transformation function must be registered.</doc>
|
||
<source-position filename="gvalue.h" line="164"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7669">%TRUE if the transformation is possible, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7661">Source type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7662">Target type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</record>
|
||
<record name="ValueArray"
|
||
c:type="GValueArray"
|
||
glib:type-name="GValueArray"
|
||
glib:get-type="g_value_array_get_type"
|
||
c:symbol-prefix="value_array">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluearray.h"
|
||
line="44">A #GValueArray contains an array of #GValue elements.</doc>
|
||
<source-position filename="gvaluearray.h" line="58"/>
|
||
<field name="n_values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluearray.h"
|
||
line="46">number of values contained in the array</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="values" writable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gvaluearray.h"
|
||
line="47">array of values</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</field>
|
||
<field name="n_prealloced" readable="0" private="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<constructor name="new"
|
||
c:identifier="g_value_array_new"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6818">Allocate and initialize a new #GValueArray, optionally preserve space
|
||
for @n_prealloced elements. New arrays always contain 0 elements,
|
||
regardless of the value of @n_prealloced.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_sized_new() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="69"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6826">a newly allocated #GValueArray with 0 values</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="n_prealloced" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6820">number of values to preallocate space for</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</constructor>
|
||
<method name="append"
|
||
c:identifier="g_value_array_append"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6757">Insert a copy of @value as last element of @value_array. If @value is
|
||
%NULL, an uninitialized value is appended.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_append_val() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="82"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6765">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6759">#GValueArray to add an element to</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6760">#GValue to copy into #GValueArray, or %NULL</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="copy"
|
||
c:identifier="g_value_array_copy"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6770">Construct an exact copy of a #GValueArray by duplicating all its
|
||
contents.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_ref() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="75"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6777">Newly allocated copy of #GValueArray</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6772">#GValueArray to copy</doc>
|
||
<type name="ValueArray" c:type="const GValueArray*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="free"
|
||
c:identifier="g_value_array_free"
|
||
introspectable="0"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6782">Free a #GValueArray including its contents.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_unref() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="72"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6784">#GValueArray to free</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get_nth"
|
||
c:identifier="g_value_array_get_nth"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6792">Return a pointer to the value at @index_ containd in @value_array.</doc>
|
||
<doc-deprecated xml:space="preserve">Use g_array_index() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="65"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6799">pointer to a value at @index_ in @value_array</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6794">#GValueArray to get a value from</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="index_" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6795">index of the value of interest</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="insert"
|
||
c:identifier="g_value_array_insert"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6804">Insert a copy of @value at specified position into @value_array. If @value
|
||
is %NULL, an uninitialized value is inserted.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_insert_val() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="86"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6813">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6806">#GValueArray to add an element to</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="index_" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6807">insertion position, must be <= value_array->;n_values</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6808">#GValue to copy into #GValueArray, or %NULL</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="prepend"
|
||
c:identifier="g_value_array_prepend"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6831">Insert a copy of @value as first element of @value_array. If @value is
|
||
%NULL, an uninitialized value is prepended.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_prepend_val() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="78"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6839">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6833">#GValueArray to add an element to</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6834">#GValue to copy into #GValueArray, or %NULL</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="remove"
|
||
c:identifier="g_value_array_remove"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6844">Remove the value at position @index_ from @value_array.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_remove_index() instead.</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="91"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6852">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6846">#GValueArray to remove an element from</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="index_" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6847">position of value to remove, which must be less than
|
||
@value_array->n_values</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="sort"
|
||
c:identifier="g_value_array_sort"
|
||
shadowed-by="sort_with_data"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6857">Sort @value_array using @compare_func to compare the elements according to
|
||
the semantics of #GCompareFunc.
|
||
|
||
The current implementation uses the same sorting algorithm as standard
|
||
C qsort() function.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_sort().</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="95"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6868">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6859">#GValueArray to sort</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="compare_func"
|
||
transfer-ownership="none"
|
||
scope="call">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6860">function to compare elements</doc>
|
||
<type name="GLib.CompareFunc" c:type="GCompareFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="sort_with_data"
|
||
c:identifier="g_value_array_sort_with_data"
|
||
shadows="sort"
|
||
deprecated="1"
|
||
deprecated-version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6873">Sort @value_array using @compare_func to compare the elements according
|
||
to the semantics of #GCompareDataFunc.
|
||
|
||
The current implementation uses the same sorting algorithm as standard
|
||
C qsort() function.</doc>
|
||
<doc-deprecated xml:space="preserve">Use #GArray and g_array_sort_with_data().</doc-deprecated>
|
||
<source-position filename="gvaluearray.h" line="99"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6885">the #GValueArray passed in as @value_array</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="value_array" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6875">#GValueArray to sort</doc>
|
||
<type name="ValueArray" c:type="GValueArray*"/>
|
||
</instance-parameter>
|
||
<parameter name="compare_func"
|
||
transfer-ownership="none"
|
||
scope="call"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6876">function to compare elements</doc>
|
||
<type name="GLib.CompareDataFunc" c:type="GCompareDataFunc"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6877">extra data argument provided for @compare_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
</record>
|
||
<callback name="ValueTransform" c:type="GValueTransform">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="87">The type of value transformation functions which can be registered with
|
||
g_value_register_transform_func().
|
||
|
||
@dest_value will be initialized to the correct destination type.</doc>
|
||
<source-position filename="gvalue.h" line="97"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="89">Source value.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="dest_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gvalue.h"
|
||
line="90">Target value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<callback name="WeakNotify" c:type="GWeakNotify">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="232">A #GWeakNotify function can be added to an object as a callback that gets
|
||
triggered when the object is finalized.
|
||
|
||
Since the object is already being disposed when the #GWeakNotify is called,
|
||
there's not much you could do with the object, apart from e.g. using its
|
||
address as hash-index or the like.
|
||
|
||
In particular, this means it’s invalid to call g_object_ref(),
|
||
g_weak_ref_init(), g_weak_ref_set(), g_object_add_toggle_ref(),
|
||
g_object_weak_ref(), g_object_add_weak_pointer() or any function which calls
|
||
them on the object from this callback.</doc>
|
||
<source-position filename="gobject.h" line="249"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="234">data that was provided when the weak reference was established</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="where_the_object_was" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="235">the object being disposed</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</callback>
|
||
<record name="WeakRef" c:type="GWeakRef">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="157">A structure containing a weak reference to a #GObject.
|
||
|
||
A `GWeakRef` can either be empty (i.e. point to %NULL), or point to an
|
||
object for as long as at least one "strong" reference to that object
|
||
exists. Before the object's #GObjectClass.dispose method is called,
|
||
every #GWeakRef associated with becomes empty (i.e. points to %NULL).
|
||
|
||
Like #GValue, #GWeakRef can be statically allocated, stack- or
|
||
heap-allocated, or embedded in larger structures.
|
||
|
||
Unlike g_object_weak_ref() and g_object_add_weak_pointer(), this weak
|
||
reference is thread-safe: converting a weak pointer to a reference is
|
||
atomic with respect to invalidation of weak pointers to destroyed
|
||
objects.
|
||
|
||
If the object's #GObjectClass.dispose method results in additional
|
||
references to the object being held (‘re-referencing’), any #GWeakRefs taken
|
||
before it was disposed will continue to point to %NULL. Any #GWeakRefs taken
|
||
during disposal and after re-referencing, or after disposal has returned due
|
||
to the re-referencing, will continue to point to the object until its refcount
|
||
goes back to zero, at which point they too will be invalidated.
|
||
|
||
It is invalid to take a #GWeakRef on an object during #GObjectClass.dispose
|
||
without first having or creating a strong reference to the object.</doc>
|
||
<source-position filename="gobject.h" line="938"/>
|
||
<union name="priv" c:type="priv">
|
||
<source-position filename="gobject.h" line="937"/>
|
||
<field name="p" writable="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
</union>
|
||
<method name="clear"
|
||
c:identifier="g_weak_ref_clear"
|
||
version="2.32"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7684">Frees resources associated with a non-statically-allocated #GWeakRef.
|
||
After this call, the #GWeakRef is left in an undefined state.
|
||
|
||
You should only call this on a #GWeakRef that previously had
|
||
g_weak_ref_init() called on it.</doc>
|
||
<source-position filename="gobject.h" line="944"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="weak_ref"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7686">location of a weak reference, which
|
||
may be empty</doc>
|
||
<type name="WeakRef" c:type="GWeakRef*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="get"
|
||
c:identifier="g_weak_ref_get"
|
||
version="2.32"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7699">If @weak_ref is not empty, atomically acquire a strong
|
||
reference to the object it points to, and return that reference.
|
||
|
||
This function is needed because of the potential race between taking
|
||
the pointer value and g_object_ref() on it, if the object was losing
|
||
its last reference at the same time in a different thread.
|
||
|
||
The caller should release the resulting reference in the usual way,
|
||
by using g_object_unref().</doc>
|
||
<source-position filename="gobject.h" line="946"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7713">the object pointed to
|
||
by @weak_ref, or %NULL if it was empty</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="weak_ref"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7701">location of a weak reference to a #GObject</doc>
|
||
<type name="WeakRef" c:type="GWeakRef*"/>
|
||
</instance-parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="init"
|
||
c:identifier="g_weak_ref_init"
|
||
version="2.32"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7719">Initialise a non-statically-allocated #GWeakRef.
|
||
|
||
This function also calls g_weak_ref_set() with @object on the
|
||
freshly-initialised weak reference.
|
||
|
||
This function should always be matched with a call to
|
||
g_weak_ref_clear(). It is not necessary to use this function for a
|
||
#GWeakRef in static storage because it will already be
|
||
properly initialised. Just use g_weak_ref_set() directly.</doc>
|
||
<source-position filename="gobject.h" line="941"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="weak_ref"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7721">uninitialized or empty location for a weak
|
||
reference</doc>
|
||
<type name="WeakRef" c:type="GWeakRef*"/>
|
||
</instance-parameter>
|
||
<parameter name="object"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7723">a #GObject or %NULL</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
<method name="set"
|
||
c:identifier="g_weak_ref_set"
|
||
version="2.32"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7739">Change the object to which @weak_ref points, or set it to
|
||
%NULL.
|
||
|
||
You must own a strong reference on @object while calling this
|
||
function.</doc>
|
||
<source-position filename="gobject.h" line="948"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<instance-parameter name="weak_ref" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7741">location for a weak reference</doc>
|
||
<type name="WeakRef" c:type="GWeakRef*"/>
|
||
</instance-parameter>
|
||
<parameter name="object"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7742">a #GObject or %NULL</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</method>
|
||
</record>
|
||
<union name="_Value__data__union">
|
||
<field name="v_int" writable="1">
|
||
<type name="gint" c:type="gint"/>
|
||
</field>
|
||
<field name="v_uint" writable="1">
|
||
<type name="guint" c:type="guint"/>
|
||
</field>
|
||
<field name="v_long" writable="1">
|
||
<type name="glong" c:type="glong"/>
|
||
</field>
|
||
<field name="v_ulong" writable="1">
|
||
<type name="gulong" c:type="gulong"/>
|
||
</field>
|
||
<field name="v_int64" writable="1">
|
||
<type name="gint64" c:type="gint64"/>
|
||
</field>
|
||
<field name="v_uint64" writable="1">
|
||
<type name="guint64" c:type="guint64"/>
|
||
</field>
|
||
<field name="v_float" writable="1">
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</field>
|
||
<field name="v_double" writable="1">
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</field>
|
||
<field name="v_pointer" writable="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</field>
|
||
</union>
|
||
<function-macro name="assert_finalize_object"
|
||
c:identifier="g_assert_finalize_object"
|
||
version="2.62"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="799">Assert that @object is non-%NULL, then release one reference to it with
|
||
g_object_unref() and assert that it has been finalized (i.e. that there
|
||
are no more references).
|
||
|
||
If assertions are disabled via `G_DISABLE_ASSERT`,
|
||
this macro just calls g_object_unref() without any further checks.
|
||
|
||
This macro should only be used in regression tests.</doc>
|
||
<source-position filename="gobject.h" line="826"/>
|
||
<parameters>
|
||
<parameter name="object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="801">an object</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="boxed_copy" c:identifier="g_boxed_copy">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1211">Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.</doc>
|
||
<source-position filename="gboxed.h" line="72"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1218">The newly created copy of the boxed
|
||
structure.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="boxed_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1213">The type of @src_boxed.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="src_boxed" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1214">The boxed structure to be copied.</doc>
|
||
<type name="gpointer" c:type="gconstpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="boxed_free" c:identifier="g_boxed_free">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1223">Free the boxed structure @boxed which is of type @boxed_type.</doc>
|
||
<source-position filename="gboxed.h" line="75"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="boxed_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1225">The type of @boxed.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="boxed" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1226">The boxed structure to be freed.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="boxed_type_register_static"
|
||
c:identifier="g_boxed_type_register_static"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1232">This function creates a new %G_TYPE_BOXED derived type id for a new
|
||
boxed type with name @name.
|
||
|
||
Boxed type handling functions have to be provided to copy and free
|
||
opaque boxed structures of this type.
|
||
|
||
For the general case, it is recommended to use G_DEFINE_BOXED_TYPE()
|
||
instead of calling g_boxed_type_register_static() directly. The macro
|
||
will create the appropriate `*_get_type()` function for the boxed type.</doc>
|
||
<source-position filename="gboxed.h" line="97"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1248">New %G_TYPE_BOXED derived type id for @name.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1234">Name of the new boxed type.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="boxed_copy" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1235">Boxed structure copy function.</doc>
|
||
<type name="BoxedCopyFunc" c:type="GBoxedCopyFunc"/>
|
||
</parameter>
|
||
<parameter name="boxed_free" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1236">Boxed structure free function.</doc>
|
||
<type name="BoxedFreeFunc" c:type="GBoxedFreeFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_BOOLEAN__BOXED_BOXED"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXED"
|
||
moved-to="CClosure.marshal_BOOLEAN__BOXED_BOXED">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1252">A #GClosureMarshal function for use with signals with handlers that
|
||
take two boxed pointers as arguments and return a boolean. If you
|
||
have such a signal, you will probably also need to use an
|
||
accumulator, such as g_signal_accumulator_true_handled().</doc>
|
||
<source-position filename="gmarshal.h" line="399"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1254">A #GClosure.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1255">A #GValue to store the return value. May be %NULL
|
||
if the callback of closure doesn't return a value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1257">The length of the @param_values array.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1258">An array of #GValues holding the arguments
|
||
on which to invoke the callback of closure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1260">The invocation hint given as the last argument to
|
||
g_closure_invoke().</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1262">Additional data specified when registering the
|
||
marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_BOOLEAN__FLAGS"
|
||
c:identifier="g_cclosure_marshal_BOOLEAN__FLAGS"
|
||
moved-to="CClosure.marshal_BOOLEAN__FLAGS">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1292">A marshaller for a #GCClosure with a callback of type
|
||
`gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter
|
||
denotes a flags type.</doc>
|
||
<source-position filename="gmarshal.h" line="347"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1294">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1295">a #GValue which can store the returned #gboolean</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1296">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1297">a #GValue array holding instance and arg1</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1298">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1300">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_STRING__OBJECT_POINTER"
|
||
c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTER"
|
||
moved-to="CClosure.marshal_STRING__OBJECT_POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1351">A marshaller for a #GCClosure with a callback of type
|
||
`gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="382"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1353">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1354">a #GValue, which can store the returned string</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1355">3</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1356">a #GValue array holding instance, arg1 and arg2</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1357">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1359">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__BOOLEAN"
|
||
c:identifier="g_cclosure_marshal_VOID__BOOLEAN"
|
||
moved-to="CClosure.marshal_VOID__BOOLEAN">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1385">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="41"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1387">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1388">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1389">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1390">a #GValue array holding the instance and the #gboolean parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1391">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1393">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__BOXED"
|
||
c:identifier="g_cclosure_marshal_VOID__BOXED"
|
||
moved-to="CClosure.marshal_VOID__BOXED">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1419">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="262"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1421">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1422">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1423">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1424">a #GValue array holding the instance and the #GBoxed* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1425">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1427">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__CHAR"
|
||
c:identifier="g_cclosure_marshal_VOID__CHAR"
|
||
moved-to="CClosure.marshal_VOID__CHAR">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1453">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="58"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1455">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1456">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1457">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1458">a #GValue array holding the instance and the #gchar parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1459">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1461">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__DOUBLE"
|
||
c:identifier="g_cclosure_marshal_VOID__DOUBLE"
|
||
moved-to="CClosure.marshal_VOID__DOUBLE">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1487">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="211"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1489">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1490">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1491">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1492">a #GValue array holding the instance and the #gdouble parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1493">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1495">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__ENUM"
|
||
c:identifier="g_cclosure_marshal_VOID__ENUM"
|
||
moved-to="CClosure.marshal_VOID__ENUM">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1521">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type..</doc>
|
||
<source-position filename="gmarshal.h" line="160"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1523">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1524">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1525">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1526">a #GValue array holding the instance and the enumeration parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1527">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1529">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__FLAGS"
|
||
c:identifier="g_cclosure_marshal_VOID__FLAGS"
|
||
moved-to="CClosure.marshal_VOID__FLAGS">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1555">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type.</doc>
|
||
<source-position filename="gmarshal.h" line="177"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1557">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1558">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1559">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1560">a #GValue array holding the instance and the flags parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1561">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1563">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__FLOAT"
|
||
c:identifier="g_cclosure_marshal_VOID__FLOAT"
|
||
moved-to="CClosure.marshal_VOID__FLOAT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1589">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="194"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1591">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1592">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1593">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1594">a #GValue array holding the instance and the #gfloat parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1595">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1597">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__INT"
|
||
c:identifier="g_cclosure_marshal_VOID__INT"
|
||
moved-to="CClosure.marshal_VOID__INT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1623">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gint arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="92"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1625">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1626">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1627">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1628">a #GValue array holding the instance and the #gint parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1629">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1631">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__LONG"
|
||
c:identifier="g_cclosure_marshal_VOID__LONG"
|
||
moved-to="CClosure.marshal_VOID__LONG">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1657">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, glong arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="126"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1659">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1660">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1661">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1662">a #GValue array holding the instance and the #glong parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1663">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1665">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__OBJECT"
|
||
c:identifier="g_cclosure_marshal_VOID__OBJECT"
|
||
moved-to="CClosure.marshal_VOID__OBJECT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1691">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="296"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1693">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1694">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1695">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1696">a #GValue array holding the instance and the #GObject* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1697">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1699">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__PARAM"
|
||
c:identifier="g_cclosure_marshal_VOID__PARAM"
|
||
moved-to="CClosure.marshal_VOID__PARAM">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1725">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="245"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1727">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1728">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1729">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1730">a #GValue array holding the instance and the #GParamSpec* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1731">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1733">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__POINTER"
|
||
c:identifier="g_cclosure_marshal_VOID__POINTER"
|
||
moved-to="CClosure.marshal_VOID__POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1759">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="279"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1761">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1762">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1763">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1764">a #GValue array holding the instance and the #gpointer parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1765">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1767">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__STRING"
|
||
c:identifier="g_cclosure_marshal_VOID__STRING"
|
||
moved-to="CClosure.marshal_VOID__STRING">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1793">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="228"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1795">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1796">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1797">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1798">a #GValue array holding the instance and the #gchar* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1799">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1801">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__UCHAR"
|
||
c:identifier="g_cclosure_marshal_VOID__UCHAR"
|
||
moved-to="CClosure.marshal_VOID__UCHAR">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1827">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="75"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1829">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1830">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1831">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1832">a #GValue array holding the instance and the #guchar parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1833">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1835">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__UINT"
|
||
c:identifier="g_cclosure_marshal_VOID__UINT"
|
||
moved-to="CClosure.marshal_VOID__UINT">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1861">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guint arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="109"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1863">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1864">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1865">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1866">a #GValue array holding the instance and the #guint parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1867">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1869">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__UINT_POINTER"
|
||
c:identifier="g_cclosure_marshal_VOID__UINT_POINTER"
|
||
moved-to="CClosure.marshal_VOID__UINT_POINTER">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1876">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="330"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1878">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1879">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1880">3</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1881">a #GValue array holding instance, arg1 and arg2</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1882">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1884">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__ULONG"
|
||
c:identifier="g_cclosure_marshal_VOID__ULONG"
|
||
moved-to="CClosure.marshal_VOID__ULONG">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1929">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="143"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1931">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1932">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1933">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1934">a #GValue array holding the instance and the #gulong parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1935">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1937">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__VARIANT"
|
||
c:identifier="g_cclosure_marshal_VOID__VARIANT"
|
||
moved-to="CClosure.marshal_VOID__VARIANT"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1963">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="313"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1965">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1966">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1967">2</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1968">a #GValue array holding the instance and the #GVariant* parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1969">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1971">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_VOID__VOID"
|
||
c:identifier="g_cclosure_marshal_VOID__VOID"
|
||
moved-to="CClosure.marshal_VOID__VOID">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="1999">A marshaller for a #GCClosure with a callback of type
|
||
`void (*callback) (gpointer instance, gpointer user_data)`.</doc>
|
||
<source-position filename="gmarshal.h" line="24"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2001">the #GClosure to which the marshaller belongs</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2002">ignored</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2003">1</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2004">a #GValue array holding only the instance</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2005">the invocation hint given as the last argument
|
||
to g_closure_invoke()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2007">additional data specified when registering the marshaller</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_marshal_generic"
|
||
c:identifier="g_cclosure_marshal_generic"
|
||
moved-to="CClosure.marshal_generic"
|
||
version="2.30">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2033">A generic marshaller function implemented via
|
||
[libffi](http://sourceware.org/libffi/).
|
||
|
||
Normally this function is not passed explicitly to g_signal_new(),
|
||
but used automatically by GLib when specifying a %NULL marshaller.</doc>
|
||
<source-position filename="gclosure.h" line="304"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2035">A #GClosure.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="return_gvalue" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2036">A #GValue to store the return value. May be %NULL
|
||
if the callback of closure doesn't return a value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="n_param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2038">The length of the @param_values array.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2039">An array of #GValues holding the arguments
|
||
on which to invoke the callback of closure.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="invocation_hint"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2041">The invocation hint given as the last argument to
|
||
g_closure_invoke().</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="marshal_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2043">Additional data specified when registering the
|
||
marshaller, see g_closure_set_marshal() and
|
||
g_closure_set_meta_marshal()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_new"
|
||
c:identifier="g_cclosure_new"
|
||
moved-to="CClosure.new"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2080">Creates a new closure which invokes @callback_func with @user_data as
|
||
the last parameter.
|
||
|
||
@destroy_data will be called as a finalize notifier on the #GClosure.</doc>
|
||
<source-position filename="gclosure.h" line="231"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2091">a floating reference to a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2082">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2083">user data to pass to @callback_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy_data" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2084">destroy notify to be called when @user_data is no longer used</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_new_object"
|
||
c:identifier="g_cclosure_new_object"
|
||
moved-to="CClosure.new_object"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2095">A variant of g_cclosure_new() which uses @object as @user_data and
|
||
calls g_object_watch_closure() on @object and the created
|
||
closure. This function is useful when you have a callback closely
|
||
associated with a #GObject, and want the callback to no longer run
|
||
after the object is is freed.</doc>
|
||
<source-position filename="gobject.h" line="642"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2106">a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2097">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2098">a #GObject pointer to pass to @callback_func</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_new_object_swap"
|
||
c:identifier="g_cclosure_new_object_swap"
|
||
moved-to="CClosure.new_object_swap"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2110">A variant of g_cclosure_new_swap() which uses @object as @user_data
|
||
and calls g_object_watch_closure() on @object and the created
|
||
closure. This function is useful when you have a callback closely
|
||
associated with a #GObject, and want the callback to no longer run
|
||
after the object is is freed.</doc>
|
||
<source-position filename="gobject.h" line="645"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2121">a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2112">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="object" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2113">a #GObject pointer to pass to @callback_func</doc>
|
||
<type name="Object" c:type="GObject*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="cclosure_new_swap"
|
||
c:identifier="g_cclosure_new_swap"
|
||
moved-to="CClosure.new_swap"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2125">Creates a new closure which invokes @callback_func with @user_data as
|
||
the first parameter.
|
||
|
||
@destroy_data will be called as a finalize notifier on the #GClosure.</doc>
|
||
<source-position filename="gclosure.h" line="235"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2136">a floating reference to a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="callback_func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2127">the function to invoke</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="user_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2128">user data to pass to @callback_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy_data" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2129">destroy notify to be called when @user_data is no longer used</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="clear_object"
|
||
c:identifier="g_clear_object"
|
||
version="2.28"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2140">Clears a reference to a #GObject.
|
||
|
||
@object_ptr must not be %NULL.
|
||
|
||
If the reference is %NULL then this function does nothing.
|
||
Otherwise, the reference count of the object is decreased and the
|
||
pointer is set to %NULL.
|
||
|
||
A macro is also included that allows this function to be used without
|
||
pointer casts.</doc>
|
||
<source-position filename="gobject.h" line="709"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="object_ptr" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2142">a pointer to a #GObject reference</doc>
|
||
<type name="Object" c:type="GObject**"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="clear_signal_handler"
|
||
c:identifier="g_clear_signal_handler"
|
||
version="2.62">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2159">Disconnects a handler from @instance so it will not be called during
|
||
any future or currently ongoing emissions of the signal it has been
|
||
connected to. The @handler_id_ptr is then set to zero, which is never a valid handler ID value (see g_signal_connect()).
|
||
|
||
If the handler ID is 0 then this function does nothing.
|
||
|
||
There is also a macro version of this function so that the code
|
||
will be inlined.</doc>
|
||
<source-position filename="gsignal.h" line="461"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="handler_id_ptr" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2161">A pointer to a handler ID (of type #gulong) of the handler to be disconnected.</doc>
|
||
<type name="gulong" c:type="gulong*"/>
|
||
</parameter>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2162">The instance to remove the signal handler from.
|
||
This pointer may be %NULL or invalid, if the handler ID is zero.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="clear_weak_pointer"
|
||
c:identifier="g_clear_weak_pointer"
|
||
version="2.56"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="831">Clears a weak reference to a #GObject.
|
||
|
||
@weak_pointer_location must not be %NULL.
|
||
|
||
If the weak reference is %NULL then this function does nothing.
|
||
Otherwise, the weak reference to the object is removed for that location
|
||
and the pointer is set to %NULL.
|
||
|
||
A macro is also included that allows this function to be used without
|
||
pointer casts. The function itself is static inline, so its address may vary
|
||
between compilation units.</doc>
|
||
<source-position filename="gobject.h" line="861"/>
|
||
<parameters>
|
||
<parameter name="weak_pointer_location">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="833">The memory address of a pointer</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="enum_complete_type_info"
|
||
c:identifier="g_enum_complete_type_info">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2478">This function is meant to be called from the `complete_type_info`
|
||
function of a #GTypePlugin implementation, as in the following
|
||
example:
|
||
|
||
|[<!-- language="C" -->
|
||
static void
|
||
my_enum_complete_type_info (GTypePlugin *plugin,
|
||
GType g_type,
|
||
GTypeInfo *info,
|
||
GTypeValueTable *value_table)
|
||
{
|
||
static const GEnumValue values[] = {
|
||
{ MY_ENUM_FOO, "MY_ENUM_FOO", "foo" },
|
||
{ MY_ENUM_BAR, "MY_ENUM_BAR", "bar" },
|
||
{ 0, NULL, NULL }
|
||
};
|
||
|
||
g_enum_complete_type_info (type, info, values);
|
||
}
|
||
]|</doc>
|
||
<source-position filename="genums.h" line="271"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_enum_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2480">the type identifier of the type being completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2481">the #GTypeInfo struct to be filled in</doc>
|
||
<type name="TypeInfo" c:type="GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="const_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2482">An array of #GEnumValue structs for the possible
|
||
enumeration values. The array is terminated by a struct with all
|
||
members being 0.</doc>
|
||
<type name="EnumValue" c:type="const GEnumValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="enum_get_value" c:identifier="g_enum_get_value">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2509">Returns the #GEnumValue for a value.</doc>
|
||
<source-position filename="genums.h" line="221"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2516">the #GEnumValue for @value, or %NULL
|
||
if @value is not a member of the enumeration</doc>
|
||
<type name="EnumValue" c:type="GEnumValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="enum_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2511">a #GEnumClass</doc>
|
||
<type name="EnumClass" c:type="GEnumClass*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2512">the value to look up</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="enum_get_value_by_name"
|
||
c:identifier="g_enum_get_value_by_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2521">Looks up a #GEnumValue by name.</doc>
|
||
<source-position filename="genums.h" line="224"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2528">the #GEnumValue with name @name,
|
||
or %NULL if the enumeration doesn't have a member
|
||
with that name</doc>
|
||
<type name="EnumValue" c:type="GEnumValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="enum_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2523">a #GEnumClass</doc>
|
||
<type name="EnumClass" c:type="GEnumClass*"/>
|
||
</parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2524">the name to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="enum_get_value_by_nick"
|
||
c:identifier="g_enum_get_value_by_nick">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2534">Looks up a #GEnumValue by nickname.</doc>
|
||
<source-position filename="genums.h" line="227"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2541">the #GEnumValue with nickname @nick,
|
||
or %NULL if the enumeration doesn't have a member
|
||
with that nickname</doc>
|
||
<type name="EnumValue" c:type="GEnumValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="enum_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2536">a #GEnumClass</doc>
|
||
<type name="EnumClass" c:type="GEnumClass*"/>
|
||
</parameter>
|
||
<parameter name="nick" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2537">the nickname to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="enum_register_static"
|
||
c:identifier="g_enum_register_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2547">Registers a new static enumeration type with the name @name.
|
||
|
||
It is normally more convenient to let [glib-mkenums][glib-mkenums],
|
||
generate a my_enum_get_type() function from a usual C enumeration
|
||
definition than to write one yourself using g_enum_register_static().</doc>
|
||
<source-position filename="genums.h" line="262"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2561">The new type identifier.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2549">A nul-terminated string used as the name of the new type.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="const_static_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2550">An array of #GEnumValue structs for the possible
|
||
enumeration values. The array is terminated by a struct with all
|
||
members being 0. GObject keeps a reference to the data, so it cannot
|
||
be stack-allocated.</doc>
|
||
<type name="EnumValue" c:type="const GEnumValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="enum_to_string"
|
||
c:identifier="g_enum_to_string"
|
||
version="2.54">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2565">Pretty-prints @value in the form of the enum’s name.
|
||
|
||
This is intended to be used for debugging purposes. The format of the output
|
||
may change in the future.</doc>
|
||
<source-position filename="genums.h" line="239"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2575">a newly-allocated text string</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_enum_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2567">the type identifier of a #GEnumClass type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2568">the value</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<docsection name="enumerations_flags">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="187">The GLib type system provides fundamental types for enumeration and
|
||
flags types. (Flags types are like enumerations, but allow their
|
||
values to be combined by bitwise or). A registered enumeration or
|
||
flags type associates a name and a nickname with each allowed
|
||
value, and the methods g_enum_get_value_by_name(),
|
||
g_enum_get_value_by_nick(), g_flags_get_value_by_name() and
|
||
g_flags_get_value_by_nick() can look up values by their name or
|
||
nickname. When an enumeration or flags type is registered with the
|
||
GLib type system, it can be used as value type for object
|
||
properties, using g_param_spec_enum() or g_param_spec_flags().
|
||
|
||
GObject ships with a utility called [glib-mkenums][glib-mkenums],
|
||
that can construct suitable type registration functions from C enumeration
|
||
definitions.
|
||
|
||
Example of how to get a string representation of an enum value:
|
||
|[<!-- language="C" -->
|
||
GEnumClass *enum_class;
|
||
GEnumValue *enum_value;
|
||
|
||
enum_class = g_type_class_ref (MAMAN_TYPE_MY_ENUM);
|
||
enum_value = g_enum_get_value (enum_class, MAMAN_MY_ENUM_FOO);
|
||
|
||
g_print ("Name: %s\n", enum_value->value_name);
|
||
|
||
g_type_class_unref (enum_class);
|
||
]|</doc>
|
||
</docsection>
|
||
<function name="flags_complete_type_info"
|
||
c:identifier="g_flags_complete_type_info">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2580">This function is meant to be called from the complete_type_info()
|
||
function of a #GTypePlugin implementation, see the example for
|
||
g_enum_complete_type_info() above.</doc>
|
||
<source-position filename="genums.h" line="275"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_flags_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2582">the type identifier of the type being completed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2583">the #GTypeInfo struct to be filled in</doc>
|
||
<type name="TypeInfo" c:type="GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="const_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2584">An array of #GFlagsValue structs for the possible
|
||
enumeration values. The array is terminated by a struct with all
|
||
members being 0.</doc>
|
||
<type name="FlagsValue" c:type="const GFlagsValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="flags_get_first_value"
|
||
c:identifier="g_flags_get_first_value">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2594">Returns the first #GFlagsValue which is set in @value.</doc>
|
||
<source-position filename="genums.h" line="230"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2601">the first #GFlagsValue which is set in
|
||
@value, or %NULL if none is set</doc>
|
||
<type name="FlagsValue" c:type="GFlagsValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="flags_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2596">a #GFlagsClass</doc>
|
||
<type name="FlagsClass" c:type="GFlagsClass*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2597">the value</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="flags_get_value_by_name"
|
||
c:identifier="g_flags_get_value_by_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2606">Looks up a #GFlagsValue by name.</doc>
|
||
<source-position filename="genums.h" line="233"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2613">the #GFlagsValue with name @name,
|
||
or %NULL if there is no flag with that name</doc>
|
||
<type name="FlagsValue" c:type="GFlagsValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="flags_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2608">a #GFlagsClass</doc>
|
||
<type name="FlagsClass" c:type="GFlagsClass*"/>
|
||
</parameter>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2609">the name to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="flags_get_value_by_nick"
|
||
c:identifier="g_flags_get_value_by_nick">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2618">Looks up a #GFlagsValue by nickname.</doc>
|
||
<source-position filename="genums.h" line="236"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2625">the #GFlagsValue with nickname @nick,
|
||
or %NULL if there is no flag with that nickname</doc>
|
||
<type name="FlagsValue" c:type="GFlagsValue*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="flags_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2620">a #GFlagsClass</doc>
|
||
<type name="FlagsClass" c:type="GFlagsClass*"/>
|
||
</parameter>
|
||
<parameter name="nick" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2621">the nickname to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="flags_register_static"
|
||
c:identifier="g_flags_register_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2630">Registers a new static flags type with the name @name.
|
||
|
||
It is normally more convenient to let [glib-mkenums][glib-mkenums]
|
||
generate a my_flags_get_type() function from a usual C enumeration
|
||
definition than to write one yourself using g_flags_register_static().</doc>
|
||
<source-position filename="genums.h" line="265"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2643">The new type identifier.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2632">A nul-terminated string used as the name of the new type.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="const_static_values" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2633">An array of #GFlagsValue structs for the possible
|
||
flags values. The array is terminated by a struct with all members being 0.
|
||
GObject keeps a reference to the data, so it cannot be stack-allocated.</doc>
|
||
<type name="FlagsValue" c:type="const GFlagsValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="flags_to_string"
|
||
c:identifier="g_flags_to_string"
|
||
version="2.54">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2647">Pretty-prints @value in the form of the flag names separated by ` | ` and
|
||
sorted. Any extra bits will be shown at the end as a hexadecimal number.
|
||
|
||
This is intended to be used for debugging purposes. The format of the output
|
||
may change in the future.</doc>
|
||
<source-position filename="genums.h" line="242"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2658">a newly-allocated text string</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="flags_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2649">the type identifier of a #GFlagsClass type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="2650">the value</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<docsection name="gboxed">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="328">#GBoxed is a generic wrapper mechanism for arbitrary C structures.
|
||
|
||
The only thing the type system needs to know about the structures is how to
|
||
copy them (a #GBoxedCopyFunc) and how to free them (a #GBoxedFreeFunc);
|
||
beyond that, they are treated as opaque chunks of memory.
|
||
|
||
Boxed types are useful for simple value-holder structures like rectangles or
|
||
points. They can also be used for wrapping structures defined in non-#GObject
|
||
based libraries. They allow arbitrary structures to be handled in a uniform
|
||
way, allowing uniform copying (or referencing) and freeing (or unreferencing)
|
||
of them, and uniform representation of the type of the contained structure.
|
||
In turn, this allows any type which can be boxed to be set as the data in a
|
||
#GValue, which allows for polymorphic handling of a much wider range of data
|
||
types, and hence usage of such types as #GObject property values.
|
||
|
||
#GBoxed is designed so that reference counted types can be boxed. Use the
|
||
type’s ‘ref’ function as the #GBoxedCopyFunc, and its ‘unref’ function as the
|
||
#GBoxedFreeFunc. For example, for #GBytes, the #GBoxedCopyFunc is
|
||
g_bytes_ref(), and the #GBoxedFreeFunc is g_bytes_unref().</doc>
|
||
</docsection>
|
||
<docsection name="generic_values">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="409">The #GValue structure is basically a variable container that consists
|
||
of a type identifier and a specific value of that type.
|
||
|
||
The type identifier within a #GValue structure always determines the
|
||
type of the associated value.
|
||
|
||
To create an undefined #GValue structure, simply create a zero-filled
|
||
#GValue structure. To initialize the #GValue, use the g_value_init()
|
||
function. A #GValue cannot be used until it is initialized. Before
|
||
destruction you must always use g_value_unset() to make sure allocated
|
||
memory is freed.
|
||
|
||
The basic type operations (such as freeing and copying) are determined
|
||
by the #GTypeValueTable associated with the type ID stored in the #GValue.
|
||
Other #GValue operations (such as converting values between types) are
|
||
provided by this interface.
|
||
|
||
The code in the example program below demonstrates #GValue's
|
||
features.
|
||
|
||
|[<!-- language="C" -->
|
||
#include <glib-object.h>
|
||
|
||
static void
|
||
int2string (const GValue *src_value,
|
||
GValue *dest_value)
|
||
{
|
||
if (g_value_get_int (src_value) == 42)
|
||
g_value_set_static_string (dest_value, "An important number");
|
||
else
|
||
g_value_set_static_string (dest_value, "What's that?");
|
||
}
|
||
|
||
int
|
||
main (int argc,
|
||
char *argv[])
|
||
{
|
||
// GValues must be initialized
|
||
GValue a = G_VALUE_INIT;
|
||
GValue b = G_VALUE_INIT;
|
||
const gchar *message;
|
||
|
||
// The GValue starts empty
|
||
g_assert (!G_VALUE_HOLDS_STRING (&a));
|
||
|
||
// Put a string in it
|
||
g_value_init (&a, G_TYPE_STRING);
|
||
g_assert (G_VALUE_HOLDS_STRING (&a));
|
||
g_value_set_static_string (&a, "Hello, world!");
|
||
g_printf ("%s\n", g_value_get_string (&a));
|
||
|
||
// Reset it to its pristine state
|
||
g_value_unset (&a);
|
||
|
||
// It can then be reused for another type
|
||
g_value_init (&a, G_TYPE_INT);
|
||
g_value_set_int (&a, 42);
|
||
|
||
// Attempt to transform it into a GValue of type STRING
|
||
g_value_init (&b, G_TYPE_STRING);
|
||
|
||
// An INT is transformable to a STRING
|
||
g_assert (g_value_type_transformable (G_TYPE_INT, G_TYPE_STRING));
|
||
|
||
g_value_transform (&a, &b);
|
||
g_printf ("%s\n", g_value_get_string (&b));
|
||
|
||
// Attempt to transform it again using a custom transform function
|
||
g_value_register_transform_func (G_TYPE_INT, G_TYPE_STRING, int2string);
|
||
g_value_transform (&a, &b);
|
||
g_printf ("%s\n", g_value_get_string (&b));
|
||
return 0;
|
||
}
|
||
]|
|
||
|
||
See also [gobject-Standard-Parameter-and-Value-Types] for more information on
|
||
validation of #GValue.
|
||
|
||
For letting a #GValue own (and memory manage) arbitrary types or pointers,
|
||
they need to become a [boxed type][gboxed]. The example below shows how
|
||
the pointer `mystruct` of type `MyStruct` is used as a [boxed type][gboxed].
|
||
|
||
|[<!-- language="C" -->
|
||
typedef struct { ... } MyStruct;
|
||
G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free)
|
||
|
||
// These two lines normally go in a public header. By GObject convention,
|
||
// the naming scheme is NAMESPACE_TYPE_NAME:
|
||
#define MY_TYPE_STRUCT (my_struct_get_type ())
|
||
GType my_struct_get_type (void);
|
||
|
||
void
|
||
foo ()
|
||
{
|
||
GValue *value = g_new0 (GValue, 1);
|
||
g_value_init (value, MY_TYPE_STRUCT);
|
||
g_value_set_boxed (value, mystruct);
|
||
// [... your code ....]
|
||
g_value_unset (value);
|
||
g_value_free (value);
|
||
}
|
||
]|</doc>
|
||
</docsection>
|
||
<docsection name="gtype">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="577">The GType API is the foundation of the GObject system. It provides the
|
||
facilities for registering and managing all fundamental data types,
|
||
user-defined object and interface types.
|
||
|
||
For type creation and registration purposes, all types fall into one of
|
||
two categories: static or dynamic. Static types are never loaded or
|
||
unloaded at run-time as dynamic types may be. Static types are created
|
||
with g_type_register_static() that gets type specific information passed
|
||
in via a #GTypeInfo structure.
|
||
|
||
Dynamic types are created with g_type_register_dynamic() which takes a
|
||
#GTypePlugin structure instead. The remaining type information (the
|
||
#GTypeInfo structure) is retrieved during runtime through #GTypePlugin
|
||
and the g_type_plugin_*() API.
|
||
|
||
These registration functions are usually called only once from a
|
||
function whose only purpose is to return the type identifier for a
|
||
specific class. Once the type (or class or interface) is registered,
|
||
it may be instantiated, inherited, or implemented depending on exactly
|
||
what sort of type it is.
|
||
|
||
There is also a third registration function for registering fundamental
|
||
types called g_type_register_fundamental() which requires both a #GTypeInfo
|
||
structure and a #GTypeFundamentalInfo structure but it is seldom used
|
||
since most fundamental types are predefined rather than user-defined.
|
||
|
||
Type instance and class structs are limited to a total of 64 KiB,
|
||
including all parent types. Similarly, type instances' private data
|
||
(as created by G_ADD_PRIVATE()) are limited to a total of
|
||
64 KiB. If a type instance needs a large static buffer, allocate it
|
||
separately (typically by using #GArray or #GPtrArray) and put a pointer
|
||
to the buffer in the structure.
|
||
|
||
As mentioned in the [GType conventions][gtype-conventions], type names must
|
||
be at least three characters long. There is no upper length limit. The first
|
||
character must be a letter (a–z or A–Z) or an underscore (‘_’). Subsequent
|
||
characters can be letters, numbers or any of ‘-_+’.</doc>
|
||
</docsection>
|
||
<function name="gtype_get_type" c:identifier="g_gtype_get_type">
|
||
<source-position filename="gvaluetypes.h" line="272"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
</function>
|
||
<docsection name="objects">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="719">GObject is the fundamental type providing the common attributes and
|
||
methods for all object types in GTK+, Pango and other libraries
|
||
based on GObject. The GObject class provides methods for object
|
||
construction and destruction, property access methods, and signal
|
||
support. Signals are described in detail [here][gobject-Signals].
|
||
|
||
For a tutorial on implementing a new GObject class, see [How to define and
|
||
implement a new GObject][howto-gobject]. For a list of naming conventions for
|
||
GObjects and their methods, see the [GType conventions][gtype-conventions].
|
||
For the high-level concepts behind GObject, read [Instantiatable classed types:
|
||
Objects][gtype-instantiatable-classed].
|
||
|
||
## Floating references # {#floating-ref}
|
||
|
||
**Note**: Floating references are a C convenience API and should not be
|
||
used in modern GObject code. Language bindings in particular find the
|
||
concept highly problematic, as floating references are not identifiable
|
||
through annotations, and neither are deviations from the floating reference
|
||
behavior, like types that inherit from #GInitiallyUnowned and still return
|
||
a full reference from g_object_new().
|
||
|
||
GInitiallyUnowned is derived from GObject. The only difference between
|
||
the two is that the initial reference of a GInitiallyUnowned is flagged
|
||
as a "floating" reference. This means that it is not specifically
|
||
claimed to be "owned" by any code portion. The main motivation for
|
||
providing floating references is C convenience. In particular, it
|
||
allows code to be written as:
|
||
|
||
|[<!-- language="C" -->
|
||
container = create_container ();
|
||
container_add_child (container, create_child());
|
||
]|
|
||
|
||
If container_add_child() calls g_object_ref_sink() on the passed-in child,
|
||
no reference of the newly created child is leaked. Without floating
|
||
references, container_add_child() can only g_object_ref() the new child,
|
||
so to implement this code without reference leaks, it would have to be
|
||
written as:
|
||
|
||
|[<!-- language="C" -->
|
||
Child *child;
|
||
container = create_container ();
|
||
child = create_child ();
|
||
container_add_child (container, child);
|
||
g_object_unref (child);
|
||
]|
|
||
|
||
The floating reference can be converted into an ordinary reference by
|
||
calling g_object_ref_sink(). For already sunken objects (objects that
|
||
don't have a floating reference anymore), g_object_ref_sink() is equivalent
|
||
to g_object_ref() and returns a new reference.
|
||
|
||
Since floating references are useful almost exclusively for C convenience,
|
||
language bindings that provide automated reference and memory ownership
|
||
maintenance (such as smart pointers or garbage collection) should not
|
||
expose floating references in their API. The best practice for handling
|
||
types that have initially floating references is to immediately sink those
|
||
references after g_object_new() returns, by checking if the #GType
|
||
inherits from #GInitiallyUnowned. For instance:
|
||
|
||
|[<!-- language="C" -->
|
||
GObject *res = g_object_new_with_properties (gtype,
|
||
n_props,
|
||
prop_names,
|
||
prop_values);
|
||
|
||
// or: if (g_type_is_a (gtype, G_TYPE_INITIALLY_UNOWNED))
|
||
if (G_IS_INITIALLY_UNOWNED (res))
|
||
g_object_ref_sink (res);
|
||
|
||
return res;
|
||
]|
|
||
|
||
Some object implementations may need to save an objects floating state
|
||
across certain code portions (an example is #GtkMenu), to achieve this,
|
||
the following sequence can be used:
|
||
|
||
|[<!-- language="C" -->
|
||
// save floating state
|
||
gboolean was_floating = g_object_is_floating (object);
|
||
g_object_ref_sink (object);
|
||
// protected code portion
|
||
|
||
...
|
||
|
||
// restore floating state
|
||
if (was_floating)
|
||
g_object_force_floating (object);
|
||
else
|
||
g_object_unref (object); // release previously acquired reference
|
||
]|</doc>
|
||
</docsection>
|
||
<function name="param_spec_boolean" c:identifier="g_param_spec_boolean">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3926">Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN
|
||
property. In many cases, it may be more appropriate to use an enum with
|
||
g_param_spec_enum(), both to improve code clarity by using explicitly named
|
||
values, and to allow for more values to be added in future without breaking
|
||
API.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1006"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3942">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3928">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3929">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3930">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3931">default value for the property specified</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3932">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_boxed" c:identifier="g_param_spec_boxed">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3946">Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED
|
||
derived property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1108"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3959">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3948">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3949">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3950">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="boxed_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3951">%G_TYPE_BOXED derived type of this property</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3952">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_char" c:identifier="g_param_spec_char">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3963">Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property.</doc>
|
||
<source-position filename="gparamspecs.h" line="990"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3975">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3965">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3966">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3967">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3968">minimum value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3969">maximum value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3970">default value for the property specified</doc>
|
||
<type name="gint8" c:type="gint8"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3971">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_double" c:identifier="g_param_spec_double">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3979">Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1088"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3994">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3981">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3982">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3983">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3984">minimum value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3985">maximum value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3986">default value for the property specified</doc>
|
||
<type name="gdouble" c:type="gdouble"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3987">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_enum" c:identifier="g_param_spec_enum">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="3998">Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1066"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4012">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4000">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4001">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4002">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="enum_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4003">a #GType derived from %G_TYPE_ENUM</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4004">default value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4005">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_flags" c:identifier="g_param_spec_flags">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4016">Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1073"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4030">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4018">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4019">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4020">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4021">a #GType derived from %G_TYPE_FLAGS</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4022">default value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4023">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_float" c:identifier="g_param_spec_float">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4034">Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1080"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4048">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4036">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4037">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4038">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4039">minimum value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4040">maximum value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4041">default value for the property specified</doc>
|
||
<type name="gfloat" c:type="gfloat"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4042">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_gtype"
|
||
c:identifier="g_param_spec_gtype"
|
||
version="2.10">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4138">Creates a new #GParamSpecGType instance specifying a
|
||
%G_TYPE_GTYPE property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1134"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4153">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4140">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4141">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4142">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="is_a_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4143">a #GType whose subtypes are allowed as values
|
||
of the property (use %G_TYPE_NONE for any type)</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4145">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_int" c:identifier="g_param_spec_int">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4157">Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1012"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4171">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4159">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4160">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4161">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4162">minimum value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4163">maximum value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4164">default value for the property specified</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4165">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_int64" c:identifier="g_param_spec_int64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4175">Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1044"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4189">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4177">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4178">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4179">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4180">minimum value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4181">maximum value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4182">default value for the property specified</doc>
|
||
<type name="gint64" c:type="gint64"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4183">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_long" c:identifier="g_param_spec_long">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4235">Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1028"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4249">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4237">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4238">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4239">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4240">minimum value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4241">maximum value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4242">default value for the property specified</doc>
|
||
<type name="glong" c:type="glong"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4243">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_object" c:identifier="g_param_spec_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4253">Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT
|
||
derived property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1125"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4266">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4255">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4256">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4257">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="object_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4258">%G_TYPE_OBJECT derived type of this property</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4259">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_override"
|
||
c:identifier="g_param_spec_override"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4270">Creates a new property of type #GParamSpecOverride. This is used
|
||
to direct operations to another paramspec, and will not be directly
|
||
useful unless you are implementing a new base type similar to GObject.</doc>
|
||
<source-position filename="gparamspecs.h" line="1131"/>
|
||
<return-value>
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4280">the newly created #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4272">the name of the property.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="overridden" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4273">The property that is being overridden</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_param" c:identifier="g_param_spec_param">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4284">Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1102"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4297">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4286">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4287">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4288">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="param_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4289">a #GType derived from %G_TYPE_PARAM</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4290">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_pointer" c:identifier="g_param_spec_pointer">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4301">Creates a new #GParamSpecPointer instance specifying a pointer property.
|
||
Where possible, it is better to use g_param_spec_object() or
|
||
g_param_spec_boxed() to expose memory management information.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1114"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4314">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4303">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4304">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4305">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4306">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_string" c:identifier="g_param_spec_string">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4476">Creates a new #GParamSpecString instance.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1096"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4488">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4478">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4479">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4480">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="default_value"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4481">default value for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4482">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_uchar" c:identifier="g_param_spec_uchar">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4492">Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property.</doc>
|
||
<source-position filename="gparamspecs.h" line="998"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4504">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4494">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4495">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4496">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4497">minimum value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4498">maximum value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4499">default value for the property specified</doc>
|
||
<type name="guint8" c:type="guint8"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4500">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_uint" c:identifier="g_param_spec_uint">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4508">Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1020"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4522">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4510">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4511">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4512">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4513">minimum value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4514">maximum value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4515">default value for the property specified</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4516">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_uint64" c:identifier="g_param_spec_uint64">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4526">Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1052"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4541">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4528">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4529">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4530">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4531">minimum value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4532">maximum value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4533">default value for the property specified</doc>
|
||
<type name="guint64" c:type="guint64"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4534">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_ulong" c:identifier="g_param_spec_ulong">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4545">Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG
|
||
property.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1036"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4560">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4547">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4548">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4549">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="minimum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4550">minimum value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
<parameter name="maximum" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4551">maximum value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4552">default value for the property specified</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4553">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_unichar" c:identifier="g_param_spec_unichar">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4564">Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT
|
||
property. #GValue structures for this property can be accessed with
|
||
g_value_set_uint() and g_value_get_uint().
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1060"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4578">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4566">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4567">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4568">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="default_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4569">default value for the property specified</doc>
|
||
<type name="gunichar" c:type="gunichar"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4570">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_value_array"
|
||
c:identifier="g_param_spec_value_array"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4590">Creates a new #GParamSpecValueArray instance specifying a
|
||
%G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a
|
||
%G_TYPE_BOXED type, as such, #GValue structures for this property
|
||
can be accessed with g_value_set_boxed() and g_value_get_boxed().
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1119"/>
|
||
<return-value>
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4606">a newly created parameter specification</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4592">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4593">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4594">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="element_spec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4595">a #GParamSpec describing the elements contained in
|
||
arrays of this property, may be %NULL</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4597">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_spec_variant"
|
||
c:identifier="g_param_spec_variant"
|
||
version="2.26">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4610">Creates a new #GParamSpecVariant instance specifying a #GVariant
|
||
property.
|
||
|
||
If @default_value is floating, it is consumed.
|
||
|
||
See g_param_spec_internal() for details on property names.</doc>
|
||
<source-position filename="gparamspecs.h" line="1140"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4627">the newly created #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4612">canonical name of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="nick"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4613">nick name for the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="blurb"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4614">description of the property specified</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4615">a #GVariantType</doc>
|
||
<type name="GLib.VariantType" c:type="const GVariantType*"/>
|
||
</parameter>
|
||
<parameter name="default_value"
|
||
transfer-ownership="full"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4616">a #GVariant of type @type to
|
||
use as the default value, or %NULL</doc>
|
||
<type name="GLib.Variant" c:type="GVariant*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4618">flags for the property specified</doc>
|
||
<type name="ParamFlags" c:type="GParamFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_type_register_static"
|
||
c:identifier="g_param_type_register_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4632">Registers @name as the name of a new static type derived
|
||
from %G_TYPE_PARAM.
|
||
|
||
The type system uses the information contained in the #GParamSpecTypeInfo
|
||
structure pointed to by @info to manage the #GParamSpec type and its
|
||
instances.</doc>
|
||
<source-position filename="gparam.h" line="416"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4644">The new type identifier.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4634">0-terminated string used as the name of the new #GParamSpec type.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="pspec_info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4635">The #GParamSpecTypeInfo for this #GParamSpec type.</doc>
|
||
<type name="ParamSpecTypeInfo" c:type="const GParamSpecTypeInfo*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_value_convert" c:identifier="g_param_value_convert">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4648">Transforms @src_value into @dest_value if possible, and then
|
||
validates @dest_value, in order for it to conform to @pspec. If
|
||
@strict_validation is %TRUE this function will only succeed if the
|
||
transformed @dest_value complied to @pspec without modifications.
|
||
|
||
See also g_value_type_transformable(), g_value_transform() and
|
||
g_param_value_validate().</doc>
|
||
<source-position filename="gparam.h" line="335"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4664">%TRUE if transformation and validation were successful,
|
||
%FALSE otherwise and @dest_value is left untouched.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4650">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="src_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4651">source #GValue</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="dest_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4652">destination #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="strict_validation" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4653">%TRUE requires @dest_value to conform to @pspec
|
||
without modifications</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_value_defaults"
|
||
c:identifier="g_param_value_defaults">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4669">Checks whether @value contains the default value as specified in @pspec.</doc>
|
||
<source-position filename="gparam.h" line="326"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4676">whether @value contains the canonical default for this @pspec</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4671">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4672">a #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_value_is_valid"
|
||
c:identifier="g_param_value_is_valid"
|
||
version="2.74">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4680">Return whether the contents of @value comply with the specifications
|
||
set out by @pspec.</doc>
|
||
<source-position filename="gparam.h" line="332"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4688">whether the contents of @value comply with the specifications
|
||
set out by @pspec.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4682">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4683">a #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_value_set_default"
|
||
c:identifier="g_param_value_set_default">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4694">Sets @value to its default value as specified in @pspec.</doc>
|
||
<source-position filename="gparam.h" line="323"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4696">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4697">a #GValue of correct type for @pspec; since 2.64, you
|
||
can also pass an empty #GValue, initialized with %G_VALUE_INIT</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<docsection name="param_value_types">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="819">#GValue provides an abstract container structure which can be
|
||
copied, transformed and compared while holding a value of any
|
||
(derived) type, which is registered as a #GType with a
|
||
#GTypeValueTable in its #GTypeInfo structure. Parameter
|
||
specifications for most value types can be created as #GParamSpec
|
||
derived instances, to implement e.g. #GObject properties which
|
||
operate on #GValue containers.
|
||
|
||
Parameter names need to start with a letter (a-z or A-Z). Subsequent
|
||
characters can be letters, numbers or a '-'.
|
||
All other characters are replaced by a '-' during construction.
|
||
|
||
See also #GValue for more information.</doc>
|
||
</docsection>
|
||
<function name="param_value_validate"
|
||
c:identifier="g_param_value_validate">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4704">Ensures that the contents of @value comply with the specifications
|
||
set out by @pspec. For example, a #GParamSpecInt might require
|
||
that integers stored in @value may not be smaller than -42 and not be
|
||
greater than +42. If @value contains an integer outside of this range,
|
||
it is modified accordingly, so the resulting value will fit into the
|
||
range -42 .. +42.</doc>
|
||
<source-position filename="gparam.h" line="329"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4716">whether modifying @value was necessary to ensure validity</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4706">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4707">a #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="param_values_cmp" c:identifier="g_param_values_cmp">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4720">Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1,
|
||
if @value1 is found to be less than, equal to or greater than @value2,
|
||
respectively.</doc>
|
||
<source-position filename="gparam.h" line="340"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4730">-1, 0 or +1, for a less than, equal to or greater than result</doc>
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="pspec" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4722">a valid #GParamSpec</doc>
|
||
<type name="ParamSpec" c:type="GParamSpec*"/>
|
||
</parameter>
|
||
<parameter name="value1" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4723">a #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="value2" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4724">a #GValue of correct type for @pspec</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="pointer_type_register_static"
|
||
c:identifier="g_pointer_type_register_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4734">Creates a new %G_TYPE_POINTER derived type id for a new
|
||
pointer type with name @name.</doc>
|
||
<source-position filename="gvaluetypes.h" line="292"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4741">a new %G_TYPE_POINTER derived type id for @name.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4736">the name of the new pointer type.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="set_object"
|
||
c:identifier="g_set_object"
|
||
version="2.44"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="712">Updates a #GObject pointer to refer to @new_object.
|
||
|
||
It increments the reference count of @new_object (if non-%NULL), decrements
|
||
the reference count of the current value of @object_ptr (if non-%NULL), and
|
||
assigns @new_object to @object_ptr. The assignment is not atomic.
|
||
|
||
@object_ptr must not be %NULL, but can point to a %NULL value.
|
||
|
||
A macro is also included that allows this function to be used without
|
||
pointer casts. The function itself is static inline, so its address may vary
|
||
between compilation units.
|
||
|
||
One convenient usage of this function is in implementing property setters:
|
||
|[
|
||
void
|
||
foo_set_bar (Foo *foo,
|
||
Bar *new_bar)
|
||
{
|
||
g_return_if_fail (IS_FOO (foo));
|
||
g_return_if_fail (new_bar == NULL || IS_BAR (new_bar));
|
||
|
||
if (g_set_object (&foo->bar, new_bar))
|
||
g_object_notify (foo, "bar");
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="777"/>
|
||
<parameters>
|
||
<parameter name="object_ptr">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="714">a pointer to a #GObject reference</doc>
|
||
</parameter>
|
||
<parameter name="new_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="715">a pointer to the new #GObject to
|
||
assign to @object_ptr, or %NULL to clear the pointer</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="set_weak_pointer"
|
||
c:identifier="g_set_weak_pointer"
|
||
version="2.56"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="866">Updates a pointer to weakly refer to @new_object.
|
||
|
||
It assigns @new_object to @weak_pointer_location and ensures
|
||
that @weak_pointer_location will automatically be set to %NULL
|
||
if @new_object gets destroyed. The assignment is not atomic.
|
||
The weak reference is not thread-safe, see g_object_add_weak_pointer()
|
||
for details.
|
||
|
||
The @weak_pointer_location argument must not be %NULL.
|
||
|
||
A macro is also included that allows this function to be used without
|
||
pointer casts. The function itself is static inline, so its address may vary
|
||
between compilation units.
|
||
|
||
One convenient usage of this function is in implementing property setters:
|
||
|[
|
||
void
|
||
foo_set_bar (Foo *foo,
|
||
Bar *new_bar)
|
||
{
|
||
g_return_if_fail (IS_FOO (foo));
|
||
g_return_if_fail (new_bar == NULL || IS_BAR (new_bar));
|
||
|
||
if (g_set_weak_pointer (&foo->bar, new_bar))
|
||
g_object_notify (foo, "bar");
|
||
}
|
||
]|</doc>
|
||
<source-position filename="gobject.h" line="929"/>
|
||
<parameters>
|
||
<parameter name="weak_pointer_location">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="868">the memory address of a pointer</doc>
|
||
</parameter>
|
||
<parameter name="new_object">
|
||
<doc xml:space="preserve"
|
||
filename="gobject.h"
|
||
line="869">a pointer to the new #GObject to
|
||
assign to it, or %NULL to clear the pointer</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_accumulator_first_wins"
|
||
c:identifier="g_signal_accumulator_first_wins"
|
||
version="2.28">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4745">A predefined #GSignalAccumulator for signals intended to be used as a
|
||
hook for application code to provide a particular value. Usually
|
||
only one such value is desired and multiple handlers for the same
|
||
signal don't make much sense (except for the case of the default
|
||
handler defined in the class structure, in which case you will
|
||
usually want the signal connection to override the class handler).
|
||
|
||
This accumulator will use the return value from the first signal
|
||
handler that is run as the return value for the signal and not run
|
||
any further handlers (ie: the first handler "wins").</doc>
|
||
<source-position filename="gsignal.h" line="635"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4763">standard #GSignalAccumulator result</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="ihint" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4747">standard #GSignalAccumulator parameter</doc>
|
||
<type name="SignalInvocationHint" c:type="GSignalInvocationHint*"/>
|
||
</parameter>
|
||
<parameter name="return_accu" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4748">standard #GSignalAccumulator parameter</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="handler_return" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4749">standard #GSignalAccumulator parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="dummy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4750">standard #GSignalAccumulator parameter</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_accumulator_true_handled"
|
||
c:identifier="g_signal_accumulator_true_handled"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4768">A predefined #GSignalAccumulator for signals that return a
|
||
boolean values. The behavior that this accumulator gives is
|
||
that a return of %TRUE stops the signal emission: no further
|
||
callbacks will be invoked, while a return of %FALSE allows
|
||
the emission to continue. The idea here is that a %TRUE return
|
||
indicates that the callback handled the signal, and no further
|
||
handling is needed.</doc>
|
||
<source-position filename="gsignal.h" line="629"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4784">standard #GSignalAccumulator result</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="ihint" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4770">standard #GSignalAccumulator parameter</doc>
|
||
<type name="SignalInvocationHint" c:type="GSignalInvocationHint*"/>
|
||
</parameter>
|
||
<parameter name="return_accu" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4771">standard #GSignalAccumulator parameter</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
<parameter name="handler_return" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4772">standard #GSignalAccumulator parameter</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="dummy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4773">standard #GSignalAccumulator parameter</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_add_emission_hook"
|
||
c:identifier="g_signal_add_emission_hook">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4788">Adds an emission hook for a signal, which will get called for any emission
|
||
of that signal, independent of the instance. This is possible only
|
||
for signals which don't have %G_SIGNAL_NO_HOOKS flag set.</doc>
|
||
<source-position filename="gsignal.h" line="381"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4800">the hook id, for later use with g_signal_remove_emission_hook().</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4790">the signal identifier, as returned by g_signal_lookup().</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4791">the detail on which to call the hook.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="hook_func"
|
||
transfer-ownership="none"
|
||
scope="notified"
|
||
closure="3"
|
||
destroy="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4792">a #GSignalEmissionHook function.</doc>
|
||
<type name="SignalEmissionHook" c:type="GSignalEmissionHook"/>
|
||
</parameter>
|
||
<parameter name="hook_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4793">user data for @hook_func.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="data_destroy"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="async"
|
||
destroy="3">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4794">a #GDestroyNotify for @hook_data.</doc>
|
||
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_chain_from_overridden"
|
||
c:identifier="g_signal_chain_from_overridden">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4804">Calls the original class closure of a signal. This function should only
|
||
be called from an overridden class closure; see
|
||
g_signal_override_class_closure() and
|
||
g_signal_override_class_handler().</doc>
|
||
<source-position filename="gsignal.h" line="488"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_and_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4806">the argument list of the signal emission.
|
||
The first element in the array is a #GValue for the instance the signal
|
||
is being emitted on. The rest are any arguments to be passed to the signal.</doc>
|
||
<array zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="return_value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4809">Location for the return value.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_chain_from_overridden_handler"
|
||
c:identifier="g_signal_chain_from_overridden_handler"
|
||
version="2.18"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4818">Calls the original class closure of a signal. This function should
|
||
only be called from an overridden class closure; see
|
||
g_signal_override_class_closure() and
|
||
g_signal_override_class_handler().</doc>
|
||
<source-position filename="gsignal.h" line="491"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4820">the instance the signal is being
|
||
emitted on.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4822">parameters to be passed to the parent class closure, followed by a
|
||
location for the return value. If the return type of the signal
|
||
is %G_TYPE_NONE, the return value location can be omitted.</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="signal_connect"
|
||
c:identifier="g_signal_connect"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="496">Connects a #GCallback function to a signal for a particular object.
|
||
|
||
The handler will be called synchronously, before the default handler of the signal. g_signal_emit() will not return control until all handlers are called.
|
||
|
||
See [memory management of signal handlers][signal-memory-management] for
|
||
details on how to handle the return value and memory management of @data.</doc>
|
||
<source-position filename="gsignal.h" line="514"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="498">the instance to connect to.</doc>
|
||
</parameter>
|
||
<parameter name="detailed_signal">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="499">a string of the form "signal-name::detail".</doc>
|
||
</parameter>
|
||
<parameter name="c_handler">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="500">the #GCallback to connect.</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="501">data to pass to @c_handler calls.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="signal_connect_after"
|
||
c:identifier="g_signal_connect_after"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="516">Connects a #GCallback function to a signal for a particular object.
|
||
|
||
The handler will be called synchronously, after the default handler of the signal.</doc>
|
||
<source-position filename="gsignal.h" line="529"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="518">the instance to connect to.</doc>
|
||
</parameter>
|
||
<parameter name="detailed_signal">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="519">a string of the form "signal-name::detail".</doc>
|
||
</parameter>
|
||
<parameter name="c_handler">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="520">the #GCallback to connect.</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="521">data to pass to @c_handler calls.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_connect_closure"
|
||
c:identifier="g_signal_connect_closure">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4835">Connects a closure to a signal for a particular object.
|
||
|
||
If @closure is a floating reference (see g_closure_sink()), this function
|
||
takes ownership of @closure.</doc>
|
||
<source-position filename="gsignal.h" line="404"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4848">the handler ID (always greater than 0 for successful connections)</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4837">the instance to connect to.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4838">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4839">the closure to connect.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="after" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4840">whether the handler should be called before or after the
|
||
default handler of the signal.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_connect_closure_by_id"
|
||
c:identifier="g_signal_connect_closure_by_id">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4852">Connects a closure to a signal for a particular object.
|
||
|
||
If @closure is a floating reference (see g_closure_sink()), this function
|
||
takes ownership of @closure.</doc>
|
||
<source-position filename="gsignal.h" line="398"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4866">the handler ID (always greater than 0 for successful connections)</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4854">the instance to connect to.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4855">the id of the signal.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4856">the detail.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4857">the closure to connect.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="after" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4858">whether the handler should be called before or after the
|
||
default handler of the signal.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_connect_data"
|
||
c:identifier="g_signal_connect_data"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4870">Connects a #GCallback function to a signal for a particular object. Similar
|
||
to g_signal_connect(), but allows to provide a #GClosureNotify for the data
|
||
which will be called when the signal handler is disconnected and no longer
|
||
used. Specify @connect_flags if you need `..._after()` or
|
||
`..._swapped()` variants of this function.</doc>
|
||
<source-position filename="gsignal.h" line="409"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4885">the handler ID (always greater than 0 for successful connections)</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4872">the instance to connect to.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4873">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler" transfer-ownership="none" closure="3">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4874">the #GCallback to connect.</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified"
|
||
closure="2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4875">data to pass to @c_handler calls.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="destroy_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
scope="notified"
|
||
destroy="3">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4876">a #GClosureNotify for @data.</doc>
|
||
<type name="ClosureNotify" c:type="GClosureNotify"/>
|
||
</parameter>
|
||
<parameter name="connect_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4877">a combination of #GConnectFlags.</doc>
|
||
<type name="ConnectFlags" c:type="GConnectFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_connect_object"
|
||
c:identifier="g_signal_connect_object"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4889">This is similar to g_signal_connect_data(), but uses a closure which
|
||
ensures that the @gobject stays alive during the call to @c_handler
|
||
by temporarily adding a reference count to @gobject.
|
||
|
||
When the @gobject is destroyed the signal handler will be automatically
|
||
disconnected. Note that this is not currently threadsafe (ie:
|
||
emitting a signal while @gobject is being destroyed in another thread
|
||
is not safe).</doc>
|
||
<source-position filename="gobject.h" line="658"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4907">the handler id.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4891">the instance to connect to.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4892">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="c_handler" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4893">the #GCallback to connect.</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="gobject"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4894">the object to pass as data
|
||
to @c_handler.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="connect_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4896">a combination of #GConnectFlags.</doc>
|
||
<type name="ConnectFlags" c:type="GConnectFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="signal_connect_swapped"
|
||
c:identifier="g_signal_connect_swapped"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="531">Connects a #GCallback function to a signal for a particular object.
|
||
|
||
The instance on which the signal is emitted and @data will be swapped when
|
||
calling the handler. This is useful when calling pre-existing functions to
|
||
operate purely on the @data, rather than the @instance: swapping the
|
||
parameters avoids the need to write a wrapper function.
|
||
|
||
For example, this allows the shorter code:
|
||
|[<!-- language="C" -->
|
||
g_signal_connect_swapped (button, "clicked",
|
||
(GCallback) gtk_widget_hide, other_widget);
|
||
]|
|
||
|
||
Rather than the cumbersome:
|
||
|[<!-- language="C" -->
|
||
static void
|
||
button_clicked_cb (GtkButton *button, GtkWidget *other_widget)
|
||
{
|
||
gtk_widget_hide (other_widget);
|
||
}
|
||
|
||
...
|
||
|
||
g_signal_connect (button, "clicked",
|
||
(GCallback) button_clicked_cb, other_widget);
|
||
]|</doc>
|
||
<source-position filename="gsignal.h" line="567"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="533">the instance to connect to.</doc>
|
||
</parameter>
|
||
<parameter name="detailed_signal">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="534">a string of the form "signal-name::detail".</doc>
|
||
</parameter>
|
||
<parameter name="c_handler">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="535">the #GCallback to connect.</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="536">data to pass to @c_handler calls.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_emit"
|
||
c:identifier="g_signal_emit"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4911">Emits a signal. Signal emission is done synchronously.
|
||
The method will only return control after all handlers are called or signal emission was stopped.
|
||
|
||
Note that g_signal_emit() resets the return value to the default
|
||
if no handlers are connected, in contrast to g_signal_emitv().</doc>
|
||
<source-position filename="gsignal.h" line="341"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4913">the instance the signal is being emitted on.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4914">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4915">the detail</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4916">parameters to be passed to the signal, followed by a
|
||
location for the return value. If the return type of the signal
|
||
is %G_TYPE_NONE, the return value location can be omitted.</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_emit_by_name"
|
||
c:identifier="g_signal_emit_by_name"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4928">Emits a signal. Signal emission is done synchronously.
|
||
The method will only return control after all handlers are called or signal emission was stopped.
|
||
|
||
Note that g_signal_emit_by_name() resets the return value to the default
|
||
if no handlers are connected, in contrast to g_signal_emitv().</doc>
|
||
<source-position filename="gsignal.h" line="346"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4930">the instance the signal is being emitted on.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4931">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4932">parameters to be passed to the signal, followed by a
|
||
location for the return value. If the return type of the signal
|
||
is %G_TYPE_NONE, the return value location can be omitted. The
|
||
number of parameters to pass to this function is defined when creating the signal.</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_emit_valist"
|
||
c:identifier="g_signal_emit_valist"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4945">Emits a signal. Signal emission is done synchronously.
|
||
The method will only return control after all handlers are called or signal emission was stopped.
|
||
|
||
Note that g_signal_emit_valist() resets the return value to the default
|
||
if no handlers are connected, in contrast to g_signal_emitv().</doc>
|
||
<source-position filename="gsignal.h" line="336"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4947">the instance the signal is being
|
||
emitted on.</doc>
|
||
<type name="TypeInstance" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4949">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4950">the detail</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="var_args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4951">a list of parameters to be passed to the signal, followed by a
|
||
location for the return value. If the return type of the signal
|
||
is %G_TYPE_NONE, the return value location can be omitted.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_emitv" c:identifier="g_signal_emitv">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4963">Emits a signal. Signal emission is done synchronously.
|
||
The method will only return control after all handlers are called or signal emission was stopped.
|
||
|
||
Note that g_signal_emitv() doesn't change @return_value if no handlers are
|
||
connected, in contrast to g_signal_emit() and g_signal_emit_valist().</doc>
|
||
<source-position filename="gsignal.h" line="331"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_and_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4965">argument list for the signal emission.
|
||
The first element in the array is a #GValue for the instance the signal
|
||
is being emitted on. The rest are any arguments to be passed to the signal.</doc>
|
||
<array zero-terminated="0" c:type="const GValue*">
|
||
<type name="Value" c:type="GValue"/>
|
||
</array>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4968">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4969">the detail</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="return_value"
|
||
direction="inout"
|
||
caller-allocates="0"
|
||
transfer-ownership="full"
|
||
optional="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4970">Location to
|
||
store the return value of the signal emission. This must be provided if the
|
||
specified signal returns a value, but may be ignored otherwise.</doc>
|
||
<type name="Value" c:type="GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_get_invocation_hint"
|
||
c:identifier="g_signal_get_invocation_hint">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4982">Returns the invocation hint of the innermost signal emission of instance.</doc>
|
||
<source-position filename="gsignal.h" line="369"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4988">the invocation hint of the innermost
|
||
signal emission, or %NULL if not found.</doc>
|
||
<type name="SignalInvocationHint" c:type="GSignalInvocationHint*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="4984">the instance to query</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handler_block"
|
||
c:identifier="g_signal_handler_block">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5166">Blocks a handler of an instance so it will not be called during any
|
||
signal emissions unless it is unblocked again. Thus "blocking" a
|
||
signal handler means to temporarily deactivate it, a signal handler
|
||
has to be unblocked exactly the same amount of times it has been
|
||
blocked before to become active again.
|
||
|
||
The @handler_id has to be a valid signal handler id, connected to a
|
||
signal of @instance.</doc>
|
||
<source-position filename="gsignal.h" line="416"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5168">The instance to block the signal handler of.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="handler_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5169">Handler id of the handler to be blocked.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handler_disconnect"
|
||
c:identifier="g_signal_handler_disconnect">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5182">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. The @handler_id becomes invalid and may be reused.
|
||
|
||
The @handler_id has to be a valid signal handler id, connected to a
|
||
signal of @instance.</doc>
|
||
<source-position filename="gsignal.h" line="422"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5184">The instance to remove the signal handler from.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="handler_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5185">Handler id of the handler to be disconnected.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handler_find" c:identifier="g_signal_handler_find">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5196">Finds the first signal handler that matches certain selection criteria.
|
||
The criteria mask is passed as an OR-ed combination of #GSignalMatchType
|
||
flags, and the criteria values are passed as arguments.
|
||
The match @mask has to be non-0 for successful matches.
|
||
If no handler was found, 0 is returned.</doc>
|
||
<source-position filename="gsignal.h" line="428"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5213">A valid non-0 signal handler id for a successful match.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5198">The instance owning the signal handler to be found.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="mask" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5199">Mask indicating which of @signal_id, @detail, @closure, @func
|
||
and/or @data the handler has to match.</doc>
|
||
<type name="SignalMatchType" c:type="GSignalMatchType"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5201">Signal the handler has to be connected to.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5202">Signal detail the handler has to be connected to.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5203">The closure the handler will invoke.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5204">The C closure callback of the handler (useless for non-C closures).</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5205">The closure data of the handler's closure.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handler_is_connected"
|
||
c:identifier="g_signal_handler_is_connected">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5217">Returns whether @handler_id is the ID of a handler connected to @instance.</doc>
|
||
<source-position filename="gsignal.h" line="425"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5224">whether @handler_id identifies a handler connected to @instance.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5219">The instance where a signal handler is sought.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="handler_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5220">the handler ID.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handler_unblock"
|
||
c:identifier="g_signal_handler_unblock">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5228">Undoes the effect of a previous g_signal_handler_block() call. A
|
||
blocked handler is skipped during signal emissions and will not be
|
||
invoked, unblocking it (for exactly the amount of times it has been
|
||
blocked before) reverts its "blocked" state, so the handler will be
|
||
recognized by the signal system and is called upon future or
|
||
currently ongoing signal emissions (since the order in which
|
||
handlers are called during signal emissions is deterministic,
|
||
whether the unblocked handler in question is called as part of a
|
||
currently ongoing emission depends on how far that emission has
|
||
proceeded yet).
|
||
|
||
The @handler_id has to be a valid id of a signal handler that is
|
||
connected to a signal of @instance and is currently blocked.</doc>
|
||
<source-position filename="gsignal.h" line="419"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5230">The instance to unblock the signal handler of.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="handler_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5231">Handler id of the handler to be unblocked.</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="signal_handlers_block_by_func"
|
||
c:identifier="g_signal_handlers_block_by_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="598">Blocks all handlers on an instance that match @func and @data.</doc>
|
||
<source-position filename="gsignal.h" line="608"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="600">The instance to block handlers from.</doc>
|
||
</parameter>
|
||
<parameter name="func">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="601">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="602">The closure data of the handlers' closures.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_handlers_block_matched"
|
||
c:identifier="g_signal_handlers_block_matched">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5249">Blocks all handlers on an instance that match a certain selection criteria.
|
||
The criteria mask is passed as an OR-ed combination of #GSignalMatchType
|
||
flags, and the criteria values are passed as arguments.
|
||
Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
|
||
or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
|
||
If no handlers were found, 0 is returned, the number of blocked handlers
|
||
otherwise.</doc>
|
||
<source-position filename="gsignal.h" line="436"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5268">The number of handlers that matched.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5251">The instance to block handlers from.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="mask" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5252">Mask indicating which of @signal_id, @detail, @closure, @func
|
||
and/or @data the handlers have to match.</doc>
|
||
<type name="SignalMatchType" c:type="GSignalMatchType"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5254">Signal the handlers have to be connected to.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5255">Signal detail the handlers have to be connected to.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5256">The closure the handlers will invoke.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5257">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5258">The closure data of the handlers' closures.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_handlers_destroy"
|
||
c:identifier="g_signal_handlers_destroy">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5272">Destroy all signal handlers of a type instance. This function is
|
||
an implementation detail of the #GObject dispose implementation,
|
||
and should not be used outside of the type system.</doc>
|
||
<source-position filename="gsignal.h" line="642"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5274">The instance whose signal handlers are destroyed</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="signal_handlers_disconnect_by_data"
|
||
c:identifier="g_signal_handlers_disconnect_by_data"
|
||
version="2.32"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="584">Disconnects all handlers on an instance that match @data.</doc>
|
||
<source-position filename="gsignal.h" line="595"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="586">The instance to remove handlers from</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="587">the closure data of the handlers' closures</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function-macro name="signal_handlers_disconnect_by_func"
|
||
c:identifier="g_signal_handlers_disconnect_by_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="569">Disconnects all handlers on an instance that match @func and @data.</doc>
|
||
<source-position filename="gsignal.h" line="579"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="571">The instance to remove handlers from.</doc>
|
||
</parameter>
|
||
<parameter name="func">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="572">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="573">The closure data of the handlers' closures.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_handlers_disconnect_matched"
|
||
c:identifier="g_signal_handlers_disconnect_matched">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5282">Disconnects all handlers on an instance that match a certain
|
||
selection criteria. The criteria mask is passed as an OR-ed
|
||
combination of #GSignalMatchType flags, and the criteria values are
|
||
passed as arguments. Passing at least one of the
|
||
%G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
|
||
%G_SIGNAL_MATCH_DATA match flags is required for successful
|
||
matches. If no handlers were found, 0 is returned, the number of
|
||
disconnected handlers otherwise.</doc>
|
||
<source-position filename="gsignal.h" line="452"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5302">The number of handlers that matched.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5284">The instance to remove handlers from.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="mask" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5285">Mask indicating which of @signal_id, @detail, @closure, @func
|
||
and/or @data the handlers have to match.</doc>
|
||
<type name="SignalMatchType" c:type="GSignalMatchType"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5287">Signal the handlers have to be connected to.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5288">Signal detail the handlers have to be connected to.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5289">The closure the handlers will invoke.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5290">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5291">The closure data of the handlers' closures.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function-macro name="signal_handlers_unblock_by_func"
|
||
c:identifier="g_signal_handlers_unblock_by_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="612">Unblocks all handlers on an instance that match @func and @data.</doc>
|
||
<source-position filename="gsignal.h" line="622"/>
|
||
<parameters>
|
||
<parameter name="instance">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="614">The instance to unblock handlers from.</doc>
|
||
</parameter>
|
||
<parameter name="func">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="615">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
</parameter>
|
||
<parameter name="data">
|
||
<doc xml:space="preserve"
|
||
filename="gsignal.h"
|
||
line="616">The closure data of the handlers' closures.</doc>
|
||
</parameter>
|
||
</parameters>
|
||
</function-macro>
|
||
<function name="signal_handlers_unblock_matched"
|
||
c:identifier="g_signal_handlers_unblock_matched">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5306">Unblocks all handlers on an instance that match a certain selection
|
||
criteria. The criteria mask is passed as an OR-ed combination of
|
||
#GSignalMatchType flags, and the criteria values are passed as arguments.
|
||
Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
|
||
or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
|
||
If no handlers were found, 0 is returned, the number of unblocked handlers
|
||
otherwise. The match criteria should not apply to any handlers that are
|
||
not currently blocked.</doc>
|
||
<source-position filename="gsignal.h" line="444"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5326">The number of handlers that matched.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5308">The instance to unblock handlers from.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="mask" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5309">Mask indicating which of @signal_id, @detail, @closure, @func
|
||
and/or @data the handlers have to match.</doc>
|
||
<type name="SignalMatchType" c:type="GSignalMatchType"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5311">Signal the handlers have to be connected to.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5312">Signal detail the handlers have to be connected to.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5313">The closure the handlers will invoke.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="func"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5314">The C closure callback of the handlers (useless for non-C closures).</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5315">The closure data of the handlers' closures.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_has_handler_pending"
|
||
c:identifier="g_signal_has_handler_pending">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5330">Returns whether there are any handlers connected to @instance for the
|
||
given signal id and detail.
|
||
|
||
If @detail is 0 then it will only match handlers that were connected
|
||
without detail. If @detail is non-zero then it will match handlers
|
||
connected both without detail and with the given detail. This is
|
||
consistent with how a signal emitted with @detail would be delivered
|
||
to those handlers.
|
||
|
||
Since 2.46 this also checks for a non-default class closure being
|
||
installed, as this is basically always what you want.
|
||
|
||
One example of when you might use this is when the arguments to the
|
||
signal are difficult to compute. A class implementor may opt to not
|
||
emit the signal if no one is attached anyway, thus saving the cost
|
||
of building the arguments.</doc>
|
||
<source-position filename="gsignal.h" line="393"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5354">%TRUE if a handler is connected to the signal, %FALSE
|
||
otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5332">the object whose signal handlers are sought.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5333">the signal id.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5334">the detail.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="may_be_blocked" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5335">whether blocked handlers should count as match.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_is_valid_name"
|
||
c:identifier="g_signal_is_valid_name"
|
||
version="2.66">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5359">Validate a signal name. This can be useful for dynamically-generated signals
|
||
which need to be validated at run-time before actually trying to create them.
|
||
|
||
See [canonical parameter names][canonical-parameter-names] for details of
|
||
the rules for valid names. The rules for signal names are the same as those
|
||
for property names.</doc>
|
||
<source-position filename="gsignal.h" line="361"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5370">%TRUE if @name is a valid signal name, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5361">the canonical name of the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_list_ids" c:identifier="g_signal_list_ids">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5375">Lists the signals by id that a certain instance or interface type
|
||
created. Further information about the signals can be acquired through
|
||
g_signal_query().</doc>
|
||
<source-position filename="gsignal.h" line="358"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5384">Newly allocated array of signal IDs.</doc>
|
||
<array length="1" zero-terminated="0" c:type="guint*">
|
||
<type name="guint" c:type="guint"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5377">Instance or interface type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_ids"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5378">Location to store the number of signal ids for @itype.</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_lookup" c:identifier="g_signal_lookup">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5388">Given the name of the signal and the type of object it connects to, gets
|
||
the signal's identifying integer. Emitting the signal by number is
|
||
somewhat faster than using the name each time.
|
||
|
||
Also tries the ancestors of the given type.
|
||
|
||
The type class passed as @itype must already have been instantiated (for
|
||
example, using g_type_class_ref()) for this function to work, as signals are
|
||
always installed during class initialization.
|
||
|
||
See g_signal_new() for details on allowed signal names.</doc>
|
||
<source-position filename="gsignal.h" line="350"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5405">the signal's identifying number, or 0 if no signal was found.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5390">the signal's name.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5391">the type that the signal operates on.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_name" c:identifier="g_signal_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5409">Given the signal's identifier, finds its name.
|
||
|
||
Two different signals may have the same name, if they have differing types.</doc>
|
||
<source-position filename="gsignal.h" line="353"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5417">the signal name, or %NULL if the signal number was invalid.</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5411">the signal's identifying number.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_new" c:identifier="g_signal_new" introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5421">Creates a new signal. (This is usually done in the class initializer.)
|
||
|
||
A signal name consists of segments consisting of ASCII letters and
|
||
digits, separated by either the `-` or `_` character. The first
|
||
character of a signal name must be a letter. Names which violate these
|
||
rules lead to undefined behaviour. These are the same rules as for property
|
||
naming (see g_param_spec_internal()).
|
||
|
||
When registering a signal and looking up a signal, either separator can
|
||
be used, but they cannot be mixed. Using `-` is considerably more efficient.
|
||
Using `_` is discouraged.
|
||
|
||
If 0 is used for @class_offset subclasses cannot override the class handler
|
||
in their class_init method by doing super_class->signal_handler = my_signal_handler.
|
||
Instead they will have to use g_signal_override_class_handler().
|
||
|
||
If @c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
|
||
the marshaller for this signal. In some simple cases, g_signal_new()
|
||
will use a more optimized c_marshaller and va_marshaller for the signal
|
||
instead of g_cclosure_marshal_generic().
|
||
|
||
If @c_marshaller is non-%NULL, you need to also specify a va_marshaller
|
||
using g_signal_set_va_marshaller() or the generic va_marshaller will
|
||
be used.</doc>
|
||
<source-position filename="gsignal.h" line="304"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5466">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5423">the name for the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5424">the type this signal pertains to. It will also pertain to
|
||
types which are derived from this type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="signal_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5426">a combination of #GSignalFlags specifying detail of when
|
||
the default handler is to be invoked. You should at least specify
|
||
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</parameter>
|
||
<parameter name="class_offset" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5429">The offset of the function pointer in the class structure
|
||
for this type. Used to invoke a class method generically. Pass 0 to
|
||
not associate a class method slot with this signal.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="accumulator"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="5">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5432">the accumulator for this signal; may be %NULL.</doc>
|
||
<type name="SignalAccumulator" c:type="GSignalAccumulator"/>
|
||
</parameter>
|
||
<parameter name="accu_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5433">user data for the @accumulator.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="c_marshaller"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5434">the function to translate arrays of parameter
|
||
values to signal emissions into C language callback invocations or %NULL.</doc>
|
||
<type name="SignalCMarshaller" c:type="GSignalCMarshaller"/>
|
||
</parameter>
|
||
<parameter name="return_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5436">the type of return value, or %G_TYPE_NONE for a signal
|
||
without a return value.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5438">the number of parameter types to follow.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5439">a list of types, one for each parameter.</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_new_class_handler"
|
||
c:identifier="g_signal_new_class_handler"
|
||
version="2.18"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5470">Creates a new signal. (This is usually done in the class initializer.)
|
||
|
||
This is a variant of g_signal_new() that takes a C callback instead
|
||
of a class offset for the signal's class handler. This function
|
||
doesn't need a function pointer exposed in the class structure of
|
||
an object definition, instead the function pointer is passed
|
||
directly and can be overridden by derived classes with
|
||
g_signal_override_class_closure() or
|
||
g_signal_override_class_handler() and chained to with
|
||
g_signal_chain_from_overridden() or
|
||
g_signal_chain_from_overridden_handler().
|
||
|
||
See g_signal_new() for information about signal names.
|
||
|
||
If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
|
||
the marshaller for this signal.</doc>
|
||
<source-position filename="gsignal.h" line="315"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5507">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5472">the name for the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5473">the type this signal pertains to. It will also pertain to
|
||
types which are derived from this type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="signal_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5475">a combination of #GSignalFlags specifying detail of when
|
||
the default handler is to be invoked. You should at least specify
|
||
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</parameter>
|
||
<parameter name="class_handler"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5478">a #GCallback which acts as class implementation of
|
||
this signal. Used to invoke a class method generically. Pass %NULL to
|
||
not associate a class method with this signal.</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
<parameter name="accumulator"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="5">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5481">the accumulator for this signal; may be %NULL.</doc>
|
||
<type name="SignalAccumulator" c:type="GSignalAccumulator"/>
|
||
</parameter>
|
||
<parameter name="accu_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5482">user data for the @accumulator.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="c_marshaller"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5483">the function to translate arrays of parameter
|
||
values to signal emissions into C language callback invocations or %NULL.</doc>
|
||
<type name="SignalCMarshaller" c:type="GSignalCMarshaller"/>
|
||
</parameter>
|
||
<parameter name="return_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5485">the type of return value, or %G_TYPE_NONE for a signal
|
||
without a return value.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5487">the number of parameter types to follow.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="..." transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5488">a list of types, one for each parameter.</doc>
|
||
<varargs/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_new_valist"
|
||
c:identifier="g_signal_new_valist"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5512">Creates a new signal. (This is usually done in the class initializer.)
|
||
|
||
See g_signal_new() for details on allowed signal names.
|
||
|
||
If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
|
||
the marshaller for this signal.</doc>
|
||
<source-position filename="gsignal.h" line="293"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5537">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5514">the name for the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5515">the type this signal pertains to. It will also pertain to
|
||
types which are derived from this type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="signal_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5517">a combination of #GSignalFlags specifying detail of when
|
||
the default handler is to be invoked. You should at least specify
|
||
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</parameter>
|
||
<parameter name="class_closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5520">The closure to invoke on signal emission; may be %NULL.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="accumulator"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="5">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5521">the accumulator for this signal; may be %NULL.</doc>
|
||
<type name="SignalAccumulator" c:type="GSignalAccumulator"/>
|
||
</parameter>
|
||
<parameter name="accu_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5522">user data for the @accumulator.</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="c_marshaller"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5523">the function to translate arrays of parameter
|
||
values to signal emissions into C language callback invocations or %NULL.</doc>
|
||
<type name="SignalCMarshaller" c:type="GSignalCMarshaller"/>
|
||
</parameter>
|
||
<parameter name="return_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5525">the type of return value, or %G_TYPE_NONE for a signal
|
||
without a return value.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5527">the number of parameter types in @args.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="args" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5528">va_list of #GType, one for each parameter.</doc>
|
||
<type name="va_list" c:type="va_list"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_newv"
|
||
c:identifier="g_signal_newv"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5541">Creates a new signal. (This is usually done in the class initializer.)
|
||
|
||
See g_signal_new() for details on allowed signal names.
|
||
|
||
If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as
|
||
the marshaller for this signal.</doc>
|
||
<source-position filename="gsignal.h" line="282"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5569">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5543">the name for the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5544">the type this signal pertains to. It will also pertain to
|
||
types which are derived from this type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="signal_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5546">a combination of #GSignalFlags specifying detail of when
|
||
the default handler is to be invoked. You should at least specify
|
||
%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST</doc>
|
||
<type name="SignalFlags" c:type="GSignalFlags"/>
|
||
</parameter>
|
||
<parameter name="class_closure"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5549">The closure to invoke on signal emission;
|
||
may be %NULL</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
<parameter name="accumulator"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="5">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5551">the accumulator for this signal; may be %NULL</doc>
|
||
<type name="SignalAccumulator" c:type="GSignalAccumulator"/>
|
||
</parameter>
|
||
<parameter name="accu_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1"
|
||
closure="4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5552">user data for the @accumulator</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="c_marshaller"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5553">the function to translate arrays of
|
||
parameter values to signal emissions into C language callback
|
||
invocations or %NULL</doc>
|
||
<type name="SignalCMarshaller" c:type="GSignalCMarshaller"/>
|
||
</parameter>
|
||
<parameter name="return_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5556">the type of return value, or %G_TYPE_NONE for a signal
|
||
without a return value</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_params" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5558">the length of @param_types</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="param_types"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5559">an array of types, one for
|
||
each parameter (may be %NULL if @n_params is zero)</doc>
|
||
<array length="8" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_override_class_closure"
|
||
c:identifier="g_signal_override_class_closure">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5573">Overrides the class closure (i.e. the default handler) for the given signal
|
||
for emissions on instances of @instance_type. @instance_type must be derived
|
||
from the type to which the signal belongs.
|
||
|
||
See g_signal_chain_from_overridden() and
|
||
g_signal_chain_from_overridden_handler() for how to chain up to the
|
||
parent class closure from inside the overridden one.</doc>
|
||
<source-position filename="gsignal.h" line="480"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5575">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5576">the instance type on which to override the class closure
|
||
for the signal.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="class_closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5578">the closure.</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_override_class_handler"
|
||
c:identifier="g_signal_override_class_handler"
|
||
version="2.18"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5590">Overrides the class closure (i.e. the default handler) for the
|
||
given signal for emissions on instances of @instance_type with
|
||
callback @class_handler. @instance_type must be derived from the
|
||
type to which the signal belongs.
|
||
|
||
See g_signal_chain_from_overridden() and
|
||
g_signal_chain_from_overridden_handler() for how to chain up to the
|
||
parent class closure from inside the overridden one.</doc>
|
||
<source-position filename="gsignal.h" line="484"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5592">the name for the signal</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5593">the instance type on which to override the class handler
|
||
for the signal.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="class_handler" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5595">the handler.</doc>
|
||
<type name="Callback" c:type="GCallback"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_parse_name" c:identifier="g_signal_parse_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5610">Internal function to parse a signal name into its @signal_id
|
||
and @detail quark.</doc>
|
||
<source-position filename="gsignal.h" line="363"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5621">Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5612">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5613">The interface/instance type that introduced "signal-name".</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="signal_id_p"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5614">Location to store the signal id.</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
<parameter name="detail_p"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5615">Location to store the detail quark.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark*"/>
|
||
</parameter>
|
||
<parameter name="force_detail_quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5616">%TRUE forces creation of a #GQuark for the detail.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_query" c:identifier="g_signal_query">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5625">Queries the signal system for in-depth information about a
|
||
specific signal. This function will fill in a user-provided
|
||
structure to hold signal-specific information. If an invalid
|
||
signal id is passed in, the @signal_id member of the #GSignalQuery
|
||
is 0. All members filled into the #GSignalQuery structure should
|
||
be considered constant and have to be left untouched.</doc>
|
||
<source-position filename="gsignal.h" line="355"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5627">The signal id of the signal to query information for.</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="query"
|
||
direction="out"
|
||
caller-allocates="1"
|
||
transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5628">A user provided structure that is
|
||
filled in with constant values upon success.</doc>
|
||
<type name="SignalQuery" c:type="GSignalQuery*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_remove_emission_hook"
|
||
c:identifier="g_signal_remove_emission_hook">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5640">Deletes an emission hook.</doc>
|
||
<source-position filename="gsignal.h" line="387"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5642">the id of the signal</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="hook_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5643">the id of the emission hook, as returned by
|
||
g_signal_add_emission_hook()</doc>
|
||
<type name="gulong" c:type="gulong"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_set_va_marshaller"
|
||
c:identifier="g_signal_set_va_marshaller"
|
||
version="2.32">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5650">Change the #GSignalCVaMarshaller used for a given signal. This is a
|
||
specialised form of the marshaller that can often be used for the
|
||
common case of a single connected signal handler and avoids the
|
||
overhead of #GValue. Its use is optional.</doc>
|
||
<source-position filename="gsignal.h" line="326"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5652">the signal id</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5653">the instance type on which to set the marshaller.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="va_marshaller" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5654">the marshaller to set.</doc>
|
||
<type name="SignalCVaMarshaller" c:type="GSignalCVaMarshaller"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_stop_emission"
|
||
c:identifier="g_signal_stop_emission">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5665">Stops a signal's current emission.
|
||
|
||
This will prevent the default method from running, if the signal was
|
||
%G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
|
||
flag).
|
||
|
||
Prints a warning if used on a signal which isn't being emitted.</doc>
|
||
<source-position filename="gsignal.h" line="374"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5667">the object whose signal handlers you wish to stop.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="signal_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5668">the signal identifier, as returned by g_signal_lookup().</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="detail" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5669">the detail which the signal was emitted with.</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_stop_emission_by_name"
|
||
c:identifier="g_signal_stop_emission_by_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5681">Stops a signal's current emission.
|
||
|
||
This is just like g_signal_stop_emission() except it will look up the
|
||
signal id for you.</doc>
|
||
<source-position filename="gsignal.h" line="378"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5683">the object whose signal handlers you wish to stop.</doc>
|
||
<type name="Object" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="detailed_signal" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5684">a string of the form "signal-name::detail".</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="signal_type_cclosure_new"
|
||
c:identifier="g_signal_type_cclosure_new">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5693">Creates a new closure which invokes the function found at the offset
|
||
@struct_offset in the class structure of the interface or classed type
|
||
identified by @itype.</doc>
|
||
<source-position filename="gclosure.h" line="239"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5703">a floating reference to a new #GCClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="itype" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5695">the #GType identifier of an interface or classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="struct_offset" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5696">the offset of the member function of @itype's class
|
||
structure which is to be invoked by the new closure</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<docsection name="signals">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="841">The basic concept of the signal system is that of the emission
|
||
of a signal. Signals are introduced per-type and are identified
|
||
through strings. Signals introduced for a parent type are available
|
||
in derived types as well, so basically they are a per-type facility
|
||
that is inherited.
|
||
|
||
A signal emission mainly involves invocation of a certain set of
|
||
callbacks in precisely defined manner. There are two main categories
|
||
of such callbacks, per-object ones and user provided ones.
|
||
(Although signals can deal with any kind of instantiatable type, I'm
|
||
referring to those types as "object types" in the following, simply
|
||
because that is the context most users will encounter signals in.)
|
||
The per-object callbacks are most often referred to as "object method
|
||
handler" or "default (signal) handler", while user provided callbacks are
|
||
usually just called "signal handler".
|
||
|
||
The object method handler is provided at signal creation time (this most
|
||
frequently happens at the end of an object class' creation), while user
|
||
provided handlers are frequently connected and disconnected to/from a
|
||
certain signal on certain object instances.
|
||
|
||
A signal emission consists of five stages, unless prematurely stopped:
|
||
|
||
1. Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals
|
||
|
||
2. Invocation of normal user-provided signal handlers (where the @after
|
||
flag is not set)
|
||
|
||
3. Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals
|
||
|
||
4. Invocation of user provided signal handlers (where the @after flag is set)
|
||
|
||
5. Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals
|
||
|
||
The user-provided signal handlers are called in the order they were
|
||
connected in.
|
||
|
||
All handlers may prematurely stop a signal emission, and any number of
|
||
handlers may be connected, disconnected, blocked or unblocked during
|
||
a signal emission.
|
||
|
||
There are certain criteria for skipping user handlers in stages 2 and 4
|
||
of a signal emission.
|
||
|
||
First, user handlers may be blocked. Blocked handlers are omitted during
|
||
callback invocation, to return from the blocked state, a handler has to
|
||
get unblocked exactly the same amount of times it has been blocked before.
|
||
|
||
Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional
|
||
@detail argument passed in to g_signal_emit() has to match the detail
|
||
argument of the signal handler currently subject to invocation.
|
||
Specification of no detail argument for signal handlers (omission of the
|
||
detail part of the signal specification upon connection) serves as a
|
||
wildcard and matches any detail argument passed in to emission.
|
||
|
||
While the @detail argument is typically used to pass an object property name
|
||
(as with #GObject::notify), no specific format is mandated for the detail
|
||
string, other than that it must be non-empty.
|
||
|
||
## Memory management of signal handlers # {#signal-memory-management}
|
||
|
||
If you are connecting handlers to signals and using a #GObject instance as
|
||
your signal handler user data, you should remember to pair calls to
|
||
g_signal_connect() with calls to g_signal_handler_disconnect() or
|
||
g_signal_handlers_disconnect_by_func(). While signal handlers are
|
||
automatically disconnected when the object emitting the signal is finalised,
|
||
they are not automatically disconnected when the signal handler user data is
|
||
destroyed. If this user data is a #GObject instance, using it from a
|
||
signal handler after it has been finalised is an error.
|
||
|
||
There are two strategies for managing such user data. The first is to
|
||
disconnect the signal handler (using g_signal_handler_disconnect() or
|
||
g_signal_handlers_disconnect_by_func()) when the user data (object) is
|
||
finalised; this has to be implemented manually. For non-threaded programs,
|
||
g_signal_connect_object() can be used to implement this automatically.
|
||
Currently, however, it is unsafe to use in threaded programs.
|
||
|
||
The second is to hold a strong reference on the user data until after the
|
||
signal is disconnected for other reasons. This can be implemented
|
||
automatically using g_signal_connect_data().
|
||
|
||
The first approach is recommended, as the second approach can result in
|
||
effective memory leaks of the user data if the signal handler is never
|
||
disconnected for some reason.</doc>
|
||
</docsection>
|
||
<function name="source_set_closure" c:identifier="g_source_set_closure">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5707">Set the callback for a source as a #GClosure.
|
||
|
||
If the source is not one of the standard GLib types, the @closure_callback
|
||
and @closure_marshal fields of the #GSourceFuncs structure must have been
|
||
filled in with pointers to appropriate functions.</doc>
|
||
<source-position filename="gsourceclosure.h" line="32"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="source" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5709">the source</doc>
|
||
<type name="GLib.Source" c:type="GSource*"/>
|
||
</parameter>
|
||
<parameter name="closure" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5710">a #GClosure</doc>
|
||
<type name="Closure" c:type="GClosure*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="source_set_dummy_callback"
|
||
c:identifier="g_source_set_dummy_callback">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5720">Sets a dummy callback for @source. The callback will do nothing, and
|
||
if the source expects a #gboolean return value, it will return %TRUE.
|
||
(If the source expects any other type of return value, it will return
|
||
a 0/%NULL value; whatever g_value_init() initializes a #GValue to for
|
||
that type.)
|
||
|
||
If the source is not one of the standard GLib types, the
|
||
@closure_callback and @closure_marshal fields of the #GSourceFuncs
|
||
structure must have been filled in with pointers to appropriate
|
||
functions.</doc>
|
||
<source-position filename="gsourceclosure.h" line="36"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="source" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5722">the source</doc>
|
||
<type name="GLib.Source" c:type="GSource*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="strdup_value_contents"
|
||
c:identifier="g_strdup_value_contents">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5737">Return a newly allocated string, which describes the contents of a
|
||
#GValue. The main purpose of this function is to describe #GValue
|
||
contents for debugging output, the way in which the contents are
|
||
described may change between different GLib versions.</doc>
|
||
<source-position filename="gvaluetypes.h" line="296"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5746">Newly allocated string.</doc>
|
||
<type name="utf8" c:type="gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5739">#GValue which contents are to be described.</doc>
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_class_cache_func"
|
||
c:identifier="g_type_add_class_cache_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5750">Adds a #GTypeClassCacheFunc to be called before the reference count of a
|
||
class goes from one to zero. This can be used to prevent premature class
|
||
destruction. All installed #GTypeClassCacheFunc functions will be chained
|
||
until one of them returns %TRUE. The functions have to check the class id
|
||
passed in to figure whether they actually want to cache the class of this
|
||
type, since all classes are routed through the same #GTypeClassCacheFunc
|
||
chain.</doc>
|
||
<source-position filename="gtype.h" line="2465"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="cache_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5752">data to be passed to @cache_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="cache_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5753">a #GTypeClassCacheFunc</doc>
|
||
<type name="TypeClassCacheFunc" c:type="GTypeClassCacheFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_class_private"
|
||
c:identifier="g_type_add_class_private"
|
||
version="2.24">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5765">Registers a private class structure for a classed type;
|
||
when the class is allocated, the private structures for
|
||
the class and all of its parent types are allocated
|
||
sequentially in the same memory block as the public
|
||
structures, and are zero-filled.
|
||
|
||
This function should be called in the
|
||
type's get_type() function after the type is registered.
|
||
The private structure can be retrieved using the
|
||
G_TYPE_CLASS_GET_PRIVATE() macro.</doc>
|
||
<source-position filename="gtype.h" line="1387"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="class_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5767">GType of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="private_size" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5768">size of private structure</doc>
|
||
<type name="gsize" c:type="gsize"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_instance_private"
|
||
c:identifier="g_type_add_instance_private">
|
||
<source-position filename="gtype.h" line="1377"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gint" c:type="gint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="class_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="private_size" transfer-ownership="none">
|
||
<type name="gsize" c:type="gsize"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_interface_check"
|
||
c:identifier="g_type_add_interface_check"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5785">Adds a function to be called after an interface vtable is
|
||
initialized for any class (i.e. after the @interface_init
|
||
member of #GInterfaceInfo has been called).
|
||
|
||
This function is useful when you want to check an invariant
|
||
that depends on the interfaces of a class. For instance, the
|
||
implementation of #GObject uses this facility to check that an
|
||
object implements all of the properties that are defined on its
|
||
interfaces.</doc>
|
||
<source-position filename="gtype.h" line="2474"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="check_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5787">data to pass to @check_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="check_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5788">function to be called after each interface
|
||
is initialized</doc>
|
||
<type name="TypeInterfaceCheckFunc"
|
||
c:type="GTypeInterfaceCheckFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_interface_dynamic"
|
||
c:identifier="g_type_add_interface_dynamic">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5805">Adds @interface_type to the dynamic @instance_type. The information
|
||
contained in the #GTypePlugin structure pointed to by @plugin
|
||
is used to manage the relationship.</doc>
|
||
<source-position filename="gtype.h" line="1361"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5807">#GType value of an instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5808">#GType value of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5809">#GTypePlugin structure to retrieve the #GInterfaceInfo from</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_add_interface_static"
|
||
c:identifier="g_type_add_interface_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5817">Adds @interface_type to the static @instance_type.
|
||
The information contained in the #GInterfaceInfo structure
|
||
pointed to by @info is used to manage the relationship.</doc>
|
||
<source-position filename="gtype.h" line="1357"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5819">#GType value of an instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5820">#GType value of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5821">#GInterfaceInfo structure for this
|
||
(@instance_type, @interface_type) combination</doc>
|
||
<type name="InterfaceInfo" c:type="const GInterfaceInfo*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_class_cast"
|
||
c:identifier="g_type_check_class_cast"
|
||
introspectable="0">
|
||
<source-position filename="gtype.h" line="2497"/>
|
||
<return-value>
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</parameter>
|
||
<parameter name="is_a_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_class_is_a"
|
||
c:identifier="g_type_check_class_is_a">
|
||
<source-position filename="gtype.h" line="2500"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</parameter>
|
||
<parameter name="is_a_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_instance" c:identifier="g_type_check_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5830">Private helper function to aid implementation of the
|
||
G_TYPE_CHECK_INSTANCE() macro.</doc>
|
||
<source-position filename="gtype.h" line="2486"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5837">%TRUE if @instance is valid, %FALSE otherwise</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5832">a valid #GTypeInstance structure</doc>
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_instance_cast"
|
||
c:identifier="g_type_check_instance_cast"
|
||
introspectable="0">
|
||
<source-position filename="gtype.h" line="2488"/>
|
||
<return-value>
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
<parameter name="iface_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_instance_is_a"
|
||
c:identifier="g_type_check_instance_is_a">
|
||
<source-position filename="gtype.h" line="2491"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
<parameter name="iface_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_instance_is_fundamentally_a"
|
||
c:identifier="g_type_check_instance_is_fundamentally_a">
|
||
<source-position filename="gtype.h" line="2494"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
<parameter name="fundamental_type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_is_value_type"
|
||
c:identifier="g_type_check_is_value_type">
|
||
<source-position filename="gtype.h" line="2503"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_value" c:identifier="g_type_check_value">
|
||
<source-position filename="gtype.h" line="2505"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_check_value_holds"
|
||
c:identifier="g_type_check_value_holds">
|
||
<source-position filename="gtype.h" line="2507"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="value" transfer-ownership="none">
|
||
<type name="Value" c:type="const GValue*"/>
|
||
</parameter>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_children" c:identifier="g_type_children">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5841">Return a newly allocated and 0-terminated array of type IDs, listing
|
||
the child types of @type.</doc>
|
||
<source-position filename="gtype.h" line="776"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5850">Newly allocated
|
||
and 0-terminated array of child types, free with g_free()</doc>
|
||
<array length="1" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5843">the parent type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_children"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full"
|
||
optional="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5844">location to store the length of
|
||
the returned array, or %NULL</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_class_adjust_private_offset"
|
||
c:identifier="g_type_class_adjust_private_offset"
|
||
moved-to="TypeClass.adjust_private_offset">
|
||
<source-position filename="gtype.h" line="1383"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="private_size_or_offset" transfer-ownership="none">
|
||
<type name="gint" c:type="gint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_class_peek"
|
||
c:identifier="g_type_class_peek"
|
||
moved-to="TypeClass.peek">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5948">This function is essentially the same as g_type_class_ref(),
|
||
except that the classes reference count isn't incremented.
|
||
As a consequence, this function may return %NULL if the class
|
||
of the type passed in does not currently exist (hasn't been
|
||
referenced before).</doc>
|
||
<source-position filename="gtype.h" line="754"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5958">the #GTypeClass
|
||
structure for the given type ID or %NULL if the class does not
|
||
currently exist</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5950">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_class_peek_static"
|
||
c:identifier="g_type_class_peek_static"
|
||
moved-to="TypeClass.peek_static"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5983">A more efficient version of g_type_class_peek() which works only for
|
||
static types.</doc>
|
||
<source-position filename="gtype.h" line="756"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5990">the #GTypeClass
|
||
structure for the given type ID or %NULL if the class does not
|
||
currently exist or is dynamically loaded</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5985">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_class_ref"
|
||
c:identifier="g_type_class_ref"
|
||
moved-to="TypeClass.ref">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5997">Increments the reference count of the class structure belonging to
|
||
@type. This function will demand-create the class if it doesn't
|
||
exist already.</doc>
|
||
<source-position filename="gtype.h" line="752"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6005">the #GTypeClass
|
||
structure for the given type ID</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="5999">type ID of a classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_create_instance"
|
||
c:identifier="g_type_create_instance"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6032">Creates and initializes an instance of @type if @type is valid and
|
||
can be instantiated. The type system only performs basic allocation
|
||
and structure setups for instances: actual instance creation should
|
||
happen through functions supplied by the type's fundamental type
|
||
implementation. So use of g_type_create_instance() is reserved for
|
||
implementers of fundamental types only. E.g. instances of the
|
||
#GObject hierarchy should be created via g_object_new() and never
|
||
directly through g_type_create_instance() which doesn't handle things
|
||
like singleton objects or object construction.
|
||
|
||
The extended members of the returned instance are guaranteed to be filled
|
||
with zeros.
|
||
|
||
Note: Do not use this function, unless you're implementing a
|
||
fundamental type. Also language bindings should not use this
|
||
function, but g_object_new() instead.</doc>
|
||
<source-position filename="gtype.h" line="2460"/>
|
||
<return-value>
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6053">an allocated and initialized instance, subject to further
|
||
treatment by the fundamental type implementation</doc>
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6034">an instantiatable type to create an instance for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_default_interface_peek"
|
||
c:identifier="g_type_default_interface_peek"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6058">If the interface type @g_type is currently in use, returns its
|
||
default interface vtable.</doc>
|
||
<source-position filename="gtype.h" line="770"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6066">the default
|
||
vtable for the interface, or %NULL if the type is not currently
|
||
in use</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6060">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_default_interface_ref"
|
||
c:identifier="g_type_default_interface_ref"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6072">Increments the reference count for the interface type @g_type,
|
||
and returns the default interface vtable for the type.
|
||
|
||
If the type is not currently in use, then the default vtable
|
||
for the type will be created and initialized by calling
|
||
the base interface init and default vtable init functions for
|
||
the type (the @base_init and @class_init members of #GTypeInfo).
|
||
Calling g_type_default_interface_ref() is useful when you
|
||
want to make sure that signals and properties for an interface
|
||
have been installed.</doc>
|
||
<source-position filename="gtype.h" line="768"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6088">the default
|
||
vtable for the interface; call g_type_default_interface_unref()
|
||
when you are done using the interface.</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6074">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_default_interface_unref"
|
||
c:identifier="g_type_default_interface_unref"
|
||
version="2.4">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6094">Decrements the reference count for the type corresponding to the
|
||
interface default vtable @g_iface. If the type is dynamic, then
|
||
when no one is using the interface and all references have
|
||
been released, the finalize function for the interface's default
|
||
vtable (the @class_finalize member of #GTypeInfo) will be called.</doc>
|
||
<source-position filename="gtype.h" line="772"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_iface" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6096">the default vtable
|
||
structure for an interface, as returned by g_type_default_interface_ref()</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_depth" c:identifier="g_type_depth">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6109">Returns the length of the ancestry of the passed in type. This
|
||
includes the type itself, so that e.g. a fundamental type has depth 1.</doc>
|
||
<source-position filename="gtype.h" line="740"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6116">the depth of @type</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6111">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_ensure" c:identifier="g_type_ensure" version="2.34">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6120">Ensures that the indicated @type has been registered with the
|
||
type system, and its _class_init() method has been run.
|
||
|
||
In theory, simply calling the type's _get_type() method (or using
|
||
the corresponding macro) is supposed take care of this. However,
|
||
_get_type() methods are often marked %G_GNUC_CONST for performance
|
||
reasons, even though this is technically incorrect (since
|
||
%G_GNUC_CONST requires that the function not have side effects,
|
||
which _get_type() methods do on the first call). As a result, if
|
||
you write a bare call to a _get_type() macro, it may get optimized
|
||
out by the compiler. Using g_type_ensure() guarantees that the
|
||
type's _get_type() method is called.</doc>
|
||
<source-position filename="gtype.h" line="1396"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6122">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_free_instance" c:identifier="g_type_free_instance">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6141">Frees an instance of a type, returning it to the instance pool for
|
||
the type, if there is one.
|
||
|
||
Like g_type_create_instance(), this function is reserved for
|
||
implementors of fundamental types.</doc>
|
||
<source-position filename="gtype.h" line="2462"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6143">an instance of a type</doc>
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_from_name" c:identifier="g_type_from_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6153">Look up the type ID from a given type name, returning 0 if no type
|
||
has been registered under this name (this is the preferred method
|
||
to find out by name whether a specific type has been registered
|
||
yet).</doc>
|
||
<source-position filename="gtype.h" line="736"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6162">corresponding type ID or 0</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6155">type name to look up</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_fundamental" c:identifier="g_type_fundamental">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6166">Internal function, used to extract the fundamental type ID portion.
|
||
Use G_TYPE_FUNDAMENTAL() instead.</doc>
|
||
<source-position filename="gtype.h" line="2458"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6173">fundamental type ID</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6168">valid type ID</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_fundamental_next"
|
||
c:identifier="g_type_fundamental_next">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6177">Returns the next free fundamental type id which can be used to
|
||
register a new fundamental type with g_type_register_fundamental().
|
||
The returned type ID represents the highest currently registered
|
||
fundamental type identifier.</doc>
|
||
<source-position filename="gtype.h" line="2456"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6185">the next available fundamental type ID to be registered,
|
||
or 0 if the type system ran out of fundamental type IDs</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
</function>
|
||
<function name="type_get_instance_count"
|
||
c:identifier="g_type_get_instance_count"
|
||
version="2.44">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6190">Returns the number of instances allocated of the particular type;
|
||
this is only available if GLib is built with debugging support and
|
||
the instance_count debug flag is set (by setting the GOBJECT_DEBUG
|
||
variable to include instance-count).</doc>
|
||
<source-position filename="gtype.h" line="795"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6199">the number of instances allocated of the given type;
|
||
if instance counts are not available, returns 0.</doc>
|
||
<type name="gint" c:type="int"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6192">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_get_plugin" c:identifier="g_type_get_plugin">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6205">Returns the #GTypePlugin structure for @type.</doc>
|
||
<source-position filename="gtype.h" line="2451"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6211">the corresponding plugin
|
||
if @type is a dynamic type, %NULL otherwise</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6207">#GType to retrieve the plugin for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_get_qdata" c:identifier="g_type_get_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6216">Obtains data which has previously been attached to @type
|
||
with g_type_set_qdata().
|
||
|
||
Note that this does not take subtyping into account; data
|
||
attached to one type with g_type_set_qdata() cannot
|
||
be retrieved from a subtype using g_type_get_qdata().</doc>
|
||
<source-position filename="gtype.h" line="788"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6228">the data, or %NULL if no data was found</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6218">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6219">a #GQuark id to identify the data</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_get_type_registration_serial"
|
||
c:identifier="g_type_get_type_registration_serial"
|
||
version="2.36">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6232">Returns an opaque serial number that represents the state of the set
|
||
of registered types. Any time a type is registered this serial changes,
|
||
which means you can cache information based on type lookups (such as
|
||
g_type_from_name()) and know if the cache is still valid at a later
|
||
time by comparing the current serial with the one at the type lookup.</doc>
|
||
<source-position filename="gtype.h" line="1398"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6242">An unsigned int, representing the state of type registrations</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</return-value>
|
||
</function>
|
||
<function name="type_init"
|
||
c:identifier="g_type_init"
|
||
deprecated="1"
|
||
deprecated-version="2.36">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6246">This function used to initialise the type system. Since GLib 2.36,
|
||
the type system is initialised automatically and this function does
|
||
nothing.</doc>
|
||
<doc-deprecated xml:space="preserve">the type system is now initialised automatically</doc-deprecated>
|
||
<source-position filename="gtype.h" line="726"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
</function>
|
||
<function name="type_init_with_debug_flags"
|
||
c:identifier="g_type_init_with_debug_flags"
|
||
deprecated="1"
|
||
deprecated-version="2.36">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6257">This function used to initialise the type system with debugging
|
||
flags. Since GLib 2.36, the type system is initialised automatically
|
||
and this function does nothing.
|
||
|
||
If you need to enable debugging features, use the GOBJECT_DEBUG
|
||
environment variable.</doc>
|
||
<doc-deprecated xml:space="preserve">the type system is now initialised automatically</doc-deprecated>
|
||
<source-position filename="gtype.h" line="728"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="debug_flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6259">bitwise combination of #GTypeDebugFlags values for
|
||
debugging purposes</doc>
|
||
<type name="TypeDebugFlags" c:type="GTypeDebugFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interface_add_prerequisite"
|
||
c:identifier="g_type_interface_add_prerequisite"
|
||
moved-to="TypeInterface.add_prerequisite">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6273">Adds @prerequisite_type to the list of prerequisites of @interface_type.
|
||
This means that any type implementing @interface_type must also implement
|
||
@prerequisite_type. Prerequisites can be thought of as an alternative to
|
||
interface derivation (which GType doesn't support). An interface can have
|
||
at most one instantiatable prerequisite type.</doc>
|
||
<source-position filename="gtype.h" line="1365"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6275">#GType value of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="prerequisite_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6276">#GType value of an interface or instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interface_get_plugin"
|
||
c:identifier="g_type_interface_get_plugin"
|
||
moved-to="TypeInterface.get_plugin">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6286">Returns the #GTypePlugin structure for the dynamic interface
|
||
@interface_type which has been added to @instance_type, or %NULL
|
||
if @interface_type has not been added to @instance_type or does
|
||
not have a #GTypePlugin structure. See g_type_add_interface_dynamic().</doc>
|
||
<source-position filename="gtype.h" line="2453"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6296">the #GTypePlugin for the dynamic
|
||
interface @interface_type of @instance_type</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6288">#GType of an instantiatable type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6289">#GType of an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interface_instantiatable_prerequisite"
|
||
c:identifier="g_type_interface_instantiatable_prerequisite"
|
||
moved-to="TypeInterface.instantiatable_prerequisite"
|
||
version="2.68">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6301">Returns the most specific instantiatable prerequisite of an
|
||
interface type. If the interface type has no instantiatable
|
||
prerequisite, %G_TYPE_INVALID is returned.
|
||
|
||
See g_type_interface_add_prerequisite() for more information
|
||
about prerequisites.</doc>
|
||
<source-position filename="gtype.h" line="1371"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6312">the instantiatable prerequisite type or %G_TYPE_INVALID if none</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6303">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interface_peek"
|
||
c:identifier="g_type_interface_peek"
|
||
moved-to="TypeInterface.peek">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6317">Returns the #GTypeInterface structure of an interface to which the
|
||
passed in class conforms.</doc>
|
||
<source-position filename="gtype.h" line="762"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6325">the #GTypeInterface
|
||
structure of @iface_type if implemented by @instance_class, %NULL
|
||
otherwise</doc>
|
||
<type name="TypeInterface" c:type="gpointer"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance_class" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6319">a #GTypeClass structure</doc>
|
||
<type name="TypeClass" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="iface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6320">an interface ID which this class conforms to</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interface_prerequisites"
|
||
c:identifier="g_type_interface_prerequisites"
|
||
moved-to="TypeInterface.prerequisites"
|
||
version="2.2">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6347">Returns the prerequisites of an interfaces type.</doc>
|
||
<source-position filename="gtype.h" line="1368"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6356">a
|
||
newly-allocated zero-terminated array of #GType containing
|
||
the prerequisites of @interface_type</doc>
|
||
<array length="1" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="interface_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6349">an interface type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_prerequisites"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full"
|
||
optional="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6350">location to return the number
|
||
of prerequisites, or %NULL</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_interfaces" c:identifier="g_type_interfaces">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6362">Return a newly allocated and 0-terminated array of type IDs, listing
|
||
the interface types that @type conforms to.</doc>
|
||
<source-position filename="gtype.h" line="779"/>
|
||
<return-value transfer-ownership="full">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6371">Newly allocated
|
||
and 0-terminated array of interface types, free with g_free()</doc>
|
||
<array length="1" zero-terminated="0" c:type="GType*">
|
||
<type name="GType" c:type="GType"/>
|
||
</array>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6364">the type to list interface types for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="n_interfaces"
|
||
direction="out"
|
||
caller-allocates="0"
|
||
transfer-ownership="full"
|
||
optional="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6365">location to store the length of
|
||
the returned array, or %NULL</doc>
|
||
<type name="guint" c:type="guint*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_is_a" c:identifier="g_type_is_a">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6376">If @is_a_type is a derivable type, check whether @type is a
|
||
descendant of @is_a_type. If @is_a_type is an interface, check
|
||
whether @type conforms to it.</doc>
|
||
<source-position filename="gtype.h" line="745"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6386">%TRUE if @type is a @is_a_type</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6378">type to check ancestry for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="is_a_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6379">possible ancestor of @type or interface that @type
|
||
could conform to</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_name" c:identifier="g_type_name">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6521">Get the unique name that is assigned to a type ID. Note that this
|
||
function (like all other GType API) cannot cope with invalid type
|
||
IDs. %G_TYPE_INVALID may be passed to this function, as may be any
|
||
other validly registered type ID, but randomized type IDs should
|
||
not be passed in and will most likely lead to a crash.</doc>
|
||
<source-position filename="gtype.h" line="732"/>
|
||
<return-value transfer-ownership="none" nullable="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6531">static type name or %NULL</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6523">type to return name for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_name_from_class"
|
||
c:identifier="g_type_name_from_class">
|
||
<source-position filename="gtype.h" line="2518"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="g_class" transfer-ownership="none">
|
||
<type name="TypeClass" c:type="GTypeClass*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_name_from_instance"
|
||
c:identifier="g_type_name_from_instance">
|
||
<source-position filename="gtype.h" line="2516"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="instance" transfer-ownership="none">
|
||
<type name="TypeInstance" c:type="GTypeInstance*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_next_base" c:identifier="g_type_next_base">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6535">Given a @leaf_type and a @root_type which is contained in its
|
||
ancestry, return the type that @root_type is the immediate parent
|
||
of. In other words, this function determines the type that is
|
||
derived directly from @root_type which is also a base class of
|
||
@leaf_type. Given a root type and a leaf type, this function can
|
||
be used to determine the types and order in which the leaf type is
|
||
descended from the root type.</doc>
|
||
<source-position filename="gtype.h" line="742"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6548">immediate child of @root_type and ancestor of @leaf_type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="leaf_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6537">descendant of @root_type and the type to be returned</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="root_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6538">immediate parent of the returned type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_parent" c:identifier="g_type_parent">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6552">Return the direct parent type of the passed in type. If the passed
|
||
in type has no parent, i.e. is a fundamental type, 0 is returned.</doc>
|
||
<source-position filename="gtype.h" line="738"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6559">the parent type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6554">the derived type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_qname" c:identifier="g_type_qname">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6610">Get the corresponding quark of the type IDs name.</doc>
|
||
<source-position filename="gtype.h" line="734"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6616">the type names quark or 0</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6612">type to return quark of type name for</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_query" c:identifier="g_type_query">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6620">Queries the type system for information about a specific type.
|
||
This function will fill in a user-provided structure to hold
|
||
type-specific information. If an invalid #GType is passed in, the
|
||
@type member of the #GTypeQuery is 0. All members filled into the
|
||
#GTypeQuery structure should be considered constant and have to be
|
||
left untouched.</doc>
|
||
<source-position filename="gtype.h" line="791"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6622">#GType of a static, classed type</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="query"
|
||
direction="out"
|
||
caller-allocates="1"
|
||
transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6623">a user provided structure that is
|
||
filled in with constant values upon success</doc>
|
||
<type name="TypeQuery" c:type="GTypeQuery*"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_register_dynamic"
|
||
c:identifier="g_type_register_dynamic">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6635">Registers @type_name as the name of a new dynamic type derived from
|
||
@parent_type. The type system uses the information contained in the
|
||
#GTypePlugin structure pointed to by @plugin to manage the type and its
|
||
instances (if not abstract). The value of @flags determines the nature
|
||
(e.g. abstract or not) of the type.</doc>
|
||
<source-position filename="gtype.h" line="1346"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6648">the new type identifier or %G_TYPE_INVALID if registration failed</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="parent_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6637">type from which this type will be derived</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="type_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6638">0-terminated string used as the name of the new type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="plugin" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6639">#GTypePlugin structure to retrieve the #GTypeInfo from</doc>
|
||
<type name="TypePlugin" c:type="GTypePlugin*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6640">bitwise combination of #GTypeFlags values</doc>
|
||
<type name="TypeFlags" c:type="GTypeFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_register_fundamental"
|
||
c:identifier="g_type_register_fundamental">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6652">Registers @type_id as the predefined identifier and @type_name as the
|
||
name of a fundamental type. If @type_id is already registered, or a
|
||
type named @type_name is already registered, the behaviour is undefined.
|
||
The type system uses the information contained in the #GTypeInfo structure
|
||
pointed to by @info and the #GTypeFundamentalInfo structure pointed to by
|
||
@finfo to manage the type and its instances. The value of @flags determines
|
||
additional characteristics of the fundamental type.</doc>
|
||
<source-position filename="gtype.h" line="1351"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6668">the predefined type identifier</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type_id" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6654">a predefined type identifier</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="type_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6655">0-terminated string used as the name of the new type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6656">#GTypeInfo structure for this type</doc>
|
||
<type name="TypeInfo" c:type="const GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="finfo" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6657">#GTypeFundamentalInfo structure for this type</doc>
|
||
<type name="TypeFundamentalInfo"
|
||
c:type="const GTypeFundamentalInfo*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6658">bitwise combination of #GTypeFlags values</doc>
|
||
<type name="TypeFlags" c:type="GTypeFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_register_static"
|
||
c:identifier="g_type_register_static">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6672">Registers @type_name as the name of a new static type derived from
|
||
@parent_type. The type system uses the information contained in the
|
||
#GTypeInfo structure pointed to by @info to manage the type and its
|
||
instances (if not abstract). The value of @flags determines the nature
|
||
(e.g. abstract or not) of the type.</doc>
|
||
<source-position filename="gtype.h" line="1332"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6685">the new type identifier</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="parent_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6674">type from which this type will be derived</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="type_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6675">0-terminated string used as the name of the new type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="info" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6676">#GTypeInfo structure for this type</doc>
|
||
<type name="TypeInfo" c:type="const GTypeInfo*"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6677">bitwise combination of #GTypeFlags values</doc>
|
||
<type name="TypeFlags" c:type="GTypeFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_register_static_simple"
|
||
c:identifier="g_type_register_static_simple"
|
||
version="2.12"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6689">Registers @type_name as the name of a new static type derived from
|
||
@parent_type. The value of @flags determines the nature (e.g.
|
||
abstract or not) of the type. It works by filling a #GTypeInfo
|
||
struct and calling g_type_register_static().</doc>
|
||
<source-position filename="gtype.h" line="1337"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6705">the new type identifier</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="parent_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6691">type from which this type will be derived</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="type_name" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6692">0-terminated string used as the name of the new type</doc>
|
||
<type name="utf8" c:type="const gchar*"/>
|
||
</parameter>
|
||
<parameter name="class_size" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6693">size of the class structure (see #GTypeInfo)</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="class_init" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6694">location of the class initialization function (see #GTypeInfo)</doc>
|
||
<type name="ClassInitFunc" c:type="GClassInitFunc"/>
|
||
</parameter>
|
||
<parameter name="instance_size" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6695">size of the instance structure (see #GTypeInfo)</doc>
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
<parameter name="instance_init" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6696">location of the instance initialization function (see #GTypeInfo)</doc>
|
||
<type name="InstanceInitFunc" c:type="GInstanceInitFunc"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6697">bitwise combination of #GTypeFlags values</doc>
|
||
<type name="TypeFlags" c:type="GTypeFlags"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_remove_class_cache_func"
|
||
c:identifier="g_type_remove_class_cache_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6709">Removes a previously installed #GTypeClassCacheFunc. The cache
|
||
maintained by @cache_func has to be empty when calling
|
||
g_type_remove_class_cache_func() to avoid leaks.</doc>
|
||
<source-position filename="gtype.h" line="2468"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="cache_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6711">data that was given when adding @cache_func</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="cache_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6712">a #GTypeClassCacheFunc</doc>
|
||
<type name="TypeClassCacheFunc" c:type="GTypeClassCacheFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_remove_interface_check"
|
||
c:identifier="g_type_remove_interface_check"
|
||
version="2.4"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6720">Removes an interface check function added with
|
||
g_type_add_interface_check().</doc>
|
||
<source-position filename="gtype.h" line="2477"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="check_data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6722">callback data passed to g_type_add_interface_check()</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
<parameter name="check_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6723">callback function passed to g_type_add_interface_check()</doc>
|
||
<type name="TypeInterfaceCheckFunc"
|
||
c:type="GTypeInterfaceCheckFunc"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_set_qdata" c:identifier="g_type_set_qdata">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6732">Attaches arbitrary data to a type.</doc>
|
||
<source-position filename="gtype.h" line="784"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6734">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="quark" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6735">a #GQuark id to identify the data</doc>
|
||
<type name="GLib.Quark" c:type="GQuark"/>
|
||
</parameter>
|
||
<parameter name="data"
|
||
transfer-ownership="none"
|
||
nullable="1"
|
||
allow-none="1">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6736">the data</doc>
|
||
<type name="gpointer" c:type="gpointer"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_test_flags" c:identifier="g_type_test_flags">
|
||
<source-position filename="gtype.h" line="2510"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="flags" transfer-ownership="none">
|
||
<type name="guint" c:type="guint"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="type_value_table_peek"
|
||
c:identifier="g_type_value_table_peek"
|
||
moved-to="TypeValueTable.peek"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6742">Returns the location of the #GTypeValueTable associated with @type.
|
||
|
||
Note that this function should only be used from source code
|
||
that implements or has internal knowledge of the implementation of
|
||
@type.</doc>
|
||
<source-position filename="gtype.h" line="2481"/>
|
||
<return-value>
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6752">location of the #GTypeValueTable associated with @type or
|
||
%NULL if there is no #GTypeValueTable associated with @type</doc>
|
||
<type name="TypeValueTable" c:type="GTypeValueTable*"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="6744">a #GType</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<docsection name="value_arrays">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="934">The prime purpose of a #GValueArray is for it to be used as an
|
||
object property that holds an array of values. A #GValueArray wraps
|
||
an array of #GValue elements in order for it to be used as a boxed
|
||
type through %G_TYPE_VALUE_ARRAY.
|
||
|
||
#GValueArray is deprecated in favour of #GArray since GLib 2.32. It
|
||
is possible to create a #GArray that behaves like a #GValueArray by
|
||
using the size of #GValue as the element size, and by setting
|
||
g_value_unset() as the clear function using g_array_set_clear_func(),
|
||
for instance, the following code:
|
||
|
||
|[<!-- language="C" -->
|
||
GValueArray *array = g_value_array_new (10);
|
||
]|
|
||
|
||
can be replaced by:
|
||
|
||
|[<!-- language="C" -->
|
||
GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10);
|
||
g_array_set_clear_func (array, (GDestroyNotify) g_value_unset);
|
||
]|</doc>
|
||
</docsection>
|
||
<function name="value_register_transform_func"
|
||
c:identifier="g_value_register_transform_func"
|
||
moved-to="Value.register_transform_func"
|
||
introspectable="0">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7228">Registers a value transformation function for use in g_value_transform().
|
||
A previously registered transformation function for @src_type and @dest_type
|
||
will be replaced.</doc>
|
||
<source-position filename="gvalue.h" line="170"/>
|
||
<return-value transfer-ownership="none">
|
||
<type name="none" c:type="void"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7230">Source type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7231">Target type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="transform_func" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7232">a function which transforms values of type @src_type
|
||
into value of type @dest_type</doc>
|
||
<type name="ValueTransform" c:type="GValueTransform"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="value_type_compatible"
|
||
c:identifier="g_value_type_compatible"
|
||
moved-to="Value.type_compatible">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7647">Returns whether a #GValue of type @src_type can be copied into
|
||
a #GValue of type @dest_type.</doc>
|
||
<source-position filename="gvalue.h" line="161"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7655">%TRUE if g_value_copy() is possible with @src_type and @dest_type.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7649">source type to be copied.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7650">destination type for copying.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
<function name="value_type_transformable"
|
||
c:identifier="g_value_type_transformable"
|
||
moved-to="Value.type_transformable">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7659">Check whether g_value_transform() is able to transform values
|
||
of type @src_type into values of type @dest_type. Note that for
|
||
the types to be transformable, they must be compatible or a
|
||
transformation function must be registered.</doc>
|
||
<source-position filename="gvalue.h" line="164"/>
|
||
<return-value transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7669">%TRUE if the transformation is possible, %FALSE otherwise.</doc>
|
||
<type name="gboolean" c:type="gboolean"/>
|
||
</return-value>
|
||
<parameters>
|
||
<parameter name="src_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7661">Source type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
<parameter name="dest_type" transfer-ownership="none">
|
||
<doc xml:space="preserve"
|
||
filename="gobject-2.0.c"
|
||
line="7662">Target type.</doc>
|
||
<type name="GType" c:type="GType"/>
|
||
</parameter>
|
||
</parameters>
|
||
</function>
|
||
</namespace>
|
||
</repository>
|