Module: Clutter::Container

Defined in:
(unknown)

Overview

Clutter::Container is an opaque structure whose members cannot be directly
accessed

Instance Method Summary collapse

Instance Method Details

#actor_added(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#actor_removed(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#add(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#add_actor(actor) ⇒ nil

Adds a Clutter::Actor to container. This function will emit the
"actor-added" signal. The actor should be parented to
container. You cannot add a Clutter::Actor to more than one
Clutter::Container.

This function will call Clutter::ContainerIface.add(), which is a
deprecated virtual function. The default implementation will
call clutter_actor_add_child().

Parameters:

Returns:

  • (nil)

#add_valist(first_actor, var_args) ⇒ nil

Alternative va_list version of clutter_container_add().

This function will call Clutter::ContainerIface.add(), which is a
deprecated virtual function. The default implementation will
call clutter_actor_add_child().

Parameters:

  • first_actor (Clutter::Actor) —

    the first Clutter::Actor to add

  • var_args (Clutter::va_list) —

    list of actors to add, followed by nil

Returns:

  • (nil)

#child_get(actor, first_prop, array) ⇒ nil

Gets container specific properties of an actor.

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().
pairs terminated with NULL.

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor that is a child of container.

  • first_prop (String) —

    name of the first property to be set.

  • array (Array) —

    value for the first property, followed optionally by more name/value

Returns:

  • (nil)

#child_get_property(child, property, value) ⇒ nil

Gets a container specific property of a child of container, 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 clutter_container_child_set_property() is really intended for
language bindings, clutter_container_child_set() is much more convenient
for C programming.

Parameters:

  • child (Clutter::Actor) —

    a Clutter::Actor that is a child of container.

  • property (String) —

    the name of the property to set.

  • value (GObject::Value) —

    the value.

Returns:

  • (nil)

#child_notify(container, child, pspec) ⇒ nil

Parameters:

Returns:

  • (nil)

#child_set(actor, first_prop, array) ⇒ nil

Sets container specific properties on the child of a container.
pairs terminated with NULL.

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor that is a child of container.

  • first_prop (String) —

    name of the first property to be set.

  • array (Array) —

    value for the first property, followed optionally by more name/value

Returns:

  • (nil)

#child_set_property(child, property, value) ⇒ nil

Sets a container-specific property on a child of container.

Parameters:

  • child (Clutter::Actor) —

    a Clutter::Actor that is a child of container.

  • property (String) —

    the name of the property to set.

  • value (GObject::Value) —

    the value.

Returns:

  • (nil)

#children ⇒ GLib::List<Clutter::Actor>

Retrieves all the children of container.

Returns:

  • (GLib::List<Clutter::Actor>) —

    a list
    of Clutter::Actors. Use g_list_free() on the returned
    list when done.

#create_child_meta(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#destroy_child_meta(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#find_child_by_name(child_name) ⇒ Clutter::Actor

Finds a child actor of a container by its name. Search recurses
into any child container.

Parameters:

  • child_name (String) —

    the name of the requested child.

Returns:

  • (Clutter::Actor) —

    The child actor with the requested name,
    or nil if no actor with that name was found.

#foreach(container, callback, user_data) ⇒ nil

Parameters:

  • container (Clutter::Container) —

    a Clutter::Container

  • callback (Clutter::Callback) —

    a function to be called for each child

  • user_data (GObject) —

    data to be passed to the function, or nil

Returns:

  • (nil)

#foreach_with_internals(container, callback, user_data) ⇒ nil

Parameters:

  • container (Clutter::Container) —

    a Clutter::Container

  • callback (Clutter::Callback) —

    a function to be called for each child

  • user_data (GObject) —

    data to be passed to the function, or nil

Returns:

  • (nil)

#get_child_meta(container, actor) ⇒ Clutter::ChildMeta

Returns the Clutter::ChildMeta for the actor child
of container or nil if the specifiec actor does not exist or the
container is not configured to provide Clutter::ChildMetas.

Parameters:

Returns:

  • (Clutter::ChildMeta) —

    the Clutter::ChildMeta for the actor child
    of container or nil if the specifiec actor does not exist or the
    container is not configured to provide Clutter::ChildMetas

#lower(container, actor, sibling) ⇒ nil

Parameters:

Returns:

  • (nil)

#lower_child(actor, sibling) ⇒ nil

Lowers actor to sibling level, in the depth ordering.

This function calls the Clutter::ContainerIface.lower() virtual function,
which has been deprecated. The default implementation will call
clutter_actor_set_child_below_sibling().

Parameters:

Returns:

  • (nil)

#raise(container, actor, sibling) ⇒ nil

Parameters:

Returns:

  • (nil)

#raise_child(actor, sibling) ⇒ nil

Raises actor to sibling level, in the depth ordering.

This function calls the Clutter::ContainerIface.raise() virtual function,
which has been deprecated. The default implementation will call
clutter_actor_set_child_above_sibling().

Parameters:

Returns:

  • (nil)

#remove(container, actor) ⇒ nil

Parameters:

Returns:

  • (nil)

#remove_actor(actor) ⇒ nil

Removes actor from container. The actor should be unparented, so
if you want to keep it around you must hold a reference to it
yourself, using g_object_ref(). When the actor has been removed,
the "actor-removed" signal is emitted by container.

This function will call Clutter::ContainerIface.remove(), which is a
deprecated virtual function. The default implementation will call
clutter_actor_remove_child().

Parameters:

Returns:

  • (nil)

#remove_valist(first_actor, var_args) ⇒ nil

Alternative va_list version of clutter_container_remove().

This function will call Clutter::ContainerIface.remove(), which is a
deprecated virtual function. The default implementation will call
clutter_actor_remove_child().

Parameters:

  • first_actor (Clutter::Actor) —

    the first Clutter::Actor to add

  • var_args (Clutter::va_list) —

    list of actors to remove, followed by nil

Returns:

  • (nil)

#sort_depth_order(container) ⇒ nil

Parameters:

Returns:

  • (nil)