The duration of the animations, in case #ClutterBoxLayout:use-animations is set to %TRUE.
The duration is expressed in milliseconds.
The easing mode for the animations, in case #ClutterBoxLayout:use-animations is set to %TRUE.
The easing mode has the same semantics of #ClutterAnimation:mode: it can either be a value from the #ClutterAnimationMode enumeration, like %CLUTTER_EASE_OUT_CUBIC, or a logical id as returned by clutter_alpha_register_func().
The default value is %CLUTTER_EASE_OUT_CUBIC.
Whether the #ClutterBoxLayout should arrange its children homogeneously, i.e. all children get the same size
The orientation of the #ClutterBoxLayout, either horizontal or vertical
Whether the #ClutterBoxLayout should pack items at the start or append them at the end
The spacing between children of the #ClutterBoxLayout, in pixels
Whether the #ClutterBoxLayout should animate changes in the layout, overriding the easing state of the children.
Whether the #ClutterBoxLayout should arrange its children alongside the Y axis, instead of alongside the X axis
Allocates the children of container given an area
See also clutter_actor_allocate()
the #ClutterContainer using manager
the #ClutterActorBox containing the allocated area of container
the allocation flags
Begins an animation of duration milliseconds, using the provided
easing mode
The easing mode can be specified either as a #ClutterAnimationMode or as a logical id returned by clutter_alpha_register_func()
The result of this function depends on the manager implementation
the duration of the animation, in milliseconds
the easing mode of the animation
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
Gets a property on the #ClutterLayoutMeta created by manager and
attached to a child of container
The #GValue must already be initialized to the type of the property and has to be unset with g_value_unset() after extracting the real value out of it
a #ClutterContainer using manager
a #ClutterActor child of container
the name of the property to get
a #GValue with the value of the property to get
Sets a property on the #ClutterLayoutMeta created by manager and
attached to a child of container
a #ClutterContainer using manager
a #ClutterActor child of container
the name of the property to set
a #GValue with the value of the property to set
Ends an animation started by clutter_layout_manager_begin_animation()
The result of this call depends on the manager implementation
Retrieves the #GParamSpec for the layout property name inside
the #ClutterLayoutMeta sub-class used by manager
the name of the property
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.
Retrieves the horizontal and vertical alignment policies for actor
as set using clutter_box_layout_pack() or clutter_box_layout_set_alignment()
Retrieves the progress of the animation, if one has been started by clutter_layout_manager_begin_animation()
The returned value has the same semantics of the #ClutterAlpha:alpha value
Retrieves the #ClutterLayoutMeta that the layout manager associated
to the actor child of container, eventually by creating one if the
#ClutterLayoutManager supports layout properties
a #ClutterContainer using manager
a #ClutterActor child of container
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Retrieves the duration set using clutter_box_layout_set_easing_duration()
Retrieves the easing mode set using clutter_box_layout_set_easing_mode()
Retrieves if the children sizes are allocated homogeneously.
Retrieves the orientation of the layout.
Retrieves the value set using clutter_box_layout_set_pack_start()
Computes the minimum and natural heights of the container according
to manager.
See also clutter_actor_get_preferred_height()
the #ClutterContainer using manager
the width for which the height should be computed, or -1
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
Retrieves the spacing set using clutter_box_layout_set_spacing()
Retrieves whether layout should animate changes in the layout properties.
Retrieves the orientation of the layout as set using the
clutter_box_layout_set_vertical() function
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 object has a [floating][floating-ref] reference.
Emits the #ClutterLayoutManager::layout-changed signal on manager
This function should only be called by implementations of the #ClutterLayoutManager class
Retrieves all the #GParamSpecs for the layout properties
stored inside the #ClutterLayoutMeta sub-class used by manager
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.
Packs actor inside the #ClutterContainer associated to layout
and sets the layout properties
a #ClutterActor
whether the actor should expand
whether the actor should fill horizontally
whether the actor should fill vertically
the horizontal alignment policy for actor
the vertical alignment policy for actor
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().
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 horizontal and vertical alignment policies for actor
inside layout
a #ClutterActor child of layout
Horizontal alignment policy for actor
Vertical alignment policy for actor
If the #ClutterLayoutManager sub-class allows it, allow
adding a weak reference of the container using manager
from within the layout manager
The layout manager should not increase the reference
count of the container
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 duration of the animations used by layout when animating changes
in the layout properties.
the duration of the animations, in milliseconds
Sets the easing mode to be used by layout when animating changes in layout
properties.
an easing mode, either from #ClutterAnimationMode or a logical id from clutter_alpha_register_func()
Sets whether the size of layout children should be
homogeneous
%TRUE if the layout should be homogeneous
Sets the orientation of the #ClutterBoxLayout layout manager.
the orientation of the #ClutterBoxLayout
Sets whether children of layout should be layed out by appending
them or by prepending them
%TRUE if the layout should pack children at the beginning of the layout
Sets a property on an object.
the name of the property to set
the value
Sets the spacing between children of layout
the spacing between children of the layout, in pixels
Sets whether layout should animate changes in the layout properties
The duration of the animations is controlled by clutter_box_layout_set_easing_duration(); the easing mode to be used by the animations is controlled by clutter_box_layout_set_easing_mode().
Enabling animations will override the easing state of each child
of the actor using layout, and will use the #ClutterBoxLayout:easing-mode
and #ClutterBoxLayout:easing-duration properties instead.
%TRUE if the layout should use animations
Sets whether layout should arrange its children vertically alongside
the Y axis, instead of horizontally alongside the X axis
%TRUE if the layout should be vertical
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
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.
Allocates the children of container given an area
See also clutter_actor_allocate()
the #ClutterContainer using manager
the #ClutterActorBox containing the allocated area of container
the allocation flags
Begins an animation of duration milliseconds, using the provided
easing mode
The easing mode can be specified either as a #ClutterAnimationMode or as a logical id returned by clutter_alpha_register_func()
The result of this function depends on the manager implementation
the duration of the animation, in milliseconds
the easing mode of the animation
Ends an animation started by clutter_layout_manager_begin_animation()
The result of this call depends on the manager implementation
Retrieves the progress of the animation, if one has been started by clutter_layout_manager_begin_animation()
The returned value has the same semantics of the #ClutterAlpha:alpha value
Computes the minimum and natural heights of the container according
to manager.
See also clutter_actor_get_preferred_height()
the #ClutterContainer using manager
the width for which the height should be computed, or -1
Emits the #ClutterLayoutManager::layout-changed signal on manager
This function should only be called by implementations of the #ClutterLayoutManager class
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.
If the #ClutterLayoutManager sub-class allows it, allow
adding a weak reference of the container using manager
from within the layout manager
The layout manager should not increase the reference
count of the container
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
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
The #ClutterBoxLayout structure contains only private data and should be accessed using the provided API