the #GObject
a string identifier for this internal widget.
the generic name of the parent used for fancy child names.
Whether or not this widget is a widget outside of the parent's hierarchy (like a popup window)
The #GladeCreateReason for which this internal widget was created (usually just pass the reason from the post_create function; note also this is used only by the plugin code so pass something useful here).
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.
The child #GladeWidget to add
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 is a convenience function to create a GladeEditorProperty corresponding
to property
The widget's property
whether property indicates a packing property or not.
Whether the undo/redo stack applies here.
Creates a deep copy of #GladeWidget. if exact is specified,
the widget name is preserved and signals are carried over
(this is used to maintain names & signals in Cut/Paste context
as opposed to Copy/Paste contexts).
whether or not to creat an exact duplicate
Copies a list of properties, if as_load is specified, then
properties that are not saved to the glade file are ignored.
the #GladeProperty list to copy
whether to behave as if loading the project
whether to copy reffed widgets at all
whether to copy reffed widgets exactly
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.
Creates a user friendly name to describe project widgets
Returns a #GladeWidgetAction object indentified by action_path.
a full action path including groups
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Checks if widget is a composite template to be used
with gtk_widget_class_set_template().
Returns a #GladeWidgetAction object indentified by action_path.
a full action path including groups
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.
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
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
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
Hide widget
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.
This function retrieves the value of the property property_name on
the runtime object of widget and sets it in value.
The property identifier
The #GValue
This function applies value to the property property_name on
the runtime object of widget.
The property identifier
The #GValue
Resets id_property in widget's packing properties to it's default value
a string naming a #GladeProperty
Sets the enabled state of id_property in widget's packing
properties; this is used for optional properties.
a string naming a #GladeProperty
setting enabled or disabled
Sets whether id_property in widget should be special cased
to always be saved regardless of its default value.
(used for some special cases like properties
that are assigned initial values in composite widgets
or derived widget code).
a string naming a #GladeProperty
the setting
Sets the sensitivity of id_property in widget's packing properties.
a string naming a #GladeProperty
setting sensitive or insensitive
a description of why the user cant edit this property which will be used as a tooltip
Same as glade_widget_property_string() but for packing properties.
a string naming a #GladeProperty
the #GValue to print or %NULL
Returns whether placeholders should be used in operations concerning this parent & child.
Currently that criteria is whether parent is a
GtkContainer, widget is a GtkWidget and the parent
adaptor has been marked to use placeholders.
Resets id_property in widget to it's default value
a string naming a #GladeProperty
Sets the enabled state of id_property in widget; this is
used for optional properties.
a string naming a #GladeProperty
setting enabled or disabled
Sets whether id_property in widget should be special cased
to always be saved regardless of its default value.
(used for some special cases like properties
that are assigned initial values in composite widgets
or derived widget code).
a string naming a #GladeProperty
the setting
Sets the sensitivity of id_property in widget
a string naming a #GladeProperty
setting sensitive or insensitive
a description of why the user cant edit this property which will be used as a tooltip
Creates a printable string representing id_property in
widget, if value is specified it will be used in place
of id_property's real value (this is a convenience
function to print/debug properties usually from plugin
backends).
a string naming a #GladeProperty
the #GValue to print or %NULL
Replaces the current widget instance with a new one while preserving all properties children and takes care of reparenting.
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().
Removes the #GladeProperty indicated by id_property
from widget (this is intended for use in the plugin, to
remove properties from composite children that don't make
sense to allow the user to specify, notably - properties
that are proxied through the composite widget's properties or
style properties).
the name of the property
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets the sensitivity of action_path in widget
a full action path including groups
setting sensitive or insensitive
Sets the visibility of action_path in widget
a full action path including groups
setting visible or invisible
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
Sets the internal name of widget to internal
The internal name
Set's this widget to be toplevel composite object to be eventually used with gtk_widget_class_set_template()
Only one widget in a project should be composite.
whether widget should be a composite template
Sets widget's name to name.
a string
Sets the sensitivity of action_path in widget
a full action path including groups
setting sensitive or insensitive
Sets the visibility of action_path in widget
a full action path including groups
setting visible or invisible
Generates the packing_properties list of the widget, given the class of the container we are adding the widget to. If the widget already has packing_properties, but the container has changed, the current list is freed and replaced.
Sets a property on an object.
the name of the property to set
the value
Display widget in it's project's GladeDesignView
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
Notifies that support metadata has changed on the widget.
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.
Unlocks widget so that it can be removed
from the project again
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.
Verify this widget for deprecation and versioning warnings.
This function will update the widget's support warning.
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
Recursively writes out widget and its children
and appends the created #GladeXmlNode to node.
A #GladeXmlContext
A #GladeXmlNode
Writes out a widget to the xml, takes care of packing properties and special child types.
The child #GladeWidget to write
A #GladeXmlContext
A #GladeXmlNode
Writes out a placeholder to the xml
A #GladePlaceholder
A #GladeXmlContext
A #GladeXmlNode
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
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
Unsets superuser mode
Sets superuser mode
Creates a new #GladeWidget from a XML node.
If node is a template and its parent class is abstract/non instantiatable, Glade will use a class with the GladeInstantiable prefix instead.
For example, with a GtkBin template Glade will GladeInstantiableGtkBin class
a #GladeProject
The parent #GladeWidget or %NULL
a #GladeXmlNode
the name of an internal child name
Checks if we are in superuser mode.
Superuser mode is when we are
In these cases, we must act like a load, this should be checked from the plugin when implementing containers, when undo/redo comes around, the plugin is responsable for maintaining the same container size when widgets are added/removed.
A convenience function to create a #GladeWidget of the prescribed type for internal widgets.