vcs.maemo.org Git - clutter-gtk/blob - clutter-gtk/gtk-clutter-embed.h

   1 /* gtk-clutter-embed.h: Embeddable ClutterStage
   2  *
   3  * Copyright (C) 2007 OpenedHand
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library. If not see <http://www.fsf.org/licensing>.
  17  *
  18  * Authors:
  19  *   Iain Holmes  <iain@openedhand.com>
  20  *   Emmanuele Bassi  <ebassi@openedhand.com>
  21  */
  22
  23 #ifndef __GTK_CLUTTER_EMBED_H__
  24 #define __GTK_CLUTTER_EMBED_H__
  25
  26 #include <gtk/gtkwidget.h>
  27 #include <clutter/clutter-main.h>
  28 #include <clutter/clutter-actor.h>
  29 #include <clutter-gtk/gtk-clutter-util.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GTK_TYPE_CLUTTER_EMBED          (gtk_clutter_embed_get_type ())
  34 #define GTK_CLUTTER_EMBED(o)            (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbed))
  35 #define GTK_IS_CLUTTER_EMBED(o)         (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_CLUTTER_EMBED))
  36 #define GTK_CLUTTER_EMBED_CLASS(k)      (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedClass))
  37 #define GTK_IS_CLUTTER_EMBED_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_CLUTTER_EMBED))
  38 #define GTK_CLUTTER_EMBED_GET_CLASS(o)  (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedClass))
  39
  40 typedef struct _GtkClutterEmbed         GtkClutterEmbed;
  41 typedef struct _GtkClutterEmbedPrivate  GtkClutterEmbedPrivate;
  42 typedef struct _GtkClutterEmbedClass    GtkClutterEmbedClass;
  43
  44 /**
  45  * ClutterGtkInitError:
  46  * @CLUTTER_INIT_ERROR_LAST: Placeholder
  47  * @CLUTTER_INIT_ERROR_GTK: Unable to initialize GTK+
  48  *
  49  * Extension of the #ClutterInitError enumeration for the integration
  50  * with GTK+
  51  *
  52  * Since: 0.8
  53  */
  54 typedef enum {
  55   CLUTTER_INIT_ERROR_LAST = CLUTTER_INIT_ERROR_INTERNAL,
  56
  57   CLUTTER_INIT_ERROR_GTK  = (CLUTTER_INIT_ERROR_LAST - 1)
  58 } ClutterGtkInitError;
  59
  60 /**
  61  * GtkClutterEmbed:
  62  *
  63  * A #GtkWidget containing the default Clutter stage.
  64  *
  65  * Since: 0.6
  66  */
  67 struct _GtkClutterEmbed
  68 {
  69   /*< private >*/
  70   GtkWidget parent_instance;
  71
  72   GtkClutterEmbedPrivate *priv;
  73 };
  74
  75 /**
  76  * GtkClutterEmbedClass:
  77  *
  78  * Base class for #GtkClutterEmbed.
  79  *
  80  * Since: 0.6
  81  */
  82 struct _GtkClutterEmbedClass
  83 {
  84   /*< private >*/
  85   GtkWidgetClass parent_class;
  86
  87   /* padding for future expansion */
  88   void (*_clutter_gtk_reserved1) (void);
  89   void (*_clutter_gtk_reserved2) (void);
  90   void (*_clutter_gtk_reserved3) (void);
  91   void (*_clutter_gtk_reserved4) (void);
  92   void (*_clutter_gtk_reserved5) (void);
  93   void (*_clutter_gtk_reserved6) (void);
  94 };
  95
  96 GType         gtk_clutter_embed_get_type  (void) G_GNUC_CONST;
  97 GtkWidget *   gtk_clutter_embed_new       (void);
  98 ClutterActor *gtk_clutter_embed_get_stage (GtkClutterEmbed *embed);
  99
 100 ClutterInitError gtk_clutter_init (gint    *argc,
 101                                    gchar ***argv);
 102
 103 G_END_DECLS
 104
 105 #endif /* __GTK_CLUTTER_EMBED_H__ */