mutter/clutter/clutter-group.h

/*
 * Clutter.
 *
 * An OpenGL based 'interactive canvas' library.
 *
 * Authored By Matthew Allum  <mallum@openedhand.com>
 *
 * Copyright (C) 2006 OpenedHand
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _HAVE_CLUTTER_GROUP_H
#define _HAVE_CLUTTER_GROUP_H

#include <glib-object.h>
#include <clutter/clutter-actor.h>

G_BEGIN_DECLS

#define CLUTTER_TYPE_GROUP clutter_group_get_type()

#define CLUTTER_GROUP(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  CLUTTER_TYPE_GROUP, ClutterGroup))

#define CLUTTER_GROUP_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), \
  CLUTTER_TYPE_GROUP, ClutterGroupClass))

#define CLUTTER_IS_GROUP(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  CLUTTER_TYPE_GROUP))

#define CLUTTER_IS_GROUP_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  CLUTTER_TYPE_GROUP))

#define CLUTTER_GROUP_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  CLUTTER_TYPE_GROUP, ClutterGroupClass))

typedef struct _ClutterGroupPrivate ClutterGroupPrivate;
typedef struct _ClutterGroup        ClutterGroup;
typedef struct _ClutterGroupClass   ClutterGroupClass;
 
struct _ClutterGroup
{
  ClutterActor          parent;

  /*< private >*/
  ClutterGroupPrivate      *priv;
};

struct _ClutterGroupClass
{
  /*< private >*/
  ClutterActorClass     parent_class;

  void (*add)    (ClutterGroup   *group,
		  ClutterActor *child);
  void (*remove) (ClutterGroup   *group,
		  ClutterActor *child);

  /* padding for future expansion */
  void (*_clutter_group_1) (void);
  void (*_clutter_group_2) (void);
  void (*_clutter_group_3) (void);
  void (*_clutter_group_4) (void);
  void (*_clutter_group_5) (void);
  void (*_clutter_group_6) (void);
};

GType clutter_group_get_type (void);

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 *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,
			...) G_GNUC_NULL_TERMINATED;

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

G_END_DECLS

#endif