Add an action to adaptor
.
If the action is present then it overrides label and stock
The identifier of this action in the action tree
A translated label to show in the UI for this action
If set, this stock item will be shown in the UI along side the label.
if this action is important.
Remove an adaptor'
s action.
The identifier of this action in the action tree
Create a list of actions.
Checks whether child
can be added to parent
.
If user_feedback
is %TRUE and child
cannot be
added then this shows a notification dialog to the user
explaining why.
A #GObject container
A #GObject child
whether a notification dialog should be presented in the case that the child cannot not be added.
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:
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.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.
The #GObject container
The #GObject child
The id of the property
The GValue
This function is called to construct a GObject instance for
a #GladeWidget of the said adaptor
. (provided for language
bindings that may need to construct a wrapper object).
amount of construct parameters
array of construct #GParameter args to create the new object with.
This is used to allow the backend to override the way an editor page is layed out (note that editor widgets are created on demand and not at startup).
The #GladeEditorPageType
Creates a GladeEditorProperty to edit def
The #GladePropertyDef to be edited
whether to use the GladeCommand interface to commit property changes
Creates a #GladeEditorProperty to edit #GladePropertyDef name
in adaptor
the string if of the corresponding #GladePropertyDef to be edited
whether this refers to a packing property
whether to use the GladeCommand interface to commit property changes
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().
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.
Assumes pspec
is a property in an object class wrapped by adaptor,
this function will search for the specific parent adaptor class which
originally introduced pspec
.
a #GParamSpec
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Retrieves the #GladePropertyDef for name
in adaptor'
s child properties
a string
Gets the default value for property_id
on a widget governed by
child_adaptor
when parented in a widget governed by parent_adaptor
The #GladeWidgetAdaptor for the parent object
The string property identifier
Gets value
of property_name
on object
.
The #GObject
The property identifier
The #GValue
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling 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.
the name of the property to get
return location for the property value
Retrieves the #GladePropertyDef for name
in adaptor
a string
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Looks up signal class name
on adaptor
.
the name of the signal class.
Get the _get_type () function name if it is set, a %NULL value means that the default heuristic for getting the GType is enough for both Glade and GtkBuilder.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether or not this adaptor has support to interface with child objects.
Checks whether object
has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
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_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
Add a packing action to adaptor
.
If the action is present then it overrides label and stock
The identifier of this action in the action tree
A translated label to show in the UI for this action
If set, this stock item will be shown in the UI along side the label.
if this action is important.
Remove an adaptor'
s packing action.
The identifier of this action in the action tree
Create a list of packing actions.
An adaptor function to be called after the object is created
The #GObject
The #GladeCreateReason that object
was created for
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().
Registers adaptor
into the Glade core (every supported
object type must have a registered adaptor).
Replaces old_obj
with new_obj
in container
while positioning
new_obj
where old_obj
was and assigning it appropriate packing
property values.
The #GObject container
The old #GObject child
The new #GObject child
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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.
name of the key
data to associate with that key
This delegate function is used to apply the property value on the runtime object.
The #GObject
The property identifier
The #GValue
Sets a property on an object.
the name of the property to set
the value
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
For normal properties this is used to serialize property values, for custom properties its still needed to update the UI for undo/redo items etc.
The #GladePropertyDef
The #GValue to convert to a string
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.
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.
This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.
The #GObject
The property identifier
The #GValue
Checks whether child
can be added to parent
.
If user_feedback
is %TRUE and child
cannot be
added then this shows a notification dialog to the user
explaining why.
A #GObject container
A #GObject child
whether a notification dialog should be presented in the case that the child cannot not be added.
This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.
The #GObject container
The #GObject child
The id of the property
The GValue
This function is called to construct a GObject instance for
a #GladeWidget of the said adaptor
. (provided for language
bindings that may need to construct a wrapper object).
amount of construct parameters
array of construct #GParameter args to create the new object with.
This is used to allow the backend to override the way an editor page is layed out (note that editor widgets are created on demand and not at startup).
The #GladeEditorPageType
Creates a GladeEditorProperty to edit def
The #GladePropertyDef to be edited
whether to use the GladeCommand interface to commit property changes
Gets value
of property_name
on object
.
The #GObject
The property identifier
The #GValue
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.
An adaptor function to be called after the object is created
The #GObject
The #GladeCreateReason that object
was created for
Replaces old_obj
with new_obj
in container
while positioning
new_obj
where old_obj
was and assigning it appropriate packing
property values.
The #GObject container
The old #GObject child
The new #GObject child
This delegate function is used to apply the property value on the runtime object.
The #GObject
The property identifier
The #GValue
For normal properties this is used to serialize property values, for custom properties its still needed to update the UI for undo/redo items etc.
The #GladePropertyDef
The #GValue to convert to a string
This delegate function is always called whenever setting any properties with the exception of load time, and copy/paste time (basically the two places where we recreate a hierarchy that we already know "works") its basically an optional backend provided boundary checker for properties.
The #GObject
The property identifier
The #GValue
This function is called to write the child widget
to node
when writing xml files (takes care of packing and recurses
into glade_widget_write())
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
This function is called to write widget
to node
when writing xml files.
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
This function is called to write widget
to node
when writing xml files (after writing children)
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
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.
#GClosure to watch
This function is called to write the child widget
to node
when writing xml files (takes care of packing and recurses
into glade_widget_write())
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
This function is called to write widget
to node
when writing xml files.
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
This function is called to write widget
to node
when writing xml files (after writing children)
The #GladeWidget
The #GladeXmlContext
The #GladeXmlNode
Dynamically creates a subclass of #GladeWidgetAdaptor and subclasses the closest parent adaptor (parent class adapters must be created/registered prior to child classes, otherwise inheritance wont work) and parses in the relevant catalog info.
A #GladeCatalog
the #GladeXmlNode to load
the plugin GModule.
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().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
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.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Compiles a list of all registered adaptors.
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.
the type id of the #GObject subtype to instantiate
an array of #GParameter
An adaptor function to be called on widget actions.