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/x11/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 G_DEFINE_TYPE (GtkClutterEmbed, gtk_clutter_embed, GTK_TYPE_WIDGET);
68 #define GTK_CLUTTER_EMBED_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_CLUTTER_EMBED, GtkClutterEmbedPrivate))
70 struct _GtkClutterEmbedPrivate
76 gtk_clutter_embed_send_configure (GtkClutterEmbed *embed)
79 GdkEvent *event = gdk_event_new (GDK_CONFIGURE);
81 widget = GTK_WIDGET (embed);
83 event->configure.window = g_object_ref (widget->window);
84 event->configure.send_event = TRUE;
85 event->configure.x = widget->allocation.x;
86 event->configure.y = widget->allocation.y;
87 event->configure.width = widget->allocation.width;
88 event->configure.height = widget->allocation.height;
90 gtk_widget_event (widget, event);
91 gdk_event_free (event);
95 gtk_clutter_embed_dispose (GObject *gobject)
97 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (gobject)->priv;
101 clutter_actor_destroy (priv->stage);
105 G_OBJECT_CLASS (gtk_clutter_embed_parent_class)->dispose (gobject);
109 gtk_clutter_embed_show (GtkWidget *widget)
111 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
113 /* Make sure the widget is realised before we show */
114 if (!GTK_WIDGET_REALIZED (widget))
115 gtk_widget_realize (widget);
117 clutter_actor_show (priv->stage);
119 GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->show (widget);
123 gtk_clutter_embed_hide (GtkWidget *widget)
125 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
127 clutter_actor_hide (priv->stage);
129 GTK_WIDGET_CLASS (gtk_clutter_embed_parent_class)->hide (widget);
133 gtk_clutter_embed_realize (GtkWidget *widget)
135 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
136 GdkWindowAttr attributes;
139 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
141 attributes.window_type = GDK_WINDOW_CHILD;
142 attributes.x = widget->allocation.x;
143 attributes.y = widget->allocation.y;
144 attributes.width = widget->allocation.width;
145 attributes.height = widget->allocation.height;
146 attributes.wclass = GDK_INPUT_OUTPUT;
147 attributes.visual = gtk_widget_get_visual (widget);
148 attributes.colormap = gtk_widget_get_colormap (widget);
150 /* NOTE: GDK_MOTION_NOTIFY above should be safe as Clutter does its own
153 attributes.event_mask = gtk_widget_get_events (widget)
155 | GDK_BUTTON_PRESS_MASK
156 | GDK_BUTTON_RELEASE_MASK
158 | GDK_KEY_RELEASE_MASK
159 | GDK_POINTER_MOTION_MASK;
161 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
163 widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
166 gdk_window_set_user_data (widget->window, widget);
168 widget->style = gtk_style_attach (widget->style, widget->window);
169 gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
171 gdk_window_set_back_pixmap (widget->window, NULL, FALSE);
173 #if defined(HAVE_CLUTTER_GTK_X11)
174 clutter_x11_set_stage_foreign (CLUTTER_STAGE (priv->stage),
175 GDK_WINDOW_XID (widget->window));
176 #elif defined(HAVE_CLUTTER_GTK_WIN32)
177 clutter_win32_set_stage_foreign (CLUTTER_STAGE (priv->stage),
178 GDK_WINDOW_HWND (widget->window));
179 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
181 clutter_actor_queue_redraw (CLUTTER_ACTOR (priv->stage));
183 gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
187 gtk_clutter_embed_size_allocate (GtkWidget *widget,
188 GtkAllocation *allocation)
190 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
192 widget->allocation = *allocation;
194 if (GTK_WIDGET_REALIZED (widget))
196 gdk_window_move_resize (widget->window,
197 allocation->x, allocation->y,
198 allocation->width, allocation->height);
200 gtk_clutter_embed_send_configure (GTK_CLUTTER_EMBED (widget));
203 clutter_actor_set_size (priv->stage,
207 clutter_actor_queue_relayout (priv->stage);
211 gtk_clutter_embed_motion_notify_event (GtkWidget *widget,
212 GdkEventMotion *event)
214 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
215 ClutterEvent cevent = { 0, };
217 cevent.type = CLUTTER_MOTION;
218 cevent.any.stage = CLUTTER_STAGE (priv->stage);
219 cevent.motion.x = event->x;
220 cevent.motion.y = event->y;
221 cevent.motion.time = event->time;
223 clutter_do_event (&cevent);
225 /* doh - motion events can push ENTER/LEAVE events onto Clutters
226 * internal event queue which we do really ever touch (essentially
227 * proxying from gtks queue). The below pumps them back out and
229 * *could* be side effects with below though doubful as no other
230 * events reach the queue (we shut down event collection). Maybe
231 * a peek_mask type call could be even safer.
233 while (clutter_events_pending())
235 ClutterEvent *ev = clutter_event_get ();
238 clutter_do_event (ev);
239 clutter_event_free (ev);
247 gtk_clutter_embed_button_event (GtkWidget *widget,
248 GdkEventButton *event)
250 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
251 ClutterEvent cevent = { 0, };
253 if (event->type == GDK_BUTTON_PRESS ||
254 event->type == GDK_2BUTTON_PRESS ||
255 event->type == GDK_3BUTTON_PRESS)
256 cevent.type = cevent.button.type = CLUTTER_BUTTON_PRESS;
257 else if (event->type == GDK_BUTTON_RELEASE)
258 cevent.type = cevent.button.type = CLUTTER_BUTTON_RELEASE;
262 cevent.any.stage = CLUTTER_STAGE (priv->stage);
263 cevent.button.x = event->x;
264 cevent.button.y = event->y;
265 cevent.button.time = event->time;
266 cevent.button.click_count =
267 (event->type == GDK_BUTTON_PRESS ? 1
268 : (event->type == GDK_2BUTTON_PRESS ? 2
270 cevent.button.modifier_state = event->state;
271 cevent.button.button = event->button;
273 clutter_do_event (&cevent);
279 gtk_clutter_embed_key_event (GtkWidget *widget,
282 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
283 ClutterEvent cevent = { 0, };
285 if (event->type == GDK_KEY_PRESS)
286 cevent.type = cevent.key.type = CLUTTER_KEY_PRESS;
287 else if (event->type == GDK_KEY_RELEASE)
288 cevent.type = cevent.key.type = CLUTTER_KEY_RELEASE;
292 cevent.any.stage = CLUTTER_STAGE (priv->stage);
293 cevent.key.time = event->time;
294 cevent.key.modifier_state = event->state;
295 cevent.key.keyval = event->keyval;
296 cevent.key.hardware_keycode = event->hardware_keycode;
298 clutter_do_event (&cevent);
304 gtk_clutter_embed_expose_event (GtkWidget *widget,
305 GdkEventExpose *event)
307 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
309 if (CLUTTER_ACTOR_IS_VISIBLE (priv->stage))
310 clutter_actor_queue_redraw (priv->stage);
316 gtk_clutter_embed_map_event (GtkWidget *widget,
319 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
321 /* The backend wont get the XEvent as we go strait to do_event().
322 * So we have to make sure we set the event here.
324 CLUTTER_ACTOR_SET_FLAGS (priv->stage, CLUTTER_ACTOR_MAPPED);
330 gtk_clutter_embed_focus_out (GtkWidget *widget,
331 GdkEventFocus *event)
333 GtkClutterEmbedPrivate *priv = GTK_CLUTTER_EMBED (widget)->priv;
335 /* give back key focus to the stage */
336 clutter_stage_set_key_focus (CLUTTER_STAGE (priv->stage), NULL);
342 gtk_clutter_embed_class_init (GtkClutterEmbedClass *klass)
344 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
345 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
347 g_type_class_add_private (klass, sizeof (GtkClutterEmbedPrivate));
349 gobject_class->dispose = gtk_clutter_embed_dispose;
351 widget_class->size_allocate = gtk_clutter_embed_size_allocate;
352 widget_class->realize = gtk_clutter_embed_realize;
353 widget_class->show = gtk_clutter_embed_show;
354 widget_class->hide = gtk_clutter_embed_hide;
355 widget_class->button_press_event = gtk_clutter_embed_button_event;
356 widget_class->button_release_event = gtk_clutter_embed_button_event;
357 widget_class->key_press_event = gtk_clutter_embed_key_event;
358 widget_class->key_release_event = gtk_clutter_embed_key_event;
359 widget_class->motion_notify_event = gtk_clutter_embed_motion_notify_event;
360 widget_class->expose_event = gtk_clutter_embed_expose_event;
361 widget_class->map_event = gtk_clutter_embed_map_event;
362 widget_class->focus_out_event = gtk_clutter_embed_focus_out;
366 gtk_clutter_embed_init (GtkClutterEmbed *embed)
368 GtkClutterEmbedPrivate *priv;
370 embed->priv = priv = GTK_CLUTTER_EMBED_GET_PRIVATE (embed);
372 GTK_WIDGET_SET_FLAGS (embed, GTK_CAN_FOCUS);
374 /* disable double-buffering: it's automatically provided
377 gtk_widget_set_double_buffered (GTK_WIDGET (embed), FALSE);
379 /* we always create new stages rather than use the default */
380 priv->stage = clutter_stage_new ();
382 /* we must realize the stage to get it ready for embedding */
383 clutter_actor_realize (priv->stage);
385 #ifdef HAVE_CLUTTER_GTK_X11
387 const XVisualInfo *xvinfo;
389 GdkColormap *colormap;
391 /* We need to use the colormap from the Clutter visual */
392 xvinfo = clutter_x11_get_stage_visual (CLUTTER_STAGE (priv->stage));
393 visual = gdk_x11_screen_lookup_visual (gdk_screen_get_default (),
395 colormap = gdk_colormap_new (visual, FALSE);
396 gtk_widget_set_colormap (GTK_WIDGET (embed), colormap);
403 * @argc: pointer to the arguments count, or %NULL
404 * @argv: pointer to the arguments vector, or %NULL
406 * This function should be called instead of clutter_init() and
409 * Return value: %CLUTTER_INIT_SUCCESS on success, a negative integer
415 gtk_clutter_init (int *argc,
418 if (!gtk_init_check (argc, argv))
419 return CLUTTER_INIT_ERROR_GTK;
421 #if defined(HAVE_CLUTTER_GTK_X11)
422 clutter_x11_set_display (GDK_DISPLAY());
423 clutter_x11_disable_event_retrieval ();
424 #elif defined(HAVE_CLUTTER_GTK_WIN32)
425 clutter_win32_disable_event_retrieval ();
426 #endif /* HAVE_CLUTTER_GTK_{X11,WIN32} */
428 return clutter_init (argc, argv);
432 * gtk_clutter_embed_new:
434 * Creates a new #GtkClutterEmbed widget. This widget can be
435 * used to build a scene using Clutter API into a GTK+ application.
437 * Return value: the newly created #GtkClutterEmbed
442 gtk_clutter_embed_new (void)
444 return g_object_new (GTK_TYPE_CLUTTER_EMBED, NULL);
448 * gtk_clutter_embed_get_stage:
449 * @embed: a #GtkClutterEmbed
451 * Retrieves the #ClutterStage from @embed. The returned stage can be
452 * used to add actors to the Clutter scene.
454 * Return value: the Clutter stage. You should never destroy or unref
455 * the returned actor.
460 gtk_clutter_embed_get_stage (GtkClutterEmbed *embed)
462 g_return_val_if_fail (GTK_IS_CLUTTER_EMBED (embed), NULL);
464 return embed->priv->stage;