ClutterGroup

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

Synopsis




            ClutterGroupPrivate;
            ClutterGroup;
ClutterGroup* clutter_group_new             (void);
GList*      clutter_group_get_children      (ClutterGroup *self);
void        clutter_group_foreach           (ClutterGroup *self,
                                             ClutterCallback callback,
                                             gpointer user_data);
void        clutter_group_add               (ClutterGroup *group,
                                             ClutterActor *actor);
void        clutter_group_add_many_valist   (ClutterGroup *group,
                                             ClutterActor *first_actor,
                                             va_list args);
void        clutter_group_add_many          (ClutterGroup *group,
                                             ClutterActor *first_actor,
                                             ...);
void        clutter_group_remove            (ClutterGroup *group,
                                             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
   +----ClutterActor
         +----ClutterGroup
               +----ClutterStage

Signals


"add"       void        user_function      (ClutterGroup *cluttergroup,
                                            ClutterActor *arg1,
                                            gpointer      user_data)         : Run last
"remove"    void        user_function      (ClutterGroup *cluttergroup,
                                            ClutterActor *arg1,
                                            gpointer      user_data)         : Run last

Description

ClutterGroup is an Actor which can contain multiple child actors.

Details

ClutterGroupPrivate

typedef struct _ClutterGroupPrivate ClutterGroupPrivate;

ClutterGroup

typedef struct _ClutterGroup ClutterGroup;

clutter_group_new ()

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

clutter_group_foreach ()

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

self :
callback :
user_data :

clutter_group_add ()

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

Adds a new child ClutterActor to the ClutterGroup.

group :
actor : A ClutterActor

clutter_group_add_many_valist ()

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

group :
first_actor :
args :

clutter_group_add_many ()

void        clutter_group_add_many          (ClutterGroup *group,
                                             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.

group :
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 *group,
                                             ClutterActor *actor);

Remove a child ClutterActor from the ClutterGroup.

group :
actor : A ClutterActor

clutter_group_show_all ()

void        clutter_group_show_all          (ClutterGroup *self);

Show all child actors of the group. Note, does not recurse.

self : A ClutterGroup

clutter_group_hide_all ()

void        clutter_group_hide_all          (ClutterGroup *self);

Hide all child actors of the group. Note, does not recurse.

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 :

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);

self :

Signal Details

The "add" signal

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

cluttergroup : the object which received the signal.
arg1 :
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

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