git.maemo.org Git - clutter-gtk/blob - clutter-gtk/gtk-clutter-embed.c

   1 /* gtk-clutter-embed.c: 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 /**
  24  * SECTION:gtk-clutter-embed
  25  * @short_description: Widget for embedding a Clutter scene
  26  *
  27  * #GtkClutterEmbed is a GTK+ widget embedding a #ClutterStage. Using
  28  * a #GtkClutterEmbed widget is possible to build, show and interact with
  29  * a scene built using Clutter inside a GTK+ application.
  30  *
  31  * <note>You should never resize the #ClutterStage embedded into the
  32  * #GtkClutterEmbed widget. Instead, resize the widget using
  33  * gtk_widget_set_size_request().</note>
  34  *
  35  * Since: 0.6
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include "config.h"
  40 #endif
  41
  42 #include <glib-object.h>
  43
  44 #include <clutter/clutter-main.h>
  45 #include <clutter/clutter-stage.h>
  46
  47 #include <gdk/gdk.h>
  48 #include <gdk/gdkx.h>
  49 #include <clutter/clutter-x11.h>
  50
  51 #include "gtk-clutter-embed.h"
  52
  53 G_DEFINE_TYPE (GtkClutterEmbed, gtk_clutter_embed, GTK_TYPE_WIDGET);
  54
  55 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedPrivate))
  56
  57 struct _GtkClutterEmbedPrivate
  58 {
  59   ClutterActor *stage;
  60 };
  61
  62 static void
  63 gtk_clutter_embed_dispose (GObject *gobject)
  64 {
  65   G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
  66 }
  67
  68 static void
  69 gtk_clutter_embed_realize (GtkWidget *widget)
  70 {
  71   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
  72   GdkWindowAttr attributes;
  73   int attributes_mask;
  74
  75   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
  76
  77   attributes.window_type = GDK_WINDOW_CHILD;
  78   attributes.x = widget->allocation.x;
  79   attributes.y = widget->allocation.y;
  80   attributes.width = widget->allocation.width;
  81   attributes.height = widget->allocation.height;
  82   attributes.wclass = GDK_INPUT_OUTPUT;
  83   attributes.visual = gtk_widget_get_visual (widget);
  84   attributes.colormap = gtk_widget_get_colormap (widget);
  85   attributes.event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
  86
  87   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
  88
  89   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
  90                                    &attributes,
  91                                    attributes_mask);
  92   gdk_window_set_user_data (widget->window, widget);
  93
  94   widget->style = gtk_style_attach (widget->style, widget->window);
  95   gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
  96
  97   gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
  98
  99   clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 100                                  GDK_WINDOW_XID (widget->window));
 101
 102   /* allow a redraw here */
 103   clutter_actor_queue_redraw (priv->stage);
 104 }
 105
 106 static void
 107 gtk_clutter_embed_size_allocate (GtkWidget     *widget,
 108                                  GtkAllocation *allocation)
 109 {
 110   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 111
 112   clutter_actor_set_size (priv->stage,
 113                           allocation->width,
 114                           allocation->height);
 115
 116   if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
 117     clutter_actor_queue_redraw (priv->stage);
 118
 119   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->size_allocate (widget, allocation);
 120 }
 121
 122 static gboolean
 123 gtk_clutter_embed_button_event (GtkWidget      *widget,
 124                                 GdkEventButton *event)
 125 {
 126   ClutterEvent cevent = { 0, };
 127
 128   if (event->type == GDK_BUTTON_PRESS ||
 129       event->type == GDK_2BUTTON_PRESS ||
 130       event->type == GDK_3BUTTON_PRESS)
 131     cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
 132   else if (event->type == GDK_BUTTON_RELEASE)
 133     cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
 134   else
 135     return FALSE;
 136
 137   cevent.button.x = event->x;
 138   cevent.button.y = event->y;
 139   cevent.button.time = event->time;
 140   cevent.button.click_count =
 141     (event->type == GDK_BUTTON_PRESS ? 1
 142                                      : (event->type == GDK_2BUTTON_PRESS ? 2
 143                                                                          : 3));
 144   cevent.button.modifier_state = event->state;
 145   cevent.button.button = event->button;
 146
 147   clutter_do_event (&cevent);
 148
 149   return TRUE;
 150 }
 151
 152 static gboolean
 153 gtk_clutter_embed_key_event (GtkWidget   *widget,
 154                              GdkEventKey *event)
 155 {
 156   ClutterEvent cevent = { 0, };
 157
 158   if (event->type == GDK_KEY_PRESS)
 159     cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
 160   else if (event->type == GDK_KEY_RELEASE)
 161     cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
 162   else
 163     return FALSE;
 164
 165   cevent.key.time = event->time;
 166   cevent.key.modifier_state = event->state;
 167   cevent.key.keyval = event->keyval;
 168   cevent.key.hardware_keycode = event->hardware_keycode;
 169
 170   clutter_do_event (&cevent);
 171
 172   return TRUE;
 173 }
 174
 175 static void
 176 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
 177 {
 178   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 179   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 180
 181   g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
 182
 183   gobject_class->dispose = gtk_clutter_embed_dispose;
 184
 185   widget_class->size_allocate = gtk_clutter_embed_size_allocate;
 186   widget_class->realize = gtk_clutter_embed_realize;
 187   widget_class->button_press_event = gtk_clutter_embed_button_event;
 188   widget_class->button_release_event = gtk_clutter_embed_button_event;
 189   widget_class->key_press_event = gtk_clutter_embed_key_event;
 190   widget_class->key_release_event = gtk_clutter_embed_key_event;
 191 }
 192
 193 static void
 194 gtk_clutter_embed_init (GtkClutterEmbed *embed)
 195 {
 196   GtkClutterEmbedPrivate *priv;
 197   const XVisualInfo *xvinfo;
 198   GdkVisual *visual;
 199   GdkColormap *colormap;
 200
 201   embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
 202
 203   gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
 204
 205   /* note we never ref or unref this */
 206   priv->stage = clutter_stage_get_default ();
 207
 208   /* We need to use the colormap from the Clutter visual */
 209   xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
 210   visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
 211                                          xvinfo->visualid);
 212   colormap = gdk_colormap_new (visual, FALSE);
 213   gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
 214 }
 215
 216 /**
 217  * gtk_clutter_embed_new:
 218  *
 219  * FIXME
 220  *
 221  * Return value: the newly created #GtkClutterEmbed
 222  *
 223  * Since: 0.6
 224  */
 225 GtkWidget *
 226 gtk_clutter_embed_new (void)
 227 {
 228   return g_object_new (GTK_TYPE_CLUTTER_EMBED, NULL);
 229 }
 230
 231 /**
 232  * gtk_clutter_embed_get_stage:
 233  * @embed: a #GtkClutterEmbed
 234  *
 235  * Retrieves the #ClutterStage from @embed. The returned stage can be
 236  * used to add actors to the Clutter scene.
 237  *
 238  * Return value: the Clutter stage. You should never destroy or unref
 239  *   the returned actor.
 240  *
 241  * Since: 0.6
 242  */
 243 ClutterActor *
 244 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
 245 {
 246   g_return_val_if_fail (GTK_IS_CLUTTER_EMBED (embed), NULL);
 247
 248   return embed->priv->stage;
 249 }