clutter_container_add_actor ()

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

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]

Since: 0.4

clutter_container_add ()

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

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]

Since: 0.4

clutter_container_add_valist ()

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

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]

Since: 0.4

clutter_container_remove_actor ()

void
clutter_container_remove_actor (ClutterContainer *container,
                                ClutterActor *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 .

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

[virtual remove]

Since: 0.4

clutter_container_remove ()

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

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]

Since: 0.4

clutter_container_remove_valist ()

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

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]

Since: 0.4

clutter_container_get_children ()

GList *
clutter_container_get_children (ClutterContainer *container);

Retrieves all the children of container .

Since: 0.4

clutter_container_foreach ()

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

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.

Since: 0.4

clutter_container_foreach_with_internals ()

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

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.

Since: 1.0

clutter_container_find_child_by_name ()

ClutterActor *
clutter_container_find_child_by_name (ClutterContainer *container,
                                      const gchar *child_name);

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

Since: 0.6

clutter_container_raise_child ()

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

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]

Since: 0.6

clutter_container_lower_child ()

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

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]

Since: 0.6

clutter_container_sort_depth_order ()

void
clutter_container_sort_depth_order (ClutterContainer *container);

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

Since: 0.6

clutter_container_class_find_child_property ()

GParamSpec *
clutter_container_class_find_child_property
                               (GObjectClass *klass,
                                const gchar *property_name);

Looks up the GParamSpec for a child property of klass .

Since: 0.8

clutter_container_class_list_child_properties ()

GParamSpec **
clutter_container_class_list_child_properties
                               (GObjectClass *klass,
                                guint *n_properties);

Returns an array of GParamSpec for all child properties.

Since: 0.8

clutter_container_child_set_property ()

void
clutter_container_child_set_property (ClutterContainer *container,
                                      ClutterActor *child,
                                      const gchar *property,
                                      const GValue *value);

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

Since: 0.8

clutter_container_child_get_property ()

void
clutter_container_child_get_property (ClutterContainer *container,
                                      ClutterActor *child,
                                      const gchar *property,
                                      GValue *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 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.

Since: 0.8

clutter_container_child_set ()

void
clutter_container_child_set (ClutterContainer *container,
                             ClutterActor *actor,
                             const gchar *first_prop,
                             ...);

Sets container specific properties on the child of a container.

Since: 0.8

clutter_container_child_get ()

void
clutter_container_child_get (ClutterContainer *container,
                             ClutterActor *actor,
                             const gchar *first_prop,
                             ...);

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

Since: 0.8

clutter_container_child_notify ()

void
clutter_container_child_notify (ClutterContainer *container,
                                ClutterActor *child,
                                GParamSpec *pspec);

Calls the ClutterContainerIface.child_notify() virtual function of ClutterContainer. The default implementation will emit the “child-notify” signal.

Since: 1.6

clutter_container_create_child_meta ()

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

Creates the ClutterChildMeta wrapping actor inside the container , if the “child_meta_type” class member is not set to G_TYPE_INVALID.

This function is only useful when adding a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation.

Applications should not call this function.

Since: 1.2

clutter_container_destroy_child_meta ()

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

Destroys the ClutterChildMeta wrapping actor inside the container , if any.

This function is only useful when removing a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation.

Applications should not call this function.

Since: 1.2

clutter_container_get_child_meta ()

ClutterChildMeta *
clutter_container_get_child_meta (ClutterContainer *container,
                                  ClutterActor *actor);

Retrieves the ClutterChildMeta which contains the data about the container specific state for actor .

Since: 0.8

ClutterContainer

typedef struct _ClutterContainer ClutterContainer;

ClutterContainer is an opaque structure whose members cannot be directly accessed

Since: 0.4

struct ClutterContainerIface

struct ClutterContainerIface {
  void (* add)              (ClutterContainer *container,
                             ClutterActor     *actor);
  void (* remove)           (ClutterContainer *container,
                             ClutterActor     *actor);
  void (* foreach)          (ClutterContainer *container,
                             ClutterCallback   callback,
                             gpointer          user_data);

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

  /* child stacking */
  void (* raise)            (ClutterContainer *container,
                             ClutterActor     *actor,
                             ClutterActor     *sibling);
  void (* lower)            (ClutterContainer *container,
                             ClutterActor     *actor,
                             ClutterActor     *sibling);
  void (* sort_depth_order) (ClutterContainer *container);

  /* ClutterChildMeta management */
  GType                child_meta_type;
  void              (* create_child_meta)  (ClutterContainer *container,
                                            ClutterActor     *actor);
  void              (* destroy_child_meta) (ClutterContainer *container,
                                            ClutterActor     *actor);
  ClutterChildMeta *(* get_child_meta)     (ClutterContainer *container,
                                            ClutterActor     *actor);

  /* signals */
  void (* actor_added)   (ClutterContainer *container,
                          ClutterActor     *actor);
  void (* actor_removed) (ClutterContainer *container,
                          ClutterActor     *actor);

  void (* child_notify)  (ClutterContainer *container,
                          ClutterActor     *child,
                          GParamSpec       *pspec);
};

Base interface for container actors. The add , remove and foreach virtual functions must be provided by any implementation; the other virtual functions are optional.

Since: 0.4

The “actor-added” signal

void
user_function (ClutterContainer *container,
               ClutterActor     *actor,
               gpointer          user_data)

The ::actor-added signal is emitted each time an actor has been added to container .

Flags: Run First

Since: 0.4

The “actor-removed” signal

void
user_function (ClutterContainer *container,
               ClutterActor     *actor,
               gpointer          user_data)

The ::actor-removed signal is emitted each time an actor is removed from container .

Flags: Run First

Since: 0.4

The “child-notify” signal

void
user_function (ClutterContainer *container,
               ClutterActor     *actor,
               GParamSpec       *pspec,
               gpointer          user_data)

The ::child-notify signal is emitted each time a property is being set through the clutter_container_child_set() and clutter_container_child_set_property() calls.

Flags: Has Details

Since: 0.8