ClutterGroup

ClutterGroup — Base class for actors which contain multiple child actors.

Synopsis




                    ClutterGroup;
                    ClutterGroupClass;
ClutterActor*       clutter_group_new                   (void);
GList*              clutter_group_get_children          (ClutterGroup *self);
gint                clutter_group_get_n_children        (ClutterGroup *self);
ClutterActor*       clutter_group_get_nth_child         (ClutterGroup *self,
                                                         gint index);
void                clutter_group_foreach               (ClutterGroup *self,
                                                         ClutterCallback callback,
                                                         gpointer user_data);
void                clutter_group_add                   (ClutterGroup *self,
                                                         ClutterActor *actor);
void                clutter_group_add_many_valist       (ClutterGroup *self,
                                                         ClutterActor *first_actor,
                                                         va_list args);
void                clutter_group_add_many              (ClutterGroup *self,
                                                         ClutterActor *first_actor,
                                                         ...);
void                clutter_group_remove                (ClutterGroup *self,
                                                         ClutterActor *actor);
void                clutter_group_show_all              (ClutterGroup *self);
void                clutter_group_hide_all              (ClutterGroup *self);
ClutterActor*       clutter_group_find_child_by_id      (ClutterGroup *self,
                                                         guint id);
void                clutter_group_raise                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);
void                clutter_group_lower                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);
void                clutter_group_sort_depth_order      (ClutterGroup *self);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----ClutterGroup
                     +----ClutterStage

Signals


  "add"                                            : Run Last
  "remove"                                         : Run Last

Description

A ClutterGroup is an Actor which can contain multiple child actors.

Details

ClutterGroup

typedef struct _ClutterGroup ClutterGroup;

ClutterGroup has no publicly available members.


ClutterGroupClass

typedef struct {
} ClutterGroupClass;


clutter_group_new ()

ClutterActor*       clutter_group_new                   (void);

Create a new ClutterGroup instance.

Returns : a new ClutterGroup

clutter_group_get_children ()

GList*              clutter_group_get_children          (ClutterGroup *self);

Get a list containing all actors contained in the group.

self : A ClutterGroup
Returns : A GList containing child ClutterActors. You should free the returned list using g_list_free() when finished using it.

clutter_group_get_n_children ()

gint                clutter_group_get_n_children        (ClutterGroup *self);

Gets the number of actors held in the group.

self : A ClutterGroup
Returns : The number of child actors held in the group.

Since 0.2


clutter_group_get_nth_child ()

ClutterActor*       clutter_group_get_nth_child         (ClutterGroup *self,
                                                         gint index);

Gets a groups child held at position index in stack.

self : A ClutterGroup
index : the position of the requested actor.
Returns : A Clutter actor or NULL if index is invalid.

Since 0.2


clutter_group_foreach ()

void                clutter_group_foreach               (ClutterGroup *self,
                                                         ClutterCallback callback,
                                                         gpointer user_data);

Invokes callback on each child of the group.

self : A ClutterGroup
callback : a callback
user_data : callback user data

clutter_group_add ()

void                clutter_group_add                   (ClutterGroup *self,
                                                         ClutterActor *actor);

Adds a new child ClutterActor to the ClutterGroup.

self : A ClutterGroup
actor : A ClutterActor

clutter_group_add_many_valist ()

void                clutter_group_add_many_valist       (ClutterGroup *self,
                                                         ClutterActor *first_actor,
                                                         va_list args);

Similar to clutter_group_add_many() but using a va_list. Use this function inside bindings.

self : a ClutterGroup
first_actor : the ClutterActor actor to add to the group
args : the actors to be added

clutter_group_add_many ()

void                clutter_group_add_many              (ClutterGroup *self,
                                                         ClutterActor *first_actor,
                                                         ...);

Adds a NULL-terminated list of actors to a group. This function is equivalent to calling clutter_group_add() for each member of the list.

self : A ClutterGroup
first_actor : the ClutterActor actor to add to the group
... : additional actors to add to the group

clutter_group_remove ()

void                clutter_group_remove                (ClutterGroup *self,
                                                         ClutterActor *actor);

Remove a child ClutterActor from the ClutterGroup.

self : A ClutterGroup
actor : A ClutterActor

clutter_group_show_all ()

void                clutter_group_show_all              (ClutterGroup *self);

Show all child actors of the group, like clutter_actor_show_all().

Deprecated: Use clutter_actor_show_all() instead.

self : A ClutterGroup

clutter_group_hide_all ()

void                clutter_group_hide_all              (ClutterGroup *self);

Hide all child actors of the group, like clutter_actor_hide_all().

Deprecated: Use clutter_actor_hide_all() instead

self : A ClutterGroup

clutter_group_find_child_by_id ()

ClutterActor*       clutter_group_find_child_by_id      (ClutterGroup *self,
                                                         guint id);

Finds a child actor of a group by its unique ID. Search recurses into any child groups.

self : A ClutterGroup
id : A unique Clutteractor ID
Returns : the ClutterActor if found, or NULL.

clutter_group_raise ()

void                clutter_group_raise                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);

FIXME

self : a ClutterGroup
actor : a ClutterActor
sibling : a ClutterActor

clutter_group_lower ()

void                clutter_group_lower                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);

FIXME

self : a ClutterGroup
actor : a ClutterActor
sibling : a ClutterActor

clutter_group_sort_depth_order ()

void                clutter_group_sort_depth_order      (ClutterGroup *self);

Sorts a ClutterGroup's children by there depth value. This function should not be used by applications.

self : A ClutterGroup

Signal Details

The "add" signal

void                user_function                      (ClutterGroup *cluttergroup,
                                                        ClutterActor *arg1,
                                                        gpointer      user_data)         : Run Last

The ClutterActor arg1 was added to the group.

cluttergroup : the object which received the signal.
arg1 : a ClutterActor.
user_data : user data set when the signal handler was connected.

The "remove" signal

void                user_function                      (ClutterGroup *cluttergroup,
                                                        ClutterActor *arg1,
                                                        gpointer      user_data)         : Run Last

The ClutterActor arg1 was removed from the group.

cluttergroup : the object which received the signal.
arg1 : a ClutterActor.
user_data : user data set when the signal handler was connected.