Container
Object Hierarchy:
Description:
public interface Container :
Object
Base interface for container actors. The add, remove and foreach virtual functions must be
provided by any implementation; the other virtual functions are optional.
All known implementing classes:
Namespace: Clutter
Package: clutter-1.0
Content:
Static methods:
Methods:
-
public void add (Actor[] actors)
Adds a list of Actors to container
. Each time and actor is added, the "actor-added" signal is emitted. Each actor should be parented to container,
which takes a reference on the actor. You cannot add a Actor to more than
one Container.
-
public abstract void add_actor (Actor actor)
Adds a Actor to container. This
function will emit the "actor-added" signal. The actor should be parented to container. You cannot add a
Actor to more than one
Container.
-
public void add_valist (Actor first_actor, void* var_args)
Alternative va_list version of add.
-
public void child_get (Actor actor, ...)
Gets container specific properties of an actor.
-
public void child_get_property (Actor child, string property, Value value)
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
unset.
-
public void child_set (Actor actor, ...)
Sets container specific properties on the child of a container.
-
public void child_set_property (Actor child, string property, Value value)
Sets a container-specific property on a child of container.
-
public virtual void create_child_meta (Actor actor)
Creates the ChildMeta wrapping actor
inside the container, if the ClutterContainerIface::child_meta_type class member is not set to
INVALID.
-
public virtual void destroy_child_meta (Actor actor)
Destroys the ChildMeta wrapping
actor inside the container, if any.
-
public weak Actor find_child_by_name (string child_name)
Finds a child actor of a container by its name. Search recurses into any child container.
-
public abstract void foreach (Callback callback)
Calls callback for each child of container that was added by the application
(with add_actor). Does not iterate over "internal" children
that are part of the container's own implementation, if any.
-
public virtual void foreach_with_internals (Callback callback)
Calls callback for each child of container, including "internal" children
built in to the container itself that were never added by the application.
-
public virtual weak ChildMeta get_child_meta (Actor actor)
Retrieves the ChildMeta which contains the
data about the container specific state for actor.
-
public List<weak Actor> get_children ()
Retrieves all the children of container.
-
public virtual void lower_child (Actor actor, Actor? sibling = null)
Lowers actor to sibling level, in the depth ordering.
-
public virtual void raise_child (Actor actor, Actor? sibling = null)
Raises actor to sibling level, in the depth ordering.
-
public void remove (...)
Removes a null terminated list of
Actors from container. Each actor should be unparented, so if you want to keep it around you must hold a
reference to it yourself, using ref. Each time an actor is removed,
the "actor-removed" signal is emitted by container.
-
public abstract void remove_actor (Actor actor)
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 ref
. When the actor has been removed, the "actor-removed" signal is emitted by container.
-
public void remove_valist (Actor first_actor, va_list var_args)
Alternative va_list version of remove.
-
public abstract void sort_depth_order ()
Sorts a container's children using their depth. This function should not be normally used by
applications.
Signals:
