vcs.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>To avoid flickering on show, you should call gtk_widget_show()
  32  * or gtk_widget_realize() before calling clutter_actor_show() on the
  33  * embedded #ClutterStage actor. This is needed for Clutter to be able
  34  * to paint on the #GtkClutterEmbed widget.</note>
  35  *
  36  * Since: 0.6
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include <glib-object.h>
  44
  45 #include <clutter/clutter-main.h>
  46 #include <clutter/clutter-stage.h>
  47
  48 #include <gdk/gdk.h>
  49 #include <gdk/gdkx.h>
  50 #include <gtk/gtkmain.h>
  51 #include <clutter/clutter-x11.h>
  52
  53 #include "gtk-clutter-embed.h"
  54
  55 G_DEFINE_TYPE (GtkClutterEmbed, gtk_clutter_embed, GTK_TYPE_WIDGET);
  56
  57 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedPrivate))
  58
  59 struct _GtkClutterEmbedPrivate
  60 {
  61   ClutterActor *stage;
  62 };
  63
  64 static void
  65 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
  66 {
  67   GtkWidget *widget;
  68   GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
  69
  70   widget = GTK_WIDGET (embed);
  71
  72   event->configure.window = g_object_ref (widget->window);
  73   event->configure.send_event = TRUE;
  74   event->configure.x = widget->allocation.x;
  75   event->configure.y = widget->allocation.y;
  76   event->configure.width = widget->allocation.width;
  77   event->configure.height = widget->allocation.height;
  78
  79   gtk_widget_event (widget, event);
  80   gdk_event_free (event);
  81 }
  82
  83 static void
  84 gtk_clutter_embed_dispose (GObject *gobject)
  85 {
  86   G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
  87 }
  88
  89 static void
  90 gtk_clutter_embed_show (GtkWidget *widget)
  91 {
  92   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
  93
  94   /* Make sure the widget is realised before we show */
  95   gtk_widget_realize (widget);
  96
  97   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
  98
  99   clutter_actor_show (priv->stage);
 100 }
 101
 102 static void
 103 gtk_clutter_embed_hide (GtkWidget *widget)
 104 {
 105   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 106
 107   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
 108
 109   clutter_actor_hide (priv->stage);
 110 }
 111
 112 static void
 113 gtk_clutter_embed_realize (GtkWidget *widget)
 114 {
 115   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 116   GdkWindowAttr attributes;
 117   int attributes_mask;
 118
 119   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 120
 121   attributes.window_type = GDK_WINDOW_CHILD;
 122   attributes.x = widget->allocation.x;
 123   attributes.y = widget->allocation.y;
 124   attributes.width = widget->allocation.width;
 125   attributes.height = widget->allocation.height;
 126   attributes.wclass = GDK_INPUT_OUTPUT;
 127   attributes.visual = gtk_widget_get_visual (widget);
 128   attributes.colormap = gtk_widget_get_colormap (widget);
 129   attributes.event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
 130
 131   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 132
 133   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 134                                    &attributes,
 135                                    attributes_mask);
 136   gdk_window_set_user_data (widget->window, widget);
 137
 138   widget->style = gtk_style_attach (widget->style, widget->window);
 139   gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 140
 141   gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
 142
 143   clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 144                                  GDK_WINDOW_XID (widget->window));
 145   clutter_redraw (CLUTTER_STAGE(priv->stage));
 146
 147   gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 148 }
 149
 150 static void
 151 gtk_clutter_embed_size_allocate (GtkWidget     *widget,
 152                                  GtkAllocation *allocation)
 153 {
 154   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 155
 156   widget->allocation = *allocation;
 157
 158   if (GTK_WIDGET_REALIZED (widget))
 159     {
 160       gdk_window_move_resize (widget->window,
 161                               allocation->x, allocation->y,
 162                               allocation->width, allocation->height);
 163
 164       gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 165     }
 166
 167   clutter_actor_set_size (priv->stage,
 168                           allocation->width,
 169                           allocation->height);
 170
 171   if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
 172     clutter_actor_queue_redraw (priv->stage);
 173 }
 174
 175 static gboolean
 176 gtk_clutter_embed_button_event (GtkWidget      *widget,
 177                                 GdkEventButton *event)
 178 {
 179   ClutterEvent cevent = { 0, };
 180
 181   if (event->type == GDK_BUTTON_PRESS ||
 182       event->type == GDK_2BUTTON_PRESS ||
 183       event->type == GDK_3BUTTON_PRESS)
 184     cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
 185   else if (event->type == GDK_BUTTON_RELEASE)
 186     cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
 187   else
 188     return FALSE;
 189
 190   cevent.button.x = event->x;
 191   cevent.button.y = event->y;
 192   cevent.button.time = event->time;
 193   cevent.button.click_count =
 194     (event->type == GDK_BUTTON_PRESS ? 1
 195                                      : (event->type == GDK_2BUTTON_PRESS ? 2
 196                                                                          : 3));
 197   cevent.button.modifier_state = event->state;
 198   cevent.button.button = event->button;
 199
 200   clutter_do_event (&cevent);
 201
 202   return TRUE;
 203 }
 204
 205 static gboolean
 206 gtk_clutter_embed_key_event (GtkWidget   *widget,
 207                              GdkEventKey *event)
 208 {
 209   ClutterEvent cevent = { 0, };
 210
 211   if (event->type == GDK_KEY_PRESS)
 212     cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
 213   else if (event->type == GDK_KEY_RELEASE)
 214     cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
 215   else
 216     return FALSE;
 217
 218   cevent.key.time = event->time;
 219   cevent.key.modifier_state = event->state;
 220   cevent.key.keyval = event->keyval;
 221   cevent.key.hardware_keycode = event->hardware_keycode;
 222
 223   clutter_do_event (&cevent);
 224
 225   return TRUE;
 226 }
 227
 228 static gboolean
 229 gtk_clutter_embed_expose_event (GtkWidget *widget, GdkEventExpose *event)
 230 {
 231   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 232
 233   if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
 234     clutter_actor_queue_redraw (priv->stage);
 235
 236   return TRUE;
 237 }
 238
 239 static gboolean
 240 gtk_clutter_embed_map_event (GtkWidget       *widget,
 241                              GdkEventAny     *event)
 242 {
 243   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 244
 245   /* The backend wont get the XEvent as we go strait to do_event().
 246    * So we have to make sure we set the event here.
 247   */
 248   CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
 249
 250   return TRUE;
 251 }
 252
 253 static void
 254 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
 255 {
 256   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 257   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 258
 259   g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
 260
 261   gobject_class->dispose = gtk_clutter_embed_dispose;
 262
 263   widget_class->size_allocate = gtk_clutter_embed_size_allocate;
 264   widget_class->realize = gtk_clutter_embed_realize;
 265   widget_class->show = gtk_clutter_embed_show;
 266   widget_class->hide = gtk_clutter_embed_hide;
 267   widget_class->button_press_event = gtk_clutter_embed_button_event;
 268   widget_class->button_release_event = gtk_clutter_embed_button_event;
 269   widget_class->key_press_event = gtk_clutter_embed_key_event;
 270   widget_class->key_release_event = gtk_clutter_embed_key_event;
 271   widget_class->expose_event = gtk_clutter_embed_expose_event;
 272   widget_class->map_event = gtk_clutter_embed_map_event;
 273 }
 274
 275 static void
 276 gtk_clutter_embed_init (GtkClutterEmbed *embed)
 277 {
 278   GtkClutterEmbedPrivate *priv;
 279   const XVisualInfo *xvinfo;
 280   GdkVisual *visual;
 281   GdkColormap *colormap;
 282
 283   embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
 284
 285   gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
 286
 287   /* note we never ref or unref this */
 288   priv->stage = clutter_stage_new ();
 289   /* we always create new stages rather than use the default */
 290   /* priv->stage = clutter_stage_get_default (); */
 291
 292   /* We need to use the colormap from the Clutter visual */
 293   xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
 294   visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
 295                                          xvinfo->visualid);
 296   colormap = gdk_colormap_new (visual, FALSE);
 297   gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
 298 }
 299
 300 /**
 301  * gtk_clutter_init:
 302  *
 303  * This function should be called instead of clutter_init() and
 304  * gtk_init().
 305  *
 306  * Return value: %CLUTTER_INIT_SUCCESS on success, a negative integer
 307  *   on failure.
 308  *
 309  * Since: 0.8
 310  */
 311 ClutterInitError
 312 gtk_clutter_init (int *argc, char ***argv)
 313 {
 314   if (!gtk_init_check (argc, argv))
 315     return CLUTTER_INIT_ERROR_GTK;
 316
 317   clutter_x11_set_display (GDK_DISPLAY ());
 318   clutter_x11_disable_event_retrieval ();
 319
 320   return clutter_init (argc, argv);
 321 }
 322
 323 /**
 324  * gtk_clutter_embed_new:
 325  *
 326  * Creates a new #GtkClutterEmbed widget. This widget can be
 327  * used to build a scene using Clutter API into a GTK+ application.
 328  *
 329  * Return value: the newly created #GtkClutterEmbed
 330  *
 331  * Since: 0.6
 332  */
 333 GtkWidget *
 334 gtk_clutter_embed_new (void)
 335 {
 336   return g_object_new (GTK_TYPE_CLUTTER_EMBED, NULL);
 337 }
 338
 339 /**
 340  * gtk_clutter_embed_get_stage:
 341  * @embed: a #GtkClutterEmbed
 342  *
 343  * Retrieves the #ClutterStage from @embed. The returned stage can be
 344  * used to add actors to the Clutter scene.
 345  *
 346  * Return value: the Clutter stage. You should never destroy or unref
 347  *   the returned actor.
 348  *
 349  * Since: 0.6
 350  */
 351 ClutterActor *
 352 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
 353 {
 354   g_return_val_if_fail (GTK_IS_CLUTTER_EMBED (embed), NULL);
 355
 356   return embed->priv->stage;
 357 }