Next: , Previous: Colors, Up: Top

16 ClutterContainer

An interface for implementing container actors

16.1 Overview

<clutter-container> is an interface for writing actors containing other <clutter-actor>s. It provides a standard API for adding, removing and iterating on every contained actor.

An actor implementing <clutter-container> is <clutter-group>.

<clutter-container> is available since Clutter 0.4

16.2 Usage

— Class: <clutter-container>

Derives from <ginterface>.

This class defines no direct slots.

— Signal on <clutter-container>: actor-added (arg0 <clutter-actor>)

undocumented

— Signal on <clutter-container>: actor-removed (arg0 <clutter-actor>)

undocumented

— Signal on <clutter-container>: child-notify (arg0 <clutter-actor>) (arg1 <gparam>)

undocumented

— Function: clutter-container-add-actor (self <clutter-container>) (actor <clutter-actor>)
— Method: add-actor

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>.

container
a <clutter-container>
actor
the first <clutter-actor> to add

Since 0.4

— Function: clutter-container-remove-actor (self <clutter-container>) (actor <clutter-actor>)
— Method: remove-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 g-object-ref. When the actor has been removed, the "actor-removed" signal is emitted by container.

container
a <clutter-container>
actor
a <clutter-actor>

Since 0.4

— Function: clutter-container-get-children (self <clutter-container>)   (ret glist-of)
— Method: get-children

Retrieves all the children of container.

container
a <clutter-container>
ret
a list of <clutter-actor>s. Use g-list-free on the returned list when done.

Since 0.4

— Function: clutter-container-raise-child (self <clutter-container>) (actor <clutter-actor>) (sibling <clutter-actor>)
— Method: raise-child

Raises actor to sibling level, in the depth ordering.

container
a <clutter-container>
actor
the actor to raise
sibling
the sibling to raise to, or ‘#f’ to raise to the top

Since 0.6

— Function: clutter-container-lower-child (self <clutter-container>) (actor <clutter-actor>) (sibling <clutter-actor>)
— Method: lower-child

Lowers actor to sibling level, in the depth ordering.

container
a <clutter-container>
actor
the actor to raise
sibling
the sibling to lower to, or ‘#f’ to lower to the bottom

Since 0.6

— Function: clutter-container-sort-depth-order (self <clutter-container>)
— Method: sort-depth-order

Sorts a container's children using their depth. This function should not be normally used by applications.

container
a <clutter-container>

Since 0.6

— Function: clutter-container-get-child-meta (self <clutter-container>) (actor <clutter-actor>)   (ret <clutter-child-meta>)
— Method: get-child-meta

Retrieves the <clutter-child-meta> which contains the data about the container specific state for actor.

container
a <clutter-container>
actor
a <clutter-actor> that is a child of container.
ret
the <clutter-child-meta> for the actor child of container or ‘#f’ if the specifiec actor does not exist or the container is not configured to provide <clutter-child-meta>s

Since 0.8