1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2005. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gdkwindow.h"
31 #include "gdkinternals.h"
32 #include "gdkwindowimpl.h"
33 #include "gdkpixmap.h"
34 #include "gdkdrawable.h"
36 #include "gdkscreen.h"
38 #include "gdkcursor.h"
43 * Offscreen windows can't be the child of a foreign window,
44 * nor contain foreign windows
45 * GDK_POINTER_MOTION_HINT_MASK isn't effective
48 typedef struct _GdkOffscreenWindow GdkOffscreenWindow;
49 typedef struct _GdkOffscreenWindowClass GdkOffscreenWindowClass;
51 struct _GdkOffscreenWindow
53 GdkDrawable parent_instance;
57 GdkColormap *colormap;
64 struct _GdkOffscreenWindowClass
66 GdkDrawableClass parent_class;
69 #define GDK_TYPE_OFFSCREEN_WINDOW (gdk_offscreen_window_get_type())
70 #define GDK_OFFSCREEN_WINDOW(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_OFFSCREEN_WINDOW, GdkOffscreenWindow))
71 #define GDK_IS_OFFSCREEN_WINDOW(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_OFFSCREEN_WINDOW))
72 #define GDK_OFFSCREEN_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_OFFSCREEN_WINDOW, GdkOffscreenWindowClass))
73 #define GDK_IS_OFFSCREEN_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_OFFSCREEN_WINDOW))
74 #define GDK_OFFSCREEN_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_OFFSCREEN_WINDOW, GdkOffscreenWindowClass))
76 static void gdk_offscreen_window_impl_iface_init (GdkWindowImplIface *iface);
77 static void gdk_offscreen_window_hide (GdkWindow *window);
79 G_DEFINE_TYPE_WITH_CODE (GdkOffscreenWindow,
82 G_IMPLEMENT_INTERFACE (GDK_TYPE_WINDOW_IMPL,
83 gdk_offscreen_window_impl_iface_init));
87 gdk_offscreen_window_finalize (GObject *object)
89 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (object);
91 if (offscreen->cursor)
92 gdk_cursor_unref (offscreen->cursor);
94 offscreen->cursor = NULL;
96 g_object_unref (offscreen->pixmap);
98 G_OBJECT_CLASS (gdk_offscreen_window_parent_class)->finalize (object);
102 gdk_offscreen_window_init (GdkOffscreenWindow *window)
107 gdk_offscreen_window_destroy (GdkWindow *window,
109 gboolean foreign_destroy)
111 GdkWindowObject *private = GDK_WINDOW_OBJECT (window);
112 GdkOffscreenWindow *offscreen;
114 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
116 gdk_offscreen_window_set_embedder (window, NULL);
119 gdk_offscreen_window_hide (window);
121 g_object_unref (offscreen->colormap);
122 offscreen->colormap = NULL;
126 is_parent_of (GdkWindow *parent,
137 w = gdk_window_get_parent (w);
143 static cairo_surface_t *
144 gdk_offscreen_window_ref_cairo_surface (GdkDrawable *drawable)
146 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
148 return _gdk_drawable_ref_cairo_surface (offscreen->pixmap);
152 gdk_offscreen_window_get_colormap (GdkDrawable *drawable)
154 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
156 return offscreen->colormap;
160 gdk_offscreen_window_set_colormap (GdkDrawable *drawable,
161 GdkColormap*colormap)
163 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
165 if (colormap && GDK_WINDOW_DESTROYED (offscreen->wrapper))
168 if (offscreen->colormap == colormap)
171 if (offscreen->colormap)
172 g_object_unref (offscreen->colormap);
174 offscreen->colormap = colormap;
175 if (offscreen->colormap)
176 g_object_ref (offscreen->colormap);
181 gdk_offscreen_window_get_depth (GdkDrawable *drawable)
183 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
185 return gdk_drawable_get_depth (offscreen->wrapper);
189 gdk_offscreen_window_get_source_drawable (GdkDrawable *drawable)
191 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
193 return _gdk_drawable_get_source_drawable (offscreen->pixmap);
197 gdk_offscreen_window_get_screen (GdkDrawable *drawable)
199 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
201 return offscreen->screen;
205 gdk_offscreen_window_get_visual (GdkDrawable *drawable)
207 GdkOffscreenWindow *offscreen = GDK_OFFSCREEN_WINDOW (drawable);
209 return gdk_drawable_get_visual (offscreen->wrapper);
213 add_damage (GdkOffscreenWindow *offscreen,
219 cairo_region_t *damage;
228 /* This should really take into account line width, line
229 * joins (and miter) and line caps. But these are hard
230 * to compute, rarely used and generally a pain. And in
231 * the end a snug damage rectangle is not that important
232 * as multiple damages are generally created anyway.
234 * So, we just add some padding around the rect.
235 * We use a padding of 3 pixels, plus an extra row
236 * below and on the right for the normal line size. I.E.
237 * line from (0,0) to (2,0) gets h=0 but is really
238 * at least one pixel tall.
246 damage = cairo_region_create_rectangle (&rect);
247 _gdk_window_add_damage (offscreen->wrapper, damage);
248 cairo_region_destroy (damage);
252 _gdk_offscreen_window_new (GdkWindow *window,
255 GdkWindowAttr *attributes,
256 gint attributes_mask)
258 GdkWindowObject *private;
259 GdkOffscreenWindow *offscreen;
261 g_return_if_fail (attributes != NULL);
263 if (attributes->wclass != GDK_INPUT_OUTPUT)
264 return; /* Can't support input only offscreens */
266 private = (GdkWindowObject *)window;
268 if (private->parent != NULL && GDK_WINDOW_DESTROYED (private->parent))
271 private->impl = g_object_new (GDK_TYPE_OFFSCREEN_WINDOW, NULL);
272 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
273 offscreen->wrapper = window;
275 offscreen->screen = screen;
277 if (attributes_mask & GDK_WA_COLORMAP)
278 offscreen->colormap = g_object_ref (attributes->colormap);
281 if (gdk_screen_get_system_visual (screen) == visual)
283 offscreen->colormap = gdk_screen_get_system_colormap (screen);
284 g_object_ref (offscreen->colormap);
287 offscreen->colormap = gdk_colormap_new (visual, FALSE);
290 offscreen->pixmap = gdk_pixmap_new ((GdkDrawable *)private->parent,
294 gdk_drawable_set_colormap (offscreen->pixmap, offscreen->colormap);
298 gdk_offscreen_window_reparent (GdkWindow *window,
299 GdkWindow *new_parent,
303 GdkWindowObject *private = (GdkWindowObject *)window;
304 GdkWindowObject *new_parent_private = (GdkWindowObject *)new_parent;
305 GdkWindowObject *old_parent;
310 /* No input-output children of input-only windows */
311 if (new_parent_private->input_only && !private->input_only)
314 /* Don't create loops in hierarchy */
315 if (is_parent_of (window, new_parent))
319 was_mapped = GDK_WINDOW_IS_MAPPED (window);
321 gdk_window_hide (window);
324 private->parent->children = g_list_remove (private->parent->children, window);
326 old_parent = private->parent;
327 private->parent = new_parent_private;
331 if (new_parent_private)
332 private->parent->children = g_list_prepend (private->parent->children, window);
334 _gdk_synthesize_crossing_events_for_geometry_change (window);
336 _gdk_synthesize_crossing_events_for_geometry_change (GDK_WINDOW (old_parent));
342 from_embedder (GdkWindow *window,
343 double embedder_x, double embedder_y,
344 double *offscreen_x, double *offscreen_y)
346 GdkWindowObject *private;
348 private = (GdkWindowObject *)window;
350 g_signal_emit_by_name (private->impl_window,
352 embedder_x, embedder_y,
353 offscreen_x, offscreen_y,
358 to_embedder (GdkWindow *window,
359 double offscreen_x, double offscreen_y,
360 double *embedder_x, double *embedder_y)
362 GdkWindowObject *private;
364 private = (GdkWindowObject *)window;
366 g_signal_emit_by_name (private->impl_window,
368 offscreen_x, offscreen_y,
369 embedder_x, embedder_y,
374 gdk_offscreen_window_get_root_coords (GdkWindow *window,
380 GdkWindowObject *private = GDK_WINDOW_OBJECT (window);
381 GdkOffscreenWindow *offscreen;
387 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
388 if (offscreen->embedder)
394 tmpx = floor (dx + 0.5);
395 tmpy = floor (dy + 0.5);
396 gdk_window_get_root_coords (offscreen->embedder,
411 gdk_offscreen_window_get_deskrelative_origin (GdkWindow *window,
415 GdkWindowObject *private = GDK_WINDOW_OBJECT (window);
416 GdkOffscreenWindow *offscreen;
422 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
423 if (offscreen->embedder)
426 gdk_window_get_deskrelative_origin (offscreen->embedder,
432 tmpx = floor (tmpx + dx + 0.5);
433 tmpy = floor (tmpy + dy + 0.5);
446 gdk_offscreen_window_get_device_state (GdkWindow *window,
450 GdkModifierType *mask)
452 GdkWindowObject *private = GDK_WINDOW_OBJECT (window);
453 GdkOffscreenWindow *offscreen;
456 GdkModifierType tmpmask;
462 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
463 if (offscreen->embedder != NULL)
465 gdk_window_get_device_position (offscreen->embedder, device, &tmpx, &tmpy, &tmpmask);
466 from_embedder (window,
469 tmpx = floor (dtmpx + 0.5);
470 tmpy = floor (dtmpy + 0.5);
483 * gdk_offscreen_window_get_pixmap:
484 * @window: a #GdkWindow
486 * Gets the offscreen pixmap that an offscreen window renders into.
487 * If you need to keep this around over window resizes, you need to
488 * add a reference to it.
490 * Returns: The offscreen pixmap, or %NULL if not offscreen
495 gdk_offscreen_window_get_pixmap (GdkWindow *window)
497 GdkWindowObject *private = (GdkWindowObject *)window;
498 GdkOffscreenWindow *offscreen;
500 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
502 if (!GDK_IS_OFFSCREEN_WINDOW (private->impl))
505 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
506 return offscreen->pixmap;
510 gdk_offscreen_window_raise (GdkWindow *window)
512 /* gdk_window_raise already changed the stacking order */
513 _gdk_synthesize_crossing_events_for_geometry_change (window);
517 gdk_offscreen_window_lower (GdkWindow *window)
519 /* gdk_window_lower already changed the stacking order */
520 _gdk_synthesize_crossing_events_for_geometry_change (window);
524 gdk_offscreen_window_move_resize_internal (GdkWindow *window,
529 gboolean send_expose_events)
531 GdkWindowObject *private = (GdkWindowObject *)window;
532 GdkOffscreenWindow *offscreen;
534 GdkPixmap *old_pixmap;
536 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
543 if (private->destroyed)
548 dw = width - private->width;
549 dh = height - private->height;
554 if (private->width != width ||
555 private->height != height)
559 private->width = width;
560 private->height = height;
562 old_pixmap = offscreen->pixmap;
563 offscreen->pixmap = gdk_pixmap_new (GDK_DRAWABLE (old_pixmap),
568 cr = gdk_cairo_create (offscreen->pixmap);
569 gdk_cairo_set_source_pixmap (cr, old_pixmap, 0, 0);
574 if (GDK_WINDOW_IS_MAPPED (private))
576 // TODO: Only invalidate new area, i.e. for larger windows
577 gdk_window_invalidate_rect (window, NULL, TRUE);
578 _gdk_synthesize_crossing_events_for_geometry_change (window);
583 gdk_offscreen_window_move_resize (GdkWindow *window,
590 GdkWindowObject *private = (GdkWindowObject *)window;
591 GdkOffscreenWindow *offscreen;
593 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
602 width = private->width;
605 height = private->height;
607 gdk_offscreen_window_move_resize_internal (window, x, y,
613 gdk_offscreen_window_show (GdkWindow *window,
614 gboolean already_mapped)
616 GdkWindowObject *private = (GdkWindowObject *)window;
618 gdk_window_clear_area_e (window, 0, 0,
619 private->width, private->height);
624 gdk_offscreen_window_hide (GdkWindow *window)
626 GdkWindowObject *private;
627 GdkOffscreenWindow *offscreen;
630 g_return_if_fail (window != NULL);
632 private = (GdkWindowObject*) window;
633 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
635 /* May need to break grabs on children */
636 display = gdk_drawable_get_display (window);
638 /* TODO: This needs updating to the new grab world */
640 if (display->pointer_grab.window != NULL)
642 if (is_parent_of (window, display->pointer_grab.window))
644 /* Call this ourselves, even though gdk_display_pointer_ungrab
645 does so too, since we want to pass implicit == TRUE so the
646 broken grab event is generated */
647 _gdk_display_unset_has_pointer_grab (display,
651 gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
658 gdk_offscreen_window_withdraw (GdkWindow *window)
663 gdk_offscreen_window_get_events (GdkWindow *window)
669 gdk_offscreen_window_set_events (GdkWindow *window,
670 GdkEventMask event_mask)
675 gdk_offscreen_window_set_background (GdkWindow *window,
676 const GdkColor *color)
678 GdkWindowObject *private = (GdkWindowObject *)window;
679 GdkColormap *colormap = gdk_drawable_get_colormap (window);
681 private->bg_color = *color;
682 gdk_colormap_query_color (colormap, private->bg_color.pixel, &private->bg_color);
684 if (private->bg_pixmap &&
685 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
686 private->bg_pixmap != GDK_NO_BG)
687 g_object_unref (private->bg_pixmap);
689 private->bg_pixmap = NULL;
693 gdk_offscreen_window_set_back_pixmap (GdkWindow *window,
696 GdkWindowObject *private = (GdkWindowObject *)window;
699 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
700 private->bg_pixmap != GDK_NO_BG &&
701 !gdk_drawable_get_colormap (pixmap))
703 g_warning ("gdk_window_set_back_pixmap(): pixmap must have a colormap");
707 if (private->bg_pixmap &&
708 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
709 private->bg_pixmap != GDK_NO_BG)
710 g_object_unref (private->bg_pixmap);
712 private->bg_pixmap = pixmap;
715 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
716 private->bg_pixmap != GDK_NO_BG)
717 g_object_ref (pixmap);
721 gdk_offscreen_window_shape_combine_region (GdkWindow *window,
722 const cairo_region_t *shape_region,
729 gdk_offscreen_window_input_shape_combine_region (GdkWindow *window,
730 const cairo_region_t *shape_region,
737 gdk_offscreen_window_set_static_gravities (GdkWindow *window,
744 gdk_offscreen_window_get_geometry (GdkWindow *window,
751 GdkWindowObject *private = (GdkWindowObject *)window;
753 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
755 if (!GDK_WINDOW_DESTROYED (window))
762 *width = private->width;
764 *height = private->height;
766 *depth = private->depth;
771 gdk_offscreen_window_queue_antiexpose (GdkWindow *window,
772 cairo_region_t *area)
778 gdk_offscreen_window_translate (GdkWindow *window,
779 cairo_region_t *area,
783 cairo_surface_t *surface;
786 /* Can't use gdk_cairo_create here due to clipping */
787 surface = _gdk_drawable_ref_cairo_surface (window);
788 cr = cairo_create (surface);
789 cairo_surface_destroy (surface);
791 area = cairo_region_copy (area);
793 gdk_cairo_region (cr, area);
796 /* NB: This is a self-copy and Cairo doesn't support that yet.
797 * So we do a litle trick.
799 cairo_push_group (cr);
801 gdk_cairo_set_source_pixmap (cr, window, dx, dy);
804 cairo_pop_group_to_source (cr);
809 _gdk_window_add_damage (window, area);
813 * gdk_offscreen_window_set_embedder:
814 * @window: a #GdkWindow
815 * @embedder: the #GdkWindow that @window gets embedded in
817 * Sets @window to be embedded in @embedder.
819 * To fully embed an offscreen window, in addition to calling this
820 * function, it is also necessary to handle the #GdkWindow::pick-embedded-child
821 * signal on the @embedder and the #GdkWindow::to-embedder and
822 * #GdkWindow::from-embedder signals on @window.
827 gdk_offscreen_window_set_embedder (GdkWindow *window,
830 GdkWindowObject *private = (GdkWindowObject *)window;
831 GdkOffscreenWindow *offscreen;
833 g_return_if_fail (GDK_IS_WINDOW (window));
835 if (!GDK_IS_OFFSCREEN_WINDOW (private->impl))
838 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
842 g_object_ref (embedder);
843 GDK_WINDOW_OBJECT (embedder)->num_offscreen_children++;
846 if (offscreen->embedder)
848 g_object_unref (offscreen->embedder);
849 GDK_WINDOW_OBJECT (offscreen->embedder)->num_offscreen_children--;
852 offscreen->embedder = embedder;
856 * gdk_offscreen_window_get_embedder:
857 * @window: a #GdkWindow
859 * Gets the window that @window is embedded in.
861 * Returns: the embedding #GdkWindow, or %NULL if @window is not an
862 * embedded offscreen window
867 gdk_offscreen_window_get_embedder (GdkWindow *window)
869 GdkWindowObject *private = (GdkWindowObject *)window;
870 GdkOffscreenWindow *offscreen;
872 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
874 if (!GDK_IS_OFFSCREEN_WINDOW (private->impl))
877 offscreen = GDK_OFFSCREEN_WINDOW (private->impl);
879 return offscreen->embedder;
883 gdk_offscreen_window_class_init (GdkOffscreenWindowClass *klass)
885 GdkDrawableClass *drawable_class = GDK_DRAWABLE_CLASS (klass);
886 GObjectClass *object_class = G_OBJECT_CLASS (klass);
888 object_class->finalize = gdk_offscreen_window_finalize;
890 drawable_class->ref_cairo_surface = gdk_offscreen_window_ref_cairo_surface;
891 drawable_class->set_colormap = gdk_offscreen_window_set_colormap;
892 drawable_class->get_colormap = gdk_offscreen_window_get_colormap;
893 drawable_class->get_depth = gdk_offscreen_window_get_depth;
894 drawable_class->get_screen = gdk_offscreen_window_get_screen;
895 drawable_class->get_visual = gdk_offscreen_window_get_visual;
896 drawable_class->get_source_drawable = gdk_offscreen_window_get_source_drawable;
900 gdk_offscreen_window_impl_iface_init (GdkWindowImplIface *iface)
902 iface->show = gdk_offscreen_window_show;
903 iface->hide = gdk_offscreen_window_hide;
904 iface->withdraw = gdk_offscreen_window_withdraw;
905 iface->raise = gdk_offscreen_window_raise;
906 iface->lower = gdk_offscreen_window_lower;
907 iface->move_resize = gdk_offscreen_window_move_resize;
908 iface->set_background = gdk_offscreen_window_set_background;
909 iface->set_back_pixmap = gdk_offscreen_window_set_back_pixmap;
910 iface->get_events = gdk_offscreen_window_get_events;
911 iface->set_events = gdk_offscreen_window_set_events;
912 iface->reparent = gdk_offscreen_window_reparent;
913 iface->get_geometry = gdk_offscreen_window_get_geometry;
914 iface->shape_combine_region = gdk_offscreen_window_shape_combine_region;
915 iface->input_shape_combine_region = gdk_offscreen_window_input_shape_combine_region;
916 iface->set_static_gravities = gdk_offscreen_window_set_static_gravities;
917 iface->queue_antiexpose = gdk_offscreen_window_queue_antiexpose;
918 iface->translate = gdk_offscreen_window_translate;
919 iface->get_root_coords = gdk_offscreen_window_get_root_coords;
920 iface->get_deskrelative_origin = gdk_offscreen_window_get_deskrelative_origin;
921 iface->get_device_state = gdk_offscreen_window_get_device_state;
922 iface->destroy = gdk_offscreen_window_destroy;