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 "gtk-clutter-embed.h"
  44
  45 #include <glib-object.h>
  46
  47 #include <gdk/gdk.h>
  48
  49 #if defined(HAVE_CLUTTER_GTK_X11)
  50
  51 #include <clutter/x11/clutter-x11.h>
  52 #include <gdk/gdkx.h>
  53
  54 #elif defined(HAVE_CLUTTER_GTK_WIN32)
  55
  56 #include <clutter/clutter-win32.h>
  57 #include <gdk/gdkwin32.h>
  58
  59 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
  60
  61 G_DEFINE_TYPE (GtkClutterEmbed, gtk_clutter_embed, GTK_TYPE_WIDGET);
  62
  63 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_CLUTTER_TYPE_EMBED, GtkClutterEmbedPrivate))
  64
  65 struct _GtkClutterEmbedPrivate
  66 {
  67   ClutterActor *stage;
  68
  69   guint queue_redraw_id;
  70 };
  71
  72 static void
  73 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
  74 {
  75   GtkWidget *widget;
  76   GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
  77
  78   widget = GTK_WIDGET (embed);
  79
  80   event->configure.window = g_object_ref (widget->window);
  81   event->configure.send_event = TRUE;
  82   event->configure.x = widget->allocation.x;
  83   event->configure.y = widget->allocation.y;
  84   event->configure.width = widget->allocation.width;
  85   event->configure.height = widget->allocation.height;
  86
  87   gtk_widget_event (widget, event);
  88   gdk_event_free (event);
  89 }
  90
  91 static void
  92 on_stage_queue_redraw (ClutterStage *stage,
  93                        gboolean      queue_origin,
  94                        gpointer      user_data)
  95 {
  96   GtkWidget *embed = user_data;
  97
  98   /* we stop the emission of the Stage::queue-redraw signal to prevent
  99    * the default handler from running; then we queue a redraw on the
 100    * GtkClutterEmbed widget which will cause an expose event to be
 101    * emitted. the Stage is redrawn in the expose event handler, thus
 102    * "slaving" the Clutter redraw cycle to GTK+'s own
 103    */
 104   g_signal_stop_emission_by_name (stage, "queue-redraw");
 105
 106   gtk_widget_queue_draw (embed);
 107 }
 108
 109 static void
 110 gtk_clutter_embed_dispose (GObject *gobject)
 111 {
 112   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (gobject)->priv;
 113
 114   if (priv->queue_redraw_id)
 115     {
 116       g_signal_handler_disconnect (priv->stage, priv->queue_redraw_id);
 117       priv->queue_redraw_id = 0;
 118     }
 119
 120   if (priv->stage)
 121     {
 122       clutter_actor_destroy (priv->stage);
 123       priv->stage = NULL;
 124     }
 125
 126   G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
 127 }
 128
 129 static void
 130 gtk_clutter_embed_show (GtkWidget *widget)
 131 {
 132   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 133
 134   /* Make sure the widget is realised before we show */
 135   if (!GTK_WIDGET_REALIZED (widget))
 136     gtk_widget_realize (widget);
 137
 138   clutter_actor_show (priv->stage);
 139
 140   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
 141 }
 142
 143 static void
 144 gtk_clutter_embed_hide (GtkWidget *widget)
 145 {
 146   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 147
 148   clutter_actor_hide (priv->stage);
 149
 150   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
 151 }
 152
 153 static void
 154 gtk_clutter_embed_realize (GtkWidget *widget)
 155 {
 156   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 157   GdkWindowAttr attributes;
 158   int attributes_mask;
 159
 160   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 161
 162   attributes.window_type = GDK_WINDOW_CHILD;
 163   attributes.x = widget->allocation.x;
 164   attributes.y = widget->allocation.y;
 165   attributes.width = widget->allocation.width;
 166   attributes.height = widget->allocation.height;
 167   attributes.wclass = GDK_INPUT_OUTPUT;
 168   attributes.visual = gtk_widget_get_visual (widget);
 169   attributes.colormap = gtk_widget_get_colormap (widget);
 170
 171   /* NOTE: GDK_MOTION_NOTIFY above should be safe as Clutter does its own
 172    *       throtling.
 173   */
 174   attributes.event_mask = gtk_widget_get_events (widget)
 175                         | GDK_EXPOSURE_MASK
 176                         | GDK_BUTTON_PRESS_MASK
 177                         | GDK_BUTTON_RELEASE_MASK
 178                         | GDK_KEY_PRESS_MASK
 179                         | GDK_KEY_RELEASE_MASK
 180                         | GDK_POINTER_MOTION_MASK;
 181
 182   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 183
 184   widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 185                                    &attributes,
 186                                    attributes_mask);
 187   gdk_window_set_user_data (widget->window, widget);
 188
 189   widget->style = gtk_style_attach (widget->style, widget->window);
 190   gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 191
 192   gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
 193
 194 #if defined(HAVE_CLUTTER_GTK_X11)
 195   clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 196                                  GDK_WINDOW_XID (widget->window));
 197 #elif defined(HAVE_CLUTTER_GTK_WIN32)
 198   clutter_win32_set_stage_foreign (CLUTTER_STAGE (priv->stage),
 199                                    GDK_WINDOW_HWND (widget->window));
 200 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
 201
 202   clutter_actor_queue_redraw (CLUTTER_ACTOR (priv->stage));
 203
 204   gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 205 }
 206
 207 static void
 208 gtk_clutter_embed_size_allocate (GtkWidget     *widget,
 209                                  GtkAllocation *allocation)
 210 {
 211   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 212
 213   widget->allocation = *allocation;
 214
 215   if (GTK_WIDGET_REALIZED (widget))
 216     {
 217       gdk_window_move_resize (widget->window,
 218                               allocation->x, allocation->y,
 219                               allocation->width, allocation->height);
 220
 221       gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
 222     }
 223
 224   /* change the size of the stage and ensure that the viewport
 225    * has been updated as well
 226    */
 227   clutter_actor_set_size (priv->stage,
 228                           allocation->width,
 229                           allocation->height);
 230
 231   clutter_stage_ensure_viewport (CLUTTER_STAGE (priv->stage));
 232 }
 233
 234 static gboolean
 235 gtk_clutter_embed_expose_event (GtkWidget *widget,
 236                                 GdkEventExpose *event)
 237 {
 238   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 239
 240   /* force a redraw on expose */
 241   clutter_redraw (CLUTTER_STAGE (priv->stage));
 242
 243   return FALSE;
 244 }
 245
 246 static gboolean
 247 gtk_clutter_embed_motion_notify_event (GtkWidget      *widget,
 248                                        GdkEventMotion *event)
 249 {
 250   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 251   ClutterEvent cevent = { 0, };
 252
 253   cevent.type = CLUTTER_MOTION;
 254   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 255   cevent.motion.x = event->x;
 256   cevent.motion.y = event->y;
 257   cevent.motion.time = event->time;
 258   cevent.motion.modifier_state = event->state;
 259
 260   clutter_do_event (&cevent);
 261
 262   /* doh - motion events can push ENTER/LEAVE events onto Clutters
 263    * internal event queue which we do really ever touch (essentially
 264    * proxying from gtks queue). The below pumps them back out and
 265    * processes.
 266    * *could* be side effects with below though doubful as no other
 267    * events reach the queue (we shut down event collection). Maybe
 268    * a peek_mask type call could be even safer.
 269   */
 270   while (clutter_events_pending())
 271     {
 272       ClutterEvent *ev = clutter_event_get ();
 273       if (ev)
 274         {
 275           clutter_do_event (ev);
 276           clutter_event_free (ev);
 277         }
 278     }
 279
 280   return FALSE;
 281 }
 282
 283 static gboolean
 284 gtk_clutter_embed_button_event (GtkWidget      *widget,
 285                                 GdkEventButton *event)
 286 {
 287   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 288   ClutterEvent cevent = { 0, };
 289
 290   if (event->type == GDK_BUTTON_PRESS ||
 291       event->type == GDK_2BUTTON_PRESS ||
 292       event->type == GDK_3BUTTON_PRESS)
 293     cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
 294   else if (event->type == GDK_BUTTON_RELEASE)
 295     cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
 296   else
 297     return FALSE;
 298
 299   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 300   cevent.button.x = event->x;
 301   cevent.button.y = event->y;
 302   cevent.button.time = event->time;
 303   cevent.button.click_count =
 304     (event->type == GDK_BUTTON_PRESS ? 1
 305                                      : (event->type == GDK_2BUTTON_PRESS ? 2
 306                                                                          : 3));
 307   cevent.button.modifier_state = event->state;
 308   cevent.button.button = event->button;
 309
 310   clutter_do_event (&cevent);
 311
 312   return FALSE;
 313 }
 314
 315 static gboolean
 316 gtk_clutter_embed_key_event (GtkWidget   *widget,
 317                              GdkEventKey *event)
 318 {
 319   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 320   ClutterEvent cevent = { 0, };
 321
 322   if (event->type == GDK_KEY_PRESS)
 323     cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
 324   else if (event->type == GDK_KEY_RELEASE)
 325     cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
 326   else
 327     return FALSE;
 328
 329   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 330   cevent.key.time = event->time;
 331   cevent.key.modifier_state = event->state;
 332   cevent.key.keyval = event->keyval;
 333   cevent.key.hardware_keycode = event->hardware_keycode;
 334
 335   clutter_do_event (&cevent);
 336
 337   return FALSE;
 338 }
 339
 340 static gboolean
 341 gtk_clutter_embed_map_event (GtkWidget   *widget,
 342                              GdkEventAny *event)
 343 {
 344   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 345
 346   /* The backend wont get the XEvent as we go strait to do_event().
 347    * So we have to make sure we set the event here.
 348   */
 349   CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
 350
 351   return FALSE;
 352 }
 353
 354 static gboolean
 355 gtk_clutter_embed_focus_in (GtkWidget *widget,
 356                             GdkEventFocus *event)
 357 {
 358   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 359
 360   g_signal_emit_by_name (priv->stage, "activate");
 361
 362   return FALSE;
 363 }
 364
 365 static gboolean
 366 gtk_clutter_embed_focus_out (GtkWidget     *widget,
 367                              GdkEventFocus *event)
 368 {
 369   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 370
 371   g_signal_emit_by_name (priv->stage, "deactivate");
 372
 373   /* give back key focus to the stage */
 374   clutter_stage_set_key_focus (CLUTTER_STAGE (priv->stage), NULL);
 375
 376   return FALSE;
 377 }
 378
 379 static gboolean
 380 gtk_clutter_embed_scroll_event (GtkWidget      *widget,
 381                                 GdkEventScroll *event)
 382 {
 383   GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
 384
 385   ClutterEvent cevent = { 0, };
 386
 387   if (event->type == GDK_SCROLL)
 388     cevent.type = cevent.scroll.type = CLUTTER_SCROLL;
 389   else
 390     return FALSE;
 391
 392   cevent.any.stage = CLUTTER_STAGE (priv->stage);
 393   cevent.scroll.x = (gint) event->x;
 394   cevent.scroll.y = (gint) event->y;
 395   cevent.scroll.time = event->time;
 396   cevent.scroll.direction = event->direction;
 397   cevent.scroll.modifier_state = event->state;
 398
 399   clutter_do_event (&cevent);
 400
 401   return FALSE;
 402 }
 403
 404 static void
 405 gtk_clutter_embed_style_set (GtkWidget *widget,
 406                              GtkStyle  *old_style)
 407 {
 408   GdkScreen *screen;
 409   GtkSettings *settings;
 410   gdouble dpi;
 411   gchar *font_name;
 412   const cairo_font_options_t *font_options;
 413   gint double_click_time, double_click_distance;
 414   ClutterBackend *backend;
 415
 416   GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->style_set (widget,
 417                                                                 old_style);
 418
 419   if (gtk_widget_has_screen (widget))
 420     screen = gtk_widget_get_screen (widget);
 421   else
 422     screen = gdk_screen_get_default ();
 423
 424   dpi = gdk_screen_get_resolution (screen);
 425   if (dpi < 0)
 426     dpi = 96.0;
 427
 428   font_options = gdk_screen_get_font_options (screen);
 429
 430   settings = gtk_settings_get_for_screen (screen);
 431   g_object_get (G_OBJECT (settings),
 432                 "gtk-font-name", &font_name,
 433                 "gtk-double-click-time", &double_click_time,
 434                 "gtk-double-click-distance", &double_click_distance,
 435                 NULL);
 436
 437   /* copy all settings and values coming from GTK+ into
 438    * the ClutterBackend; this way, a scene embedded into
 439    * a GtkClutterEmbed will not look completely alien
 440    */
 441   backend = clutter_get_default_backend ();
 442   clutter_backend_set_resolution (backend, dpi);
 443   clutter_backend_set_font_options (backend, font_options);
 444   clutter_backend_set_font_name (backend, font_name);
 445   clutter_backend_set_double_click_time (backend, double_click_time);
 446   clutter_backend_set_double_click_distance (backend, double_click_distance);
 447
 448   g_free (font_name);
 449 }
 450
 451 static void
 452 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
 453 {
 454   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 455   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 456
 457   g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
 458
 459   gobject_class->dispose = gtk_clutter_embed_dispose;
 460
 461   widget_class->style_set = gtk_clutter_embed_style_set;
 462   widget_class->size_allocate = gtk_clutter_embed_size_allocate;
 463   widget_class->realize = gtk_clutter_embed_realize;
 464   widget_class->show = gtk_clutter_embed_show;
 465   widget_class->hide = gtk_clutter_embed_hide;
 466   widget_class->expose_event = gtk_clutter_embed_expose_event;
 467   widget_class->button_press_event = gtk_clutter_embed_button_event;
 468   widget_class->button_release_event = gtk_clutter_embed_button_event;
 469   widget_class->key_press_event = gtk_clutter_embed_key_event;
 470   widget_class->key_release_event = gtk_clutter_embed_key_event;
 471   widget_class->motion_notify_event = gtk_clutter_embed_motion_notify_event;
 472   widget_class->expose_event = gtk_clutter_embed_expose_event;
 473   widget_class->map_event = gtk_clutter_embed_map_event;
 474   widget_class->focus_in_event = gtk_clutter_embed_focus_in;
 475   widget_class->focus_out_event = gtk_clutter_embed_focus_out;
 476   widget_class->scroll_event = gtk_clutter_embed_scroll_event;
 477 }
 478
 479 static void
 480 gtk_clutter_embed_init (GtkClutterEmbed *embed)
 481 {
 482   GtkClutterEmbedPrivate *priv;
 483
 484   embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
 485
 486   GTK_WIDGET_SET_FLAGS (embed, GTK_CAN_FOCUS);
 487
 488   /* disable double-buffering: it's automatically provided
 489    * by OpenGL
 490    */
 491   gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
 492
 493   /* we always create new stages rather than use the default */
 494   priv->stage = clutter_stage_new ();
 495
 496   /* we must realize the stage to get it ready for embedding */
 497   clutter_actor_realize (priv->stage);
 498
 499   /* intercept the queue-redraw signal of the stage to know when
 500    * Clutter-side requests a redraw; this way we can also request
 501    * a redraw GTK-side
 502    */
 503   priv->queue_redraw_id =
 504     g_signal_connect (priv->stage,
 505                       "queue-redraw", G_CALLBACK (on_stage_queue_redraw),
 506                       embed);
 507
 508 #ifdef HAVE_CLUTTER_GTK_X11
 509   {
 510     const XVisualInfo *xvinfo;
 511     GdkVisual *visual;
 512     GdkColormap *colormap;
 513
 514     /* We need to use the colormap from the Clutter visual */
 515     xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
 516     visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
 517                                            xvinfo->visualid);
 518     colormap = gdk_colormap_new (visual, FALSE);
 519     gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
 520   }
 521 #endif
 522 }
 523
 524 /**
 525  * gtk_clutter_init:
 526  * @argc: pointer to the arguments count, or %NULL
 527  * @argv: pointer to the arguments vector, or %NULL
 528  *
 529  * This function should be called instead of clutter_init() and
 530  * gtk_init().
 531  *
 532  * Return value: %CLUTTER_INIT_SUCCESS on success, a negative integer
 533  *   on failure.
 534  *
 535  * Since: 0.8
 536  */
 537 ClutterInitError
 538 gtk_clutter_init (int    *argc,
 539                   char ***argv)
 540 {
 541   if (!gtk_init_check (argc, argv))
 542     return CLUTTER_INIT_ERROR_GTK;
 543
 544 #if defined(HAVE_CLUTTER_GTK_X11)
 545   clutter_x11_set_display (GDK_DISPLAY());
 546   clutter_x11_disable_event_retrieval ();
 547 #elif defined(HAVE_CLUTTER_GTK_WIN32)
 548   clutter_win32_disable_event_retrieval ();
 549 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
 550
 551   return clutter_init (argc, argv);
 552 }
 553
 554 /**
 555  * gtk_clutter_embed_new:
 556  *
 557  * Creates a new #GtkClutterEmbed widget. This widget can be
 558  * used to build a scene using Clutter API into a GTK+ application.
 559  *
 560  * Return value: the newly created #GtkClutterEmbed
 561  *
 562  * Since: 0.6
 563  */
 564 GtkWidget *
 565 gtk_clutter_embed_new (void)
 566 {
 567   return g_object_new (GTK_CLUTTER_TYPE_EMBED, NULL);
 568 }
 569
 570 /**
 571  * gtk_clutter_embed_get_stage:
 572  * @embed: a #GtkClutterEmbed
 573  *
 574  * Retrieves the #ClutterStage from @embed. The returned stage can be
 575  * used to add actors to the Clutter scene.
 576  *
 577  * Return value: the Clutter stage. You should never destroy or unref
 578  *   the returned actor.
 579  *
 580  * Since: 0.6
 581  */
 582 ClutterActor *
 583 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
 584 {
 585   g_return_val_if_fail (GTK_CLUTTER_IS_EMBED (embed), NULL);
 586
 587   return embed->priv->stage;
 588 }