clutter-container

clutter-container — An interface for container actors

Functions

Description

ClutterContainer is an interface implemented by ClutterActor, and it provides some common API for notifying when a child actor is added or removed, as well as the infrastructure for accessing child properties through ClutterChildMeta.

Until Clutter 1.10, the ClutterContainer interface was also the public API for implementing container actors; this part of the interface has been deprecated: ClutterContainer has a default implementation which defers to ClutterActor the child addition and removal, as well as the iteration. See the documentation of ClutterContainerIface for the list of virtual functions that should be overridden.

Functions

clutter_container_add ()

void
clutter_container_add (ClutterContainer *container,
                       ClutterActor *first_actor,
                       ...);

clutter_container_add has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_add_child() instead.

Adds a list of ClutterActors 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 ClutterActor to more than one ClutterContainer.

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

[skip]

Parameters

container

a ClutterContainer

 

first_actor

the first ClutterActor to add

 

...

NULL terminated list of actors to add

 

Since: 0.4


clutter_container_add_actor ()

void
clutter_container_add_actor (ClutterContainer *container,
                             ClutterActor *actor);

clutter_container_add_actor has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_add_child() instead.

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

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

[virtual add]

Parameters

container

a ClutterContainer

 

actor

the first ClutterActor to add

 

Since: 0.4


clutter_container_add_valist ()

void
clutter_container_add_valist (ClutterContainer *container,
                              ClutterActor *first_actor,
                              va_list var_args);

clutter_container_add_valist has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_add_child() instead.

Alternative va_list version of clutter_container_add().

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

[skip]

Parameters

container

a ClutterContainer

 

first_actor

the first ClutterActor to add

 

var_args

list of actors to add, followed by NULL

 

Since: 0.4


clutter_container_remove ()

void
clutter_container_remove (ClutterContainer *container,
                          ClutterActor *first_actor,
                          ...);

clutter_container_remove has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_remove_child() instead.

Removes a NULL terminated list of ClutterActors from container . Each actor should be unparented, so if you want to keep it around you must hold a reference to it yourself, using g_object_ref(). Each time an actor is removed, the "actor-removed" signal is emitted by container .

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

[skip]

Parameters

container

a ClutterContainer

 

first_actor

first ClutterActor to remove

 

...

a NULL-terminated list of actors to remove

 

Since: 0.4


clutter_container_remove_actor ()

void
clutter_container_remove_actor (ClutterContainer *container,
                                ClutterActor *actor);

clutter_container_remove_actor has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_remove_child() instead.

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 ClutterContainerIface.remove(), which is a deprecated virtual function. The default implementation will call clutter_actor_remove_child().

[virtual remove]

Parameters

container

a ClutterContainer

 

actor

a ClutterActor

 

Since: 0.4


clutter_container_remove_valist ()

void
clutter_container_remove_valist (ClutterContainer *container,
                                 ClutterActor *first_actor,
                                 va_list var_args);

clutter_container_remove_valist has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_remove_child() instead.

Alternative va_list version of clutter_container_remove().

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

[skip]

Parameters

container

a ClutterContainer

 

first_actor

the first ClutterActor to add

 

var_args

list of actors to remove, followed by NULL

 

Since: 0.4


clutter_container_get_children ()

GList *
clutter_container_get_children (ClutterContainer *container);

clutter_container_get_children has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_get_children() instead.

Retrieves all the children of container .

Parameters

container

a ClutterContainer

 

Returns

a list of ClutterActors. Use g_list_free() on the returned list when done.

[element-type Clutter.Actor][transfer container]

Since: 0.4


clutter_container_foreach ()

void
clutter_container_foreach (ClutterContainer *container,
                           ClutterCallback callback,
                           gpointer user_data);

clutter_container_foreach has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_get_first_child() or clutter_actor_get_last_child() to retrieve the beginning of the list of children, and clutter_actor_get_next_sibling() and clutter_actor_get_previous_sibling() to iterate over it; alternatively, use the ClutterActorIter API.

Calls callback for each child of container that was added by the application (with clutter_container_add_actor()). Does not iterate over "internal" children that are part of the container's own implementation, if any.

This function calls the ClutterContainerIface.foreach() virtual function, which has been deprecated.

Parameters

container

a ClutterContainer

 

callback

a function to be called for each child.

[scope call]

user_data

data to be passed to the function, or NULL

 

Since: 0.4


clutter_container_foreach_with_internals ()

void
clutter_container_foreach_with_internals
                               (ClutterContainer *container,
                                ClutterCallback callback,
                                gpointer user_data);

clutter_container_foreach_with_internals has been deprecated since version 1.10 and should not be used in newly-written code.

See clutter_container_foreach().

Calls callback for each child of container , including "internal" children built in to the container itself that were never added by the application.

This function calls the ClutterContainerIface.foreach_with_internals() virtual function, which has been deprecated.

Parameters

container

a ClutterContainer

 

callback

a function to be called for each child.

[scope call]

user_data

data to be passed to the function, or NULL

 

Since: 1.0


clutter_container_raise_child ()

void
clutter_container_raise_child (ClutterContainer *container,
                               ClutterActor *actor,
                               ClutterActor *sibling);

clutter_container_raise_child has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_set_child_above_sibling() instead.

Raises actor to sibling level, in the depth ordering.

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

[virtual raise]

Parameters

container

a ClutterContainer

 

actor

the actor to raise

 

sibling

the sibling to raise to, or NULL to raise to the top.

[allow-none]

Since: 0.6


clutter_container_lower_child ()

void
clutter_container_lower_child (ClutterContainer *container,
                               ClutterActor *actor,
                               ClutterActor *sibling);

clutter_container_lower_child has been deprecated since version 1.10 and should not be used in newly-written code.

Use clutter_actor_set_child_below_sibling() instead.

Lowers actor to sibling level, in the depth ordering.

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

[virtual lower]

Parameters

container

a ClutterContainer

 

actor

the actor to raise

 

sibling

the sibling to lower to, or NULL to lower to the bottom.

[allow-none]

Since: 0.6


clutter_container_sort_depth_order ()

void
clutter_container_sort_depth_order (ClutterContainer *container);

clutter_container_sort_depth_order has been deprecated since version 1.10 and should not be used in newly-written code.

The ClutterContainerIface.sort_depth_order() virtual function should not be used any more; the default implementation in ClutterContainer does not do anything.

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

Parameters

container

a ClutterContainer

 

Since: 0.6