clutter/clutter-group.h

   1 /*
   2  * Clutter.
   3  *
   4  * An OpenGL based 'interactive canvas' library.
   5  *
   6  * Authored By Matthew Allum  <mallum@openedhand.com>
   7  *
   8  * Copyright (C) 2006 OpenedHand
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
  25 #error "Only <clutter/clutter.h> can be included directly."
  26 #endif
  27
  28 #ifndef __CLUTTER_GROUP_H__
  29 #define __CLUTTER_GROUP_H__
  30
  31 #include <glib-object.h>
  32 #include <clutter/clutter-types.h>
  33 #include <clutter/clutter-actor.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define CLUTTER_TYPE_GROUP              (clutter_group_get_type ())
  38 #define CLUTTER_GROUP(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_GROUP, ClutterGroup))
  39 #define CLUTTER_GROUP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_GROUP, ClutterGroupClass))
  40 #define CLUTTER_IS_GROUP(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_GROUP))
  41 #define CLUTTER_IS_GROUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_GROUP))
  42 #define CLUTTER_GROUP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_GROUP, ClutterGroupClass))
  43
  44 /* XXX - ClutterGroup is to be considered fully deprecated; the only
  45  * reason we keep this header is because ClutterStage inherits from
  46  * ClutterGroup, and thus we need to have a structure definition for
  47  * the Stage object to expand.
  48  */
  49
  50 typedef struct _ClutterGroup            ClutterGroup;
  51 typedef struct _ClutterGroupClass       ClutterGroupClass;
  52 typedef struct _ClutterGroupPrivate     ClutterGroupPrivate;
  53
  54 /**
  55  * ClutterGroup:
  56  *
  57  * The #ClutterGroup structure contains only private data
  58  * and should be accessed using the provided API
  59  *
  60  * Since: 0.1
  61  */
  62 struct _ClutterGroup
  63 {
  64   /*< private >*/
  65   ClutterActor parent_instance;
  66
  67   ClutterGroupPrivate *priv;
  68 };
  69
  70 /**
  71  * ClutterGroupClass:
  72  *
  73  * The #ClutterGroupClass structure contains only private data
  74  *
  75  * Since: 0.1
  76  */
  77 struct _ClutterGroupClass
  78 {
  79   /*< private >*/
  80   ClutterActorClass parent_class;
  81
  82   /* padding for future expansion */
  83   void (*_clutter_reserved1) (void);
  84   void (*_clutter_reserved2) (void);
  85   void (*_clutter_reserved3) (void);
  86   void (*_clutter_reserved4) (void);
  87   void (*_clutter_reserved5) (void);
  88   void (*_clutter_reserved6) (void);
  89 };
  90
  91 GType clutter_group_get_type (void) G_GNUC_CONST;
  92
  93 G_END_DECLS
  94
  95 #endif /* __CLUTTER_GROUP_H__ */