1 /* gtk-clutter-embed.c: Embeddable ClutterStage
3 * Copyright (C) 2007 OpenedHand
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.
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.
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>.
19 * Iain Holmes <iain@openedhand.com>
20 * Emmanuele Bassi <ebassi@openedhand.com>
24 * SECTION:gtk-clutter-embed
25 * @short_description: Widget for embedding a Clutter scene
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.
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>
43 #include <glib-object.h>
46 #include <gtk/gtkmain.h>
48 #include <clutter/clutter-main.h>
49 #include <clutter/clutter-stage.h>
50 #include <clutter/clutter-container.h>
52 #if defined(HAVE_CLUTTER_GTK_X11)
54 #include <clutter/clutter-x11.h>
57 #elif defined(HAVE_CLUTTER_GTK_WIN32)
59 #include <clutter/clutter-win32.h>
60 #include <gdk/gdkwin32.h>
62 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
64 #include "gtk-clutter-embed.h"
66 static void clutter_container_iface_init (ClutterContainerIface *iface);
68 G_DEFINE_TYPE_WITH_CODE (GtkClutterEmbed,
71 G_IMPLEMENT_INTERFACE (CLUTTER_TYPE_CONTAINER,
72 clutter_container_iface_init));
74 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedPrivate))
76 struct _GtkClutterEmbedPrivate
82 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
85 GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
87 widget = GTK_WIDGET (embed);
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;
96 gtk_widget_event (widget, event);
97 gdk_event_free (event);
101 gtk_clutter_embed_dispose (GObject *gobject)
103 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (gobject)->priv;
107 clutter_actor_destroy (priv->stage);
111 G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
115 gtk_clutter_embed_show (GtkWidget *widget)
117 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
119 /* Make sure the widget is realised before we show */
120 gtk_widget_realize (widget);
122 GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
124 clutter_actor_show (priv->stage);
128 gtk_clutter_embed_hide (GtkWidget *widget)
130 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
132 GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
134 clutter_actor_hide (priv->stage);
138 gtk_clutter_embed_realize (GtkWidget *widget)
140 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
141 GdkWindowAttr attributes;
144 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
146 attributes.window_type = GDK_WINDOW_CHILD;
147 attributes.x = widget->allocation.x;
148 attributes.y = widget->allocation.y;
149 attributes.width = widget->allocation.width;
150 attributes.height = widget->allocation.height;
151 attributes.wclass = GDK_INPUT_OUTPUT;
152 attributes.visual = gtk_widget_get_visual (widget);
153 attributes.colormap = gtk_widget_get_colormap (widget);
154 attributes.event_mask = gtk_widget_get_events (widget)
155 | GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK
156 | GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK;
158 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
160 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
163 gdk_window_set_user_data (widget->window, widget);
165 widget->style = gtk_style_attach (widget->style, widget->window);
166 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
168 gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
170 #if defined(HAVE_CLUTTER_GTK_X11)
171 clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
172 GDK_WINDOW_XID (widget->window));
173 #elif defined(HAVE_CLUTTER_GTK_WIN32)
174 clutter_win32_set_stage_foreign (CLUTTER_STAGE (priv->stage),
175 GDK_WINDOW_HWND (widget->window));
176 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
178 clutter_redraw (CLUTTER_STAGE (priv->stage));
180 gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
184 gtk_clutter_embed_size_allocate (GtkWidget *widget,
185 GtkAllocation *allocation)
187 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
189 widget->allocation = *allocation;
191 if (GTK_WIDGET_REALIZED (widget))
193 gdk_window_move_resize (widget->window,
194 allocation->x, allocation->y,
195 allocation->width, allocation->height);
197 gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
200 clutter_actor_set_size (priv->stage,
204 if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
205 clutter_actor_queue_redraw (priv->stage);
209 gtk_clutter_embed_button_event (GtkWidget *widget,
210 GdkEventButton *event)
212 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
213 ClutterEvent cevent = { 0, };
215 if (event->type == GDK_BUTTON_PRESS ||
216 event->type == GDK_2BUTTON_PRESS ||
217 event->type == GDK_3BUTTON_PRESS)
218 cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
219 else if (event->type == GDK_BUTTON_RELEASE)
220 cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
224 cevent.any.stage = CLUTTER_STAGE (priv->stage);
225 cevent.button.x = event->x;
226 cevent.button.y = event->y;
227 cevent.button.time = event->time;
228 cevent.button.click_count =
229 (event->type == GDK_BUTTON_PRESS ? 1
230 : (event->type == GDK_2BUTTON_PRESS ? 2
232 cevent.button.modifier_state = event->state;
233 cevent.button.button = event->button;
235 clutter_do_event (&cevent);
241 gtk_clutter_embed_key_event (GtkWidget *widget,
244 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
245 ClutterEvent cevent = { 0, };
247 if (event->type == GDK_KEY_PRESS)
248 cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
249 else if (event->type == GDK_KEY_RELEASE)
250 cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
254 cevent.any.stage = CLUTTER_STAGE (priv->stage);
255 cevent.key.time = event->time;
256 cevent.key.modifier_state = event->state;
257 cevent.key.keyval = event->keyval;
258 cevent.key.hardware_keycode = event->hardware_keycode;
260 clutter_do_event (&cevent);
266 gtk_clutter_embed_expose_event (GtkWidget *widget, GdkEventExpose *event)
268 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
270 if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
271 clutter_actor_queue_redraw (priv->stage);
277 gtk_clutter_embed_map_event (GtkWidget *widget,
280 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
282 /* The backend wont get the XEvent as we go strait to do_event().
283 * So we have to make sure we set the event here.
285 CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
291 gtk_clutter_embed_add (ClutterContainer *container,
294 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
295 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
297 clutter_container_add_actor (stage, actor);
298 g_signal_emit_by_name (container, "actor-added", actor);
302 gtk_clutter_embed_remove (ClutterContainer *container,
305 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
306 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
308 g_object_ref (actor);
310 clutter_container_remove_actor (stage, actor);
311 g_signal_emit_by_name (container, "actor-removed", actor);
313 g_object_unref (actor);
317 gtk_clutter_embed_foreach (ClutterContainer *container,
318 ClutterCallback callback,
319 gpointer callback_data)
321 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
322 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
324 clutter_container_foreach (stage, callback, callback_data);
328 gtk_clutter_embed_raise (ClutterContainer *container,
330 ClutterActor *sibling)
332 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
333 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
335 clutter_container_raise_child (stage, child, sibling);
339 gtk_clutter_embed_lower (ClutterContainer *container,
341 ClutterActor *sibling)
343 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
344 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
346 clutter_container_lower_child (stage, child, sibling);
350 gtk_clutter_embed_sort_depth_order (ClutterContainer *container)
352 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (container)->priv;
353 ClutterContainer *stage = CLUTTER_CONTAINER (priv->stage);
355 clutter_container_sort_depth_order (stage);
359 clutter_container_iface_init (ClutterContainerIface *iface)
361 iface->add = gtk_clutter_embed_add;
362 iface->remove = gtk_clutter_embed_remove;
363 iface->foreach = gtk_clutter_embed_foreach;
364 iface->raise = gtk_clutter_embed_raise;
365 iface->lower = gtk_clutter_embed_lower;
366 iface->sort_depth_order = gtk_clutter_embed_sort_depth_order;
370 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
372 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
373 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
375 g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
377 gobject_class->dispose = gtk_clutter_embed_dispose;
379 widget_class->size_allocate = gtk_clutter_embed_size_allocate;
380 widget_class->realize = gtk_clutter_embed_realize;
381 widget_class->show = gtk_clutter_embed_show;
382 widget_class->hide = gtk_clutter_embed_hide;
383 widget_class->button_press_event = gtk_clutter_embed_button_event;
384 widget_class->button_release_event = gtk_clutter_embed_button_event;
385 widget_class->key_press_event = gtk_clutter_embed_key_event;
386 widget_class->key_release_event = gtk_clutter_embed_key_event;
387 widget_class->expose_event = gtk_clutter_embed_expose_event;
388 widget_class->map_event = gtk_clutter_embed_map_event;
392 gtk_clutter_embed_init (GtkClutterEmbed *embed)
394 GtkClutterEmbedPrivate *priv;
396 embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
398 /* disable double-buffering: it's automatically provided
401 gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
403 /* we always create new stages rather than use the default */
404 priv->stage = clutter_stage_new ();
406 #ifdef HAVE_CLUTTER_GTK_X11
408 const XVisualInfo *xvinfo;
410 GdkColormap *colormap;
412 /* We need to use the colormap from the Clutter visual */
413 xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
414 visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
416 colormap = gdk_colormap_new (visual, FALSE);
417 gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
424 * @argc: pointer to the arguments count, or %NULL
425 * @argv: pointer to the arguments vector, or %NULL
427 * This function should be called instead of clutter_init() and
430 * Return value: %CLUTTER_INIT_SUCCESS on success, a negative integer
436 gtk_clutter_init (int *argc,
439 if (!gtk_init_check (argc, argv))
440 return CLUTTER_INIT_ERROR_GTK;
442 #if defined(HAVE_CLUTTER_GTK_X11)
443 clutter_x11_set_display (GDK_DISPLAY());
444 clutter_x11_disable_event_retrieval ();
445 #elif defined(HAVE_CLUTTER_GTK_WIN32)
446 clutter_win32_disable_event_retrieval ();
447 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
449 return clutter_init (argc, argv);
453 * gtk_clutter_embed_new:
455 * Creates a new #GtkClutterEmbed widget. This widget can be
456 * used to build a scene using Clutter API into a GTK+ application.
458 * Return value: the newly created #GtkClutterEmbed
463 gtk_clutter_embed_new (void)
465 return g_object_new (GTK_TYPE_CLUTTER_EMBED, NULL);
469 * gtk_clutter_embed_get_stage:
470 * @embed: a #GtkClutterEmbed
472 * Retrieves the #ClutterStage from @embed. The returned stage can be
473 * used to add actors to the Clutter scene.
475 * Return value: the Clutter stage. You should never destroy or unref
476 * the returned actor.
481 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
483 g_return_val_if_fail (GTK_IS_CLUTTER_EMBED (embed), NULL);
485 return embed->priv->stage;