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>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 <gdk/gdk.h>
  46 #include <gtk/gtkmain.h>
  47
  48 #include <clutter/clutter-main.h>
  49 #include <clutter/clutter-stage.h>
  50 #include <clutter/clutter-container.h>
  51
  52 #if defined(HAVE_CLUTTER_GTK_X11)
  53
  54 #include <clutter/clutter-x11.h>
  55 #include <gdk/gdkx.h>
  56
  57 #elif defined(HAVE_CLUTTER_GTK_WIN32)
  58
  59 #include <clutter/clutter-win32.h>
  60 #include <gdk/gdkwin32.h>
  61
  62 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
  63
  64 #include "gtk-clutter-embed.h"
  65
  66 static void clutter_container_iface_init (ClutterContainerIface *iface);
  67
  68 G_DEFINE_TYPE_WITH_CODE (GtkClutterEmbed,
  69                          gtk_clutter_embed,
  70                          GTK_TYPE_WIDGET,
  71                          G_IMPLEMENT_INTERFACE (CLUTTER_TYPE_CONTAINER,
  72                                                 clutter_container_iface_init));
  73
  74 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedPrivate))
  75
  76 struct _GtkClutterEmbedPrivate
  77 {
  78   ClutterActor *stage;
  79 };
  80
  81 static void
  82 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
  83 {
  84   GtkWidget *widget;
  85   GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
  86
  87   widget = GTK_WIDGET (embed);
  88
  89   event->configure.window = g_object_ref (widget->window);
  90   event->configure.send_event = TRUE;
  91   event->configure.x = widget->allocation.x;
  92   event->configure.y = widget->allocation.y;
  93   event->configure.width = widget->allocation.width;
  94   event->configure.height = widget->allocation.height;
  95
  96   gtk_widget_event (widget, event);
  97   gdk_event_free (event);
  98 }
  99
 100 static void
 101 gtk_clutter_embed_dispose (GObject *gobject)
 102 {
 103   G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
 104 }
 105
 106 static void
 107 gtk_clutter_embed_show (GtkWidget *widget)
 108 {
 109   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 110
 111   /* Make sure the widget is realised before we show */
 112   gtk_widget_realize (widget);
 113
 114   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
 115
 116   clutter_actor_show (priv->stage);
 117 }
 118
 119 static void
 120 gtk_clutter_embed_hide (GtkWidget *widget)
 121 {
 122   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 123
 124   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
 125
 126   clutter_actor_hide (priv->stage);
 127 }
 128
 129 static void
 130 gtk_clutter_embed_realize (GtkWidget *widget)
 131 {
 132   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 133   GdkWindowAttr attributes;
 134   int attributes_mask;
 135
 136   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 137
 138   attributes.window_type = GDK_WINDOW_CHILD;
 139   attributes.x = widget->allocation.x;
 140   attributes.y = widget->allocation.y;
 141   attributes.width = widget->allocation.width;
 142   attributes.height = widget->allocation.height;
 143   attributes.wclass = GDK_INPUT_OUTPUT;
 144   attributes.visual = gtk_widget_get_visual (widget);
 145   attributes.colormap = gtk_widget_get_colormap (widget);
 146   attributes.event_mask = gtk_widget_get_events (widget)
 147     | GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK
 148     | GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK;
 149
 150   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 151
 152   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 153                                    &attributes,
 154                                    attributes_mask);
 155   gdk_window_set_user_data (widget->window, widget);
 156
 157   widget->style = gtk_style_attach (widget->style, widget->window);
 158   gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 159
 160   gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
 161
 162 #if defined(HAVE_CLUTTER_GTK_X11)
 163   clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 164                                  GDK_WINDOW_XID (widget->window));
 165 #elif defined(HAVE_CLUTTER_GTK_WIN32)
 166   clutter_win32_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 167                                    GDK_WINDOW_HWND (widget->window));
 168 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
 169
 170   clutter_redraw (CLUTTER_STAGE(priv->stage));
 171
 172   gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 173 }
 174
 175 static void
 176 gtk_clutter_embed_size_allocate (GtkWidget     *widget,
 177                                  GtkAllocation *allocation)
 178 {
 179   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 180
 181   widget->allocation = *allocation;
 182
 183   if (GTK_WIDGET_REALIZED (widget))
 184     {
 185       gdk_window_move_resize (widget->window,
 186                               allocation->x, allocation->y,
 187                               allocation->width, allocation->height);
 188
 189       gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 190     }
 191
 192   clutter_actor_set_size (priv->stage,
 193                           allocation->width,
 194                           allocation->height);
 195
 196   if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
 197     clutter_actor_queue_redraw (priv->stage);
 198 }
 199
 200 static gboolean
 201 gtk_clutter_embed_button_event (GtkWidget      *widget,
 202                                 GdkEventButton *event)
 203 {
 204   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 205   ClutterEvent cevent = { 0, };
 206
 207   if (event->type == GDK_BUTTON_PRESS ||
 208       event->type == GDK_2BUTTON_PRESS ||
 209       event->type == GDK_3BUTTON_PRESS)
 210     cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
 211   else if (event->type == GDK_BUTTON_RELEASE)
 212     cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
 213   else
 214     return FALSE;
 215
 216   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 217   cevent.button.x = event->x;
 218   cevent.button.y = event->y;
 219   cevent.button.time = event->time;
 220   cevent.button.click_count =
 221     (event->type == GDK_BUTTON_PRESS ? 1
 222                                      : (event->type == GDK_2BUTTON_PRESS ? 2
 223                                                                          : 3));
 224   cevent.button.modifier_state = event->state;
 225   cevent.button.button = event->button;
 226
 227   clutter_do_event (&cevent);
 228
 229   return TRUE;
 230 }
 231
 232 static gboolean
 233 gtk_clutter_embed_key_event (GtkWidget   *widget,
 234                              GdkEventKey *event)
 235 {
 236   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 237   ClutterEvent cevent = { 0, };
 238
 239   if (event->type == GDK_KEY_PRESS)
 240     cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
 241   else if (event->type == GDK_KEY_RELEASE)
 242     cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
 243   else
 244     return FALSE;
 245
 246   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 247   cevent.key.time = event->time;
 248   cevent.key.modifier_state = event->state;
 249   cevent.key.keyval = event->keyval;
 250   cevent.key.hardware_keycode = event->hardware_keycode;
 251
 252   clutter_do_event (&cevent);
 253
 254   return TRUE;
 255 }
 256
 257 static gboolean
 258 gtk_clutter_embed_expose_event (GtkWidget *widget, GdkEventExpose *event)
 259 {
 260   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 261
 262   if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
 263     clutter_actor_queue_redraw (priv->stage);
 264
 265   return TRUE;
 266 }
 267
 268 static gboolean
 269 gtk_clutter_embed_map_event (GtkWidget       *widget,
 270                              GdkEventAny     *event)
 271 {
 272   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 273
 274   /* The backend wont get the XEvent as we go strait to do_event().
 275    * So we have to make sure we set the event here.
 276   */
 277   CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
 278
 279   return TRUE;
 280 }
 281
 282 static void
 283 gtk_clutter_embed_add (ClutterContainer *container,
 284                        ClutterActor     *actor)
 285 {
 286   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 287   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 288
 289   clutter_container_add_actor (stage, actor);
 290   g_signal_emit_by_name (container, "actor-added", actor);
 291 }
 292
 293 static void
 294 gtk_clutter_embed_remove (ClutterContainer *container,
 295                           ClutterActor     *actor)
 296 {
 297   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 298   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 299
 300   g_object_ref (actor);
 301
 302   clutter_container_remove_actor (stage, actor);
 303   g_signal_emit_by_name (container, "actor-removed", actor);
 304
 305   g_object_unref (actor);
 306 }
 307
 308 static void
 309 gtk_clutter_embed_foreach (ClutterContainer *container,
 310                            ClutterCallback   callback,
 311                            gpointer          callback_data)
 312 {
 313   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 314   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 315
 316   clutter_container_foreach (stage, callback, callback_data);
 317 }
 318
 319 static void
 320 gtk_clutter_embed_raise (ClutterContainer *container,
 321                          ClutterActor     *child,
 322                          ClutterActor     *sibling)
 323 {
 324   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 325   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 326
 327   clutter_container_raise_child (stage, child, sibling);
 328 }
 329
 330 static void
 331 gtk_clutter_embed_lower (ClutterContainer *container,
 332                          ClutterActor     *child,
 333                          ClutterActor     *sibling)
 334 {
 335   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 336   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 337
 338   clutter_container_lower_child (stage, child, sibling);
 339 }
 340
 341 static void
 342 gtk_clutter_embed_sort_depth_order (ClutterContainer *container)
 343 {
 344   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
 345   ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
 346
 347   clutter_container_sort_depth_order (stage);
 348 }
 349
 350 static void
 351 clutter_container_iface_init (ClutterContainerIface *iface)
 352 {
 353   iface->add = gtk_clutter_embed_add;
 354   iface->remove = gtk_clutter_embed_remove;
 355   iface->foreach = gtk_clutter_embed_foreach;
 356   iface->raise = gtk_clutter_embed_raise;
 357   iface->lower = gtk_clutter_embed_lower;
 358   iface->sort_depth_order = gtk_clutter_embed_sort_depth_order;
 359 }
 360
 361 static void
 362 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
 363 {
 364   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 365   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 366
 367   g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
 368
 369   gobject_class->dispose = gtk_clutter_embed_dispose;
 370
 371   widget_class->size_allocate = gtk_clutter_embed_size_allocate;
 372   widget_class->realize = gtk_clutter_embed_realize;
 373   widget_class->show = gtk_clutter_embed_show;
 374   widget_class->hide = gtk_clutter_embed_hide;
 375   widget_class->button_press_event = gtk_clutter_embed_button_event;
 376   widget_class->button_release_event = gtk_clutter_embed_button_event;
 377   widget_class->key_press_event = gtk_clutter_embed_key_event;
 378   widget_class->key_release_event = gtk_clutter_embed_key_event;
 379   widget_class->expose_event = gtk_clutter_embed_expose_event;
 380   widget_class->map_event = gtk_clutter_embed_map_event;
 381 }
 382
 383 static void
 384 gtk_clutter_embed_init (GtkClutterEmbed *embed)
 385 {
 386   GtkClutterEmbedPrivate *priv;
 387 #ifdef HAVE_CLUTTER_GTK_X11
 388   const XVisualInfo *xvinfo;
 389   GdkVisual *visual;
 390   GdkColormap *colormap;
 391 #endif
 392
 393   embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
 394
 395   gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
 396
 397   /* note we never ref or unref this */
 398   priv->stage = clutter_stage_new ();
 399   /* we always create new stages rather than use the default */
 400   /* priv->stage = clutter_stage_get_default (); */
 401
 402 #ifdef HAVE_CLUTTER_GTK_X11
 403   /* We need to use the colormap from the Clutter visual */
 404   xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
 405   visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
 406                                          xvinfo->visualid);
 407   colormap = gdk_colormap_new (visual, FALSE);
 408   gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
 409 #endif
 410 }
 411
 412 /**
 413  * gtk_clutter_init:
 414  *
 415  * This function should be called instead of clutter_init() and
 416  * gtk_init().
 417  *
 418  * Return value: %CLUTTER_INIT_SUCCESS on success, a negative integer
 419  *   on failure.
 420  *
 421  * Since: 0.8
 422  */
 423 ClutterInitError
 424 gtk_clutter_init (int *argc, char ***argv)
 425 {
 426   if (!gtk_init_check (argc, argv))
 427     return CLUTTER_INIT_ERROR_GTK;
 428
 429 #if defined(HAVE_CLUTTER_GTK_X11)
 430   clutter_x11_set_display (GDK_DISPLAY());
 431   clutter_x11_disable_event_retrieval ();
 432 #elif defined(HAVE_CLUTTER_GTK_WIN32)
 433   clutter_win32_disable_event_retrieval ();
 434 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
 435
 436   return clutter_init (argc, argv);
 437 }
 438
 439 /**
 440  * gtk_clutter_embed_new:
 441  *
 442  * Creates a new #GtkClutterEmbed widget. This widget can be
 443  * used to build a scene using Clutter API into a GTK+ application.
 444  *
 445  * Return value: the newly created #GtkClutterEmbed
 446  *
 447  * Since: 0.6
 448  */
 449 GtkWidget *
 450 gtk_clutter_embed_new (void)
 451 {
 452   return g_object_new (GTK_TYPE_CLUTTER_EMBED, NULL);
 453 }
 454
 455 /**
 456  * gtk_clutter_embed_get_stage:
 457  * @embed: a #GtkClutterEmbed
 458  *
 459  * Retrieves the #ClutterStage from @embed. The returned stage can be
 460  * used to add actors to the Clutter scene.
 461  *
 462  * Return value: the Clutter stage. You should never destroy or unref
 463  *   the returned actor.
 464  *
 465  * Since: 0.6
 466  */
 467 ClutterActor *
 468 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
 469 {
 470   g_return_val_if_fail (GTK_IS_CLUTTER_EMBED (embed), NULL);
 471
 472   return embed->priv->stage;
 473 }