1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-2007 Peter Mattis, Spencer Kimball,
3 * Josh MacDonald, Ryan Lortie
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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include <cairo-gobject.h>
32 #include "gdkwindow.h"
34 #include "gdkrectangle.h"
35 #include "gdkinternals.h"
37 #include "gdkscreenprivate.h"
38 #include "gdkdisplayprivate.h"
39 #include "gdkdeviceprivate.h"
40 #include "gdkvisualprivate.h"
41 #include "gdkmarshalers.h"
42 #include "gdkwindowimpl.h"
46 #undef DEBUG_WINDOW_PRINTING
51 * @Short_description: Onscreen display areas in the target window system
54 * A #GdkWindow is a (usually) rectangular region on the screen.
55 * It's a low-level object, used to implement high-level objects such as
56 * #GtkWidget and #GtkWindow on the GTK+ level. A #GtkWindow is a toplevel
57 * window, the thing a user might think of as a "window" with a titlebar and
58 * so on; a #GtkWindow may contain many #GdkWindows. For example, each
59 * #GtkButton has a #GdkWindow associated with it.
61 * <refsect2 id="COMPOSITED-WINDOWS">
62 * <title>Composited Windows</title>
64 * Normally, the windowing system takes care of rendering the contents of a
65 * child window onto its parent window. This mechanism can be intercepted by
66 * calling gdk_window_set_composited() on the child window. For a
67 * <firstterm>composited</firstterm> window it is the responsibility of the
68 * application to render the window contents at the right spot.
70 * <example id="composited-window-example">
71 * <title>Composited windows</title>
73 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/gdk/composited-window-example.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>
74 * </programlisting></example>
76 * In the example <xref linkend="composited-window-example"/>, a button is
77 * placed inside of an event box inside of a window. The event box is set as
78 * composited and therefore is no longer automatically drawn to the screen.
80 * When the contents of the event box change, an expose event is generated on
81 * its parent window (which, in this case, belongs to the toplevel #GtkWindow).
82 * The expose handler for this widget is responsible for merging the changes
83 * back on the screen in the way that it wishes.
85 * In our case, we merge the contents with a 50% transparency. We also set the
86 * background colour of the window to red. The effect is that the background
87 * shows through the button.
90 * <refsect2 id="OFFSCREEN-WINDOWS">
91 * <title>Offscreen Windows</title>
93 * Offscreen windows are more general than composited windows, since they allow
94 * not only to modify the rendering of the child window onto its parent, but
95 * also to apply coordinate transformations.
97 * To integrate an offscreen window into a window hierarchy, one has to call
98 * gdk_offscreen_window_set_embedder() and handle a number of signals. The
99 * #GdkWindow::pick-embedded-child signal on the embedder window is used to
100 * select an offscreen child at given coordinates, and the
101 * #GdkWindow::to-embedder and #GdkWindow::from-embedder signals on the
102 * offscreen window are used to translate coordinates between the embedder and
103 * the offscreen window.
105 * For rendering an offscreen window onto its embedder, the contents of the
106 * offscreen window are available as a surface, via
107 * gdk_offscreen_window_get_surface().
113 /* Historically a GdkWindow always matches a platform native window,
114 * be it a toplevel window or a child window. In this setup the
115 * GdkWindow (and other GdkDrawables) were platform independent classes,
116 * and the actual platform specific implementation was in a delegate
117 * object availible as "impl" in the window object.
119 * With the addition of client side windows and offscreen windows this
120 * changes a bit. The application-visible GdkWindow object behaves as
121 * it did before, but not all such windows now have a corresponding native
122 * window. Instead windows that are "client side" are emulated by the gdk
123 * code such that clipping, drawing, moving, events etc work as expected.
125 * For GdkWindows that have a native window the "impl" object is the
126 * same as before. However, for all client side windows the impl object
127 * is shared with its parent (i.e. all client windows descendants of one
128 * native window has the same impl.
130 * Additionally there is a new type of platform independent impl object,
131 * GdkOffscreenWindow. All windows of type GDK_WINDOW_OFFSCREEN get an impl
132 * of this type (while their children are generally GDK_WINDOW_CHILD virtual
133 * windows). Such windows work by allocating a #cairo_surface_t as the backing
134 * store for drawing operations, which is resized with the window.
136 * GdkWindows have a pointer to the "impl window" they are in, i.e.
137 * the topmost GdkWindow which have the same "impl" value. This is stored
138 * in impl_window, which is different from the window itself only for client
140 * All GdkWindows (native or not) track the position of the window in the parent
141 * (x, y), the size of the window (width, height), the position of the window
142 * with respect to the impl window (abs_x, abs_y). We also track the clip
143 * region of the window wrt parent windows and siblings, in window-relative
144 * coordinates with and without child windows included (clip_region,
145 * clip_region_with_children).
147 * All toplevel windows are native windows, but also child windows can be
148 * native (although not children of offscreens). We always listen to
149 * a basic set of events (see get_native_event_mask) for these windows
150 * so that we can emulate events for any client side children.
152 * For native windows we apply the calculated clip region as a window shape
153 * so that eg. client side siblings that overlap the native child properly
154 * draws over the native child window.
156 * In order to minimize flicker and for performance we use a couple of cacheing
157 * tricks. First of all, every time we do a window to window copy area, for instance
158 * when moving a client side window or when scrolling/moving a region in a window
159 * we store this in outstanding_moves instead of applying immediately. We then
160 * delay this move until we really need it (because something depends on being
161 * able to read it), or until we're handing a redraw from an expose/invalidation
162 * (actually we delay it past redraw, but before blitting the double buffer
163 * to the window). This gives us two advantages. First of all it minimizes the time
164 * from the window is moved to the exposes related to that move, secondly it allows
165 * us to be smart about how to do the copy. We combine multiple moves into one (when
166 * possible) and we don't actually do copies to anything that is or will be
167 * invalidated and exposed anyway.
169 * Secondly, we use something called a "implicit paint" during repaint handling.
170 * An implicit paint is similar to a regular paint for the paint stack, but it is
171 * not put on the stack. Instead, it is set on the impl window, and later when
172 * regular gdk_window_begin_paint_region() happen on a window of this impl window
173 * we reuse the surface from the implicit paint. During repaint we create and at the
174 * end flush an implicit paint, which means we can collect all the paints on
175 * multiple client side windows in the same backing store.
178 #define USE_BACKING_STORE /* Appears to work on Win32, too, now. */
180 /* This adds a local value to the GdkVisibilityState enum */
181 #define GDK_VISIBILITY_NOT_VIEWABLE 3
184 PICK_EMBEDDED_CHILD, /* only called if children are embedded */
198 CLEAR_BG_WINCLEARED, /* Clear backgrounds except those that the window system clears */
202 struct _GdkWindowPaint
204 cairo_region_t *region;
205 cairo_surface_t *surface;
206 guint uses_implicit : 1;
211 cairo_region_t *dest_region; /* The destination region */
212 int dx, dy; /* The amount that the source was moved to reach dest_region */
213 } GdkWindowRegionMove;
217 static void gdk_window_drop_cairo_surface (GdkWindow *private);
219 static void gdk_window_free_paint_stack (GdkWindow *window);
221 static void gdk_window_finalize (GObject *object);
223 static void gdk_window_set_property (GObject *object,
227 static void gdk_window_get_property (GObject *object,
232 static void gdk_window_clear_backing_region (GdkWindow *window,
233 cairo_region_t *region);
235 static void recompute_visible_regions (GdkWindow *private,
236 gboolean recalculate_siblings,
237 gboolean recalculate_children);
238 static void gdk_window_flush_outstanding_moves (GdkWindow *window);
239 static void gdk_window_flush_recursive (GdkWindow *window);
240 static void do_move_region_bits_on_impl (GdkWindow *window,
241 cairo_region_t *region, /* In impl window coords */
243 static void gdk_window_invalidate_in_parent (GdkWindow *private);
244 static void move_native_children (GdkWindow *private);
245 static void update_cursor (GdkDisplay *display,
247 static void impl_window_add_update_area (GdkWindow *impl_window,
248 cairo_region_t *region);
249 static void gdk_window_region_move_free (GdkWindowRegionMove *move);
250 static void gdk_window_invalidate_region_full (GdkWindow *window,
251 const cairo_region_t *region,
252 gboolean invalidate_children,
254 static void gdk_window_invalidate_rect_full (GdkWindow *window,
255 const GdkRectangle *rect,
256 gboolean invalidate_children,
258 static void _gdk_window_propagate_has_alpha_background (GdkWindow *window);
260 static guint signals[LAST_SIGNAL] = { 0 };
262 static gpointer parent_class = NULL;
264 static const cairo_user_data_key_t gdk_window_cairo_key;
266 G_DEFINE_ABSTRACT_TYPE (GdkWindow, gdk_window, G_TYPE_OBJECT)
269 _gdk_paintable_get_type (void)
271 static GType paintable_type = 0;
275 const GTypeInfo paintable_info =
277 sizeof (GdkPaintableIface), /* class_size */
278 NULL, /* base_init */
279 NULL, /* base_finalize */
282 paintable_type = g_type_register_static (G_TYPE_INTERFACE,
283 g_intern_static_string ("GdkPaintable"),
286 g_type_interface_add_prerequisite (paintable_type, G_TYPE_OBJECT);
289 return paintable_type;
293 gdk_window_init (GdkWindow *window)
295 /* 0-initialization is good for all other fields. */
297 window->window_type = GDK_WINDOW_CHILD;
299 window->state = GDK_WINDOW_STATE_WITHDRAWN;
302 window->toplevel_window_type = -1;
304 window->effective_visibility = GDK_VISIBILITY_NOT_VIEWABLE;
305 window->visibility = GDK_VISIBILITY_FULLY_OBSCURED;
306 /* Default to unobscured since some backends don't send visibility events */
307 window->native_visibility = GDK_VISIBILITY_UNOBSCURED;
309 window->device_cursor = g_hash_table_new_full (NULL, NULL,
310 NULL, g_object_unref);
313 /* Stop and return on the first non-NULL parent */
315 accumulate_get_window (GSignalInvocationHint *ihint,
317 const GValue *handler_return,
320 g_value_copy (handler_return, return_accu);
321 /* Continue while returning NULL */
322 return g_value_get_object (handler_return) == NULL;
326 create_surface_accumulator (GSignalInvocationHint *ihint,
328 const GValue *handler_return,
331 g_value_copy (handler_return, return_accu);
333 /* Stop on the first non-NULL return value */
334 return g_value_get_boxed (handler_return) == NULL;
337 static GQuark quark_pointer_window = 0;
340 gdk_window_class_init (GdkWindowClass *klass)
342 GObjectClass *object_class = G_OBJECT_CLASS (klass);
344 parent_class = g_type_class_peek_parent (klass);
346 object_class->finalize = gdk_window_finalize;
347 object_class->set_property = gdk_window_set_property;
348 object_class->get_property = gdk_window_get_property;
350 klass->create_surface = _gdk_offscreen_window_create_surface;
352 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
360 * The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and
361 * gdk_window_get_cursor() for details.
365 g_object_class_install_property (object_class,
367 g_param_spec_object ("cursor",
374 * GdkWindow::pick-embedded-child:
375 * @window: the window on which the signal is emitted
376 * @x: x coordinate in the window
377 * @y: y coordinate in the window
379 * The ::pick-embedded-child signal is emitted to find an embedded
380 * child at the given position.
382 * Returns: (transfer none): the #GdkWindow of the embedded child at
387 signals[PICK_EMBEDDED_CHILD] =
388 g_signal_new (g_intern_static_string ("pick-embedded-child"),
389 G_OBJECT_CLASS_TYPE (object_class),
391 G_STRUCT_OFFSET (GdkWindowClass, pick_embedded_child),
392 accumulate_get_window, NULL,
393 _gdk_marshal_OBJECT__DOUBLE_DOUBLE,
400 * GdkWindow::to-embedder:
401 * @window: the offscreen window on which the signal is emitted
402 * @offscreen-x: x coordinate in the offscreen window
403 * @offscreen-y: y coordinate in the offscreen window
404 * @embedder-x: (out) (type double): return location for the x
405 * coordinate in the embedder window
406 * @embedder-y: (out) (type double): return location for the y
407 * coordinate in the embedder window
409 * The ::to-embedder signal is emitted to translate coordinates
410 * in an offscreen window to its embedder.
412 * See also #GtkWindow::from-embedder.
416 signals[TO_EMBEDDER] =
417 g_signal_new (g_intern_static_string ("to-embedder"),
418 G_OBJECT_CLASS_TYPE (object_class),
420 G_STRUCT_OFFSET (GdkWindowClass, to_embedder),
422 _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
431 * GdkWindow::from-embedder:
432 * @window: the offscreen window on which the signal is emitted
433 * @embedder-x: x coordinate in the embedder window
434 * @embedder-y: y coordinate in the embedder window
435 * @offscreen-x: (out) (type double): return location for the x
436 * coordinate in the offscreen window
437 * @offscreen-y: (out) (type double): return location for the y
438 * coordinate in the offscreen window
440 * The ::from-embedder signal is emitted to translate coordinates
441 * in the embedder of an offscreen window to the offscreen window.
443 * See also #GtkWindow::to-embedder.
447 signals[FROM_EMBEDDER] =
448 g_signal_new (g_intern_static_string ("from-embedder"),
449 G_OBJECT_CLASS_TYPE (object_class),
451 G_STRUCT_OFFSET (GdkWindowClass, from_embedder),
453 _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
462 * GdkWindow::create-surface:
463 * @window: the offscreen window on which the signal is emitted
464 * @width: the width of the offscreen surface to create
465 * @height: the height of the offscreen surface to create
467 * The ::create-surface signal is emitted when an offscreen window
468 * needs its surface (re)created, which happens either when the the
469 * window is first drawn to, or when the window is being
470 * resized. The first signal handler that returns a non-%NULL
471 * surface will stop any further signal emission, and its surface
474 * Note that it is not possible to access the window's previous
475 * surface from within any callback of this signal. Calling
476 * gdk_offscreen_window_get_surface() will lead to a crash.
478 * Returns: the newly created #cairo_surface_t for the offscreen window
482 signals[CREATE_SURFACE] =
483 g_signal_new (g_intern_static_string ("create-surface"),
484 G_OBJECT_CLASS_TYPE (object_class),
486 G_STRUCT_OFFSET (GdkWindowClass, create_surface),
487 create_surface_accumulator, NULL,
488 _gdk_marshal_BOXED__INT_INT,
489 CAIRO_GOBJECT_TYPE_SURFACE,
496 device_removed_cb (GdkDeviceManager *device_manager,
500 window->devices_inside = g_list_remove (window->devices_inside, device);
501 g_hash_table_remove (window->device_cursor, device);
503 if (window->device_events)
504 g_hash_table_remove (window->device_events, device);
508 gdk_window_finalize (GObject *object)
510 GdkWindow *window = GDK_WINDOW (object);
511 GdkDeviceManager *device_manager;
513 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
514 g_signal_handlers_disconnect_by_func (device_manager, device_removed_cb, window);
516 if (!GDK_WINDOW_DESTROYED (window))
518 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
520 g_warning ("losing last reference to undestroyed window\n");
521 _gdk_window_destroy (window, FALSE);
524 /* We use TRUE here, to keep us from actually calling
525 * XDestroyWindow() on the window
527 _gdk_window_destroy (window, TRUE);
530 gdk_window_drop_cairo_surface (window);
534 g_object_unref (window->impl);
538 if (window->impl_window != window)
540 g_object_unref (window->impl_window);
541 window->impl_window = NULL;
545 cairo_region_destroy (window->shape);
547 if (window->input_shape)
548 cairo_region_destroy (window->input_shape);
551 g_object_unref (window->cursor);
553 if (window->device_cursor)
554 g_hash_table_destroy (window->device_cursor);
556 if (window->device_events)
557 g_hash_table_destroy (window->device_events);
559 if (window->source_event_masks)
560 g_hash_table_destroy (window->source_event_masks);
562 if (window->devices_inside)
563 g_list_free (window->devices_inside);
565 if (window->layered_region)
566 cairo_region_destroy (window->layered_region);
568 G_OBJECT_CLASS (parent_class)->finalize (object);
572 gdk_window_set_property (GObject *object,
577 GdkWindow *window = (GdkWindow *)object;
582 gdk_window_set_cursor (window, g_value_get_object (value));
586 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
592 gdk_window_get_property (GObject *object,
597 GdkWindow *window = (GdkWindow *) object;
602 g_value_set_object (value, gdk_window_get_cursor (window));
606 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
612 gdk_window_is_offscreen (GdkWindow *window)
614 return window->window_type == GDK_WINDOW_OFFSCREEN;
618 gdk_window_get_impl_window (GdkWindow *window)
620 return window->impl_window;
624 _gdk_window_get_impl_window (GdkWindow *window)
626 return gdk_window_get_impl_window (window);
630 gdk_window_has_impl (GdkWindow *window)
632 return window->impl_window == window;
636 gdk_window_is_toplevel (GdkWindow *window)
639 window->parent == NULL ||
640 window->parent->window_type == GDK_WINDOW_ROOT;
644 _gdk_window_has_impl (GdkWindow *window)
646 return gdk_window_has_impl (window);
650 gdk_window_has_no_impl (GdkWindow *window)
652 return window->impl_window != window;
656 remove_layered_child_area (GdkWindow *window,
657 cairo_region_t *region)
660 cairo_region_t *child_region;
664 for (l = window->children; l; l = l->next)
668 /* If region is empty already, no need to do
669 anything potentially costly */
670 if (cairo_region_is_empty (region))
673 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
676 /* Ignore offscreen children, as they don't draw in their parent and
677 * don't take part in the clipping */
678 if (gdk_window_is_offscreen (child))
681 /* Only non-impl children with alpha add to the layered region */
682 if (!child->has_alpha_background && gdk_window_has_impl (child))
687 r.width = child->width;
688 r.height = child->height;
690 /* Bail early if child totally outside region */
691 if (cairo_region_contains_rectangle (region, &r) == CAIRO_REGION_OVERLAP_OUT)
694 child_region = cairo_region_create_rectangle (&r);
697 /* Adjust shape region to parent window coords */
698 cairo_region_translate (child->shape, child->x, child->y);
699 cairo_region_intersect (child_region, child->shape);
700 cairo_region_translate (child->shape, -child->x, -child->y);
703 cairo_region_subtract (region, child_region);
704 cairo_region_destroy (child_region);
709 remove_child_area (GdkWindow *window,
712 cairo_region_t *region,
713 cairo_region_t *layered_region)
716 cairo_region_t *child_region;
719 cairo_region_t *shape;
721 for (l = window->children; l; l = l->next)
728 /* If region is empty already, no need to do
729 anything potentially costly */
730 if (cairo_region_is_empty (region))
733 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
736 /* Ignore offscreen children, as they don't draw in their parent and
737 * don't take part in the clipping */
738 if (gdk_window_is_offscreen (child))
743 r.width = child->width;
744 r.height = child->height;
746 /* Bail early if child totally outside region */
747 if (cairo_region_contains_rectangle (region, &r) == CAIRO_REGION_OVERLAP_OUT)
750 child_region = cairo_region_create_rectangle (&r);
754 /* Adjust shape region to parent window coords */
755 cairo_region_translate (child->shape, child->x, child->y);
756 cairo_region_intersect (child_region, child->shape);
757 cairo_region_translate (child->shape, -child->x, -child->y);
759 else if (window->window_type == GDK_WINDOW_FOREIGN)
761 shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_shape (child);
764 cairo_region_intersect (child_region, shape);
765 cairo_region_destroy (shape);
771 if (child->input_shape)
772 cairo_region_intersect (child_region, child->input_shape);
773 else if (window->window_type == GDK_WINDOW_FOREIGN)
775 shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_input_shape (child);
778 cairo_region_intersect (child_region, shape);
779 cairo_region_destroy (shape);
784 if (child->has_alpha_background)
786 if (layered_region != NULL)
787 cairo_region_union (layered_region, child_region);
790 cairo_region_subtract (region, child_region);
791 cairo_region_destroy (child_region);
795 static GdkVisibilityState
796 effective_visibility (GdkWindow *window)
798 GdkVisibilityState native;
800 if (!gdk_window_is_viewable (window))
801 return GDK_VISIBILITY_NOT_VIEWABLE;
803 native = window->impl_window->native_visibility;
805 if (native == GDK_VISIBILITY_FULLY_OBSCURED ||
806 window->visibility == GDK_VISIBILITY_FULLY_OBSCURED)
807 return GDK_VISIBILITY_FULLY_OBSCURED;
808 else if (native == GDK_VISIBILITY_UNOBSCURED)
809 return window->visibility;
810 else /* native PARTIAL, private partial or unobscured */
811 return GDK_VISIBILITY_PARTIAL;
815 gdk_window_update_visibility (GdkWindow *window)
817 GdkVisibilityState new_visibility;
820 new_visibility = effective_visibility (window);
822 if (new_visibility != window->effective_visibility)
824 window->effective_visibility = new_visibility;
826 if (new_visibility != GDK_VISIBILITY_NOT_VIEWABLE &&
827 window->event_mask & GDK_VISIBILITY_NOTIFY_MASK)
829 event = _gdk_make_event (window, GDK_VISIBILITY_NOTIFY,
831 event->visibility.state = new_visibility;
837 gdk_window_update_visibility_recursively (GdkWindow *window,
838 GdkWindow *only_for_impl)
843 gdk_window_update_visibility (window);
844 for (l = window->children; l != NULL; l = l->next)
847 if ((only_for_impl == NULL) ||
848 (only_for_impl == child->impl_window))
849 gdk_window_update_visibility_recursively (child, only_for_impl);
854 should_apply_clip_as_shape (GdkWindow *window)
857 gdk_window_has_impl (window) &&
858 /* Not for offscreens */
859 !gdk_window_is_offscreen (window) &&
860 /* or for toplevels */
861 !gdk_window_is_toplevel (window) &&
862 /* or for foreign windows */
863 window->window_type != GDK_WINDOW_FOREIGN &&
864 /* or for the root window */
865 window->window_type != GDK_WINDOW_ROOT;
869 apply_shape (GdkWindow *window,
870 cairo_region_t *region)
872 GdkWindowImplClass *impl_class;
874 /* We trash whether we applied a shape so that
875 we can avoid unsetting it many times, which
876 could happen in e.g. apply_clip_as_shape as
877 windows get resized */
878 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
880 impl_class->shape_combine_region (window,
882 else if (window->applied_shape)
883 impl_class->shape_combine_region (window,
886 window->applied_shape = region != NULL;
890 region_rect_equal (const cairo_region_t *region,
891 const GdkRectangle *rect)
893 GdkRectangle extents;
895 if (cairo_region_num_rectangles (region) != 1)
898 cairo_region_get_extents (region, &extents);
900 return extents.x == rect->x &&
901 extents.y == rect->y &&
902 extents.width == rect->width &&
903 extents.height == rect->height;
907 apply_clip_as_shape (GdkWindow *window)
912 r.width = window->width;
913 r.height = window->height;
915 /* We only apply the clip region if would differ
916 from the actual clip region implied by the size
917 of the window. This is to avoid unneccessarily
918 adding meaningless shapes to all native subwindows */
919 if (!region_rect_equal (window->clip_region, &r))
920 apply_shape (window, window->clip_region);
922 apply_shape (window, NULL);
926 recompute_visible_regions_internal (GdkWindow *private,
927 gboolean recalculate_clip,
928 gboolean recalculate_siblings,
929 gboolean recalculate_children)
934 cairo_region_t *new_clip, *new_layered;
935 gboolean clip_region_changed;
936 gboolean abs_pos_changed;
937 int old_abs_x, old_abs_y;
939 old_abs_x = private->abs_x;
940 old_abs_y = private->abs_y;
942 /* Update absolute position */
943 if (gdk_window_has_impl (private))
945 /* Native window starts here */
951 private->abs_x = private->parent->abs_x + private->x;
952 private->abs_y = private->parent->abs_y + private->y;
956 private->abs_x != old_abs_x ||
957 private->abs_y != old_abs_y;
959 /* Update clip region based on:
962 * siblings in parents above window
964 clip_region_changed = FALSE;
965 if (recalculate_clip)
967 new_layered = cairo_region_create ();
968 if (private->viewable)
970 /* Calculate visible region (sans children) in parent window coords */
973 r.width = private->width;
974 r.height = private->height;
975 new_clip = cairo_region_create_rectangle (&r);
977 if (!gdk_window_is_toplevel (private))
979 cairo_region_intersect (new_clip, private->parent->clip_region);
980 cairo_region_union (new_layered, private->parent->layered_region);
982 /* Remove all overlapping children from parent. */
983 remove_child_area (private->parent, private, FALSE, new_clip, new_layered);
986 /* Convert from parent coords to window coords */
987 cairo_region_translate (new_clip, -private->x, -private->y);
988 cairo_region_translate (new_layered, -private->x, -private->y);
991 cairo_region_intersect (new_clip, private->shape);
994 new_clip = cairo_region_create ();
996 cairo_region_intersect (new_layered, new_clip);
998 if (private->clip_region == NULL ||
999 !cairo_region_equal (private->clip_region, new_clip))
1000 clip_region_changed = TRUE;
1002 if (private->layered_region == NULL ||
1003 !cairo_region_equal (private->layered_region, new_layered))
1004 clip_region_changed = TRUE;
1006 if (private->clip_region)
1007 cairo_region_destroy (private->clip_region);
1008 private->clip_region = new_clip;
1010 if (private->layered_region != NULL)
1011 cairo_region_destroy (private->layered_region);
1012 private->layered_region = new_layered;
1014 if (private->clip_region_with_children)
1015 cairo_region_destroy (private->clip_region_with_children);
1016 private->clip_region_with_children = cairo_region_copy (private->clip_region);
1017 if (private->window_type != GDK_WINDOW_ROOT)
1018 remove_child_area (private, NULL, FALSE, private->clip_region_with_children, NULL);
1021 if (clip_region_changed)
1023 GdkVisibilityState visibility;
1024 gboolean fully_visible;
1026 if (cairo_region_is_empty (private->clip_region))
1027 visibility = GDK_VISIBILITY_FULLY_OBSCURED;
1032 fully_visible = cairo_region_equal (private->clip_region,
1039 r.width = private->width;
1040 r.height = private->height;
1041 fully_visible = region_rect_equal (private->clip_region, &r);
1045 visibility = GDK_VISIBILITY_UNOBSCURED;
1047 visibility = GDK_VISIBILITY_PARTIAL;
1050 if (private->visibility != visibility)
1052 private->visibility = visibility;
1053 gdk_window_update_visibility (private);
1057 /* Update all children, recursively (except for root, where children are not exact). */
1058 if ((abs_pos_changed || clip_region_changed || recalculate_children) &&
1059 private->window_type != GDK_WINDOW_ROOT)
1061 for (l = private->children; l; l = l->next)
1064 /* Only recalculate clip if the the clip region changed, otherwise
1065 * there is no way the child clip region could change (its has not e.g. moved)
1066 * Except if recalculate_children is set to force child updates
1068 recompute_visible_regions_internal (child,
1069 recalculate_clip && (clip_region_changed || recalculate_children),
1074 if (clip_region_changed &&
1075 should_apply_clip_as_shape (private))
1076 apply_clip_as_shape (private);
1078 if (recalculate_siblings &&
1079 !gdk_window_is_toplevel (private))
1081 /* If we moved a child window in parent or changed the stacking order, then we
1082 * need to recompute the visible area of all the other children in the parent
1084 for (l = private->parent->children; l; l = l->next)
1088 if (child != private)
1089 recompute_visible_regions_internal (child, TRUE, FALSE, FALSE);
1092 /* We also need to recompute the _with_children clip for the parent */
1093 recompute_visible_regions_internal (private->parent, TRUE, FALSE, FALSE);
1096 if (private->cairo_surface && gdk_window_has_impl (private))
1098 GdkWindowImplClass *iface = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1100 private->cairo_surface = iface->resize_cairo_surface (private,
1101 private->cairo_surface,
1105 else if (private->cairo_surface)
1106 gdk_window_drop_cairo_surface (private);
1109 /* Call this when private has changed in one or more of these ways:
1113 * stacking order of window changed
1116 * It will recalculate abs_x/y and the clip regions
1118 * Unless the window didn't change stacking order or size/pos, pass in TRUE
1119 * for recalculate_siblings. (Mostly used internally for the recursion)
1121 * If a child window was removed (and you can't use that child for
1122 * recompute_visible_regions), pass in TRUE for recalculate_children on the parent
1125 recompute_visible_regions (GdkWindow *private,
1126 gboolean recalculate_siblings,
1127 gboolean recalculate_children)
1129 recompute_visible_regions_internal (private,
1131 recalculate_siblings,
1132 recalculate_children);
1136 _gdk_window_update_size (GdkWindow *window)
1138 recompute_visible_regions (window, TRUE, FALSE);
1141 /* Find the native window that would be just above "child"
1142 * in the native stacking order if "child" was a native window
1143 * (it doesn't have to be native). If there is no such native
1144 * window inside this native parent then NULL is returned.
1145 * If child is NULL, find lowest native window in parent.
1148 find_native_sibling_above_helper (GdkWindow *parent,
1156 l = g_list_find (parent->children, child);
1157 g_assert (l != NULL); /* Better be a child of its parent... */
1158 l = l->prev; /* Start looking at the one above the child */
1161 l = g_list_last (parent->children);
1163 for (; l != NULL; l = l->prev)
1167 if (gdk_window_has_impl (w))
1170 g_assert (parent != w);
1171 w = find_native_sibling_above_helper (w, NULL);
1181 find_native_sibling_above (GdkWindow *parent,
1186 w = find_native_sibling_above_helper (parent, child);
1190 if (gdk_window_has_impl (parent))
1193 return find_native_sibling_above (parent->parent, parent);
1197 get_native_device_event_mask (GdkWindow *private,
1200 GdkEventMask event_mask;
1203 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (private->device_events, device));
1205 event_mask = private->event_mask;
1207 if (private->window_type == GDK_WINDOW_ROOT ||
1208 private->window_type == GDK_WINDOW_FOREIGN)
1214 /* Do whatever the app asks to, since the app
1215 * may be asking for weird things for native windows,
1216 * but don't use motion hints as that may affect non-native
1217 * child windows that don't want it. Also, we need to
1218 * set all the app-specified masks since they will be picked
1219 * up by any implicit grabs (i.e. if they were not set as
1220 * native we would not get the events we need). */
1221 mask = private->event_mask & ~GDK_POINTER_MOTION_HINT_MASK;
1223 /* We need thse for all native windows so we can
1224 emulate events on children: */
1227 GDK_VISIBILITY_NOTIFY_MASK |
1228 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK;
1230 /* Additionally we select for pointer and button events
1231 * for toplevels as we need to get these to emulate
1232 * them for non-native subwindows. Even though we don't
1233 * select on them for all native windows we will get them
1234 * as the events are propagated out to the first window
1235 * that select for them.
1236 * Not selecting for button press on all windows is an
1237 * important thing, because in X only one client can do
1238 * so, and we don't want to unexpectedly prevent another
1239 * client from doing it.
1241 * We also need to do the same if the app selects for button presses
1242 * because then we will get implicit grabs for this window, and the
1243 * event mask used for that grab is based on the rest of the mask
1244 * for the window, but we might need more events than this window
1245 * lists due to some non-native child window.
1247 if (gdk_window_is_toplevel (private) ||
1248 mask & GDK_BUTTON_PRESS_MASK)
1250 GDK_POINTER_MOTION_MASK |
1251 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1259 get_native_grab_event_mask (GdkEventMask grab_mask)
1261 /* Similar to the above but for pointer events only */
1263 GDK_POINTER_MOTION_MASK |
1264 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1265 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1268 ~GDK_POINTER_MOTION_HINT_MASK);
1272 get_native_event_mask (GdkWindow *private)
1274 return get_native_device_event_mask (private, NULL);
1277 /* Puts the native window in the right order wrt the other native windows
1278 * in the hierarchy, given the position it has in the client side data.
1279 * This is useful if some operation changed the stacking order.
1280 * This calls assumes the native window is now topmost in its native parent.
1283 sync_native_window_stack_position (GdkWindow *window)
1286 GdkWindowImplClass *impl_class;
1287 GList listhead = {0};
1289 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1291 above = find_native_sibling_above (window->parent, window);
1294 listhead.data = window;
1295 impl_class->restack_under (above, &listhead);
1300 * gdk_window_new: (constructor)
1301 * @parent: (allow-none): a #GdkWindow, or %NULL to create the window as a child of
1302 * the default root window for the default display.
1303 * @attributes: attributes of the new window
1304 * @attributes_mask: mask indicating which fields in @attributes are valid
1306 * Creates a new #GdkWindow using the attributes from
1307 * @attributes. See #GdkWindowAttr and #GdkWindowAttributesType for
1308 * more details. Note: to use this on displays other than the default
1309 * display, @parent must be specified.
1311 * Return value: (transfer full): the new #GdkWindow
1314 gdk_window_new (GdkWindow *parent,
1315 GdkWindowAttr *attributes,
1316 gint attributes_mask)
1320 GdkDisplay *display;
1323 GdkEventMask event_mask;
1324 GdkWindow *real_parent;
1325 GdkDeviceManager *device_manager;
1327 g_return_val_if_fail (attributes != NULL, NULL);
1331 GDK_NOTE (MULTIHEAD,
1332 g_warning ("gdk_window_new(): no parent specified reverting to parent = default root window"));
1334 screen = gdk_screen_get_default ();
1335 parent = gdk_screen_get_root_window (screen);
1338 screen = gdk_window_get_screen (parent);
1340 g_return_val_if_fail (GDK_IS_WINDOW (parent), NULL);
1342 if (GDK_WINDOW_DESTROYED (parent))
1344 g_warning ("gdk_window_new(): parent is destroyed\n");
1348 display = gdk_screen_get_display (screen);
1350 window = _gdk_display_create_window (display);
1352 /* Windows with a foreign parent are treated as if they are children
1353 * of the root window, except for actual creation.
1355 real_parent = parent;
1356 if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_FOREIGN)
1357 parent = gdk_screen_get_root_window (screen);
1359 window->parent = parent;
1361 window->accept_focus = TRUE;
1362 window->focus_on_map = TRUE;
1364 if (attributes_mask & GDK_WA_X)
1369 if (attributes_mask & GDK_WA_Y)
1376 window->width = (attributes->width > 1) ? (attributes->width) : (1);
1377 window->height = (attributes->height > 1) ? (attributes->height) : (1);
1379 if (attributes->wclass == GDK_INPUT_ONLY)
1381 /* Backwards compatiblity - we've always ignored
1382 * attributes->window_type for input-only windows
1385 if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_ROOT)
1386 window->window_type = GDK_WINDOW_TEMP;
1388 window->window_type = GDK_WINDOW_CHILD;
1391 window->window_type = attributes->window_type;
1394 switch (window->window_type)
1396 case GDK_WINDOW_TOPLEVEL:
1397 case GDK_WINDOW_TEMP:
1398 case GDK_WINDOW_OFFSCREEN:
1399 if (GDK_WINDOW_TYPE (parent) != GDK_WINDOW_ROOT)
1400 g_warning (G_STRLOC "Toplevel windows must be created as children of\n"
1401 "of a window of type GDK_WINDOW_ROOT or GDK_WINDOW_FOREIGN");
1402 case GDK_WINDOW_CHILD:
1406 g_warning (G_STRLOC "cannot make windows of type %d", window->window_type);
1410 if (attributes_mask & GDK_WA_VISUAL)
1411 window->visual = attributes->visual;
1413 window->visual = gdk_screen_get_system_visual (screen);
1415 window->event_mask = attributes->event_mask;
1417 if (attributes->wclass == GDK_INPUT_OUTPUT)
1419 window->input_only = FALSE;
1420 window->depth = window->visual->depth;
1422 /* XXX: Cache this somehow? */
1423 window->background = cairo_pattern_create_rgba (0, 0, 0, 0);
1424 window->has_alpha_background = TRUE;
1429 window->input_only = TRUE;
1433 window->parent->children = g_list_prepend (window->parent->children, window);
1436 if (window->parent->window_type == GDK_WINDOW_ROOT)
1437 native = TRUE; /* Always use native windows for toplevels */
1438 else if (!window->input_only &&
1439 (attributes_mask & GDK_WA_VISUAL &&
1440 attributes->visual != gdk_window_get_visual (window->parent)))
1441 native = TRUE; /* InputOutput window with different visual than parent, needs native window */
1443 if (gdk_window_is_offscreen (window))
1445 _gdk_offscreen_window_new (window, attributes, attributes_mask);
1446 window->impl_window = window;
1450 event_mask = get_native_event_mask (window);
1452 /* Create the impl */
1453 _gdk_display_create_window_impl (display, window, real_parent, screen, event_mask, attributes, attributes_mask);
1454 window->impl_window = window;
1456 /* This will put the native window topmost in the native parent, which may
1457 * be wrong wrt other native windows in the non-native hierarchy, so restack */
1458 if (!_gdk_window_has_impl (real_parent))
1459 sync_native_window_stack_position (window);
1463 window->impl_window = g_object_ref (window->parent->impl_window);
1464 window->impl = g_object_ref (window->impl_window->impl);
1467 recompute_visible_regions (window, TRUE, FALSE);
1469 gdk_window_set_cursor (window, ((attributes_mask & GDK_WA_CURSOR) ?
1470 (attributes->cursor) :
1473 device_manager = gdk_display_get_device_manager (gdk_window_get_display (parent));
1474 g_signal_connect (device_manager, "device-removed",
1475 G_CALLBACK (device_removed_cb), window);
1481 is_parent_of (GdkWindow *parent,
1492 w = gdk_window_get_parent (w);
1499 change_impl (GdkWindow *private,
1500 GdkWindow *impl_window,
1505 GdkWindowImpl *old_impl;
1506 GdkWindow *old_impl_window;
1508 old_impl = private->impl;
1509 old_impl_window = private->impl_window;
1510 if (private != impl_window)
1511 private->impl_window = g_object_ref (impl_window);
1513 private->impl_window = private;
1514 private->impl = g_object_ref (new);
1515 if (old_impl_window != private)
1516 g_object_unref (old_impl_window);
1517 g_object_unref (old_impl);
1519 for (l = private->children; l != NULL; l = l->next)
1523 if (child->impl == old_impl)
1524 change_impl (child, impl_window, new);
1529 reparent_to_impl (GdkWindow *private)
1534 GdkWindowImplClass *impl_class;
1536 impl_class = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1538 /* Enumerate in reverse order so we get the right order for the native
1539 windows (first in childrens list is topmost, and reparent places on top) */
1540 for (l = g_list_last (private->children); l != NULL; l = l->prev)
1544 if (child->impl == private->impl)
1545 reparent_to_impl (child);
1548 show = impl_class->reparent ((GdkWindow *)child,
1549 (GdkWindow *)private,
1550 child->x, child->y);
1552 gdk_window_show_unraised ((GdkWindow *)child);
1559 * gdk_window_reparent:
1560 * @window: a #GdkWindow
1561 * @new_parent: new parent to move @window into
1562 * @x: X location inside the new parent
1563 * @y: Y location inside the new parent
1565 * Reparents @window into the given @new_parent. The window being
1566 * reparented will be unmapped as a side effect.
1570 gdk_window_reparent (GdkWindow *window,
1571 GdkWindow *new_parent,
1575 GdkWindow *old_parent;
1577 gboolean show, was_mapped, applied_clip_as_shape;
1578 gboolean do_reparent_to_impl;
1579 GdkEventMask old_native_event_mask;
1580 GdkWindowImplClass *impl_class;
1582 g_return_if_fail (GDK_IS_WINDOW (window));
1583 g_return_if_fail (new_parent == NULL || GDK_IS_WINDOW (new_parent));
1584 g_return_if_fail (GDK_WINDOW_TYPE (window) != GDK_WINDOW_ROOT);
1586 if (GDK_WINDOW_DESTROYED (window) ||
1587 (new_parent && GDK_WINDOW_DESTROYED (new_parent)))
1590 screen = gdk_window_get_screen (window);
1592 new_parent = gdk_screen_get_root_window (screen);
1594 /* No input-output children of input-only windows */
1595 if (new_parent->input_only && !window->input_only)
1598 /* Don't create loops in hierarchy */
1599 if (is_parent_of (window, new_parent))
1602 /* This might be wrong in the new parent, e.g. for non-native surfaces.
1603 To make sure we're ok, just wipe it. */
1604 gdk_window_drop_cairo_surface (window);
1606 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1607 old_parent = window->parent;
1609 was_mapped = GDK_WINDOW_IS_MAPPED (window);
1612 /* Reparenting to toplevel. Ensure we have a native window so this can work */
1613 if (new_parent->window_type == GDK_WINDOW_ROOT ||
1614 new_parent->window_type == GDK_WINDOW_FOREIGN)
1615 gdk_window_ensure_native (window);
1617 applied_clip_as_shape = should_apply_clip_as_shape (window);
1619 old_native_event_mask = 0;
1620 do_reparent_to_impl = FALSE;
1621 if (gdk_window_has_impl (window))
1623 old_native_event_mask = get_native_event_mask (window);
1625 show = impl_class->reparent (window, new_parent, x, y);
1629 /* This shouldn't happen, as we created a native in this case, check anyway to see if that ever fails */
1630 g_assert (new_parent->window_type != GDK_WINDOW_ROOT &&
1631 new_parent->window_type != GDK_WINDOW_FOREIGN);
1634 gdk_window_hide (window);
1636 do_reparent_to_impl = TRUE;
1637 change_impl (window,
1638 new_parent->impl_window,
1642 /* From here on, we treat parents of type GDK_WINDOW_FOREIGN like
1645 if (GDK_WINDOW_TYPE (new_parent) == GDK_WINDOW_FOREIGN)
1647 new_parent = gdk_screen_get_root_window (screen);
1651 old_parent->children = g_list_remove (old_parent->children, window);
1653 window->parent = new_parent;
1657 new_parent->children = g_list_prepend (new_parent->children, window);
1659 /* Switch the window type as appropriate */
1661 switch (GDK_WINDOW_TYPE (new_parent))
1663 case GDK_WINDOW_ROOT:
1664 case GDK_WINDOW_FOREIGN:
1665 if (window->toplevel_window_type != -1)
1666 GDK_WINDOW_TYPE (window) = window->toplevel_window_type;
1667 else if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_CHILD)
1668 GDK_WINDOW_TYPE (window) = GDK_WINDOW_TOPLEVEL;
1670 case GDK_WINDOW_OFFSCREEN:
1671 case GDK_WINDOW_TOPLEVEL:
1672 case GDK_WINDOW_CHILD:
1673 case GDK_WINDOW_TEMP:
1674 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_CHILD && \
1675 GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
1677 /* Save the original window type so we can restore it if the
1678 * window is reparented back to be a toplevel
1680 window->toplevel_window_type = GDK_WINDOW_TYPE (window);
1681 GDK_WINDOW_TYPE (window) = GDK_WINDOW_CHILD;
1685 /* We might have changed window type for a native windows, so we
1686 need to change the event mask too. */
1687 if (gdk_window_has_impl (window))
1689 GdkEventMask native_event_mask = get_native_event_mask (window);
1691 if (native_event_mask != old_native_event_mask)
1692 impl_class->set_events (window, native_event_mask);
1695 _gdk_window_update_viewable (window);
1697 if (window->background == NULL)
1699 /* parent relative background, update has_alpha_background */
1700 if (window->parent == NULL ||
1701 window->parent->window_type == GDK_WINDOW_ROOT)
1702 window->has_alpha_background = FALSE;
1704 window->has_alpha_background = window->parent->has_alpha_background;
1707 recompute_visible_regions (window, TRUE, FALSE);
1708 if (old_parent && GDK_WINDOW_TYPE (old_parent) != GDK_WINDOW_ROOT)
1709 recompute_visible_regions (old_parent, FALSE, TRUE);
1711 _gdk_window_propagate_has_alpha_background (window);
1713 /* We used to apply the clip as the shape, but no more.
1714 Reset this to the real shape */
1715 if (gdk_window_has_impl (window) &&
1716 applied_clip_as_shape &&
1717 !should_apply_clip_as_shape (window))
1718 apply_shape (window, window->shape);
1720 if (do_reparent_to_impl)
1721 reparent_to_impl (window);
1724 /* The reparent will have put the native window topmost in the native parent,
1725 * which may be wrong wrt other native windows in the non-native hierarchy,
1727 if (!gdk_window_has_impl (new_parent))
1728 sync_native_window_stack_position (window);
1732 gdk_window_show_unraised (window);
1734 _gdk_synthesize_crossing_events_for_geometry_change (window);
1738 * gdk_window_ensure_native:
1739 * @window: a #GdkWindow
1741 * Tries to ensure that there is a window-system native window for this
1742 * GdkWindow. This may fail in some situations, returning %FALSE.
1744 * Offscreen window and children of them can never have native windows.
1746 * Some backends may not support native child windows.
1748 * Returns: %TRUE if the window has a native window, %FALSE otherwise
1753 gdk_window_ensure_native (GdkWindow *window)
1755 GdkWindow *impl_window;
1756 GdkWindowImpl *new_impl, *old_impl;
1757 GdkDisplay *display;
1761 GdkWindowImplClass *impl_class;
1763 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
1765 if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_ROOT ||
1766 GDK_WINDOW_DESTROYED (window))
1769 impl_window = gdk_window_get_impl_window (window);
1771 if (gdk_window_is_offscreen (impl_window))
1772 return FALSE; /* native in offscreens not supported */
1774 if (impl_window == window)
1775 /* Already has an impl, and its not offscreen . */
1778 /* Need to create a native window */
1780 gdk_window_drop_cairo_surface (window);
1782 screen = gdk_window_get_screen (window);
1783 display = gdk_screen_get_display (screen);
1785 old_impl = window->impl;
1786 _gdk_display_create_window_impl (display,
1787 window, window->parent,
1789 get_native_event_mask (window),
1791 new_impl = window->impl;
1793 window->impl = old_impl;
1794 change_impl (window, window, new_impl);
1796 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1798 /* Native window creation will put the native window topmost in the
1799 * native parent, which may be wrong wrt the position of the previous
1800 * non-native window wrt to the other non-native children, so correct this.
1802 above = find_native_sibling_above (window->parent, window);
1805 listhead.data = window;
1806 listhead.prev = NULL;
1807 listhead.next = NULL;
1808 impl_class->restack_under ((GdkWindow *)above, &listhead);
1811 recompute_visible_regions (window, FALSE, FALSE);
1813 /* The shape may not have been set, as the clip region doesn't actually
1814 change, so do it here manually */
1815 if (should_apply_clip_as_shape (window))
1816 apply_clip_as_shape (window);
1818 reparent_to_impl (window);
1820 if (!window->input_only)
1821 impl_class->set_background (window, window->background);
1823 impl_class->input_shape_combine_region (window,
1824 window->input_shape,
1827 if (gdk_window_is_viewable (window))
1828 impl_class->show (window, FALSE);
1834 * _gdk_event_filter_unref:
1835 * @window: (allow-none): A #GdkWindow, or %NULL to be the global window
1836 * @filter: A window filter
1838 * Release a reference to @filter. Note this function may
1839 * mutate the list storage, so you need to handle this
1840 * if iterating over a list of filters.
1843 _gdk_event_filter_unref (GdkWindow *window,
1844 GdkEventFilter *filter)
1850 filters = &_gdk_default_filters;
1852 filters = &window->filters;
1854 tmp_list = *filters;
1857 GdkEventFilter *iter_filter = tmp_list->data;
1861 tmp_list = tmp_list->next;
1863 if (iter_filter != filter)
1866 g_assert (iter_filter->ref_count > 0);
1868 filter->ref_count--;
1869 if (filter->ref_count != 0)
1872 *filters = g_list_remove_link (*filters, node);
1874 g_list_free_1 (node);
1879 window_remove_filters (GdkWindow *window)
1881 while (window->filters)
1882 _gdk_event_filter_unref (window, window->filters->data);
1886 update_pointer_info_foreach (GdkDisplay *display,
1888 GdkPointerWindowInfo *pointer_info,
1891 GdkWindow *window = user_data;
1893 if (pointer_info->toplevel_under_pointer == window)
1895 g_object_unref (pointer_info->toplevel_under_pointer);
1896 pointer_info->toplevel_under_pointer = NULL;
1901 window_remove_from_pointer_info (GdkWindow *window,
1902 GdkDisplay *display)
1904 _gdk_display_pointer_info_foreach (display,
1905 update_pointer_info_foreach,
1910 * _gdk_window_destroy_hierarchy:
1911 * @window: a #GdkWindow
1912 * @recursing: If TRUE, then this is being called because a parent
1914 * @recursing_native: If TRUE, then this is being called because a native parent
1915 * was destroyed. This generally means that the call to the
1916 * windowing system to destroy the window can be omitted, since
1917 * it will be destroyed as a result of the parent being destroyed.
1918 * Unless @foreign_destroy.
1919 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
1920 * external agency. The window has already been destroyed and no
1921 * windowing system calls should be made. (This may never happen
1922 * for some windowing systems.)
1924 * Internal function to destroy a window. Like gdk_window_destroy(),
1925 * but does not drop the reference count created by gdk_window_new().
1928 _gdk_window_destroy_hierarchy (GdkWindow *window,
1930 gboolean recursing_native,
1931 gboolean foreign_destroy)
1933 GdkWindowImplClass *impl_class;
1934 GdkWindow *temp_window;
1936 GdkDisplay *display;
1940 g_return_if_fail (GDK_IS_WINDOW (window));
1942 if (GDK_WINDOW_DESTROYED (window))
1945 display = gdk_window_get_display (window);
1946 screen = gdk_window_get_screen (window);
1947 temp_window = g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
1948 if (temp_window == window)
1949 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window, NULL);
1952 switch (window->window_type)
1954 case GDK_WINDOW_ROOT:
1955 if (!screen->closed)
1957 g_error ("attempted to destroy root window");
1960 /* else fall thru */
1961 case GDK_WINDOW_TOPLEVEL:
1962 case GDK_WINDOW_CHILD:
1963 case GDK_WINDOW_TEMP:
1964 case GDK_WINDOW_FOREIGN:
1965 case GDK_WINDOW_OFFSCREEN:
1966 if (window->window_type == GDK_WINDOW_FOREIGN && !foreign_destroy)
1968 /* Logically, it probably makes more sense to send
1969 * a "destroy yourself" message to the foreign window
1970 * whether or not it's in our hierarchy; but for historical
1971 * reasons, we only send "destroy yourself" messages to
1972 * foreign windows in our hierarchy.
1976 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1978 if (gdk_window_has_impl (window))
1979 impl_class->destroy_foreign (window);
1982 /* Also for historical reasons, we remove any filters
1983 * on a foreign window when it or a parent is destroyed;
1984 * this likely causes problems if two separate portions
1985 * of code are maintaining filter lists on a foreign window.
1987 window_remove_filters (window);
1993 if (window->parent->children)
1994 window->parent->children = g_list_remove (window->parent->children, window);
1997 GDK_WINDOW_IS_MAPPED (window))
1999 recompute_visible_regions (window, TRUE, FALSE);
2000 gdk_window_invalidate_in_parent (window);
2004 gdk_window_free_paint_stack (window);
2006 if (window->background)
2008 cairo_pattern_destroy (window->background);
2009 window->background = NULL;
2012 if (window->window_type == GDK_WINDOW_FOREIGN)
2013 g_assert (window->children == NULL);
2016 children = tmp = window->children;
2017 window->children = NULL;
2021 temp_window = tmp->data;
2025 _gdk_window_destroy_hierarchy (temp_window,
2027 recursing_native || gdk_window_has_impl (window),
2031 g_list_free (children);
2034 _gdk_window_clear_update_area (window);
2036 gdk_window_drop_cairo_surface (window);
2038 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
2040 if (gdk_window_has_impl (window))
2041 impl_class->destroy (window, recursing_native,
2045 /* hide to make sure we repaint and break grabs */
2046 gdk_window_hide (window);
2049 window->state |= GDK_WINDOW_STATE_WITHDRAWN;
2050 window->parent = NULL;
2051 window->destroyed = TRUE;
2053 window_remove_filters (window);
2055 window_remove_from_pointer_info (window, display);
2057 if (window->clip_region)
2059 cairo_region_destroy (window->clip_region);
2060 window->clip_region = NULL;
2063 if (window->clip_region_with_children)
2065 cairo_region_destroy (window->clip_region_with_children);
2066 window->clip_region_with_children = NULL;
2069 g_list_free_full (window->outstanding_moves, (GDestroyNotify) gdk_window_region_move_free);
2070 window->outstanding_moves = NULL;
2077 * _gdk_window_destroy:
2078 * @window: a #GdkWindow
2079 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
2080 * external agency. The window has already been destroyed and no
2081 * windowing system calls should be made. (This may never happen
2082 * for some windowing systems.)
2084 * Internal function to destroy a window. Like gdk_window_destroy(),
2085 * but does not drop the reference count created by gdk_window_new().
2088 _gdk_window_destroy (GdkWindow *window,
2089 gboolean foreign_destroy)
2091 _gdk_window_destroy_hierarchy (window, FALSE, FALSE, foreign_destroy);
2095 * gdk_window_destroy:
2096 * @window: a #GdkWindow
2098 * Destroys the window system resources associated with @window and decrements @window's
2099 * reference count. The window system resources for all children of @window are also
2100 * destroyed, but the children's reference counts are not decremented.
2102 * Note that a window will not be destroyed automatically when its reference count
2103 * reaches zero. You must call this function yourself before that happens.
2107 gdk_window_destroy (GdkWindow *window)
2109 _gdk_window_destroy_hierarchy (window, FALSE, FALSE, FALSE);
2110 g_object_unref (window);
2114 * gdk_window_set_user_data:
2115 * @window: a #GdkWindow
2116 * @user_data: (allow-none) (type GObject.Object): user data
2118 * For most purposes this function is deprecated in favor of
2119 * g_object_set_data(). However, for historical reasons GTK+ stores
2120 * the #GtkWidget that owns a #GdkWindow as user data on the
2121 * #GdkWindow. So, custom widget implementations should use
2122 * this function for that. If GTK+ receives an event for a #GdkWindow,
2123 * and the user data for the window is non-%NULL, GTK+ will assume the
2124 * user data is a #GtkWidget, and forward the event to that widget.
2128 gdk_window_set_user_data (GdkWindow *window,
2131 g_return_if_fail (GDK_IS_WINDOW (window));
2133 window->user_data = user_data;
2137 * gdk_window_get_user_data:
2138 * @window: a #GdkWindow
2139 * @data: (out): return location for user data
2141 * Retrieves the user data for @window, which is normally the widget
2142 * that @window belongs to. See gdk_window_set_user_data().
2146 gdk_window_get_user_data (GdkWindow *window,
2149 g_return_if_fail (GDK_IS_WINDOW (window));
2151 *data = window->user_data;
2155 * gdk_window_get_window_type:
2156 * @window: a #GdkWindow
2158 * Gets the type of the window. See #GdkWindowType.
2160 * Return value: type of window
2163 gdk_window_get_window_type (GdkWindow *window)
2165 g_return_val_if_fail (GDK_IS_WINDOW (window), (GdkWindowType) -1);
2167 return GDK_WINDOW_TYPE (window);
2171 * gdk_window_get_visual:
2172 * @window: a #GdkWindow
2174 * Gets the #GdkVisual describing the pixel format of @window.
2176 * Return value: (transfer none): a #GdkVisual
2181 gdk_window_get_visual (GdkWindow *window)
2183 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2185 return window->visual;
2189 * gdk_window_get_screen:
2190 * @window: a #GdkWindow
2192 * Gets the #GdkScreen associated with a #GdkWindow.
2194 * Return value: (transfer none): the #GdkScreen associated with @window
2199 gdk_window_get_screen (GdkWindow *window)
2201 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2203 return gdk_visual_get_screen (window->visual);
2207 * gdk_window_get_display:
2208 * @window: a #GdkWindow
2210 * Gets the #GdkDisplay associated with a #GdkWindow.
2212 * Return value: (transfer none): the #GdkDisplay associated with @window
2217 gdk_window_get_display (GdkWindow *window)
2219 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2221 return gdk_screen_get_display (gdk_visual_get_screen (window->visual));
2224 * gdk_window_is_destroyed:
2225 * @window: a #GdkWindow
2227 * Check to see if a window is destroyed..
2229 * Return value: %TRUE if the window is destroyed
2234 gdk_window_is_destroyed (GdkWindow *window)
2236 return GDK_WINDOW_DESTROYED (window);
2240 to_embedder (GdkWindow *window,
2241 gdouble offscreen_x,
2242 gdouble offscreen_y,
2243 gdouble *embedder_x,
2244 gdouble *embedder_y)
2246 g_signal_emit (window, signals[TO_EMBEDDER], 0,
2247 offscreen_x, offscreen_y,
2248 embedder_x, embedder_y);
2252 from_embedder (GdkWindow *window,
2255 gdouble *offscreen_x,
2256 gdouble *offscreen_y)
2258 g_signal_emit (window, signals[FROM_EMBEDDER], 0,
2259 embedder_x, embedder_y,
2260 offscreen_x, offscreen_y);
2264 * gdk_window_has_native:
2265 * @window: a #GdkWindow
2267 * Checks whether the window has a native window or not. Note that
2268 * you can use gdk_window_ensure_native() if a native window is needed.
2270 * Returns: %TRUE if the %window has a native window, %FALSE otherwise.
2275 gdk_window_has_native (GdkWindow *window)
2277 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2279 return window->parent == NULL || window->parent->impl != window->impl;
2283 * gdk_window_get_position:
2284 * @window: a #GdkWindow
2285 * @x: (out) (allow-none): X coordinate of window
2286 * @y: (out) (allow-none): Y coordinate of window
2288 * Obtains the position of the window as reported in the
2289 * most-recently-processed #GdkEventConfigure. Contrast with
2290 * gdk_window_get_geometry() which queries the X server for the
2291 * current window position, regardless of which events have been
2292 * received or processed.
2294 * The position coordinates are relative to the window's parent window.
2298 gdk_window_get_position (GdkWindow *window,
2302 g_return_if_fail (GDK_IS_WINDOW (window));
2311 * gdk_window_get_parent:
2312 * @window: a #GdkWindow
2314 * Obtains the parent of @window, as known to GDK. Does not query the
2315 * X server; thus this returns the parent as passed to gdk_window_new(),
2316 * not the actual parent. This should never matter unless you're using
2317 * Xlib calls mixed with GDK calls on the X11 platform. It may also
2318 * matter for toplevel windows, because the window manager may choose
2321 * Note that you should use gdk_window_get_effective_parent() when
2322 * writing generic code that walks up a window hierarchy, because
2323 * gdk_window_get_parent() will most likely not do what you expect if
2324 * there are offscreen windows in the hierarchy.
2326 * Return value: (transfer none): parent of @window
2329 gdk_window_get_parent (GdkWindow *window)
2331 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2333 return window->parent;
2337 * gdk_window_get_effective_parent:
2338 * @window: a #GdkWindow
2340 * Obtains the parent of @window, as known to GDK. Works like
2341 * gdk_window_get_parent() for normal windows, but returns the
2342 * window's embedder for offscreen windows.
2344 * See also: gdk_offscreen_window_get_embedder()
2346 * Return value: (transfer none): effective parent of @window
2351 gdk_window_get_effective_parent (GdkWindow *window)
2353 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2355 if (gdk_window_is_offscreen (window))
2356 return gdk_offscreen_window_get_embedder (window);
2358 return window->parent;
2362 * gdk_window_get_toplevel:
2363 * @window: a #GdkWindow
2365 * Gets the toplevel window that's an ancestor of @window.
2367 * Any window type but %GDK_WINDOW_CHILD is considered a
2368 * toplevel window, as is a %GDK_WINDOW_CHILD window that
2369 * has a root window as parent.
2371 * Note that you should use gdk_window_get_effective_toplevel() when
2372 * you want to get to a window's toplevel as seen on screen, because
2373 * gdk_window_get_toplevel() will most likely not do what you expect
2374 * if there are offscreen windows in the hierarchy.
2376 * Return value: (transfer none): the toplevel window containing @window
2379 gdk_window_get_toplevel (GdkWindow *window)
2381 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2383 while (window->window_type == GDK_WINDOW_CHILD)
2385 if (gdk_window_is_toplevel (window))
2387 window = window->parent;
2394 * gdk_window_get_effective_toplevel:
2395 * @window: a #GdkWindow
2397 * Gets the toplevel window that's an ancestor of @window.
2399 * Works like gdk_window_get_toplevel(), but treats an offscreen window's
2400 * embedder as its parent, using gdk_window_get_effective_parent().
2402 * See also: gdk_offscreen_window_get_embedder()
2404 * Return value: (transfer none): the effective toplevel window containing @window
2409 gdk_window_get_effective_toplevel (GdkWindow *window)
2413 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2415 while ((parent = gdk_window_get_effective_parent (window)) != NULL &&
2416 (gdk_window_get_window_type (parent) != GDK_WINDOW_ROOT))
2423 * gdk_window_get_children:
2424 * @window: a #GdkWindow
2426 * Gets the list of children of @window known to GDK.
2427 * This function only returns children created via GDK,
2428 * so for example it's useless when used with the root window;
2429 * it only returns windows an application created itself.
2431 * The returned list must be freed, but the elements in the
2434 * Return value: (transfer container) (element-type GdkWindow):
2435 * list of child windows inside @window
2438 gdk_window_get_children (GdkWindow *window)
2440 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2442 if (GDK_WINDOW_DESTROYED (window))
2445 return g_list_copy (window->children);
2449 * gdk_window_peek_children:
2450 * @window: a #GdkWindow
2452 * Like gdk_window_get_children(), but does not copy the list of
2453 * children, so the list does not need to be freed.
2455 * Return value: (transfer none) (element-type GdkWindow):
2456 * a reference to the list of child windows in @window
2459 gdk_window_peek_children (GdkWindow *window)
2461 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2463 if (GDK_WINDOW_DESTROYED (window))
2466 return window->children;
2470 * gdk_window_add_filter: (skip)
2471 * @window: (allow-none): a #GdkWindow
2472 * @function: filter callback
2473 * @data: data to pass to filter callback
2475 * Adds an event filter to @window, allowing you to intercept events
2476 * before they reach GDK. This is a low-level operation and makes it
2477 * easy to break GDK and/or GTK+, so you have to know what you're
2478 * doing. Pass %NULL for @window to get all events for all windows,
2479 * instead of events for a specific window.
2481 * If you are interested in X GenericEvents, bear in mind that
2482 * XGetEventData() has been already called on the event, and
2483 * XFreeEventData() must not be called within @function.
2486 gdk_window_add_filter (GdkWindow *window,
2487 GdkFilterFunc function,
2491 GdkEventFilter *filter;
2493 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2495 if (window && GDK_WINDOW_DESTROYED (window))
2498 /* Filters are for the native events on the native window, so
2499 ensure there is a native window. */
2501 gdk_window_ensure_native (window);
2504 tmp_list = window->filters;
2506 tmp_list = _gdk_default_filters;
2510 filter = (GdkEventFilter *)tmp_list->data;
2511 if ((filter->function == function) && (filter->data == data))
2513 filter->ref_count++;
2516 tmp_list = tmp_list->next;
2519 filter = g_new (GdkEventFilter, 1);
2520 filter->function = function;
2521 filter->data = data;
2522 filter->ref_count = 1;
2526 window->filters = g_list_append (window->filters, filter);
2528 _gdk_default_filters = g_list_append (_gdk_default_filters, filter);
2532 * gdk_window_remove_filter: (skip)
2533 * @window: a #GdkWindow
2534 * @function: previously-added filter function
2535 * @data: user data for previously-added filter function
2537 * Remove a filter previously added with gdk_window_add_filter().
2540 gdk_window_remove_filter (GdkWindow *window,
2541 GdkFilterFunc function,
2545 GdkEventFilter *filter;
2547 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2550 tmp_list = window->filters;
2552 tmp_list = _gdk_default_filters;
2556 filter = (GdkEventFilter *)tmp_list->data;
2557 tmp_list = tmp_list->next;
2559 if ((filter->function == function) && (filter->data == data))
2561 filter->flags |= GDK_EVENT_FILTER_REMOVED;
2563 _gdk_event_filter_unref (window, filter);
2571 * gdk_screen_get_toplevel_windows:
2572 * @screen: The #GdkScreen where the toplevels are located.
2574 * Obtains a list of all toplevel windows known to GDK on the screen @screen.
2575 * A toplevel window is a child of the root window (see
2576 * gdk_get_default_root_window()).
2578 * The returned list should be freed with g_list_free(), but
2579 * its elements need not be freed.
2581 * Return value: (transfer container) (element-type GdkWindow):
2582 * list of toplevel windows, free with g_list_free()
2587 gdk_screen_get_toplevel_windows (GdkScreen *screen)
2589 GdkWindow * root_window;
2590 GList *new_list = NULL;
2593 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
2595 root_window = gdk_screen_get_root_window (screen);
2597 tmp_list = root_window->children;
2600 GdkWindow *w = tmp_list->data;
2602 if (w->window_type != GDK_WINDOW_FOREIGN)
2603 new_list = g_list_prepend (new_list, w);
2604 tmp_list = tmp_list->next;
2611 * gdk_window_is_visible:
2612 * @window: a #GdkWindow
2614 * Checks whether the window has been mapped (with gdk_window_show() or
2615 * gdk_window_show_unraised()).
2617 * Return value: %TRUE if the window is mapped
2620 gdk_window_is_visible (GdkWindow *window)
2622 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2624 return GDK_WINDOW_IS_MAPPED (window);
2628 * gdk_window_is_viewable:
2629 * @window: a #GdkWindow
2631 * Check if the window and all ancestors of the window are
2632 * mapped. (This is not necessarily "viewable" in the X sense, since
2633 * we only check as far as we have GDK window parents, not to the root
2636 * Return value: %TRUE if the window is viewable
2639 gdk_window_is_viewable (GdkWindow *window)
2641 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2643 if (window->destroyed)
2646 return window->viewable;
2650 * gdk_window_get_state:
2651 * @window: a #GdkWindow
2653 * Gets the bitwise OR of the currently active window state flags,
2654 * from the #GdkWindowState enumeration.
2656 * Return value: window state bitfield
2659 gdk_window_get_state (GdkWindow *window)
2661 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2663 return window->state;
2666 static cairo_content_t
2667 gdk_window_get_content (GdkWindow *window)
2669 cairo_surface_t *surface;
2670 cairo_content_t content;
2672 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
2674 surface = _gdk_window_ref_cairo_surface (window);
2675 content = cairo_surface_get_content (surface);
2676 cairo_surface_destroy (surface);
2681 /* This creates an empty "implicit" paint region for the impl window.
2682 * By itself this does nothing, but real paints to this window
2683 * or children of it can use this surface as backing to avoid allocating
2684 * multiple surfaces for subwindow rendering. When doing so they
2685 * add to the region of the implicit paint region, which will be
2686 * pushed to the window when the implicit paint region is ended.
2687 * Such paints should not copy anything to the window on paint end, but
2688 * should rely on the implicit paint end.
2689 * The implicit paint will be automatically ended if someone draws
2690 * directly to the window or a child window.
2693 gdk_window_begin_implicit_paint (GdkWindow *window, GdkRectangle *rect)
2695 GdkWindowPaint *paint;
2697 g_assert (gdk_window_has_impl (window));
2699 if (GDK_IS_PAINTABLE (window->impl))
2700 return FALSE; /* Implementation does double buffering */
2702 if (window->paint_stack != NULL ||
2703 window->implicit_paint != NULL)
2704 return FALSE; /* Don't stack implicit paints */
2706 /* Never do implicit paints for foreign windows, they don't need
2707 * double buffer combination since they have no client side children,
2708 * and creating surfaces for them is risky since they could disappear
2711 if (window->window_type == GDK_WINDOW_FOREIGN)
2714 paint = g_new (GdkWindowPaint, 1);
2715 paint->region = cairo_region_create (); /* Empty */
2716 paint->uses_implicit = FALSE;
2717 paint->flushed = FALSE;
2718 paint->surface = gdk_window_create_similar_surface (window,
2719 gdk_window_get_content (window),
2720 MAX (rect->width, 1),
2721 MAX (rect->height, 1));
2722 cairo_surface_set_device_offset (paint->surface, -rect->x, -rect->y);
2724 window->implicit_paint = paint;
2729 static cairo_surface_t *
2730 gdk_window_ref_impl_surface (GdkWindow *window)
2732 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->ref_cairo_surface (gdk_window_get_impl_window (window));
2736 gdk_cairo_create_for_impl (GdkWindow *window)
2738 cairo_surface_t *surface;
2741 surface = gdk_window_ref_impl_surface (window);
2742 cr = cairo_create (surface);
2744 cairo_surface_destroy (surface);
2749 /* Ensure that all content related to this (sub)window is pushed to the
2750 native region. If there is an active paint then that area is not
2751 pushed, in order to not show partially finished double buffers. */
2753 gdk_window_flush_implicit_paint (GdkWindow *window)
2755 GdkWindow *impl_window;
2756 GdkWindowPaint *paint;
2757 cairo_region_t *region;
2760 impl_window = gdk_window_get_impl_window (window);
2761 if (impl_window->implicit_paint == NULL)
2764 paint = impl_window->implicit_paint;
2765 paint->flushed = TRUE;
2766 region = cairo_region_copy (window->clip_region_with_children);
2768 cairo_region_translate (region, window->abs_x, window->abs_y);
2769 cairo_region_intersect (region, paint->region);
2771 /* Don't flush active double buffers, as that may show partially done
2773 for (list = window->paint_stack; list != NULL; list = list->next)
2775 GdkWindowPaint *tmp_paint = list->data;
2777 cairo_region_subtract (region, tmp_paint->region);
2780 if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (region))
2784 /* Remove flushed region from the implicit paint */
2785 cairo_region_subtract (paint->region, region);
2787 /* Some regions are valid, push these to window now */
2788 cr = gdk_cairo_create_for_impl (window);
2789 gdk_cairo_region (cr, region);
2791 cairo_set_source_surface (cr, paint->surface, 0, 0);
2792 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2797 cairo_region_destroy (region);
2800 /* Ends an implicit paint, paired with gdk_window_begin_implicit_paint returning TRUE */
2802 gdk_window_end_implicit_paint (GdkWindow *window)
2804 GdkWindowPaint *paint;
2806 g_assert (gdk_window_has_impl (window));
2808 g_assert (window->implicit_paint != NULL);
2810 paint = window->implicit_paint;
2812 window->implicit_paint = NULL;
2814 if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (paint->region))
2818 /* Some regions are valid, push these to window now */
2819 cr = gdk_cairo_create_for_impl (window);
2820 gdk_cairo_region (cr, paint->region);
2822 cairo_set_source_surface (cr, paint->surface, 0, 0);
2823 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2828 cairo_region_destroy (paint->region);
2830 cairo_surface_destroy (paint->surface);
2835 * gdk_window_begin_paint_rect:
2836 * @window: a #GdkWindow
2837 * @rectangle: rectangle you intend to draw to
2839 * A convenience wrapper around gdk_window_begin_paint_region() which
2840 * creates a rectangular region for you. See
2841 * gdk_window_begin_paint_region() for details.
2845 gdk_window_begin_paint_rect (GdkWindow *window,
2846 const GdkRectangle *rectangle)
2848 cairo_region_t *region;
2850 g_return_if_fail (GDK_IS_WINDOW (window));
2852 region = cairo_region_create_rectangle (rectangle);
2853 gdk_window_begin_paint_region (window, region);
2854 cairo_region_destroy (region);
2858 * gdk_window_begin_paint_region:
2859 * @window: a #GdkWindow
2860 * @region: region you intend to draw to
2862 * Indicates that you are beginning the process of redrawing @region.
2863 * A backing store (offscreen buffer) large enough to contain @region
2864 * will be created. The backing store will be initialized with the
2865 * background color or background surface for @window. Then, all
2866 * drawing operations performed on @window will be diverted to the
2867 * backing store. When you call gdk_window_end_paint(), the backing
2868 * store will be copied to @window, making it visible onscreen. Only
2869 * the part of @window contained in @region will be modified; that is,
2870 * drawing operations are clipped to @region.
2872 * The net result of all this is to remove flicker, because the user
2873 * sees the finished product appear all at once when you call
2874 * gdk_window_end_paint(). If you draw to @window directly without
2875 * calling gdk_window_begin_paint_region(), the user may see flicker
2876 * as individual drawing operations are performed in sequence. The
2877 * clipping and background-initializing features of
2878 * gdk_window_begin_paint_region() are conveniences for the
2879 * programmer, so you can avoid doing that work yourself.
2881 * When using GTK+, the widget system automatically places calls to
2882 * gdk_window_begin_paint_region() and gdk_window_end_paint() around
2883 * emissions of the expose_event signal. That is, if you're writing an
2884 * expose event handler, you can assume that the exposed area in
2885 * #GdkEventExpose has already been cleared to the window background,
2886 * is already set as the clip region, and already has a backing store.
2887 * Therefore in most cases, application code need not call
2888 * gdk_window_begin_paint_region(). (You can disable the automatic
2889 * calls around expose events on a widget-by-widget basis by calling
2890 * gtk_widget_set_double_buffered().)
2892 * If you call this function multiple times before calling the
2893 * matching gdk_window_end_paint(), the backing stores are pushed onto
2894 * a stack. gdk_window_end_paint() copies the topmost backing store
2895 * onscreen, subtracts the topmost region from all other regions in
2896 * the stack, and pops the stack. All drawing operations affect only
2897 * the topmost backing store in the stack. One matching call to
2898 * gdk_window_end_paint() is required for each call to
2899 * gdk_window_begin_paint_region().
2903 gdk_window_begin_paint_region (GdkWindow *window,
2904 const cairo_region_t *region)
2906 #ifdef USE_BACKING_STORE
2907 GdkRectangle clip_box;
2908 GdkWindowPaint *paint, *implicit_paint;
2909 GdkWindow *impl_window;
2912 g_return_if_fail (GDK_IS_WINDOW (window));
2914 if (GDK_WINDOW_DESTROYED (window))
2917 if (GDK_IS_PAINTABLE (window->impl))
2919 GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
2921 if (iface->begin_paint_region)
2922 iface->begin_paint_region ((GdkPaintable*)window->impl, window, region);
2927 impl_window = gdk_window_get_impl_window (window);
2928 implicit_paint = impl_window->implicit_paint;
2930 paint = g_new (GdkWindowPaint, 1);
2931 paint->region = cairo_region_copy (region);
2933 cairo_region_intersect (paint->region, window->clip_region_with_children);
2934 cairo_region_get_extents (paint->region, &clip_box);
2936 cairo_region_translate (paint->region, window->abs_x, window->abs_y);
2938 /* Mark the region as valid on the implicit paint */
2941 cairo_region_union (implicit_paint->region, paint->region);
2943 /* Convert back to normal coords */
2944 cairo_region_translate (paint->region, -window->abs_x, -window->abs_y);
2948 paint->uses_implicit = TRUE;
2949 paint->surface = cairo_surface_create_for_rectangle (implicit_paint->surface,
2950 window->abs_x + clip_box.x,
2951 window->abs_y + clip_box.y,
2952 MAX (clip_box.width, 1),
2953 MAX (clip_box.height, 1));
2957 paint->uses_implicit = FALSE;
2958 paint->surface = gdk_window_create_similar_surface (window,
2959 gdk_window_get_content (window),
2960 MAX (clip_box.width, 1),
2961 MAX (clip_box.height, 1));
2964 /* Normally alpha backgrounded client side windows are composited on the implicit paint
2965 by being drawn in back to front order. However, if implicit paints are not used, for
2966 instance if it was flushed due to a non-double-buffered paint in the middle of the
2967 expose we need to copy in the existing data here. */
2968 if (!gdk_window_has_impl (window) &&
2969 window->has_alpha_background &&
2971 (implicit_paint && implicit_paint->flushed)))
2973 cairo_t *cr = cairo_create (paint->surface);
2974 /* We can't use gdk_cairo_set_source_window here, as that might
2975 flush the implicit paint at an unfortunate time, since this
2976 would be detected as a draw during non-expose time */
2977 cairo_surface_t *source_surface = gdk_window_ref_impl_surface (impl_window);
2978 cairo_set_source_surface (cr, source_surface,
2979 - (window->abs_x + clip_box.x),
2980 - (window->abs_y + clip_box.y));
2981 cairo_surface_destroy (source_surface);
2986 cairo_surface_set_device_offset (paint->surface, -clip_box.x, -clip_box.y);
2988 for (list = window->paint_stack; list != NULL; list = list->next)
2990 GdkWindowPaint *tmp_paint = list->data;
2992 cairo_region_subtract (tmp_paint->region, paint->region);
2995 window->paint_stack = g_slist_prepend (window->paint_stack, paint);
2997 if (!cairo_region_is_empty (paint->region))
2999 gdk_window_clear_backing_region (window,
3003 #endif /* USE_BACKING_STORE */
3007 * gdk_window_end_paint:
3008 * @window: a #GdkWindow
3010 * Indicates that the backing store created by the most recent call to
3011 * gdk_window_begin_paint_region() should be copied onscreen and
3012 * deleted, leaving the next-most-recent backing store or no backing
3013 * store at all as the active paint region. See
3014 * gdk_window_begin_paint_region() for full details. It is an error to
3015 * call this function without a matching
3016 * gdk_window_begin_paint_region() first.
3020 gdk_window_end_paint (GdkWindow *window)
3022 #ifdef USE_BACKING_STORE
3023 GdkWindow *composited;
3024 GdkWindowPaint *paint;
3025 GdkRectangle clip_box;
3026 cairo_region_t *full_clip;
3028 g_return_if_fail (GDK_IS_WINDOW (window));
3030 if (GDK_WINDOW_DESTROYED (window))
3033 if (GDK_IS_PAINTABLE (window->impl))
3035 GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
3037 if (iface->end_paint)
3038 iface->end_paint ((GdkPaintable*)window->impl);
3042 if (window->paint_stack == NULL)
3044 g_warning (G_STRLOC": no preceding call to gdk_window_begin_paint_region(), see documentation");
3048 paint = window->paint_stack->data;
3050 window->paint_stack = g_slist_delete_link (window->paint_stack,
3051 window->paint_stack);
3053 cairo_region_get_extents (paint->region, &clip_box);
3055 if (!paint->uses_implicit)
3059 gdk_window_flush_outstanding_moves (window);
3061 full_clip = cairo_region_copy (window->clip_region_with_children);
3062 cairo_region_intersect (full_clip, paint->region);
3064 cr = gdk_cairo_create (window);
3065 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
3066 cairo_set_source_surface (cr, paint->surface, 0, 0);
3067 gdk_cairo_region (cr, full_clip);
3071 cairo_region_destroy (full_clip);
3074 cairo_surface_destroy (paint->surface);
3075 cairo_region_destroy (paint->region);
3078 /* find a composited window in our hierarchy to signal its
3079 * parent to redraw, calculating the clip box as we go...
3081 * stop if parent becomes NULL since then we'd have nowhere
3082 * to draw (ie: 'composited' will always be non-NULL here).
3084 for (composited = window;
3086 composited = composited->parent)
3088 clip_box.x += composited->x;
3089 clip_box.y += composited->y;
3090 clip_box.width = MIN (clip_box.width, composited->parent->width - clip_box.x);
3091 clip_box.height = MIN (clip_box.height, composited->parent->height - clip_box.y);
3093 if (composited->composited)
3095 gdk_window_invalidate_rect (GDK_WINDOW (composited->parent),
3100 #endif /* USE_BACKING_STORE */
3104 gdk_window_free_paint_stack (GdkWindow *window)
3106 if (window->paint_stack)
3108 GSList *tmp_list = window->paint_stack;
3112 GdkWindowPaint *paint = tmp_list->data;
3114 if (tmp_list == window->paint_stack)
3115 cairo_surface_destroy (paint->surface);
3117 cairo_region_destroy (paint->region);
3120 tmp_list = tmp_list->next;
3123 g_slist_free (window->paint_stack);
3124 window->paint_stack = NULL;
3129 do_move_region_bits_on_impl (GdkWindow *impl_window,
3130 cairo_region_t *dest_region, /* In impl window coords */
3133 GdkWindowImplClass *impl_class;
3135 impl_class = GDK_WINDOW_IMPL_GET_CLASS (impl_window->impl);
3137 impl_class->translate (impl_window, dest_region, dx, dy);
3140 static GdkWindowRegionMove *
3141 gdk_window_region_move_new (cairo_region_t *region,
3144 GdkWindowRegionMove *move;
3146 move = g_slice_new (GdkWindowRegionMove);
3147 move->dest_region = cairo_region_copy (region);
3155 gdk_window_region_move_free (GdkWindowRegionMove *move)
3157 cairo_region_destroy (move->dest_region);
3158 g_slice_free (GdkWindowRegionMove, move);
3162 append_move_region (GdkWindow *impl_window,
3163 cairo_region_t *new_dest_region,
3166 GdkWindowRegionMove *move, *old_move;
3167 cairo_region_t *new_total_region, *old_total_region;
3168 cairo_region_t *source_overlaps_destination;
3169 cairo_region_t *non_overwritten;
3170 gboolean added_move;
3173 if (cairo_region_is_empty (new_dest_region))
3176 /* In principle this could just append the move to the list of outstanding
3177 moves that will be replayed before drawing anything when we're handling
3178 exposes. However, we'd like to do a bit better since its commonly the case
3179 that we get multiple copies where A is copied to B and then B is copied
3180 to C, and we'd like to express this as a simple copy A to C operation. */
3182 /* We approach this by taking the new move and pushing it ahead of moves
3183 starting at the end of the list and stopping when its not safe to do so.
3184 It's not safe to push past a move if either the source of the new move
3185 is in the destination of the old move, or if the destination of the new
3186 move is in the source of the new move, or if the destination of the new
3187 move overlaps the destination of the old move. We simplify this by
3188 just comparing the total regions (src + dest) */
3189 new_total_region = cairo_region_copy (new_dest_region);
3190 cairo_region_translate (new_total_region, -dx, -dy);
3191 cairo_region_union (new_total_region, new_dest_region);
3194 for (l = g_list_last (impl_window->outstanding_moves); l != NULL; l = prev)
3199 old_total_region = cairo_region_copy (old_move->dest_region);
3200 cairo_region_translate (old_total_region, -old_move->dx, -old_move->dy);
3201 cairo_region_union (old_total_region, old_move->dest_region);
3203 cairo_region_intersect (old_total_region, new_total_region);
3204 /* If these regions intersect then its not safe to push the
3205 new region before the old one */
3206 if (!cairo_region_is_empty (old_total_region))
3208 /* The area where the new moves source overlaps the old ones
3210 source_overlaps_destination = cairo_region_copy (new_dest_region);
3211 cairo_region_translate (source_overlaps_destination, -dx, -dy);
3212 cairo_region_intersect (source_overlaps_destination, old_move->dest_region);
3213 cairo_region_translate (source_overlaps_destination, dx, dy);
3215 /* We can do all sort of optimizations here, but to do things safely it becomes
3216 quite complicated. However, a very common case is that you copy something first,
3217 then copy all that or a subset of it to a new location (i.e. if you scroll twice
3218 in the same direction). We'd like to detect this case and optimize it to one
3220 if (cairo_region_equal (source_overlaps_destination, new_dest_region))
3222 /* This means we might be able to replace the old move and the new one
3223 with the new one read from the old ones source, and a second copy of
3224 the non-overwritten parts of the old move. However, such a split
3225 is only valid if the source in the old move isn't overwritten
3226 by the destination of the new one */
3228 /* the new destination of old move if split is ok: */
3229 non_overwritten = cairo_region_copy (old_move->dest_region);
3230 cairo_region_subtract (non_overwritten, new_dest_region);
3231 /* move to source region */
3232 cairo_region_translate (non_overwritten, -old_move->dx, -old_move->dy);
3234 cairo_region_intersect (non_overwritten, new_dest_region);
3235 if (cairo_region_is_empty (non_overwritten))
3238 move = gdk_window_region_move_new (new_dest_region,
3242 impl_window->outstanding_moves =
3243 g_list_insert_before (impl_window->outstanding_moves,
3245 cairo_region_subtract (old_move->dest_region, new_dest_region);
3247 cairo_region_destroy (non_overwritten);
3250 cairo_region_destroy (source_overlaps_destination);
3251 cairo_region_destroy (old_total_region);
3254 cairo_region_destroy (old_total_region);
3257 cairo_region_destroy (new_total_region);
3261 move = gdk_window_region_move_new (new_dest_region, dx, dy);
3264 impl_window->outstanding_moves =
3265 g_list_prepend (impl_window->outstanding_moves,
3268 impl_window->outstanding_moves =
3269 g_list_insert_before (impl_window->outstanding_moves,
3274 /* Moves bits and update area by dx/dy in impl window.
3275 Takes ownership of region to avoid copy (because we may change it) */
3277 move_region_on_impl (GdkWindow *impl_window,
3278 cairo_region_t *region, /* In impl window coords */
3281 if ((dx == 0 && dy == 0) ||
3282 cairo_region_is_empty (region))
3284 cairo_region_destroy (region);
3288 g_assert (impl_window == gdk_window_get_impl_window (impl_window));
3290 /* Move any old invalid regions in the copy source area by dx/dy */
3291 if (impl_window->update_area)
3293 cairo_region_t *update_area;
3295 update_area = cairo_region_copy (region);
3297 /* Convert from target to source */
3298 cairo_region_translate (update_area, -dx, -dy);
3299 cairo_region_intersect (update_area, impl_window->update_area);
3300 /* We only copy the area, so keep the old update area invalid.
3301 It would be safe to remove it too, as code that uses
3302 move_region_on_impl generally also invalidate the source
3303 area. However, it would just use waste cycles. */
3306 cairo_region_translate (update_area, dx, dy);
3307 cairo_region_union (impl_window->update_area, update_area);
3309 /* This area of the destination is now invalid,
3310 so no need to copy to it. */
3311 cairo_region_subtract (region, update_area);
3313 cairo_region_destroy (update_area);
3316 /* If we're currently exposing this window, don't copy to this
3317 destination, as it will be overdrawn when the expose is done,
3318 instead invalidate it and repaint later. */
3319 if (impl_window->implicit_paint)
3321 GdkWindowPaint *implicit_paint = impl_window->implicit_paint;
3322 cairo_region_t *exposing;
3324 exposing = cairo_region_copy (implicit_paint->region);
3325 cairo_region_intersect (exposing, region);
3326 cairo_region_subtract (region, exposing);
3328 impl_window_add_update_area (impl_window, exposing);
3329 cairo_region_destroy (exposing);
3332 append_move_region (impl_window, region, dx, dy);
3334 cairo_region_destroy (region);
3337 /* Flushes all outstanding changes to the window, call this
3338 * before drawing directly to the window (i.e. outside a begin/end_paint pair).
3341 gdk_window_flush_outstanding_moves (GdkWindow *window)
3343 GdkWindow *impl_window;
3344 GList *l, *outstanding;
3345 GdkWindowRegionMove *move;
3347 impl_window = gdk_window_get_impl_window (window);
3348 outstanding = impl_window->outstanding_moves;
3349 impl_window->outstanding_moves = NULL;
3351 for (l = outstanding; l != NULL; l = l->next)
3355 do_move_region_bits_on_impl (impl_window,
3356 move->dest_region, move->dx, move->dy);
3358 gdk_window_region_move_free (move);
3361 g_list_free (outstanding);
3366 * @window: a #GdkWindow
3368 * Flush all outstanding cached operations on a window, leaving the
3369 * window in a state which reflects all that has been drawn before.
3371 * Gdk uses multiple kinds of caching to get better performance and
3372 * nicer drawing. For instance, during exposes all paints to a window
3373 * using double buffered rendering are keep on a surface until the last
3374 * window has been exposed. It also delays window moves/scrolls until
3375 * as long as possible until next update to avoid tearing when moving
3378 * Normally this should be completely invisible to applications, as
3379 * we automatically flush the windows when required, but this might
3380 * be needed if you for instance mix direct native drawing with
3381 * gdk drawing. For Gtk widgets that don't use double buffering this
3382 * will be called automatically before sending the expose event.
3387 gdk_window_flush (GdkWindow *window)
3389 gdk_window_flush_outstanding_moves (window);
3390 gdk_window_flush_implicit_paint (window);
3393 /* If we're about to move/resize or otherwise change the
3394 * hierarchy of a client side window in an impl and we're
3395 * called from an expose event handler then we need to
3396 * flush any already painted parts of the implicit paint
3397 * that are not part of the current paint, as these may
3398 * be used when scrolling or may overdraw the changes
3399 * caused by the hierarchy change.
3402 gdk_window_flush_if_exposing (GdkWindow *window)
3404 GdkWindow *impl_window;
3406 impl_window = gdk_window_get_impl_window (window);
3408 /* If we're in an implicit paint (i.e. in an expose handler, flush
3409 all the already finished exposes to get things to an uptodate state. */
3410 if (impl_window->implicit_paint)
3411 gdk_window_flush (window);
3416 gdk_window_flush_recursive_helper (GdkWindow *window,
3417 GdkWindowImpl *impl)
3422 for (l = window->children; l != NULL; l = l->next)
3426 if (child->impl == impl)
3427 /* Same impl, ignore */
3428 gdk_window_flush_recursive_helper (child, impl);
3430 gdk_window_flush_recursive (child);
3435 gdk_window_flush_recursive (GdkWindow *window)
3437 gdk_window_flush (window);
3438 gdk_window_flush_recursive_helper (window, window->impl);
3442 * gdk_window_get_clip_region:
3443 * @window: a #GdkWindow
3445 * Computes the region of a window that potentially can be written
3446 * to by drawing primitives. This region may not take into account
3447 * other factors such as if the window is obscured by other windows,
3448 * but no area outside of this region will be affected by drawing
3451 * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3452 * when you are done.
3455 gdk_window_get_clip_region (GdkWindow *window)
3457 cairo_region_t *result;
3459 g_return_val_if_fail (GDK_WINDOW (window), NULL);
3461 result = cairo_region_copy (window->clip_region);
3463 if (window->paint_stack)
3465 cairo_region_t *paint_region = cairo_region_create ();
3466 GSList *tmp_list = window->paint_stack;
3470 GdkWindowPaint *paint = tmp_list->data;
3472 cairo_region_union (paint_region, paint->region);
3474 tmp_list = tmp_list->next;
3477 cairo_region_intersect (result, paint_region);
3478 cairo_region_destroy (paint_region);
3485 * gdk_window_get_visible_region:
3486 * @window: a #GdkWindow
3488 * Computes the region of the @window that is potentially visible.
3489 * This does not necessarily take into account if the window is
3490 * obscured by other windows, but no area outside of this region
3493 * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3494 * when you are done.
3497 gdk_window_get_visible_region (GdkWindow *window)
3499 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3501 return cairo_region_copy (window->clip_region);
3505 setup_backing_rect (GdkWindow *window, GdkWindowPaint *paint)
3507 GdkWindow *bg_window;
3508 cairo_pattern_t *pattern = NULL;
3509 int x_offset = 0, y_offset = 0;
3512 cr = cairo_create (paint->surface);
3514 for (bg_window = window; bg_window; bg_window = bg_window->parent)
3516 pattern = gdk_window_get_background_pattern (bg_window);
3520 x_offset += bg_window->x;
3521 y_offset += bg_window->y;
3526 cairo_translate (cr, -x_offset, -y_offset);
3527 cairo_set_source (cr, pattern);
3528 cairo_translate (cr, x_offset, y_offset);
3531 cairo_set_source_rgb (cr, 0, 0, 0);
3537 gdk_window_clear_backing_region (GdkWindow *window,
3538 cairo_region_t *region)
3540 GdkWindowPaint *paint = window->paint_stack->data;
3541 cairo_region_t *clip;
3544 if (GDK_WINDOW_DESTROYED (window))
3547 cr = setup_backing_rect (window, paint);
3549 clip = cairo_region_copy (paint->region);
3550 cairo_region_intersect (clip, region);
3552 gdk_cairo_region (cr, clip);
3557 cairo_region_destroy (clip);
3561 gdk_window_clear_backing_region_direct (GdkWindow *window,
3562 cairo_region_t *region)
3564 GdkWindowPaint paint;
3565 cairo_region_t *clip;
3568 if (GDK_WINDOW_DESTROYED (window))
3571 paint.surface = _gdk_window_ref_cairo_surface (window);
3573 cr = setup_backing_rect (window, &paint);
3575 clip = cairo_region_copy (window->clip_region_with_children);
3576 cairo_region_intersect (clip, region);
3578 gdk_cairo_region (cr, clip);
3583 cairo_region_destroy (clip);
3584 cairo_surface_destroy (paint.surface);
3589 gdk_window_clear_region_internal (GdkWindow *window,
3590 cairo_region_t *region)
3592 if (window->paint_stack)
3593 gdk_window_clear_backing_region (window, region);
3595 gdk_window_clear_backing_region_direct (window, region);
3599 gdk_window_drop_cairo_surface (GdkWindow *window)
3601 if (window->cairo_surface)
3603 cairo_surface_finish (window->cairo_surface);
3604 cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3606 window->cairo_surface = NULL;
3611 gdk_window_cairo_surface_destroy (void *data)
3613 GdkWindow *window = data;
3615 window->cairo_surface = NULL;
3618 static cairo_surface_t *
3619 gdk_window_create_cairo_surface (GdkWindow *window,
3623 cairo_surface_t *surface, *subsurface;
3625 surface = gdk_window_ref_impl_surface (window);
3626 if (gdk_window_has_impl (window))
3629 subsurface = cairo_surface_create_for_rectangle (surface,
3634 cairo_surface_destroy (surface);
3640 _gdk_window_ref_cairo_surface (GdkWindow *window)
3642 cairo_surface_t *surface;
3644 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3646 if (window->paint_stack)
3648 GdkWindowPaint *paint = window->paint_stack->data;
3650 surface = paint->surface;
3651 cairo_surface_reference (surface);
3656 /* This will be drawing directly to the window, so flush implicit paint */
3657 gdk_window_flush (window);
3659 if (!window->cairo_surface)
3661 window->cairo_surface = gdk_window_create_cairo_surface (window,
3665 if (window->cairo_surface)
3667 cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3668 window, gdk_window_cairo_surface_destroy);
3672 cairo_surface_reference (window->cairo_surface);
3674 surface = window->cairo_surface;
3682 * @window: a #GdkWindow
3684 * Creates a Cairo context for drawing to @window.
3687 * Note that calling cairo_reset_clip() on the resulting #cairo_t will
3688 * produce undefined results, so avoid it at all costs.
3691 * Return value: A newly created Cairo context. Free with
3692 * cairo_destroy() when you are done drawing.
3697 gdk_cairo_create (GdkWindow *window)
3699 cairo_surface_t *surface;
3702 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3704 surface = _gdk_window_ref_cairo_surface (window);
3705 cr = cairo_create (surface);
3707 if (!window->paint_stack)
3709 gdk_cairo_region (cr, window->clip_region_with_children);
3714 GdkWindowPaint *paint = window->paint_stack->data;
3716 /* Only needs to clip to region if piggybacking
3717 on an implicit paint */
3718 if (paint->uses_implicit)
3720 gdk_cairo_region (cr, paint->region);
3725 cairo_surface_destroy (surface);
3730 /* Code for dirty-region queueing
3732 static GSList *update_windows = NULL;
3733 static guint update_idle = 0;
3734 static gboolean debug_updates = FALSE;
3736 static inline gboolean
3737 gdk_window_is_ancestor (GdkWindow *window,
3738 GdkWindow *ancestor)
3742 GdkWindow *parent = window->parent;
3744 if (parent == ancestor)
3754 gdk_window_add_update_window (GdkWindow *window)
3757 GSList *prev = NULL;
3758 gboolean has_ancestor_in_list = FALSE;
3760 for (tmp = update_windows; tmp; tmp = tmp->next)
3762 GdkWindow *parent = window->parent;
3764 /* check if tmp is an ancestor of "window"; if it is, set a
3765 * flag indicating that all following windows are either
3766 * children of "window" or from a differen hierarchy
3768 if (!has_ancestor_in_list && gdk_window_is_ancestor (window, tmp->data))
3769 has_ancestor_in_list = TRUE;
3771 /* insert in reverse stacking order when adding around siblings,
3772 * so processing updates properly paints over lower stacked windows
3774 if (parent == GDK_WINDOW (tmp->data)->parent)
3776 gint index = g_list_index (parent->children, window);
3777 for (; tmp && parent == GDK_WINDOW (tmp->data)->parent; tmp = tmp->next)
3779 gint sibling_index = g_list_index (parent->children, tmp->data);
3780 if (index > sibling_index)
3784 /* here, tmp got advanced past all lower stacked siblings */
3785 tmp = g_slist_prepend (tmp, window);
3789 update_windows = tmp;
3793 /* if "window" has an ancestor in the list and tmp is one of
3794 * "window's" children, insert "window" before tmp
3796 if (has_ancestor_in_list && gdk_window_is_ancestor (tmp->data, window))
3798 tmp = g_slist_prepend (tmp, window);
3803 update_windows = tmp;
3807 /* if we're at the end of the list and had an ancestor it it,
3808 * append to the list
3810 if (! tmp->next && has_ancestor_in_list)
3812 tmp = g_slist_append (tmp, window);
3819 /* if all above checks failed ("window" is from a different
3820 * hierarchy than what is already in the list) or the list is
3823 update_windows = g_slist_prepend (update_windows, window);
3827 gdk_window_remove_update_window (GdkWindow *window)
3829 update_windows = g_slist_remove (update_windows, window);
3833 gdk_window_update_idle (gpointer data)
3835 gdk_window_process_all_updates ();
3841 gdk_window_is_toplevel_frozen (GdkWindow *window)
3843 GdkWindow *toplevel;
3845 toplevel = gdk_window_get_toplevel (window);
3847 return toplevel->update_and_descendants_freeze_count > 0;
3851 gdk_window_schedule_update (GdkWindow *window)
3854 (window->update_freeze_count ||
3855 gdk_window_is_toplevel_frozen (window)))
3860 gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
3861 gdk_window_update_idle,
3866 _gdk_window_process_updates_recurse (GdkWindow *window,
3867 cairo_region_t *expose_region)
3870 cairo_region_t *clipped_expose_region;
3871 GList *l, *children;
3873 if (cairo_region_is_empty (expose_region))
3876 if (gdk_window_is_offscreen (window->impl_window) &&
3877 gdk_window_has_impl (window))
3878 _gdk_window_add_damage ((GdkWindow *) window->impl_window, expose_region);
3881 /* Paint the window before the children, clipped to the window region
3882 with visible child windows removed */
3883 clipped_expose_region = cairo_region_copy (expose_region);
3884 cairo_region_intersect (clipped_expose_region, window->clip_region_with_children);
3886 if (!cairo_region_is_empty (clipped_expose_region) &&
3889 if (window->event_mask & GDK_EXPOSURE_MASK)
3893 event.expose.type = GDK_EXPOSE;
3894 event.expose.window = g_object_ref (window);
3895 event.expose.send_event = FALSE;
3896 event.expose.count = 0;
3897 event.expose.region = clipped_expose_region;
3898 cairo_region_get_extents (clipped_expose_region, &event.expose.area);
3900 _gdk_event_emit (&event);
3902 g_object_unref (window);
3904 else if (window->window_type != GDK_WINDOW_FOREIGN)
3906 /* No exposure mask set, so nothing will be drawn, the
3907 * app relies on the background being what it specified
3908 * for the window. So, we need to clear this manually.
3910 * For foreign windows if expose is not set that generally
3911 * means some other client paints them, so don't clear
3914 * We use begin/end_paint around the clear so that we can
3915 * piggyback on the implicit paint */
3917 gdk_window_begin_paint_region (window, clipped_expose_region);
3918 gdk_window_clear_region_internal (window, clipped_expose_region);
3919 gdk_window_end_paint (window);
3922 cairo_region_destroy (clipped_expose_region);
3924 /* Make this reentrancy safe for expose handlers freeing windows */
3925 children = g_list_copy (window->children);
3926 g_list_foreach (children, (GFunc)g_object_ref, NULL);
3928 /* Iterate over children, starting at bottommost */
3929 for (l = g_list_last (children); l != NULL; l = l->prev)
3933 if (child->destroyed || !GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
3936 /* Ignore offscreen children, as they don't draw in their parent and
3937 * don't take part in the clipping */
3938 if (gdk_window_is_offscreen (child))
3941 /* Client side child, expose */
3942 if (child->impl == window->impl)
3944 cairo_region_translate (expose_region, -child->x, -child->y);
3945 _gdk_window_process_updates_recurse ((GdkWindow *)child, expose_region);
3946 cairo_region_translate (expose_region, child->x, child->y);
3950 g_list_free_full (children, g_object_unref);
3954 /* Process and remove any invalid area on the native window by creating
3955 * expose events for the window and all non-native descendants.
3956 * Also processes any outstanding moves on the window before doing
3957 * any drawing. Note that its possible to have outstanding moves without
3958 * any invalid area as we use the update idle mechanism to coalesce
3959 * multiple moves as well as multiple invalidations.
3962 gdk_window_process_updates_internal (GdkWindow *window)
3964 GdkWindowImplClass *impl_class;
3965 gboolean save_region = FALSE;
3966 GdkRectangle clip_box;
3968 /* Ensure the window lives while updating it */
3969 g_object_ref (window);
3971 /* If an update got queued during update processing, we can get a
3972 * window in the update queue that has an empty update_area.
3975 if (window->update_area)
3977 cairo_region_t *update_area = window->update_area;
3978 window->update_area = NULL;
3980 if (gdk_window_is_viewable (window))
3982 cairo_region_t *expose_region;
3983 gboolean end_implicit;
3985 /* Clip to part visible in toplevel */
3986 cairo_region_intersect (update_area, window->clip_region);
3990 /* Make sure we see the red invalid area before redrawing. */
3991 gdk_display_sync (gdk_window_get_display (window));
3995 /* At this point we will be completely redrawing all of update_area.
3996 * If we have any outstanding moves that end up moving stuff inside
3997 * this area we don't actually need to move that as that part would
3998 * be overdrawn by the expose anyway. So, in order to copy less data
3999 * we remove these areas from the outstanding moves.
4001 if (window->outstanding_moves)
4003 GdkWindowRegionMove *move;
4004 cairo_region_t *remove;
4007 remove = cairo_region_copy (update_area);
4008 /* We iterate backwards, starting from the state that would be
4009 if we had applied all the moves. */
4010 for (l = g_list_last (window->outstanding_moves); l != NULL; l = prev)
4015 /* Don't need this area */
4016 cairo_region_subtract (move->dest_region, remove);
4018 /* However if any of the destination we do need has a source
4019 in the updated region we do need that as a destination for
4020 the earlier moves */
4021 cairo_region_translate (move->dest_region, -move->dx, -move->dy);
4022 cairo_region_subtract (remove, move->dest_region);
4024 if (cairo_region_is_empty (move->dest_region))
4026 gdk_window_region_move_free (move);
4027 window->outstanding_moves =
4028 g_list_delete_link (window->outstanding_moves, l);
4030 else /* move back */
4031 cairo_region_translate (move->dest_region, move->dx, move->dy);
4033 cairo_region_destroy (remove);
4036 /* By now we a set of window moves that should be applied, and then
4037 * an update region that should be repainted. A trivial implementation
4038 * would just do that in order, however in order to get nicer drawing
4039 * we do some tricks:
4041 * First of all, each subwindow expose may be double buffered by
4042 * itself (depending on widget setting) via
4043 * gdk_window_begin/end_paint(). But we also do an "implicit" paint,
4044 * creating a single surface the size of the invalid area on the
4045 * native window which all the individual normal paints will draw
4046 * into. This way in the normal case there will be only one surface
4047 * allocated and only once surface draw done for all the windows
4048 * in this native window.
4049 * There are a couple of reasons this may fail, for instance, some
4050 * backends (like quartz) do its own double buffering, so we disable
4051 * gdk double buffering there. Secondly, some subwindow could be
4052 * non-double buffered and draw directly to the window outside a
4053 * begin/end_paint pair. That will be lead to a gdk_window_flush
4054 * which immediately executes all outstanding moves and paints+removes
4055 * the implicit paint (further paints will allocate their own surfaces).
4057 * Secondly, in the case of implicit double buffering we expose all
4058 * the child windows into the implicit surface before we execute
4059 * the outstanding moves. This way we minimize the time between
4060 * doing the moves and rendering the new update area, thus minimizing
4061 * flashing. Of course, if any subwindow is non-double buffered we
4062 * well flush earlier than that.
4064 * Thirdly, after having done the outstanding moves we queue an
4065 * "antiexpose" on the area that will be drawn by the expose, which
4066 * means that any invalid region on the native window side before
4067 * the first expose drawing operation will be discarded, as it
4068 * has by then been overdrawn with valid data. This means we can
4069 * avoid doing the unnecessary repaint any outstanding expose events.
4072 cairo_region_get_extents (update_area, &clip_box);
4073 end_implicit = gdk_window_begin_implicit_paint (window, &clip_box);
4074 expose_region = cairo_region_copy (update_area);
4075 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
4078 /* Rendering is not double buffered by gdk, do outstanding
4079 * moves and queue antiexposure immediately. No need to do
4081 gdk_window_flush_outstanding_moves (window);
4082 save_region = impl_class->queue_antiexpose (window, update_area);
4084 /* Render the invalid areas to the implicit paint, by sending exposes.
4085 * May flush if non-double buffered widget draw. */
4086 impl_class->process_updates_recurse (window, expose_region);
4090 /* Do moves right before exposes are rendered to the window */
4091 gdk_window_flush_outstanding_moves (window);
4093 /* By this time we know that any outstanding expose for this
4094 * area is invalid and we can avoid it, so queue an antiexpose.
4095 * we have already started drawing to the window, so it would
4096 * be to late to anti-expose now. Since this is merely an
4097 * optimization we just avoid doing it at all in that case.
4099 if (window->implicit_paint != NULL && !window->implicit_paint->flushed)
4100 save_region = impl_class->queue_antiexpose (window, update_area);
4102 gdk_window_end_implicit_paint (window);
4104 cairo_region_destroy (expose_region);
4107 cairo_region_destroy (update_area);
4110 if (window->outstanding_moves)
4112 /* Flush any outstanding moves, may happen if we moved a window but got
4113 no actual invalid area */
4114 gdk_window_flush_outstanding_moves (window);
4117 g_object_unref (window);
4121 flush_all_displays (void)
4123 GSList *displays, *l;
4125 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4126 for (l = displays; l; l = l->next)
4127 gdk_display_flush (l->data);
4129 g_slist_free (displays);
4133 before_process_all_updates (void)
4135 GSList *displays, *l;
4136 GdkDisplayClass *display_class;
4138 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4139 display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4140 for (l = displays; l; l = l->next)
4141 display_class->before_process_all_updates (l->data);
4143 g_slist_free (displays);
4147 after_process_all_updates (void)
4149 GSList *displays, *l;
4150 GdkDisplayClass *display_class;
4152 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4153 display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4154 for (l = displays; l; l = l->next)
4155 display_class->after_process_all_updates (l->data);
4157 g_slist_free (displays);
4160 /* Currently it is not possible to override
4161 * gdk_window_process_all_updates in the same manner as
4162 * gdk_window_process_updates and gdk_window_invalidate_maybe_recurse
4163 * by implementing the GdkPaintable interface. If in the future a
4164 * backend would need this, the right solution would be to add a
4165 * method to GdkDisplay that can be optionally
4166 * NULL. gdk_window_process_all_updates can then walk the list of open
4167 * displays and call the mehod.
4171 * gdk_window_process_all_updates:
4173 * Calls gdk_window_process_updates() for all windows (see #GdkWindow)
4174 * in the application.
4178 gdk_window_process_all_updates (void)
4180 GSList *old_update_windows = update_windows;
4181 GSList *tmp_list = update_windows;
4182 static gboolean in_process_all_updates = FALSE;
4183 static gboolean got_recursive_update = FALSE;
4185 if (in_process_all_updates)
4187 /* We can't do this now since that would recurse, so
4188 delay it until after the recursion is done. */
4189 got_recursive_update = TRUE;
4194 in_process_all_updates = TRUE;
4195 got_recursive_update = FALSE;
4198 g_source_remove (update_idle);
4200 update_windows = NULL;
4203 before_process_all_updates ();
4205 g_slist_foreach (old_update_windows, (GFunc)g_object_ref, NULL);
4209 GdkWindow *window = tmp_list->data;
4211 if (!GDK_WINDOW_DESTROYED (window))
4213 if (window->update_freeze_count ||
4214 gdk_window_is_toplevel_frozen (window))
4215 gdk_window_add_update_window (window);
4217 gdk_window_process_updates_internal (window);
4220 g_object_unref (window);
4221 tmp_list = tmp_list->next;
4224 g_slist_free (old_update_windows);
4226 flush_all_displays ();
4228 after_process_all_updates ();
4230 in_process_all_updates = FALSE;
4232 /* If we ignored a recursive call, schedule a
4233 redraw now so that it eventually happens,
4234 otherwise we could miss an update if nothing
4235 else schedules an update. */
4236 if (got_recursive_update && !update_idle)
4238 gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
4239 gdk_window_update_idle,
4244 * gdk_window_process_updates:
4245 * @window: a #GdkWindow
4246 * @update_children: whether to also process updates for child windows
4248 * Sends one or more expose events to @window. The areas in each
4249 * expose event will cover the entire update area for the window (see
4250 * gdk_window_invalidate_region() for details). Normally GDK calls
4251 * gdk_window_process_all_updates() on your behalf, so there's no
4252 * need to call this function unless you want to force expose events
4253 * to be delivered immediately and synchronously (vs. the usual
4254 * case, where GDK delivers them in an idle handler). Occasionally
4255 * this is useful to produce nicer scrolling behavior, for example.
4259 gdk_window_process_updates (GdkWindow *window,
4260 gboolean update_children)
4262 GdkWindow *impl_window;
4264 g_return_if_fail (GDK_IS_WINDOW (window));
4266 if (GDK_WINDOW_DESTROYED (window))
4269 /* Make sure the window lives during the expose callouts */
4270 g_object_ref (window);
4272 impl_window = gdk_window_get_impl_window (window);
4273 if ((impl_window->update_area ||
4274 impl_window->outstanding_moves) &&
4275 !impl_window->update_freeze_count &&
4276 !gdk_window_is_toplevel_frozen (window) &&
4278 /* Don't recurse into process_updates_internal, we'll
4279 * do the update later when idle instead. */
4280 impl_window->implicit_paint == NULL)
4282 gdk_window_process_updates_internal ((GdkWindow *)impl_window);
4283 gdk_window_remove_update_window ((GdkWindow *)impl_window);
4286 if (update_children)
4288 /* process updates in reverse stacking order so composition or
4289 * painting over achieves the desired effect for offscreen windows
4291 GList *node, *children;
4293 children = g_list_copy (window->children);
4294 g_list_foreach (children, (GFunc)g_object_ref, NULL);
4296 for (node = g_list_last (children); node; node = node->prev)
4298 gdk_window_process_updates (node->data, TRUE);
4299 g_object_unref (node->data);
4302 g_list_free (children);
4305 g_object_unref (window);
4309 gdk_window_invalidate_rect_full (GdkWindow *window,
4310 const GdkRectangle *rect,
4311 gboolean invalidate_children,
4314 GdkRectangle window_rect;
4315 cairo_region_t *region;
4317 g_return_if_fail (GDK_IS_WINDOW (window));
4319 if (GDK_WINDOW_DESTROYED (window))
4322 if (window->input_only || !window->viewable)
4329 window_rect.width = window->width;
4330 window_rect.height = window->height;
4331 rect = &window_rect;
4334 region = cairo_region_create_rectangle (rect);
4335 gdk_window_invalidate_region_full (window, region, invalidate_children, clear_bg);
4336 cairo_region_destroy (region);
4340 * gdk_window_invalidate_rect:
4341 * @window: a #GdkWindow
4342 * @rect: (allow-none): rectangle to invalidate or %NULL to invalidate the whole
4344 * @invalidate_children: whether to also invalidate child windows
4346 * A convenience wrapper around gdk_window_invalidate_region() which
4347 * invalidates a rectangular region. See
4348 * gdk_window_invalidate_region() for details.
4351 gdk_window_invalidate_rect (GdkWindow *window,
4352 const GdkRectangle *rect,
4353 gboolean invalidate_children)
4355 gdk_window_invalidate_rect_full (window, rect, invalidate_children, CLEAR_BG_NONE);
4359 draw_ugly_color (GdkWindow *window,
4360 const cairo_region_t *region)
4364 cr = gdk_cairo_create (window);
4365 /* Draw ugly color all over the newly-invalid region */
4366 cairo_set_source_rgb (cr, 50000/65535., 10000/65535., 10000/65535.);
4367 gdk_cairo_region (cr, region);
4374 impl_window_add_update_area (GdkWindow *impl_window,
4375 cairo_region_t *region)
4377 if (impl_window->update_area)
4378 cairo_region_union (impl_window->update_area, region);
4381 gdk_window_add_update_window (impl_window);
4382 impl_window->update_area = cairo_region_copy (region);
4383 gdk_window_schedule_update (impl_window);
4387 /* clear_bg controls if the region will be cleared to
4388 * the background pattern if the exposure mask is not
4389 * set for the window, whereas this might not otherwise be
4390 * done (unless necessary to emulate background settings).
4391 * Set this to CLEAR_BG_WINCLEARED or CLEAR_BG_ALL if you
4392 * need to clear the background, such as when exposing the area beneath a
4393 * hidden or moved window, but not when an app requests repaint or when the
4394 * windowing system exposes a newly visible area (because then the windowing
4395 * system has already cleared the area).
4398 gdk_window_invalidate_maybe_recurse_full (GdkWindow *window,
4399 const cairo_region_t *region,
4401 GdkWindowChildFunc child_func,
4404 GdkWindow *impl_window;
4405 cairo_region_t *visible_region;
4408 g_return_if_fail (GDK_IS_WINDOW (window));
4410 if (GDK_WINDOW_DESTROYED (window))
4413 if (window->input_only ||
4414 !window->viewable ||
4415 cairo_region_is_empty (region) ||
4416 window->window_type == GDK_WINDOW_ROOT)
4419 visible_region = gdk_window_get_visible_region (window);
4420 cairo_region_intersect (visible_region, region);
4422 tmp_list = window->children;
4425 GdkWindow *child = tmp_list->data;
4427 if (!child->input_only)
4429 cairo_region_t *child_region;
4430 GdkRectangle child_rect;
4432 child_rect.x = child->x;
4433 child_rect.y = child->y;
4434 child_rect.width = child->width;
4435 child_rect.height = child->height;
4436 child_region = cairo_region_create_rectangle (&child_rect);
4438 /* remove child area from the invalid area of the parent */
4439 if (GDK_WINDOW_IS_MAPPED (child) && !child->shaped &&
4440 !child->composited &&
4441 !gdk_window_is_offscreen (child))
4442 cairo_region_subtract (visible_region, child_region);
4444 if (child_func && (*child_func) ((GdkWindow *)child, user_data))
4446 cairo_region_t *tmp = cairo_region_copy (region);
4448 cairo_region_translate (tmp, - child_rect.x, - child_rect.y);
4449 cairo_region_translate (child_region, - child_rect.x, - child_rect.y);
4450 cairo_region_intersect (child_region, tmp);
4452 gdk_window_invalidate_maybe_recurse_full ((GdkWindow *)child,
4453 child_region, clear_bg, child_func, user_data);
4455 cairo_region_destroy (tmp);
4458 cairo_region_destroy (child_region);
4461 tmp_list = tmp_list->next;
4464 impl_window = gdk_window_get_impl_window (window);
4466 if (!cairo_region_is_empty (visible_region) ||
4467 /* Even if we're not exposing anything, make sure we process
4468 idles for windows with outstanding moves */
4469 (impl_window->outstanding_moves != NULL &&
4470 impl_window->update_area == NULL))
4473 draw_ugly_color (window, region);
4475 /* Convert to impl coords */
4476 cairo_region_translate (visible_region, window->abs_x, window->abs_y);
4478 /* Only invalidate area if app requested expose events or if
4479 we need to clear the area (by request or to emulate background
4480 clearing for non-native windows or native windows with no support
4481 for window backgrounds */
4482 if (window->event_mask & GDK_EXPOSURE_MASK ||
4483 clear_bg == CLEAR_BG_ALL ||
4484 clear_bg == CLEAR_BG_WINCLEARED)
4485 impl_window_add_update_area (impl_window, visible_region);
4488 cairo_region_destroy (visible_region);
4492 * gdk_window_invalidate_maybe_recurse:
4493 * @window: a #GdkWindow
4494 * @region: a #cairo_region_t
4495 * @child_func: (scope call) (allow-none): function to use to decide if to
4496 * recurse to a child, %NULL means never recurse.
4497 * @user_data: data passed to @child_func
4499 * Adds @region to the update area for @window. The update area is the
4500 * region that needs to be redrawn, or "dirty region." The call
4501 * gdk_window_process_updates() sends one or more expose events to the
4502 * window, which together cover the entire update area. An
4503 * application would normally redraw the contents of @window in
4504 * response to those expose events.
4506 * GDK will call gdk_window_process_all_updates() on your behalf
4507 * whenever your program returns to the main loop and becomes idle, so
4508 * normally there's no need to do that manually, you just need to
4509 * invalidate regions that you know should be redrawn.
4511 * The @child_func parameter controls whether the region of
4512 * each child window that intersects @region will also be invalidated.
4513 * Only children for which @child_func returns TRUE will have the area
4517 gdk_window_invalidate_maybe_recurse (GdkWindow *window,
4518 const cairo_region_t *region,
4519 GdkWindowChildFunc child_func,
4522 gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_NONE,
4523 child_func, user_data);
4527 true_predicate (GdkWindow *window,
4534 gdk_window_invalidate_region_full (GdkWindow *window,
4535 const cairo_region_t *region,
4536 gboolean invalidate_children,
4539 gdk_window_invalidate_maybe_recurse_full (window, region, clear_bg,
4540 invalidate_children ?
4541 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4546 * gdk_window_invalidate_region:
4547 * @window: a #GdkWindow
4548 * @region: a #cairo_region_t
4549 * @invalidate_children: %TRUE to also invalidate child windows
4551 * Adds @region to the update area for @window. The update area is the
4552 * region that needs to be redrawn, or "dirty region." The call
4553 * gdk_window_process_updates() sends one or more expose events to the
4554 * window, which together cover the entire update area. An
4555 * application would normally redraw the contents of @window in
4556 * response to those expose events.
4558 * GDK will call gdk_window_process_all_updates() on your behalf
4559 * whenever your program returns to the main loop and becomes idle, so
4560 * normally there's no need to do that manually, you just need to
4561 * invalidate regions that you know should be redrawn.
4563 * The @invalidate_children parameter controls whether the region of
4564 * each child window that intersects @region will also be invalidated.
4565 * If %FALSE, then the update area for child windows will remain
4566 * unaffected. See gdk_window_invalidate_maybe_recurse if you need
4567 * fine grained control over which children are invalidated.
4570 gdk_window_invalidate_region (GdkWindow *window,
4571 const cairo_region_t *region,
4572 gboolean invalidate_children)
4574 gdk_window_invalidate_maybe_recurse (window, region,
4575 invalidate_children ?
4576 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4581 * _gdk_window_invalidate_for_expose:
4582 * @window: a #GdkWindow
4583 * @region: a #cairo_region_t
4585 * Adds @region to the update area for @window. The update area is the
4586 * region that needs to be redrawn, or "dirty region." The call
4587 * gdk_window_process_updates() sends one or more expose events to the
4588 * window, which together cover the entire update area. An
4589 * application would normally redraw the contents of @window in
4590 * response to those expose events.
4592 * GDK will call gdk_window_process_all_updates() on your behalf
4593 * whenever your program returns to the main loop and becomes idle, so
4594 * normally there's no need to do that manually, you just need to
4595 * invalidate regions that you know should be redrawn.
4597 * This version of invalidation is used when you recieve expose events
4598 * from the native window system. It exposes the native window, plus
4599 * any non-native child windows (but not native child windows, as those would
4600 * have gotten their own expose events).
4603 _gdk_window_invalidate_for_expose (GdkWindow *window,
4604 cairo_region_t *region)
4606 GdkWindowRegionMove *move;
4607 cairo_region_t *move_region;
4610 /* Any invalidations comming from the windowing system will
4611 be in areas that may be moved by outstanding moves,
4612 so we need to modify the expose region correspondingly,
4613 otherwise we would expose in the wrong place, as the
4614 outstanding moves will be copied before we draw the
4616 for (l = window->outstanding_moves; l != NULL; l = l->next)
4620 /* covert to move source region */
4621 move_region = cairo_region_copy (move->dest_region);
4622 cairo_region_translate (move_region, -move->dx, -move->dy);
4624 /* Move area of region that intersects with move source
4625 by dx, dy of the move*/
4626 cairo_region_intersect (move_region, region);
4627 cairo_region_subtract (region, move_region);
4628 cairo_region_translate (move_region, move->dx, move->dy);
4629 cairo_region_union (region, move_region);
4631 cairo_region_destroy (move_region);
4634 gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_WINCLEARED,
4635 (gboolean (*) (GdkWindow *, gpointer))gdk_window_has_no_impl,
4641 * gdk_window_get_update_area:
4642 * @window: a #GdkWindow
4644 * Transfers ownership of the update area from @window to the caller
4645 * of the function. That is, after calling this function, @window will
4646 * no longer have an invalid/dirty region; the update area is removed
4647 * from @window and handed to you. If a window has no update area,
4648 * gdk_window_get_update_area() returns %NULL. You are responsible for
4649 * calling cairo_region_destroy() on the returned region if it's non-%NULL.
4651 * Return value: the update area for @window
4654 gdk_window_get_update_area (GdkWindow *window)
4656 GdkWindow *impl_window;
4657 cairo_region_t *tmp_region, *to_remove;
4659 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4661 impl_window = gdk_window_get_impl_window (window);
4663 if (impl_window->update_area)
4665 tmp_region = cairo_region_copy (window->clip_region_with_children);
4666 /* Convert to impl coords */
4667 cairo_region_translate (tmp_region, window->abs_x, window->abs_y);
4668 cairo_region_intersect (tmp_region, impl_window->update_area);
4670 if (cairo_region_is_empty (tmp_region))
4672 cairo_region_destroy (tmp_region);
4677 /* Convert from impl coords */
4678 cairo_region_translate (tmp_region, -window->abs_x, -window->abs_y);
4680 /* Don't remove any update area that is overlapped by non-opaque windows
4681 (children or siblings) with alpha, as these really need to be repainted
4682 independently of this window. */
4683 to_remove = cairo_region_copy (tmp_region);
4684 cairo_region_subtract (to_remove, window->parent->layered_region);
4685 remove_layered_child_area (window, to_remove);
4687 /* Remove from update_area */
4688 cairo_region_translate (to_remove, window->abs_x, window->abs_y);
4689 cairo_region_subtract (impl_window->update_area, to_remove);
4691 cairo_region_destroy (to_remove);
4693 if (cairo_region_is_empty (impl_window->update_area) &&
4694 impl_window->outstanding_moves == NULL)
4696 cairo_region_destroy (impl_window->update_area);
4697 impl_window->update_area = NULL;
4699 gdk_window_remove_update_window ((GdkWindow *)impl_window);
4710 * _gdk_window_clear_update_area:
4711 * @window: a #GdkWindow.
4713 * Internal function to clear the update area for a window. This
4714 * is called when the window is hidden or destroyed.
4717 _gdk_window_clear_update_area (GdkWindow *window)
4719 g_return_if_fail (GDK_IS_WINDOW (window));
4721 if (window->update_area)
4723 gdk_window_remove_update_window (window);
4725 cairo_region_destroy (window->update_area);
4726 window->update_area = NULL;
4731 * gdk_window_freeze_updates:
4732 * @window: a #GdkWindow
4734 * Temporarily freezes a window such that it won't receive expose
4735 * events. The window will begin receiving expose events again when
4736 * gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
4737 * has been called more than once, gdk_window_thaw_updates() must be called
4738 * an equal number of times to begin processing exposes.
4741 gdk_window_freeze_updates (GdkWindow *window)
4743 GdkWindow *impl_window;
4745 g_return_if_fail (GDK_IS_WINDOW (window));
4747 impl_window = gdk_window_get_impl_window (window);
4748 impl_window->update_freeze_count++;
4752 * gdk_window_thaw_updates:
4753 * @window: a #GdkWindow
4755 * Thaws a window frozen with gdk_window_freeze_updates().
4758 gdk_window_thaw_updates (GdkWindow *window)
4760 GdkWindow *impl_window;
4762 g_return_if_fail (GDK_IS_WINDOW (window));
4764 impl_window = gdk_window_get_impl_window (window);
4766 g_return_if_fail (impl_window->update_freeze_count > 0);
4768 if (--impl_window->update_freeze_count == 0)
4769 gdk_window_schedule_update (GDK_WINDOW (impl_window));
4773 * gdk_window_freeze_toplevel_updates_libgtk_only:
4774 * @window: a #GdkWindow
4776 * Temporarily freezes a window and all its descendants such that it won't
4777 * receive expose events. The window will begin receiving expose events
4778 * again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If
4779 * gdk_window_freeze_toplevel_updates_libgtk_only()
4780 * has been called more than once,
4781 * gdk_window_thaw_toplevel_updates_libgtk_only() must be called
4782 * an equal number of times to begin processing exposes.
4784 * This function is not part of the GDK public API and is only
4788 gdk_window_freeze_toplevel_updates_libgtk_only (GdkWindow *window)
4790 g_return_if_fail (GDK_IS_WINDOW (window));
4791 g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4793 window->update_and_descendants_freeze_count++;
4797 * gdk_window_thaw_toplevel_updates_libgtk_only:
4798 * @window: a #GdkWindow
4800 * Thaws a window frozen with
4801 * gdk_window_freeze_toplevel_updates_libgtk_only().
4803 * This function is not part of the GDK public API and is only
4807 gdk_window_thaw_toplevel_updates_libgtk_only (GdkWindow *window)
4809 g_return_if_fail (GDK_IS_WINDOW (window));
4810 g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4811 g_return_if_fail (window->update_and_descendants_freeze_count > 0);
4813 window->update_and_descendants_freeze_count--;
4815 gdk_window_schedule_update (window);
4819 * gdk_window_set_debug_updates:
4820 * @setting: %TRUE to turn on update debugging
4822 * With update debugging enabled, calls to
4823 * gdk_window_invalidate_region() clear the invalidated region of the
4824 * screen to a noticeable color, and GDK pauses for a short time
4825 * before sending exposes to windows during
4826 * gdk_window_process_updates(). The net effect is that you can see
4827 * the invalid region for each window and watch redraws as they
4828 * occur. This allows you to diagnose inefficiencies in your application.
4830 * In essence, because the GDK rendering model prevents all flicker,
4831 * if you are redrawing the same region 400 times you may never
4832 * notice, aside from noticing a speed problem. Enabling update
4833 * debugging causes GTK to flicker slowly and noticeably, so you can
4834 * see exactly what's being redrawn when, in what order.
4836 * The --gtk-debug=updates command line option passed to GTK+ programs
4837 * enables this debug option at application startup time. That's
4838 * usually more useful than calling gdk_window_set_debug_updates()
4839 * yourself, though you might want to use this function to enable
4840 * updates sometime after application startup time.
4844 gdk_window_set_debug_updates (gboolean setting)
4846 debug_updates = setting;
4850 * gdk_window_constrain_size:
4851 * @geometry: a #GdkGeometry structure
4852 * @flags: a mask indicating what portions of @geometry are set
4853 * @width: desired width of window
4854 * @height: desired height of the window
4855 * @new_width: (out): location to store resulting width
4856 * @new_height: (out): location to store resulting height
4858 * Constrains a desired width and height according to a
4859 * set of geometry hints (such as minimum and maximum size).
4862 gdk_window_constrain_size (GdkGeometry *geometry,
4869 /* This routine is partially borrowed from fvwm.
4871 * Copyright 1993, Robert Nation
4872 * You may use this code for any purpose, as long as the original
4873 * copyright remains in the source code and all documentation
4875 * which in turn borrows parts of the algorithm from uwm
4878 gint min_height = 0;
4879 gint base_width = 0;
4880 gint base_height = 0;
4883 gint max_width = G_MAXINT;
4884 gint max_height = G_MAXINT;
4886 #define FLOOR(value, base) ( ((gint) ((value) / (base))) * (base) )
4888 if ((flags & GDK_HINT_BASE_SIZE) && (flags & GDK_HINT_MIN_SIZE))
4890 base_width = geometry->base_width;
4891 base_height = geometry->base_height;
4892 min_width = geometry->min_width;
4893 min_height = geometry->min_height;
4895 else if (flags & GDK_HINT_BASE_SIZE)
4897 base_width = geometry->base_width;
4898 base_height = geometry->base_height;
4899 min_width = geometry->base_width;
4900 min_height = geometry->base_height;
4902 else if (flags & GDK_HINT_MIN_SIZE)
4904 base_width = geometry->min_width;
4905 base_height = geometry->min_height;
4906 min_width = geometry->min_width;
4907 min_height = geometry->min_height;
4910 if (flags & GDK_HINT_MAX_SIZE)
4912 max_width = geometry->max_width ;
4913 max_height = geometry->max_height;
4916 if (flags & GDK_HINT_RESIZE_INC)
4918 xinc = MAX (xinc, geometry->width_inc);
4919 yinc = MAX (yinc, geometry->height_inc);
4922 /* clamp width and height to min and max values
4924 width = CLAMP (width, min_width, max_width);
4925 height = CLAMP (height, min_height, max_height);
4927 /* shrink to base + N * inc
4929 width = base_width + FLOOR (width - base_width, xinc);
4930 height = base_height + FLOOR (height - base_height, yinc);
4932 /* constrain aspect ratio, according to:
4935 * min_aspect <= -------- <= max_aspect
4939 if (flags & GDK_HINT_ASPECT &&
4940 geometry->min_aspect > 0 &&
4941 geometry->max_aspect > 0)
4945 if (geometry->min_aspect * height > width)
4947 delta = FLOOR (height - width / geometry->min_aspect, yinc);
4948 if (height - delta >= min_height)
4952 delta = FLOOR (height * geometry->min_aspect - width, xinc);
4953 if (width + delta <= max_width)
4958 if (geometry->max_aspect * height < width)
4960 delta = FLOOR (width - height * geometry->max_aspect, xinc);
4961 if (width - delta >= min_width)
4965 delta = FLOOR (width / geometry->max_aspect - height, yinc);
4966 if (height + delta <= max_height)
4975 *new_height = height;
4979 * gdk_window_get_pointer:
4980 * @window: a #GdkWindow
4981 * @x: (out) (allow-none): return location for X coordinate of pointer or %NULL to not
4982 * return the X coordinate
4983 * @y: (out) (allow-none): return location for Y coordinate of pointer or %NULL to not
4984 * return the Y coordinate
4985 * @mask: (out) (allow-none): return location for modifier mask or %NULL to not return the
4988 * Obtains the current pointer position and modifier state.
4989 * The position is given in coordinates relative to the upper left
4990 * corner of @window.
4992 * Return value: (transfer none): the window containing the pointer (as with
4993 * gdk_window_at_pointer()), or %NULL if the window containing the
4994 * pointer isn't known to GDK
4996 * Deprecated: 3.0: Use gdk_window_get_device_position() instead.
4999 gdk_window_get_pointer (GdkWindow *window,
5002 GdkModifierType *mask)
5004 GdkDisplay *display;
5006 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
5008 display = gdk_window_get_display (window);
5010 return gdk_window_get_device_position (window, display->core_pointer, x, y, mask);
5014 * gdk_window_get_device_position:
5015 * @window: a #GdkWindow.
5016 * @device: pointer #GdkDevice to query to.
5017 * @x: (out) (allow-none): return location for the X coordinate of @device, or %NULL.
5018 * @y: (out) (allow-none): return location for the Y coordinate of @device, or %NULL.
5019 * @mask: (out) (allow-none): return location for the modifier mask, or %NULL.
5021 * Obtains the current device position and modifier state.
5022 * The position is given in coordinates relative to the upper left
5023 * corner of @window.
5025 * Return value: (transfer none): The window underneath @device (as with
5026 * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.
5031 gdk_window_get_device_position (GdkWindow *window,
5035 GdkModifierType *mask)
5038 GdkModifierType tmp_mask;
5039 gboolean normal_child;
5041 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
5042 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
5043 g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
5045 normal_child = GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_device_state (window,
5049 /* We got the coords on the impl, convert to the window */
5050 tmp_x -= window->abs_x;
5051 tmp_y -= window->abs_y;
5060 _gdk_display_enable_motion_hints (gdk_window_get_display (window), device);
5063 return _gdk_window_find_child_at (window, tmp_x, tmp_y);
5068 * gdk_get_default_root_window:
5070 * Obtains the root window (parent all other windows are inside)
5071 * for the default display and screen.
5073 * Return value: (transfer none): the default root window
5076 gdk_get_default_root_window (void)
5078 return gdk_screen_get_root_window (gdk_screen_get_default ());
5082 get_all_native_children (GdkWindow *window,
5088 for (l = window->children; l != NULL; l = l->next)
5092 if (gdk_window_has_impl (child))
5093 *native = g_list_prepend (*native, child);
5095 get_all_native_children (child, native);
5101 gdk_window_raise_internal (GdkWindow *window)
5103 GdkWindow *parent = window->parent;
5105 GList *native_children;
5107 GdkWindowImplClass *impl_class;
5111 parent->children = g_list_remove (parent->children, window);
5112 parent->children = g_list_prepend (parent->children, window);
5115 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5116 /* Just do native raise for toplevels */
5117 if (gdk_window_is_toplevel (window) ||
5118 /* The restack_under codepath should work correctly even if the parent
5119 is native, but it relies on the order of ->children to be correct,
5120 and some apps like SWT reorder the x windows without gdks knowledge,
5121 so we use raise directly in order to make these behave as before
5122 when using native windows */
5123 (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5125 impl_class->raise (window);
5127 else if (gdk_window_has_impl (window))
5129 above = find_native_sibling_above (parent, window);
5132 listhead.data = window;
5133 listhead.next = NULL;
5134 listhead.prev = NULL;
5135 impl_class->restack_under ((GdkWindow *)above,
5139 impl_class->raise (window);
5143 native_children = NULL;
5144 get_all_native_children (window, &native_children);
5145 if (native_children != NULL)
5147 above = find_native_sibling_above (parent, window);
5150 impl_class->restack_under (above, native_children);
5153 /* Right order, since native_children is bottom-topmost first */
5154 for (l = native_children; l != NULL; l = l->next)
5155 impl_class->raise (l->data);
5158 g_list_free (native_children);
5164 /* Returns TRUE If the native window was mapped or unmapped */
5166 set_viewable (GdkWindow *w,
5170 GdkWindowImplClass *impl_class;
5173 if (w->viewable == val)
5179 recompute_visible_regions (w, FALSE, FALSE);
5181 for (l = w->children; l != NULL; l = l->next)
5185 if (GDK_WINDOW_IS_MAPPED (child) &&
5186 child->window_type != GDK_WINDOW_FOREIGN)
5187 set_viewable (child, val);
5190 if (gdk_window_has_impl (w) &&
5191 w->window_type != GDK_WINDOW_FOREIGN &&
5192 !gdk_window_is_toplevel (w))
5194 /* For most native windows we show/hide them not when they are
5195 * mapped/unmapped, because that may not produce the correct results.
5196 * For instance, if a native window have a non-native parent which is
5197 * hidden, but its native parent is viewable then showing the window
5198 * would make it viewable to X but its not viewable wrt the non-native
5199 * hierarchy. In order to handle this we track the gdk side viewability
5200 * and only map really viewable windows.
5202 * There are two exceptions though:
5204 * For foreign windows we don't want ever change the mapped state
5205 * except when explicitly done via gdk_window_show/hide, as this may
5206 * cause problems for client owning the foreign window when its window
5207 * is suddenly mapped or unmapped.
5209 * For toplevel windows embedded in a foreign window (e.g. a plug)
5210 * we sometimes synthesize a map of a window, but the native
5211 * window is really shown by the embedder, so we don't want to
5212 * do the show ourselves. We can't really tell this case from the normal
5213 * toplevel show as such toplevels are seen by gdk as parents of the
5214 * root window, so we make an exception for all toplevels.
5217 impl_class = GDK_WINDOW_IMPL_GET_CLASS (w->impl);
5219 impl_class->show ((GdkWindow *)w, FALSE);
5221 impl_class->hide ((GdkWindow *)w);
5229 /* Returns TRUE If the native window was mapped or unmapped */
5231 _gdk_window_update_viewable (GdkWindow *window)
5235 if (window->window_type == GDK_WINDOW_FOREIGN ||
5236 window->window_type == GDK_WINDOW_ROOT)
5238 else if (gdk_window_is_toplevel (window) ||
5239 window->parent->viewable)
5240 viewable = GDK_WINDOW_IS_MAPPED (window);
5244 return set_viewable (window, viewable);
5248 gdk_window_show_internal (GdkWindow *window, gboolean raise)
5250 GdkWindowImplClass *impl_class;
5251 gboolean was_mapped, was_viewable;
5254 g_return_if_fail (GDK_IS_WINDOW (window));
5256 if (window->destroyed)
5259 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5260 was_viewable = window->viewable;
5263 /* Keep children in (reverse) stacking order */
5264 gdk_window_raise_internal (window);
5266 if (gdk_window_has_impl (window))
5269 gdk_synthesize_window_state (window,
5270 GDK_WINDOW_STATE_WITHDRAWN,
5271 GDK_WINDOW_STATE_FOCUSED);
5278 did_show = _gdk_window_update_viewable (window);
5280 /* If it was already viewable the backend show op won't be called, call it
5281 again to ensure things happen right if the mapped tracking was not right
5282 for e.g. a foreign window.
5283 Dunno if this is strictly needed but its what happened pre-csw.
5284 Also show if not done by gdk_window_update_viewable. */
5285 if (gdk_window_has_impl (window) && (was_viewable || !did_show))
5287 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5288 impl_class->show (window, !did_show ? was_mapped : TRUE);
5291 if (!was_mapped && !gdk_window_has_impl (window))
5293 if (window->event_mask & GDK_STRUCTURE_MASK)
5294 _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5296 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5297 _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5300 if (!was_mapped || raise)
5302 recompute_visible_regions (window, TRUE, FALSE);
5304 /* If any decendants became visible we need to send visibility notify */
5305 gdk_window_update_visibility_recursively (window, NULL);
5307 if (gdk_window_is_viewable (window))
5309 _gdk_synthesize_crossing_events_for_geometry_change (window);
5310 gdk_window_invalidate_rect_full (window, NULL, TRUE, CLEAR_BG_ALL);
5316 * gdk_window_show_unraised:
5317 * @window: a #GdkWindow
5319 * Shows a #GdkWindow onscreen, but does not modify its stacking
5320 * order. In contrast, gdk_window_show() will raise the window
5321 * to the top of the window stack.
5323 * On the X11 platform, in Xlib terms, this function calls
5324 * XMapWindow() (it also updates some internal GDK state, which means
5325 * that you can't really use XMapWindow() directly on a GDK window).
5328 gdk_window_show_unraised (GdkWindow *window)
5330 gdk_window_show_internal (window, FALSE);
5335 * @window: a #GdkWindow
5337 * Raises @window to the top of the Z-order (stacking order), so that
5338 * other windows with the same parent window appear below @window.
5339 * This is true whether or not the windows are visible.
5341 * If @window is a toplevel, the window manager may choose to deny the
5342 * request to move the window in the Z-order, gdk_window_raise() only
5343 * requests the restack, does not guarantee it.
5346 gdk_window_raise (GdkWindow *window)
5348 g_return_if_fail (GDK_IS_WINDOW (window));
5350 if (window->destroyed)
5353 gdk_window_flush_if_exposing (window);
5355 /* Keep children in (reverse) stacking order */
5356 gdk_window_raise_internal (window);
5358 recompute_visible_regions (window, TRUE, FALSE);
5360 if (gdk_window_is_viewable (window) &&
5361 !window->input_only)
5362 gdk_window_invalidate_region_full (window, window->clip_region, TRUE, CLEAR_BG_ALL);
5366 gdk_window_lower_internal (GdkWindow *window)
5368 GdkWindow *parent = window->parent;
5369 GdkWindowImplClass *impl_class;
5371 GList *native_children;
5376 parent->children = g_list_remove (parent->children, window);
5377 parent->children = g_list_append (parent->children, window);
5380 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5381 /* Just do native lower for toplevels */
5382 if (gdk_window_is_toplevel (window) ||
5383 /* The restack_under codepath should work correctly even if the parent
5384 is native, but it relies on the order of ->children to be correct,
5385 and some apps like SWT reorder the x windows without gdks knowledge,
5386 so we use lower directly in order to make these behave as before
5387 when using native windows */
5388 (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5390 impl_class->lower (window);
5392 else if (gdk_window_has_impl (window))
5394 above = find_native_sibling_above (parent, window);
5397 listhead.data = window;
5398 listhead.next = NULL;
5399 listhead.prev = NULL;
5400 impl_class->restack_under ((GdkWindow *)above, &listhead);
5403 impl_class->raise (window);
5407 native_children = NULL;
5408 get_all_native_children (window, &native_children);
5409 if (native_children != NULL)
5411 above = find_native_sibling_above (parent, window);
5414 impl_class->restack_under ((GdkWindow *)above,
5418 /* Right order, since native_children is bottom-topmost first */
5419 for (l = native_children; l != NULL; l = l->next)
5420 impl_class->raise (l->data);
5423 g_list_free (native_children);
5430 gdk_window_invalidate_in_parent (GdkWindow *private)
5432 GdkRectangle r, child;
5434 if (gdk_window_is_toplevel (private))
5437 /* get the visible rectangle of the parent */
5439 r.width = private->parent->width;
5440 r.height = private->parent->height;
5442 child.x = private->x;
5443 child.y = private->y;
5444 child.width = private->width;
5445 child.height = private->height;
5446 gdk_rectangle_intersect (&r, &child, &r);
5448 gdk_window_invalidate_rect_full (private->parent, &r, TRUE, CLEAR_BG_ALL);
5454 * @window: a #GdkWindow
5456 * Lowers @window to the bottom of the Z-order (stacking order), so that
5457 * other windows with the same parent window appear above @window.
5458 * This is true whether or not the other windows are visible.
5460 * If @window is a toplevel, the window manager may choose to deny the
5461 * request to move the window in the Z-order, gdk_window_lower() only
5462 * requests the restack, does not guarantee it.
5464 * Note that gdk_window_show() raises the window again, so don't call this
5465 * function before gdk_window_show(). (Try gdk_window_show_unraised().)
5468 gdk_window_lower (GdkWindow *window)
5470 g_return_if_fail (GDK_IS_WINDOW (window));
5472 if (window->destroyed)
5475 gdk_window_flush_if_exposing (window);
5477 /* Keep children in (reverse) stacking order */
5478 gdk_window_lower_internal (window);
5480 recompute_visible_regions (window, TRUE, FALSE);
5482 _gdk_synthesize_crossing_events_for_geometry_change (window);
5483 gdk_window_invalidate_in_parent (window);
5487 * gdk_window_restack:
5488 * @window: a #GdkWindow
5489 * @sibling: (allow-none): a #GdkWindow that is a sibling of @window, or %NULL
5492 * Changes the position of @window in the Z-order (stacking order), so that
5493 * it is above @sibling (if @above is %TRUE) or below @sibling (if @above is
5496 * If @sibling is %NULL, then this either raises (if @above is %TRUE) or
5497 * lowers the window.
5499 * If @window is a toplevel, the window manager may choose to deny the
5500 * request to move the window in the Z-order, gdk_window_restack() only
5501 * requests the restack, does not guarantee it.
5506 gdk_window_restack (GdkWindow *window,
5510 GdkWindowImplClass *impl_class;
5512 GdkWindow *above_native;
5513 GList *sibling_link;
5514 GList *native_children;
5517 g_return_if_fail (GDK_IS_WINDOW (window));
5518 g_return_if_fail (sibling == NULL || GDK_IS_WINDOW (sibling));
5520 if (window->destroyed)
5523 if (sibling == NULL)
5526 gdk_window_raise (window);
5528 gdk_window_lower (window);
5532 gdk_window_flush_if_exposing (window);
5534 if (gdk_window_is_toplevel (window))
5536 g_return_if_fail (gdk_window_is_toplevel (sibling));
5537 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5538 impl_class->restack_toplevel (window, sibling, above);
5542 parent = window->parent;
5545 sibling_link = g_list_find (parent->children, sibling);
5546 g_return_if_fail (sibling_link != NULL);
5547 if (sibling_link == NULL)
5550 parent->children = g_list_remove (parent->children, window);
5552 parent->children = g_list_insert_before (parent->children,
5556 parent->children = g_list_insert_before (parent->children,
5560 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5561 if (gdk_window_has_impl (window))
5563 above_native = find_native_sibling_above (parent, window);
5566 listhead.data = window;
5567 listhead.next = NULL;
5568 listhead.prev = NULL;
5569 impl_class->restack_under (above_native, &listhead);
5572 impl_class->raise (window);
5576 native_children = NULL;
5577 get_all_native_children (window, &native_children);
5578 if (native_children != NULL)
5580 above_native = find_native_sibling_above (parent, window);
5582 impl_class->restack_under (above_native,
5586 /* Right order, since native_children is bottom-topmost first */
5587 for (l = native_children; l != NULL; l = l->next)
5588 impl_class->raise (l->data);
5591 g_list_free (native_children);
5596 recompute_visible_regions (window, TRUE, FALSE);
5598 _gdk_synthesize_crossing_events_for_geometry_change (window);
5599 gdk_window_invalidate_in_parent (window);
5605 * @window: a #GdkWindow
5607 * Like gdk_window_show_unraised(), but also raises the window to the
5608 * top of the window stack (moves the window to the front of the
5611 * This function maps a window so it's visible onscreen. Its opposite
5612 * is gdk_window_hide().
5614 * When implementing a #GtkWidget, you should call this function on the widget's
5615 * #GdkWindow as part of the "map" method.
5618 gdk_window_show (GdkWindow *window)
5620 gdk_window_show_internal (window, TRUE);
5625 * @window: a #GdkWindow
5627 * For toplevel windows, withdraws them, so they will no longer be
5628 * known to the window manager; for all windows, unmaps them, so
5629 * they won't be displayed. Normally done automatically as
5630 * part of gtk_widget_hide().
5633 gdk_window_hide (GdkWindow *window)
5635 GdkWindowImplClass *impl_class;
5636 gboolean was_mapped, did_hide;
5638 g_return_if_fail (GDK_IS_WINDOW (window));
5640 if (window->destroyed)
5643 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5645 if (gdk_window_has_impl (window))
5648 if (GDK_WINDOW_IS_MAPPED (window))
5649 gdk_synthesize_window_state (window,
5651 GDK_WINDOW_STATE_WITHDRAWN);
5653 else if (was_mapped)
5655 GdkDisplay *display;
5656 GdkDeviceManager *device_manager;
5659 /* May need to break grabs on children */
5660 display = gdk_window_get_display (window);
5661 device_manager = gdk_display_get_device_manager (display);
5663 /* Get all devices */
5664 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
5665 devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_SLAVE));
5666 devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING));
5668 for (d = devices; d; d = d->next)
5670 GdkDevice *device = d->data;
5672 if (_gdk_display_end_device_grab (display,
5674 _gdk_display_get_next_serial (display),
5677 gdk_device_ungrab (device, GDK_CURRENT_TIME);
5680 window->state = GDK_WINDOW_STATE_WITHDRAWN;
5681 g_list_free (devices);
5684 did_hide = _gdk_window_update_viewable (window);
5686 /* Hide foreign window as those are not handled by update_viewable. */
5687 if (gdk_window_has_impl (window) && (!did_hide))
5689 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5690 impl_class->hide (window);
5693 recompute_visible_regions (window, TRUE, FALSE);
5695 /* all decendants became non-visible, we need to send visibility notify */
5696 gdk_window_update_visibility_recursively (window, NULL);
5698 if (was_mapped && !gdk_window_has_impl (window))
5700 if (window->event_mask & GDK_STRUCTURE_MASK)
5701 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5703 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5704 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5706 _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5709 /* Invalidate the rect */
5711 gdk_window_invalidate_in_parent (window);
5715 * gdk_window_withdraw:
5716 * @window: a toplevel #GdkWindow
5718 * Withdraws a window (unmaps it and asks the window manager to forget about it).
5719 * This function is not really useful as gdk_window_hide() automatically
5720 * withdraws toplevel windows before hiding them.
5723 gdk_window_withdraw (GdkWindow *window)
5725 GdkWindowImplClass *impl_class;
5726 gboolean was_mapped;
5728 g_return_if_fail (GDK_IS_WINDOW (window));
5730 if (window->destroyed)
5733 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5735 if (gdk_window_has_impl (window))
5737 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5738 impl_class->withdraw (window);
5742 if (window->event_mask & GDK_STRUCTURE_MASK)
5743 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5745 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5746 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5748 _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5751 recompute_visible_regions (window, TRUE, FALSE);
5756 * gdk_window_set_events:
5757 * @window: a #GdkWindow
5758 * @event_mask: event mask for @window
5760 * The event mask for a window determines which events will be reported
5761 * for that window from all master input devices. For example, an event mask
5762 * including #GDK_BUTTON_PRESS_MASK means the window should report button
5763 * press events. The event mask is the bitwise OR of values from the
5764 * #GdkEventMask enumeration.
5767 gdk_window_set_events (GdkWindow *window,
5768 GdkEventMask event_mask)
5770 GdkWindowImplClass *impl_class;
5771 GdkDisplay *display;
5773 g_return_if_fail (GDK_IS_WINDOW (window));
5775 if (window->destroyed)
5778 /* If motion hint is disabled, enable motion events again */
5779 display = gdk_window_get_display (window);
5780 if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5781 !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5783 GList *devices = window->devices_inside;
5787 _gdk_display_enable_motion_hints (display, (GdkDevice *) devices->data);
5788 devices = devices->next;
5792 window->event_mask = event_mask;
5794 if (gdk_window_has_impl (window))
5796 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5797 impl_class->set_events (window,
5798 get_native_event_mask (window));
5804 * gdk_window_get_events:
5805 * @window: a #GdkWindow
5807 * Gets the event mask for @window for all master input devices. See
5808 * gdk_window_set_events().
5810 * Return value: event mask for @window
5813 gdk_window_get_events (GdkWindow *window)
5815 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5817 if (window->destroyed)
5820 return window->event_mask;
5824 * gdk_window_set_device_events:
5825 * @window: a #GdkWindow
5826 * @device: #GdkDevice to enable events for.
5827 * @event_mask: event mask for @window
5829 * Sets the event mask for a given device (Normally a floating device, not
5830 * attached to any visible pointer) to @window. For example, an event mask
5831 * including #GDK_BUTTON_PRESS_MASK means the window should report button
5832 * press events. The event mask is the bitwise OR of values from the
5833 * #GdkEventMask enumeration.
5838 gdk_window_set_device_events (GdkWindow *window,
5840 GdkEventMask event_mask)
5842 GdkEventMask device_mask;
5843 GdkDisplay *display;
5846 g_return_if_fail (GDK_IS_WINDOW (window));
5847 g_return_if_fail (GDK_IS_DEVICE (device));
5849 if (GDK_WINDOW_DESTROYED (window))
5852 /* If motion hint is disabled, enable motion events again */
5853 display = gdk_window_get_display (window);
5854 if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5855 !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5856 _gdk_display_enable_motion_hints (display, device);
5858 if (G_UNLIKELY (!window->device_events))
5859 window->device_events = g_hash_table_new (NULL, NULL);
5861 if (event_mask == 0)
5863 /* FIXME: unsetting events on a master device
5864 * would restore window->event_mask
5866 g_hash_table_remove (window->device_events, device);
5869 g_hash_table_insert (window->device_events, device,
5870 GINT_TO_POINTER (event_mask));
5872 native = gdk_window_get_toplevel (window);
5874 while (gdk_window_is_offscreen (native))
5876 native = gdk_offscreen_window_get_embedder (native);
5878 if (native == NULL ||
5879 (!_gdk_window_has_impl (native) &&
5880 !gdk_window_is_viewable (native)))
5883 native = gdk_window_get_toplevel (native);
5886 device_mask = get_native_device_event_mask (window, device);
5887 GDK_DEVICE_GET_CLASS (device)->select_window_events (device, native, device_mask);
5891 * gdk_window_get_device_events:
5892 * @window: a #GdkWindow.
5893 * @device: a #GdkDevice.
5895 * Returns the event mask for @window corresponding to an specific device.
5897 * Returns: device event mask for @window
5902 gdk_window_get_device_events (GdkWindow *window,
5907 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5908 g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
5910 if (GDK_WINDOW_DESTROYED (window))
5913 if (!window->device_events)
5916 mask = GPOINTER_TO_INT (g_hash_table_lookup (window->device_events, device));
5918 /* FIXME: device could be controlled by window->event_mask */
5924 gdk_window_move_resize_toplevel (GdkWindow *window,
5931 cairo_region_t *old_region, *new_region;
5932 GdkWindowImplClass *impl_class;
5939 is_resize = (width != -1) || (height != -1);
5941 if (gdk_window_is_viewable (window) &&
5942 !window->input_only)
5945 old_region = cairo_region_copy (window->clip_region);
5948 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5949 impl_class->move_resize (window, with_move, x, y, width, height);
5951 /* Avoid recomputing for pure toplevel moves, for performance reasons */
5953 recompute_visible_regions (window, TRUE, FALSE);
5957 new_region = cairo_region_copy (window->clip_region);
5959 /* This is the newly exposed area (due to any resize),
5960 * X will expose it, but lets do that without the roundtrip
5962 cairo_region_subtract (new_region, old_region);
5963 gdk_window_invalidate_region_full (window, new_region, TRUE, CLEAR_BG_WINCLEARED);
5965 cairo_region_destroy (old_region);
5966 cairo_region_destroy (new_region);
5969 _gdk_synthesize_crossing_events_for_geometry_change (window);
5974 move_native_children (GdkWindow *private)
5978 GdkWindowImplClass *impl_class;
5980 for (l = private->children; l; l = l->next)
5984 if (child->impl != private->impl)
5986 impl_class = GDK_WINDOW_IMPL_GET_CLASS (child->impl);
5987 impl_class->move_resize (child, TRUE,
5989 child->width, child->height);
5992 move_native_children (child);
5997 collect_native_child_region_helper (GdkWindow *window,
5998 GdkWindowImpl *impl,
5999 cairo_region_t **region,
6004 cairo_region_t *tmp;
6007 for (l = window->children; l != NULL; l = l->next)
6011 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only)
6014 if (child->impl != impl)
6016 tmp = cairo_region_copy (child->clip_region);
6017 cairo_region_translate (tmp,
6018 x_offset + child->x,
6019 y_offset + child->y);
6020 if (*region == NULL)
6024 cairo_region_union (*region, tmp);
6025 cairo_region_destroy (tmp);
6029 collect_native_child_region_helper (child, impl, region,
6030 x_offset + child->x,
6031 y_offset + child->y);
6037 static cairo_region_t *
6038 collect_native_child_region (GdkWindow *window,
6039 gboolean include_this)
6041 cairo_region_t *region;
6043 if (include_this && gdk_window_has_impl (window) && window->viewable)
6044 return cairo_region_copy (window->clip_region);
6048 collect_native_child_region_helper (window, window->impl, ®ion, 0, 0);
6055 gdk_window_move_resize_internal (GdkWindow *window,
6062 cairo_region_t *old_region, *old_layered, *new_region, *copy_area;
6063 cairo_region_t *old_native_child_region, *new_native_child_region;
6064 GdkWindow *impl_window;
6065 GdkWindowImplClass *impl_class;
6067 int old_x, old_y, old_abs_x, old_abs_y;
6070 g_return_if_fail (GDK_IS_WINDOW (window));
6072 if (window->destroyed)
6075 if (gdk_window_is_toplevel (window))
6077 gdk_window_move_resize_toplevel (window, with_move, x, y, width, height);
6081 /* Bail early if no change */
6082 if (window->width == width &&
6083 window->height == height &&
6089 gdk_window_flush_if_exposing (window);
6091 /* Handle child windows */
6097 impl_window = gdk_window_get_impl_window (window);
6102 old_native_child_region = NULL;
6103 if (gdk_window_is_viewable (window) &&
6104 !window->input_only)
6108 old_region = cairo_region_copy (window->clip_region);
6109 old_layered = cairo_region_copy (window->layered_region);
6110 /* Adjust regions to parent window coords */
6111 cairo_region_translate (old_region, window->x, window->y);
6112 cairo_region_translate (old_layered, window->x, window->y);
6114 old_native_child_region = collect_native_child_region (window, TRUE);
6115 if (old_native_child_region)
6117 /* Adjust region to parent window coords */
6118 cairo_region_translate (old_native_child_region, window->x, window->y);
6120 /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6121 * source or destination for a delayed GdkWindowRegionMove. So, we need
6122 * to flush those here for the parent window and all overlapped subwindows
6123 * of it. And we need to do this before setting the new clips as those will be
6126 gdk_window_flush_recursive (window->parent);
6130 /* Set the new position and size */
6136 if (!(width < 0 && height < 0))
6140 window->width = width;
6143 window->height = height;
6146 dx = window->x - old_x;
6147 dy = window->y - old_y;
6149 old_abs_x = window->abs_x;
6150 old_abs_y = window->abs_y;
6152 recompute_visible_regions (window, TRUE, FALSE);
6154 new_native_child_region = NULL;
6155 if (old_native_child_region)
6157 new_native_child_region = collect_native_child_region (window, TRUE);
6158 /* Adjust region to parent window coords */
6159 cairo_region_translate (new_native_child_region, window->x, window->y);
6162 if (gdk_window_has_impl (window))
6164 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6166 /* Do the actual move after recomputing things, as this will have set the shape to
6167 the now correct one, thus avoiding copying regions that should not be copied. */
6168 impl_class->move_resize (window, TRUE,
6169 window->x, window->y,
6170 window->width, window->height);
6172 else if (old_abs_x != window->abs_x ||
6173 old_abs_y != window->abs_y)
6174 move_native_children (window);
6178 new_region = cairo_region_copy (window->clip_region);
6179 /* Adjust region to parent window coords */
6180 cairo_region_translate (new_region, window->x, window->y);
6183 * Part of the data at the new location can be copied from the
6184 * old location, this area is the intersection of the old region
6185 * moved as the copy will move it and then intersected with
6189 * Everything in the old and new regions that is not copied must be
6190 * invalidated (including children) as this is newly exposed
6192 if (window->has_alpha_background)
6193 copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6195 copy_area = cairo_region_copy (new_region);
6197 /* Don't copy from a previously layered region */
6198 cairo_region_translate (old_layered, dx, dy);
6199 cairo_region_subtract (copy_area, old_layered);
6201 /* Don't copy into a layered region */
6202 cairo_region_translate (copy_area, -window->x, -window->y);
6203 cairo_region_subtract (copy_area, window->layered_region);
6204 cairo_region_translate (copy_area, window->x, window->y);
6206 cairo_region_union (new_region, old_region);
6208 if (old_native_child_region)
6210 /* Don't copy from inside native children, as this is copied by
6211 * the native window move.
6213 cairo_region_subtract (old_region, old_native_child_region);
6215 cairo_region_translate (old_region, dx, dy);
6217 cairo_region_intersect (copy_area, old_region);
6219 if (new_native_child_region)
6221 /* Don't copy any bits that would cause a read from the moved
6222 native windows, as we can't read that data */
6223 cairo_region_translate (new_native_child_region, dx, dy);
6224 cairo_region_subtract (copy_area, new_native_child_region);
6225 cairo_region_translate (new_native_child_region, -dx, -dy);
6228 cairo_region_subtract (new_region, copy_area);
6230 /* Convert old region to impl coords */
6231 cairo_region_translate (old_region, -dx + window->abs_x - window->x, -dy + window->abs_y - window->y);
6233 /* convert from parent coords to impl */
6234 cairo_region_translate (copy_area, window->abs_x - window->x, window->abs_y - window->y);
6236 move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6238 /* Invalidate affected part in the parent window
6239 * (no higher window should be affected)
6240 * We also invalidate any children in that area, which could include
6241 * this window if it still overlaps that area.
6243 if (old_native_child_region)
6245 /* No need to expose the region that the native window move copies */
6246 cairo_region_translate (old_native_child_region, dx, dy);
6247 cairo_region_intersect (old_native_child_region, new_native_child_region);
6248 cairo_region_subtract (new_region, old_native_child_region);
6250 gdk_window_invalidate_region_full (window->parent, new_region, TRUE, CLEAR_BG_ALL);
6252 cairo_region_destroy (old_region);
6253 cairo_region_destroy (old_layered);
6254 cairo_region_destroy (new_region);
6257 if (old_native_child_region)
6259 cairo_region_destroy (old_native_child_region);
6260 cairo_region_destroy (new_native_child_region);
6263 _gdk_synthesize_crossing_events_for_geometry_change (window);
6270 * @window: a #GdkWindow
6271 * @x: X coordinate relative to window's parent
6272 * @y: Y coordinate relative to window's parent
6274 * Repositions a window relative to its parent window.
6275 * For toplevel windows, window managers may ignore or modify the move;
6276 * you should probably use gtk_window_move() on a #GtkWindow widget
6277 * anyway, instead of using GDK functions. For child windows,
6278 * the move will reliably succeed.
6280 * If you're also planning to resize the window, use gdk_window_move_resize()
6281 * to both move and resize simultaneously, for a nicer visual effect.
6284 gdk_window_move (GdkWindow *window,
6288 gdk_window_move_resize_internal (window, TRUE, x, y, -1, -1);
6292 * gdk_window_resize:
6293 * @window: a #GdkWindow
6294 * @width: new width of the window
6295 * @height: new height of the window
6297 * Resizes @window; for toplevel windows, asks the window manager to resize
6298 * the window. The window manager may not allow the resize. When using GTK+,
6299 * use gtk_window_resize() instead of this low-level GDK function.
6301 * Windows may not be resized below 1x1.
6303 * If you're also planning to move the window, use gdk_window_move_resize()
6304 * to both move and resize simultaneously, for a nicer visual effect.
6307 gdk_window_resize (GdkWindow *window,
6311 gdk_window_move_resize_internal (window, FALSE, 0, 0, width, height);
6316 * gdk_window_move_resize:
6317 * @window: a #GdkWindow
6318 * @x: new X position relative to window's parent
6319 * @y: new Y position relative to window's parent
6321 * @height: new height
6323 * Equivalent to calling gdk_window_move() and gdk_window_resize(),
6324 * except that both operations are performed at once, avoiding strange
6325 * visual effects. (i.e. the user may be able to see the window first
6326 * move, then resize, if you don't use gdk_window_move_resize().)
6329 gdk_window_move_resize (GdkWindow *window,
6335 gdk_window_move_resize_internal (window, TRUE, x, y, width, height);
6340 * gdk_window_scroll:
6341 * @window: a #GdkWindow
6342 * @dx: Amount to scroll in the X direction
6343 * @dy: Amount to scroll in the Y direction
6345 * Scroll the contents of @window, both pixels and children, by the
6346 * given amount. @window itself does not move. Portions of the window
6347 * that the scroll operation brings in from offscreen areas are
6348 * invalidated. The invalidated region may be bigger than what would
6349 * strictly be necessary.
6351 * For X11, a minimum area will be invalidated if the window has no
6352 * subwindows, or if the edges of the window's parent do not extend
6353 * beyond the edges of the window. In other cases, a multi-step process
6354 * is used to scroll the window which may produce temporary visual
6355 * artifacts and unnecessary invalidations.
6358 gdk_window_scroll (GdkWindow *window,
6362 GdkWindow *impl_window;
6363 cairo_region_t *copy_area, *noncopy_area, *old_layered_area;
6364 cairo_region_t *old_native_child_region, *new_native_child_region;
6367 g_return_if_fail (GDK_IS_WINDOW (window));
6369 if (dx == 0 && dy == 0)
6372 if (window->destroyed)
6375 gdk_window_flush_if_exposing (window);
6377 old_layered_area = cairo_region_copy (window->layered_region);
6378 old_native_child_region = collect_native_child_region (window, FALSE);
6379 if (old_native_child_region)
6381 /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6382 * source or destination for a delayed GdkWindowRegionMove. So, we need
6383 * to flush those here for the window and all overlapped subwindows
6384 * of it. And we need to do this before setting the new clips as those will be
6387 gdk_window_flush_recursive (window);
6391 /* First move all child windows, without causing invalidation */
6393 tmp_list = window->children;
6396 GdkWindow *child = GDK_WINDOW (tmp_list->data);
6398 /* Just update the positions, the bits will move with the copy */
6402 tmp_list = tmp_list->next;
6405 recompute_visible_regions (window, FALSE, TRUE);
6407 new_native_child_region = NULL;
6408 if (old_native_child_region)
6409 new_native_child_region = collect_native_child_region (window, FALSE);
6411 move_native_children (window);
6413 /* Then copy the actual bits of the window w/ child windows */
6415 impl_window = gdk_window_get_impl_window (window);
6417 /* Calculate the area that can be gotten by copying the old area */
6418 if (window->has_alpha_background)
6419 copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6421 copy_area = cairo_region_copy (window->clip_region);
6422 cairo_region_subtract (copy_area, old_layered_area);
6423 if (old_native_child_region)
6425 /* Don't copy from inside native children, as this is copied by
6426 * the native window move.
6428 cairo_region_subtract (copy_area, old_native_child_region);
6430 /* Don't copy any bits that would cause a read from the moved
6431 native windows, as we can't read that data */
6432 cairo_region_subtract (copy_area, new_native_child_region);
6434 cairo_region_translate (copy_area, dx, dy);
6435 cairo_region_intersect (copy_area, window->clip_region);
6436 cairo_region_subtract (copy_area, window->layered_region);
6438 /* And the rest need to be invalidated */
6439 noncopy_area = cairo_region_copy (window->clip_region);
6440 cairo_region_subtract (noncopy_area, copy_area);
6442 /* convert from window coords to impl */
6443 cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6445 move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6447 /* Invalidate not copied regions */
6448 if (old_native_child_region)
6450 /* No need to expose the region that the native window move copies */
6451 cairo_region_translate (old_native_child_region, dx, dy);
6452 cairo_region_intersect (old_native_child_region, new_native_child_region);
6453 cairo_region_subtract (noncopy_area, old_native_child_region);
6455 gdk_window_invalidate_region_full (window, noncopy_area, TRUE, CLEAR_BG_ALL);
6457 cairo_region_destroy (noncopy_area);
6458 cairo_region_destroy (old_layered_area);
6460 if (old_native_child_region)
6462 cairo_region_destroy (old_native_child_region);
6463 cairo_region_destroy (new_native_child_region);
6466 _gdk_synthesize_crossing_events_for_geometry_change (window);
6470 * gdk_window_move_region:
6471 * @window: a #GdkWindow
6472 * @region: The #cairo_region_t to move
6473 * @dx: Amount to move in the X direction
6474 * @dy: Amount to move in the Y direction
6476 * Move the part of @window indicated by @region by @dy pixels in the Y
6477 * direction and @dx pixels in the X direction. The portions of @region
6478 * that not covered by the new position of @region are invalidated.
6480 * Child windows are not moved.
6485 gdk_window_move_region (GdkWindow *window,
6486 const cairo_region_t *region,
6490 GdkWindow *impl_window;
6491 cairo_region_t *nocopy_area;
6492 cairo_region_t *copy_area;
6494 g_return_if_fail (GDK_IS_WINDOW (window));
6495 g_return_if_fail (region != NULL);
6497 if (dx == 0 && dy == 0)
6500 if (window->destroyed)
6503 impl_window = gdk_window_get_impl_window (window);
6505 /* compute source regions */
6506 if (window->has_alpha_background)
6507 copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6509 copy_area = cairo_region_copy (region);
6510 cairo_region_intersect (copy_area, window->clip_region_with_children);
6511 cairo_region_subtract (copy_area, window->layered_region);
6512 remove_layered_child_area (window, copy_area);
6514 /* compute destination regions */
6515 cairo_region_translate (copy_area, dx, dy);
6516 cairo_region_intersect (copy_area, window->clip_region_with_children);
6517 cairo_region_subtract (copy_area, window->layered_region);
6518 remove_layered_child_area (window, copy_area);
6520 /* Invalidate parts of the region (source and dest) not covered
6522 nocopy_area = cairo_region_copy (region);
6523 cairo_region_translate (nocopy_area, dx, dy);
6524 cairo_region_union (nocopy_area, region);
6525 cairo_region_subtract (nocopy_area, copy_area);
6527 /* convert from window coords to impl */
6528 cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6529 move_region_on_impl (impl_window, copy_area, dx, dy); /* Takes ownership of copy_area */
6531 gdk_window_invalidate_region_full (window, nocopy_area, FALSE, CLEAR_BG_ALL);
6532 cairo_region_destroy (nocopy_area);
6536 * gdk_window_set_background:
6537 * @window: a #GdkWindow
6538 * @color: a #GdkColor
6540 * Sets the background color of @window. (However, when using GTK+,
6541 * set the background of a widget with gtk_widget_modify_bg() - if
6542 * you're an application - or gtk_style_set_background() - if you're
6543 * implementing a custom widget.)
6545 * See also gdk_window_set_background_pattern().
6547 * Deprecated: 3.4: Use gdk_window_set_background_rgba() instead.
6550 gdk_window_set_background (GdkWindow *window,
6551 const GdkColor *color)
6553 cairo_pattern_t *pattern;
6555 g_return_if_fail (GDK_IS_WINDOW (window));
6557 pattern = cairo_pattern_create_rgb (color->red / 65535.,
6558 color->green / 65535.,
6559 color->blue / 65535.);
6561 gdk_window_set_background_pattern (window, pattern);
6563 cairo_pattern_destroy (pattern);
6567 * gdk_window_set_background_rgba:
6568 * @window: a #GdkWindow
6569 * @rgba: a #GdkRGBA color
6571 * Sets the background color of @window.
6573 * See also gdk_window_set_background_pattern().
6576 gdk_window_set_background_rgba (GdkWindow *window,
6579 cairo_pattern_t *pattern;
6581 g_return_if_fail (GDK_IS_WINDOW (window));
6582 g_return_if_fail (rgba != NULL);
6584 pattern = cairo_pattern_create_rgba (rgba->red, rgba->green,
6585 rgba->blue, rgba->alpha);
6587 gdk_window_set_background_pattern (window, pattern);
6589 cairo_pattern_destroy (pattern);
6593 /* Updates has_alpha_background recursively for all child windows
6594 that have parent-relative alpha */
6596 _gdk_window_propagate_has_alpha_background (GdkWindow *window)
6601 for (l = window->children; l; l = l->next)
6605 if (child->background == NULL &&
6606 child->has_alpha_background != window->has_alpha_background)
6608 child->has_alpha_background = window->has_alpha_background;
6609 recompute_visible_regions (child, TRUE, FALSE);
6610 _gdk_window_propagate_has_alpha_background (child);
6616 * gdk_window_set_background_pattern:
6617 * @window: a #GdkWindow
6618 * @pattern: (allow-none): a pattern to use, or %NULL
6620 * Sets the background of @window.
6622 * A background of %NULL means that the window will inherit its
6623 * background form its parent window.
6625 * The windowing system will normally fill a window with its background
6626 * when the window is obscured then exposed.
6629 gdk_window_set_background_pattern (GdkWindow *window,
6630 cairo_pattern_t *pattern)
6633 cairo_pattern_type_t type;
6635 g_return_if_fail (GDK_IS_WINDOW (window));
6637 if (window->input_only)
6641 cairo_pattern_reference (pattern);
6642 if (window->background)
6643 cairo_pattern_destroy (window->background);
6644 window->background = pattern;
6648 if (pattern == NULL)
6650 /* parent-relative, copy has_alpha from parent */
6651 if (window->parent == NULL ||
6652 window->parent->window_type == GDK_WINDOW_ROOT)
6655 has_alpha = window->parent->has_alpha_background;
6659 type = cairo_pattern_get_type (pattern);
6661 if (type == CAIRO_PATTERN_TYPE_SOLID)
6664 cairo_pattern_get_rgba (pattern, NULL, NULL, NULL, &alpha);
6668 else if (type == CAIRO_PATTERN_TYPE_LINEAR ||
6669 type == CAIRO_PATTERN_TYPE_RADIAL)
6675 cairo_pattern_get_color_stop_count (pattern, &n);
6677 for (i = 0; i < n; i++)
6679 cairo_pattern_get_color_stop_rgba (pattern, i, NULL,
6680 NULL, NULL, NULL, &alpha);
6688 else if (type == CAIRO_PATTERN_TYPE_SURFACE)
6690 cairo_surface_t *surface;
6691 cairo_content_t content;
6693 cairo_pattern_get_surface (pattern, &surface);
6694 content = cairo_surface_get_content (surface);
6696 (content == CAIRO_CONTENT_ALPHA) ||
6697 (content == CAIRO_CONTENT_COLOR_ALPHA);
6701 if (has_alpha != window->has_alpha_background)
6703 window->has_alpha_background = has_alpha;
6704 recompute_visible_regions (window, TRUE, FALSE);
6706 _gdk_window_propagate_has_alpha_background (window);
6709 if (gdk_window_has_impl (window))
6711 GdkWindowImplClass *impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6712 impl_class->set_background (window, pattern);
6715 gdk_window_invalidate_rect_full (window, NULL, TRUE, CLEAR_BG_ALL);
6719 * gdk_window_get_background_pattern:
6722 * Gets the pattern used to clear the background on @window. If @window
6723 * does not have its own background and reuses the parent's, %NULL is
6724 * returned and you'll have to query it yourself.
6726 * Returns: (transfer none): The pattern to use for the background or
6727 * %NULL to use the parent's background.
6732 gdk_window_get_background_pattern (GdkWindow *window)
6734 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6736 return window->background;
6740 gdk_window_set_cursor_internal (GdkWindow *window,
6744 if (GDK_WINDOW_DESTROYED (window))
6747 if (window->window_type == GDK_WINDOW_ROOT ||
6748 window->window_type == GDK_WINDOW_FOREIGN)
6749 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_device_cursor (window, device, cursor);
6752 GdkPointerWindowInfo *pointer_info;
6753 GdkDisplay *display;
6755 display = gdk_window_get_display (window);
6756 pointer_info = _gdk_display_get_pointer_info (display, device);
6758 if (_gdk_window_event_parent_of (window, pointer_info->window_under_pointer))
6759 update_cursor (display, device);
6764 * gdk_window_get_cursor:
6765 * @window: a #GdkWindow
6767 * Retrieves a #GdkCursor pointer for the cursor currently set on the
6768 * specified #GdkWindow, or %NULL. If the return value is %NULL then
6769 * there is no custom cursor set on the specified window, and it is
6770 * using the cursor for its parent window.
6772 * Return value: (transfer none): a #GdkCursor, or %NULL. The returned
6773 * object is owned by the #GdkWindow and should not be unreferenced
6774 * directly. Use gdk_window_set_cursor() to unset the cursor of the
6780 gdk_window_get_cursor (GdkWindow *window)
6782 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6784 return window->cursor;
6788 * gdk_window_set_cursor:
6789 * @window: a #GdkWindow
6790 * @cursor: (allow-none): a cursor
6792 * Sets the default mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display()
6793 * or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor
6794 * invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument
6795 * to gdk_window_set_cursor() means that @window will use the cursor of its
6796 * parent window. Most windows should use this default.
6799 gdk_window_set_cursor (GdkWindow *window,
6802 GdkDisplay *display;
6804 g_return_if_fail (GDK_IS_WINDOW (window));
6806 display = gdk_window_get_display (window);
6810 g_object_unref (window->cursor);
6811 window->cursor = NULL;
6814 if (!GDK_WINDOW_DESTROYED (window))
6816 GdkDeviceManager *device_manager;
6820 window->cursor = g_object_ref (cursor);
6822 device_manager = gdk_display_get_device_manager (display);
6823 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
6825 for (d = devices; d; d = d->next)
6831 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
6834 gdk_window_set_cursor_internal (window, device, window->cursor);
6837 g_list_free (devices);
6838 g_object_notify (G_OBJECT (window), "cursor");
6843 * gdk_window_get_device_cursor:
6844 * @window: a #GdkWindow.
6845 * @device: a master, pointer #GdkDevice.
6847 * Retrieves a #GdkCursor pointer for the @device currently set on the
6848 * specified #GdkWindow, or %NULL. If the return value is %NULL then
6849 * there is no custom cursor set on the specified window, and it is
6850 * using the cursor for its parent window.
6852 * Returns: (transfer none): a #GdkCursor, or %NULL. The returned
6853 * object is owned by the #GdkWindow and should not be unreferenced
6854 * directly. Use gdk_window_set_cursor() to unset the cursor of the
6860 gdk_window_get_device_cursor (GdkWindow *window,
6863 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6864 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
6865 g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
6866 g_return_val_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER, NULL);
6868 return g_hash_table_lookup (window->device_cursor, device);
6872 * gdk_window_set_device_cursor:
6873 * @window: a #Gdkwindow
6874 * @device: a master, pointer #GdkDevice
6875 * @cursor: a #GdkCursor
6877 * Sets a specific #GdkCursor for a given device when it gets inside @window.
6878 * Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create
6879 * the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing
6880 * %NULL for the @cursor argument to gdk_window_set_cursor() means that
6881 * @window will use the cursor of its parent window. Most windows should
6887 gdk_window_set_device_cursor (GdkWindow *window,
6891 g_return_if_fail (GDK_IS_WINDOW (window));
6892 g_return_if_fail (GDK_IS_DEVICE (device));
6893 g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
6894 g_return_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER);
6897 g_hash_table_remove (window->device_cursor, device);
6899 g_hash_table_replace (window->device_cursor, device, g_object_ref (cursor));
6901 gdk_window_set_cursor_internal (window, device, cursor);
6905 * gdk_window_get_geometry:
6906 * @window: a #GdkWindow
6907 * @x: (out) (allow-none): return location for X coordinate of window (relative to its parent)
6908 * @y: (out) (allow-none): return location for Y coordinate of window (relative to its parent)
6909 * @width: (out) (allow-none): return location for width of window
6910 * @height: (out) (allow-none): return location for height of window
6912 * Any of the return location arguments to this function may be %NULL,
6913 * if you aren't interested in getting the value of that field.
6915 * The X and Y coordinates returned are relative to the parent window
6916 * of @window, which for toplevels usually means relative to the
6917 * window decorations (titlebar, etc.) rather than relative to the
6918 * root window (screen-size background window).
6920 * On the X11 platform, the geometry is obtained from the X server,
6921 * so reflects the latest position of @window; this may be out-of-sync
6922 * with the position of @window delivered in the most-recently-processed
6923 * #GdkEventConfigure. gdk_window_get_position() in contrast gets the
6924 * position from the most recent configure event.
6927 * If @window is not a toplevel, it is <emphasis>much</emphasis> better
6928 * to call gdk_window_get_position(), gdk_window_get_width() and
6929 * gdk_window_get_height() instead, because it avoids the roundtrip to
6930 * the X server and because these functions support the full 32-bit
6931 * coordinate space, whereas gdk_window_get_geometry() is restricted to
6932 * the 16-bit coordinates of X11.
6936 gdk_window_get_geometry (GdkWindow *window,
6943 GdkWindowImplClass *impl_class;
6947 GDK_NOTE (MULTIHEAD,
6948 g_message ("gdk_window_get_geometry(): Window needs "
6949 "to be non-NULL to be multi head safe"));
6950 window = gdk_screen_get_root_window ((gdk_screen_get_default ()));
6953 g_return_if_fail (GDK_IS_WINDOW (window));
6955 if (!GDK_WINDOW_DESTROYED (window))
6957 if (gdk_window_has_impl (window))
6959 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6960 impl_class->get_geometry (window, x, y,
6962 /* This reports the position wrt to the native parent, we need to convert
6963 it to be relative to the client side parent */
6964 parent = window->parent;
6965 if (parent && !gdk_window_has_impl (parent))
6968 *x -= parent->abs_x;
6970 *y -= parent->abs_y;
6980 *width = window->width;
6982 *height = window->height;
6988 * gdk_window_get_width:
6989 * @window: a #GdkWindow
6991 * Returns the width of the given @window.
6993 * On the X11 platform the returned size is the size reported in the
6994 * most-recently-processed configure event, rather than the current
6995 * size on the X server.
6997 * Returns: The width of @window
7002 gdk_window_get_width (GdkWindow *window)
7004 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
7006 return window->width;
7010 * gdk_window_get_height:
7011 * @window: a #GdkWindow
7013 * Returns the height of the given @window.
7015 * On the X11 platform the returned size is the size reported in the
7016 * most-recently-processed configure event, rather than the current
7017 * size on the X server.
7019 * Returns: The height of @window
7024 gdk_window_get_height (GdkWindow *window)
7026 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
7028 return window->height;
7032 * gdk_window_get_origin:
7033 * @window: a #GdkWindow
7034 * @x: (out) (allow-none): return location for X coordinate
7035 * @y: (out) (allow-none): return location for Y coordinate
7037 * Obtains the position of a window in root window coordinates.
7038 * (Compare with gdk_window_get_position() and
7039 * gdk_window_get_geometry() which return the position of a window
7040 * relative to its parent window.)
7042 * Return value: not meaningful, ignore
7045 gdk_window_get_origin (GdkWindow *window,
7049 GdkWindowImplClass *impl_class;
7051 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
7053 if (GDK_WINDOW_DESTROYED (window))
7062 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7063 impl_class->get_root_coords (window,
7072 * gdk_window_get_root_coords:
7073 * @window: a #GdkWindow
7074 * @x: X coordinate in window
7075 * @y: Y coordinate in window
7076 * @root_x: (out): return location for X coordinate
7077 * @root_y: (out): return location for Y coordinate
7079 * Obtains the position of a window position in root
7080 * window coordinates. This is similar to
7081 * gdk_window_get_origin() but allows you go pass
7082 * in any position in the window, not just the origin.
7087 gdk_window_get_root_coords (GdkWindow *window,
7093 GdkWindowImplClass *impl_class;
7095 g_return_if_fail (GDK_IS_WINDOW (window));
7097 if (GDK_WINDOW_DESTROYED (window))
7104 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7105 impl_class->get_root_coords (window,
7112 * gdk_window_coords_to_parent:
7113 * @window: a child window
7114 * @x: X coordinate in child's coordinate system
7115 * @y: Y coordinate in child's coordinate system
7116 * @parent_x: (out) (allow-none): return location for X coordinate
7117 * in parent's coordinate system, or %NULL
7118 * @parent_y: (out) (allow-none): return location for Y coordinate
7119 * in parent's coordinate system, or %NULL
7121 * Transforms window coordinates from a child window to its parent
7122 * window, where the parent window is the normal parent as returned by
7123 * gdk_window_get_parent() for normal windows, and the window's
7124 * embedder as returned by gdk_offscreen_window_get_embedder() for
7125 * offscreen windows.
7127 * For normal windows, calling this function is equivalent to adding
7128 * the return values of gdk_window_get_position() to the child coordinates.
7129 * For offscreen windows however (which can be arbitrarily transformed),
7130 * this function calls the GdkWindow::to-embedder: signal to translate
7133 * You should always use this function when writing generic code that
7134 * walks up a window hierarchy.
7136 * See also: gdk_window_coords_from_parent()
7141 gdk_window_coords_to_parent (GdkWindow *window,
7147 g_return_if_fail (GDK_IS_WINDOW (window));
7149 if (gdk_window_is_offscreen (window))
7153 to_embedder (window, x, y, &px, &py);
7164 *parent_x = x + window->x;
7167 *parent_y = y + window->y;
7172 * gdk_window_coords_from_parent:
7173 * @window: a child window
7174 * @parent_x: X coordinate in parent's coordinate system
7175 * @parent_y: Y coordinate in parent's coordinate system
7176 * @x: (out) (allow-none): return location for X coordinate in child's coordinate system
7177 * @y: (out) (allow-none): return location for Y coordinate in child's coordinate system
7179 * Transforms window coordinates from a parent window to a child
7180 * window, where the parent window is the normal parent as returned by
7181 * gdk_window_get_parent() for normal windows, and the window's
7182 * embedder as returned by gdk_offscreen_window_get_embedder() for
7183 * offscreen windows.
7185 * For normal windows, calling this function is equivalent to subtracting
7186 * the return values of gdk_window_get_position() from the parent coordinates.
7187 * For offscreen windows however (which can be arbitrarily transformed),
7188 * this function calls the GdkWindow::from-embedder: signal to translate
7191 * You should always use this function when writing generic code that
7192 * walks down a window hierarchy.
7194 * See also: gdk_window_coords_to_parent()
7199 gdk_window_coords_from_parent (GdkWindow *window,
7205 g_return_if_fail (GDK_IS_WINDOW (window));
7207 if (gdk_window_is_offscreen (window))
7211 from_embedder (window, parent_x, parent_y, &cx, &cy);
7222 *x = parent_x - window->x;
7225 *y = parent_y - window->y;
7230 * gdk_window_shape_combine_region:
7231 * @window: a #GdkWindow
7232 * @shape_region: (allow-none): region of window to be non-transparent
7233 * @offset_x: X position of @shape_region in @window coordinates
7234 * @offset_y: Y position of @shape_region in @window coordinates
7236 * Makes pixels in @window outside @shape_region be transparent,
7237 * so that the window may be nonrectangular.
7239 * If @shape_region is %NULL, the shape will be unset, so the whole
7240 * window will be opaque again. @offset_x and @offset_y are ignored
7241 * if @shape_region is %NULL.
7243 * On the X11 platform, this uses an X server extension which is
7244 * widely available on most common platforms, but not available on
7245 * very old X servers, and occasionally the implementation will be
7246 * buggy. On servers without the shape extension, this function
7249 * This function works on both toplevel and child windows.
7252 gdk_window_shape_combine_region (GdkWindow *window,
7253 const cairo_region_t *shape_region,
7257 cairo_region_t *old_region, *new_region, *diff;
7259 g_return_if_fail (GDK_IS_WINDOW (window));
7261 if (GDK_WINDOW_DESTROYED (window))
7264 if (!window->shape && shape_region == NULL)
7267 window->shaped = (shape_region != NULL);
7270 cairo_region_destroy (window->shape);
7273 if (GDK_WINDOW_IS_MAPPED (window))
7274 old_region = cairo_region_copy (window->clip_region);
7278 window->shape = cairo_region_copy (shape_region);
7279 cairo_region_translate (window->shape, offset_x, offset_y);
7282 window->shape = NULL;
7284 recompute_visible_regions (window, TRUE, FALSE);
7286 if (gdk_window_has_impl (window) &&
7287 !should_apply_clip_as_shape (window))
7288 apply_shape (window, window->shape);
7292 new_region = cairo_region_copy (window->clip_region);
7294 /* New area in the window, needs invalidation */
7295 diff = cairo_region_copy (new_region);
7296 cairo_region_subtract (diff, old_region);
7298 gdk_window_invalidate_region_full (window, diff, TRUE, CLEAR_BG_ALL);
7300 cairo_region_destroy (diff);
7302 if (!gdk_window_is_toplevel (window))
7304 /* New area in the non-root parent window, needs invalidation */
7305 diff = cairo_region_copy (old_region);
7306 cairo_region_subtract (diff, new_region);
7308 /* Adjust region to parent window coords */
7309 cairo_region_translate (diff, window->x, window->y);
7311 gdk_window_invalidate_region_full (window->parent, diff, TRUE, CLEAR_BG_ALL);
7313 cairo_region_destroy (diff);
7316 cairo_region_destroy (new_region);
7317 cairo_region_destroy (old_region);
7322 do_child_shapes (GdkWindow *window,
7326 cairo_region_t *region;
7330 r.width = window->width;
7331 r.height = window->height;
7333 region = cairo_region_create_rectangle (&r);
7334 remove_child_area (window, NULL, FALSE, region, NULL);
7336 if (merge && window->shape)
7337 cairo_region_subtract (region, window->shape);
7339 gdk_window_shape_combine_region (window, region, 0, 0);
7343 * gdk_window_set_child_shapes:
7344 * @window: a #GdkWindow
7346 * Sets the shape mask of @window to the union of shape masks
7347 * for all children of @window, ignoring the shape mask of @window
7348 * itself. Contrast with gdk_window_merge_child_shapes() which includes
7349 * the shape mask of @window in the masks to be merged.
7352 gdk_window_set_child_shapes (GdkWindow *window)
7354 g_return_if_fail (GDK_IS_WINDOW (window));
7356 do_child_shapes (window, FALSE);
7360 * gdk_window_merge_child_shapes:
7361 * @window: a #GdkWindow
7363 * Merges the shape masks for any child windows into the
7364 * shape mask for @window. i.e. the union of all masks
7365 * for @window and its children will become the new mask
7366 * for @window. See gdk_window_shape_combine_region().
7368 * This function is distinct from gdk_window_set_child_shapes()
7369 * because it includes @window's shape mask in the set of shapes to
7373 gdk_window_merge_child_shapes (GdkWindow *window)
7375 g_return_if_fail (GDK_IS_WINDOW (window));
7377 do_child_shapes (window, TRUE);
7381 * gdk_window_input_shape_combine_region:
7382 * @window: a #GdkWindow
7383 * @shape_region: region of window to be non-transparent
7384 * @offset_x: X position of @shape_region in @window coordinates
7385 * @offset_y: Y position of @shape_region in @window coordinates
7387 * Like gdk_window_shape_combine_region(), but the shape applies
7388 * only to event handling. Mouse events which happen while
7389 * the pointer position corresponds to an unset bit in the
7390 * mask will be passed on the window below @window.
7392 * An input shape is typically used with RGBA windows.
7393 * The alpha channel of the window defines which pixels are
7394 * invisible and allows for nicely antialiased borders,
7395 * and the input shape controls where the window is
7398 * On the X11 platform, this requires version 1.1 of the
7401 * On the Win32 platform, this functionality is not present and the
7402 * function does nothing.
7407 gdk_window_input_shape_combine_region (GdkWindow *window,
7408 const cairo_region_t *shape_region,
7412 GdkWindowImplClass *impl_class;
7414 g_return_if_fail (GDK_IS_WINDOW (window));
7416 if (GDK_WINDOW_DESTROYED (window))
7419 if (window->input_shape)
7420 cairo_region_destroy (window->input_shape);
7424 window->input_shape = cairo_region_copy (shape_region);
7425 cairo_region_translate (window->input_shape, offset_x, offset_y);
7428 window->input_shape = NULL;
7430 if (gdk_window_has_impl (window))
7432 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7433 impl_class->input_shape_combine_region (window, window->input_shape, 0, 0);
7436 /* Pointer may have e.g. moved outside window due to the input mask change */
7437 _gdk_synthesize_crossing_events_for_geometry_change (window);
7441 do_child_input_shapes (GdkWindow *window,
7445 cairo_region_t *region;
7449 r.width = window->width;
7450 r.height = window->height;
7452 region = cairo_region_create_rectangle (&r);
7453 remove_child_area (window, NULL, TRUE, region, NULL);
7455 if (merge && window->shape)
7456 cairo_region_subtract (region, window->shape);
7457 if (merge && window->input_shape)
7458 cairo_region_subtract (region, window->input_shape);
7460 gdk_window_input_shape_combine_region (window, region, 0, 0);
7465 * gdk_window_set_child_input_shapes:
7466 * @window: a #GdkWindow
7468 * Sets the input shape mask of @window to the union of input shape masks
7469 * for all children of @window, ignoring the input shape mask of @window
7470 * itself. Contrast with gdk_window_merge_child_input_shapes() which includes
7471 * the input shape mask of @window in the masks to be merged.
7476 gdk_window_set_child_input_shapes (GdkWindow *window)
7478 g_return_if_fail (GDK_IS_WINDOW (window));
7480 do_child_input_shapes (window, FALSE);
7484 * gdk_window_merge_child_input_shapes:
7485 * @window: a #GdkWindow
7487 * Merges the input shape masks for any child windows into the
7488 * input shape mask for @window. i.e. the union of all input masks
7489 * for @window and its children will become the new input mask
7490 * for @window. See gdk_window_input_shape_combine_region().
7492 * This function is distinct from gdk_window_set_child_input_shapes()
7493 * because it includes @window's input shape mask in the set of
7494 * shapes to be merged.
7499 gdk_window_merge_child_input_shapes (GdkWindow *window)
7501 g_return_if_fail (GDK_IS_WINDOW (window));
7503 do_child_input_shapes (window, TRUE);
7508 * gdk_window_set_static_gravities:
7509 * @window: a #GdkWindow
7510 * @use_static: %TRUE to turn on static gravity
7512 * Set the bit gravity of the given window to static, and flag it so
7513 * all children get static subwindow gravity. This is used if you are
7514 * implementing scary features that involve deep knowledge of the
7515 * windowing system. Don't worry about it unless you have to.
7517 * Return value: %TRUE if the server supports static gravity
7520 gdk_window_set_static_gravities (GdkWindow *window,
7521 gboolean use_static)
7523 GdkWindowImplClass *impl_class;
7525 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7527 if (gdk_window_has_impl (window))
7529 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7530 return impl_class->set_static_gravities (window, use_static);
7537 * gdk_window_get_composited:
7538 * @window: a #GdkWindow
7540 * Determines whether @window is composited.
7542 * See gdk_window_set_composited().
7544 * Returns: %TRUE if the window is composited.
7549 gdk_window_get_composited (GdkWindow *window)
7551 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7553 return window->composited;
7557 * gdk_window_set_composited:
7558 * @window: a #GdkWindow
7559 * @composited: %TRUE to set the window as composited
7561 * Sets a #GdkWindow as composited, or unsets it. Composited
7562 * windows do not automatically have their contents drawn to
7563 * the screen. Drawing is redirected to an offscreen buffer
7564 * and an expose event is emitted on the parent of the composited
7565 * window. It is the responsibility of the parent's expose handler
7566 * to manually merge the off-screen content onto the screen in
7567 * whatever way it sees fit. See <xref linkend="composited-window-example"/>
7570 * It only makes sense for child windows to be composited; see
7571 * gdk_window_set_opacity() if you need translucent toplevel
7574 * An additional effect of this call is that the area of this
7575 * window is no longer clipped from regions marked for
7576 * invalidation on its parent. Draws done on the parent
7577 * window are also no longer clipped by the child.
7579 * This call is only supported on some systems (currently,
7580 * only X11 with new enough Xcomposite and Xdamage extensions).
7581 * You must call gdk_display_supports_composite() to check if
7582 * setting a window as composited is supported before
7583 * attempting to do so.
7588 gdk_window_set_composited (GdkWindow *window,
7589 gboolean composited)
7591 GdkDisplay *display;
7592 GdkWindowImplClass *impl_class;
7594 g_return_if_fail (GDK_IS_WINDOW (window));
7596 composited = composited != FALSE;
7598 if (window->composited == composited)
7602 gdk_window_ensure_native (window);
7604 display = gdk_window_get_display (window);
7606 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7608 if (composited && (!gdk_display_supports_composite (display) || !impl_class->set_composited))
7610 g_warning ("gdk_window_set_composited called but "
7611 "compositing is not supported");
7615 impl_class->set_composited (window, composited);
7617 recompute_visible_regions (window, TRUE, FALSE);
7619 if (GDK_WINDOW_IS_MAPPED (window))
7620 gdk_window_invalidate_in_parent (window);
7622 window->composited = composited;
7626 * gdk_window_get_modal_hint:
7627 * @window: A toplevel #GdkWindow.
7629 * Determines whether or not the window manager is hinted that @window
7630 * has modal behaviour.
7632 * Return value: whether or not the window has the modal hint set.
7637 gdk_window_get_modal_hint (GdkWindow *window)
7639 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7641 return window->modal_hint;
7645 * gdk_window_get_accept_focus:
7646 * @window: a toplevel #GdkWindow.
7648 * Determines whether or not the desktop environment shuld be hinted that
7649 * the window does not want to receive input focus.
7651 * Return value: whether or not the window should receive input focus.
7656 gdk_window_get_accept_focus (GdkWindow *window)
7658 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7660 return window->accept_focus;
7664 * gdk_window_get_focus_on_map:
7665 * @window: a toplevel #GdkWindow.
7667 * Determines whether or not the desktop environment should be hinted that the
7668 * window does not want to receive input focus when it is mapped.
7670 * Return value: whether or not the window wants to receive input focus when
7676 gdk_window_get_focus_on_map (GdkWindow *window)
7678 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7680 return window->focus_on_map;
7684 * gdk_window_is_input_only:
7685 * @window: a toplevel #GdkWindow
7687 * Determines whether or not the window is an input only window.
7689 * Return value: %TRUE if @window is input only
7694 gdk_window_is_input_only (GdkWindow *window)
7696 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7698 return window->input_only;
7702 * gdk_window_is_shaped:
7703 * @window: a toplevel #GdkWindow
7705 * Determines whether or not the window is shaped.
7707 * Return value: %TRUE if @window is shaped
7712 gdk_window_is_shaped (GdkWindow *window)
7714 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7716 return window->shaped;
7720 _gdk_window_add_damage (GdkWindow *toplevel,
7721 cairo_region_t *damaged_region)
7723 GdkDisplay *display;
7724 GdkEvent event = { 0, };
7725 event.expose.type = GDK_DAMAGE;
7726 event.expose.window = toplevel;
7727 event.expose.send_event = FALSE;
7728 event.expose.region = damaged_region;
7729 cairo_region_get_extents (event.expose.region, &event.expose.area);
7730 display = gdk_window_get_display (event.expose.window);
7731 _gdk_event_queue_append (display, gdk_event_copy (&event));
7734 /* Gets the toplevel for a window as used for events,
7735 i.e. including offscreen parents */
7737 get_event_parent (GdkWindow *window)
7739 if (gdk_window_is_offscreen (window))
7740 return gdk_offscreen_window_get_embedder ((GdkWindow *)window);
7742 return window->parent;
7745 /* Gets the toplevel for a window as used for events,
7746 i.e. including offscreen parents going up to the native
7749 get_event_toplevel (GdkWindow *window)
7753 while ((parent = get_event_parent (window)) != NULL &&
7754 (parent->window_type != GDK_WINDOW_ROOT))
7761 _gdk_window_event_parent_of (GdkWindow *parent,
7772 w = get_event_parent (w);
7779 update_cursor (GdkDisplay *display,
7782 GdkWindow *cursor_window, *parent, *toplevel;
7783 GdkWindow *pointer_window;
7784 GdkWindowImplClass *impl_class;
7785 GdkPointerWindowInfo *pointer_info;
7786 GdkDeviceGrabInfo *grab;
7789 pointer_info = _gdk_display_get_pointer_info (display, device);
7790 pointer_window = pointer_info->window_under_pointer;
7792 /* We ignore the serials here and just pick the last grab
7793 we've sent, as that would shortly be used anyway. */
7794 grab = _gdk_display_get_last_device_grab (display, device);
7797 /* the pointer is not in a descendant of the grab window */
7798 !_gdk_window_event_parent_of (grab->window, pointer_window))
7800 /* use the cursor from the grab window */
7801 cursor_window = grab->window;
7805 /* otherwise use the cursor from the pointer window */
7806 cursor_window = pointer_window;
7809 /* Find the first window with the cursor actually set, as
7810 the cursor is inherited from the parent */
7811 while (cursor_window->cursor == NULL &&
7812 (parent = get_event_parent (cursor_window)) != NULL &&
7813 parent->window_type != GDK_WINDOW_ROOT)
7814 cursor_window = parent;
7816 cursor = g_hash_table_lookup (cursor_window->device_cursor, device);
7819 cursor = cursor_window->cursor;
7821 /* Set all cursors on toplevel, otherwise its tricky to keep track of
7822 * which native window has what cursor set. */
7823 toplevel = get_event_toplevel (pointer_window);
7824 impl_class = GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl);
7825 impl_class->set_device_cursor (toplevel, device, cursor);
7829 point_in_window (GdkWindow *window,
7834 x >= 0 && x < window->width &&
7835 y >= 0 && y < window->height &&
7836 (window->shape == NULL ||
7837 cairo_region_contains_point (window->shape,
7839 (window->input_shape == NULL ||
7840 cairo_region_contains_point (window->input_shape,
7845 convert_native_coords_to_toplevel (GdkWindow *window,
7848 gdouble *toplevel_x,
7849 gdouble *toplevel_y)
7856 while (!gdk_window_is_toplevel (window))
7860 window = window->parent;
7870 convert_toplevel_coords_to_window (GdkWindow *window,
7878 GList *children, *l;
7884 while ((parent = get_event_parent (window)) != NULL &&
7885 (parent->window_type != GDK_WINDOW_ROOT))
7887 children = g_list_prepend (children, window);
7891 for (l = children; l != NULL; l = l->next)
7892 gdk_window_coords_from_parent (l->data, x, y, &x, &y);
7894 g_list_free (children);
7901 pick_embedded_child (GdkWindow *window,
7908 g_signal_emit (window,
7909 signals[PICK_EMBEDDED_CHILD], 0,
7916 _gdk_window_find_child_at (GdkWindow *window,
7921 double child_x, child_y;
7924 if (point_in_window (window, x, y))
7926 /* Children is ordered in reverse stack order, i.e. first is topmost */
7927 for (l = window->children; l != NULL; l = l->next)
7931 if (!GDK_WINDOW_IS_MAPPED (sub))
7934 gdk_window_coords_from_parent ((GdkWindow *)sub,
7936 &child_x, &child_y);
7937 if (point_in_window (sub, child_x, child_y))
7938 return (GdkWindow *)sub;
7941 if (window->num_offscreen_children > 0)
7943 sub = pick_embedded_child (window,
7946 return (GdkWindow *)sub;
7954 _gdk_window_find_descendant_at (GdkWindow *window,
7961 gdouble child_x, child_y;
7965 if (point_in_window (window, x, y))
7970 /* Children is ordered in reverse stack order, i.e. first is topmost */
7971 for (l = window->children; l != NULL; l = l->next)
7975 if (!GDK_WINDOW_IS_MAPPED (sub))
7978 gdk_window_coords_from_parent ((GdkWindow *)sub,
7980 &child_x, &child_y);
7981 if (point_in_window (sub, child_x, child_y))
7991 window->num_offscreen_children > 0)
7993 sub = pick_embedded_child (window,
7999 from_embedder (sub, x, y, &x, &y);
8007 /* Not in window at all */
8021 * @window: a toplevel #GdkWindow
8023 * Emits a short beep associated to @window in the appropriate
8024 * display, if supported. Otherwise, emits a short beep on
8025 * the display just as gdk_display_beep().
8030 gdk_window_beep (GdkWindow *window)
8032 GdkDisplay *display;
8033 GdkWindow *toplevel;
8035 g_return_if_fail (GDK_IS_WINDOW (window));
8037 if (GDK_WINDOW_DESTROYED (window))
8040 toplevel = get_event_toplevel (window);
8041 display = gdk_window_get_display (window);
8045 if (GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl)->beep (toplevel))
8049 /* If windows fail to beep, we beep the display. */
8050 gdk_display_beep (display);
8054 * gdk_window_set_support_multidevice:
8055 * @window: a #GdkWindow.
8056 * @support_multidevice: %TRUE to enable multidevice support in @window.
8058 * This function will enable multidevice features in @window.
8060 * Multidevice aware windows will need to handle properly multiple,
8061 * per device enter/leave events, device grabs and grab ownerships.
8066 gdk_window_set_support_multidevice (GdkWindow *window,
8067 gboolean support_multidevice)
8069 g_return_if_fail (GDK_IS_WINDOW (window));
8071 if (GDK_WINDOW_DESTROYED (window))
8074 if (window->support_multidevice == support_multidevice)
8077 window->support_multidevice = support_multidevice;
8079 /* FIXME: What to do if called when some pointers are inside the window ? */
8083 * gdk_window_get_support_multidevice:
8084 * @window: a #GdkWindow.
8086 * Returns %TRUE if the window is aware of the existence of multiple
8089 * Returns: %TRUE if the window handles multidevice features.
8094 gdk_window_get_support_multidevice (GdkWindow *window)
8096 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
8098 if (GDK_WINDOW_DESTROYED (window))
8101 return window->support_multidevice;
8104 static const guint type_masks[] = {
8105 GDK_SUBSTRUCTURE_MASK, /* GDK_DELETE = 0 */
8106 GDK_STRUCTURE_MASK, /* GDK_DESTROY = 1 */
8107 GDK_EXPOSURE_MASK, /* GDK_EXPOSE = 2 */
8108 GDK_POINTER_MOTION_MASK, /* GDK_MOTION_NOTIFY = 3 */
8109 GDK_BUTTON_PRESS_MASK, /* GDK_BUTTON_PRESS = 4 */
8110 GDK_BUTTON_PRESS_MASK, /* GDK_2BUTTON_PRESS = 5 */
8111 GDK_BUTTON_PRESS_MASK, /* GDK_3BUTTON_PRESS = 6 */
8112 GDK_BUTTON_RELEASE_MASK, /* GDK_BUTTON_RELEASE = 7 */
8113 GDK_KEY_PRESS_MASK, /* GDK_KEY_PRESS = 8 */
8114 GDK_KEY_RELEASE_MASK, /* GDK_KEY_RELEASE = 9 */
8115 GDK_ENTER_NOTIFY_MASK, /* GDK_ENTER_NOTIFY = 10 */
8116 GDK_LEAVE_NOTIFY_MASK, /* GDK_LEAVE_NOTIFY = 11 */
8117 GDK_FOCUS_CHANGE_MASK, /* GDK_FOCUS_CHANGE = 12 */
8118 GDK_STRUCTURE_MASK, /* GDK_CONFIGURE = 13 */
8119 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_MAP = 14 */
8120 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_UNMAP = 15 */
8121 GDK_PROPERTY_CHANGE_MASK, /* GDK_PROPERTY_NOTIFY = 16 */
8122 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_CLEAR = 17 */
8123 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_REQUEST = 18 */
8124 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_NOTIFY = 19 */
8125 GDK_PROXIMITY_IN_MASK, /* GDK_PROXIMITY_IN = 20 */
8126 GDK_PROXIMITY_OUT_MASK, /* GDK_PROXIMITY_OUT = 21 */
8127 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_ENTER = 22 */
8128 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_LEAVE = 23 */
8129 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_MOTION = 24 */
8130 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_STATUS = 25 */
8131 GDK_ALL_EVENTS_MASK, /* GDK_DROP_START = 26 */
8132 GDK_ALL_EVENTS_MASK, /* GDK_DROP_FINISHED = 27 */
8133 GDK_ALL_EVENTS_MASK, /* GDK_CLIENT_EVENT = 28 */
8134 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_VISIBILITY_NOTIFY = 29 */
8135 GDK_EXPOSURE_MASK, /* GDK_NO_EXPOSE = 30 */
8136 GDK_SCROLL_MASK | GDK_BUTTON_PRESS_MASK,/* GDK_SCROLL= 31 */
8137 0, /* GDK_WINDOW_STATE = 32 */
8138 0, /* GDK_SETTING = 33 */
8139 0, /* GDK_OWNER_CHANGE = 34 */
8140 0, /* GDK_GRAB_BROKEN = 35 */
8141 0, /* GDK_DAMAGE = 36 */
8143 G_STATIC_ASSERT (G_N_ELEMENTS (type_masks) == GDK_EVENT_LAST);
8145 /* send motion events if the right buttons are down */
8147 update_evmask_for_button_motion (guint evmask,
8148 GdkModifierType mask)
8150 if (evmask & GDK_BUTTON_MOTION_MASK &&
8151 mask & (GDK_BUTTON1_MASK |
8156 evmask |= GDK_POINTER_MOTION_MASK;
8158 if ((evmask & GDK_BUTTON1_MOTION_MASK && mask & GDK_BUTTON1_MASK) ||
8159 (evmask & GDK_BUTTON2_MOTION_MASK && mask & GDK_BUTTON2_MASK) ||
8160 (evmask & GDK_BUTTON3_MOTION_MASK && mask & GDK_BUTTON3_MASK))
8161 evmask |= GDK_POINTER_MOTION_MASK;
8167 is_button_type (GdkEventType type)
8169 return type == GDK_BUTTON_PRESS ||
8170 type == GDK_2BUTTON_PRESS ||
8171 type == GDK_3BUTTON_PRESS ||
8172 type == GDK_BUTTON_RELEASE ||
8177 is_motion_type (GdkEventType type)
8179 return type == GDK_MOTION_NOTIFY ||
8180 type == GDK_ENTER_NOTIFY ||
8181 type == GDK_LEAVE_NOTIFY;
8185 find_common_ancestor (GdkWindow *win1,
8189 GList *path1 = NULL, *path2 = NULL;
8190 GList *list1, *list2;
8193 while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8195 path1 = g_list_prepend (path1, tmp);
8196 tmp = get_event_parent (tmp);
8200 while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8202 path2 = g_list_prepend (path2, tmp);
8203 tmp = get_event_parent (tmp);
8209 while (list1 && list2 && (list1->data == list2->data))
8212 list1 = g_list_next (list1);
8213 list2 = g_list_next (list2);
8215 g_list_free (path1);
8216 g_list_free (path2);
8222 _gdk_make_event (GdkWindow *window,
8224 GdkEvent *event_in_queue,
8225 gboolean before_event)
8227 GdkEvent *event = gdk_event_new (type);
8229 GdkModifierType the_state;
8231 the_time = gdk_event_get_time (event_in_queue);
8232 gdk_event_get_state (event_in_queue, &the_state);
8234 event->any.window = g_object_ref (window);
8235 event->any.send_event = FALSE;
8236 if (event_in_queue && event_in_queue->any.send_event)
8237 event->any.send_event = TRUE;
8241 case GDK_MOTION_NOTIFY:
8242 event->motion.time = the_time;
8243 event->motion.axes = NULL;
8244 event->motion.state = the_state;
8247 case GDK_BUTTON_PRESS:
8248 case GDK_2BUTTON_PRESS:
8249 case GDK_3BUTTON_PRESS:
8250 case GDK_BUTTON_RELEASE:
8251 event->button.time = the_time;
8252 event->button.axes = NULL;
8253 event->button.state = the_state;
8257 event->scroll.time = the_time;
8258 event->scroll.state = the_state;
8262 case GDK_KEY_RELEASE:
8263 event->key.time = the_time;
8264 event->key.state = the_state;
8267 case GDK_ENTER_NOTIFY:
8268 case GDK_LEAVE_NOTIFY:
8269 event->crossing.time = the_time;
8270 event->crossing.state = the_state;
8273 case GDK_PROPERTY_NOTIFY:
8274 event->property.time = the_time;
8275 event->property.state = the_state;
8278 case GDK_SELECTION_CLEAR:
8279 case GDK_SELECTION_REQUEST:
8280 case GDK_SELECTION_NOTIFY:
8281 event->selection.time = the_time;
8284 case GDK_PROXIMITY_IN:
8285 case GDK_PROXIMITY_OUT:
8286 event->proximity.time = the_time;
8289 case GDK_DRAG_ENTER:
8290 case GDK_DRAG_LEAVE:
8291 case GDK_DRAG_MOTION:
8292 case GDK_DRAG_STATUS:
8293 case GDK_DROP_START:
8294 case GDK_DROP_FINISHED:
8295 event->dnd.time = the_time;
8298 case GDK_FOCUS_CHANGE:
8302 case GDK_CLIENT_EVENT:
8303 case GDK_VISIBILITY_NOTIFY:
8314 _gdk_event_queue_insert_before (gdk_window_get_display (window), event_in_queue, event);
8316 _gdk_event_queue_insert_after (gdk_window_get_display (window), event_in_queue, event);
8319 _gdk_event_queue_append (gdk_window_get_display (window), event);
8325 send_crossing_event (GdkDisplay *display,
8326 GdkWindow *toplevel,
8329 GdkCrossingMode mode,
8330 GdkNotifyType notify_type,
8331 GdkWindow *subwindow,
8333 GdkDevice *source_device,
8336 GdkModifierType mask,
8338 GdkEvent *event_in_queue,
8342 guint32 window_event_mask, type_event_mask;
8343 GdkDeviceGrabInfo *grab;
8344 gboolean block_event = FALSE;
8346 grab = _gdk_display_has_device_grab (display, device, serial);
8349 !grab->owner_events)
8351 /* !owner_event => only report events wrt grab window, ignore rest */
8352 if ((GdkWindow *)window != grab->window)
8354 window_event_mask = grab->event_mask;
8357 window_event_mask = window->event_mask;
8359 if (type == GDK_LEAVE_NOTIFY)
8361 type_event_mask = GDK_LEAVE_NOTIFY_MASK;
8362 window->devices_inside = g_list_remove (window->devices_inside, device);
8364 if (!window->support_multidevice && window->devices_inside)
8366 /* Block leave events unless it's the last pointer */
8372 type_event_mask = GDK_ENTER_NOTIFY_MASK;
8374 if (!window->support_multidevice && window->devices_inside)
8376 /* Only emit enter events for the first device */
8380 if (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER &&
8381 gdk_device_get_mode (device) != GDK_MODE_DISABLED &&
8382 !g_list_find (window->devices_inside, device))
8383 window->devices_inside = g_list_prepend (window->devices_inside, device);
8389 if (window_event_mask & type_event_mask)
8391 event = _gdk_make_event ((GdkWindow *)window, type, event_in_queue, TRUE);
8392 gdk_event_set_device (event, device);
8395 gdk_event_set_source_device (event, source_device);
8397 event->crossing.time = time_;
8398 event->crossing.subwindow = subwindow;
8400 g_object_ref (subwindow);
8401 convert_toplevel_coords_to_window ((GdkWindow *)window,
8402 toplevel_x, toplevel_y,
8403 &event->crossing.x, &event->crossing.y);
8404 event->crossing.x_root = toplevel_x + toplevel->x;
8405 event->crossing.y_root = toplevel_y + toplevel->y;
8406 event->crossing.mode = mode;
8407 event->crossing.detail = notify_type;
8408 event->crossing.focus = FALSE;
8409 event->crossing.state = mask;
8414 /* The coordinates are in the toplevel window that src/dest are in.
8415 * src and dest are always (if != NULL) in the same toplevel, as
8416 * we get a leave-notify and set the window_under_pointer to null
8417 * before crossing to another toplevel.
8420 _gdk_synthesize_crossing_events (GdkDisplay *display,
8424 GdkDevice *source_device,
8425 GdkCrossingMode mode,
8428 GdkModifierType mask,
8430 GdkEvent *event_in_queue,
8432 gboolean non_linear)
8435 GdkWindow *win, *last, *next;
8439 GdkWindow *toplevel;
8440 GdkNotifyType notify_type;
8442 /* TODO: Don't send events to toplevel, as we get those from the windowing system */
8447 return; /* No crossings generated between src and dest */
8449 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER)
8451 if (a && gdk_window_get_device_events (src, device) == 0)
8454 if (b && gdk_window_get_device_events (dest, device) == 0)
8461 c = find_common_ancestor (a, b);
8463 non_linear |= (c != a) && (c != b);
8465 if (a) /* There might not be a source (i.e. if no previous pointer_in_window) */
8467 toplevel = gdk_window_get_toplevel (a);
8469 /* Traverse up from a to (excluding) c sending leave events */
8471 notify_type = GDK_NOTIFY_NONLINEAR;
8473 notify_type = GDK_NOTIFY_INFERIOR;
8475 notify_type = GDK_NOTIFY_ANCESTOR;
8476 send_crossing_event (display, toplevel,
8477 a, GDK_LEAVE_NOTIFY,
8480 NULL, device, source_device,
8481 toplevel_x, toplevel_y,
8489 notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8491 notify_type = GDK_NOTIFY_VIRTUAL;
8494 win = get_event_parent (a);
8495 while (win != c && win->window_type != GDK_WINDOW_ROOT)
8497 send_crossing_event (display, toplevel,
8498 win, GDK_LEAVE_NOTIFY,
8502 device, source_device,
8503 toplevel_x, toplevel_y,
8509 win = get_event_parent (win);
8514 if (b) /* Might not be a dest, e.g. if we're moving out of the window */
8516 toplevel = gdk_window_get_toplevel ((GdkWindow *)b);
8518 /* Traverse down from c to b */
8522 win = get_event_parent (b);
8523 while (win != c && win->window_type != GDK_WINDOW_ROOT)
8525 path = g_list_prepend (path, win);
8526 win = get_event_parent (win);
8530 notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8532 notify_type = GDK_NOTIFY_VIRTUAL;
8538 list = g_list_next (list);
8544 send_crossing_event (display, toplevel,
8545 win, GDK_ENTER_NOTIFY,
8549 device, source_device,
8550 toplevel_x, toplevel_y,
8560 notify_type = GDK_NOTIFY_NONLINEAR;
8562 notify_type = GDK_NOTIFY_ANCESTOR;
8564 notify_type = GDK_NOTIFY_INFERIOR;
8566 send_crossing_event (display, toplevel,
8567 b, GDK_ENTER_NOTIFY,
8571 device, source_device,
8572 toplevel_x, toplevel_y,
8579 /* Returns the window inside the event window with the pointer in it
8580 * at the specified coordinates, or NULL if its not in any child of
8581 * the toplevel. It also takes into account !owner_events grabs.
8584 get_pointer_window (GdkDisplay *display,
8585 GdkWindow *event_window,
8591 GdkWindow *pointer_window;
8592 GdkDeviceGrabInfo *grab;
8593 GdkPointerWindowInfo *pointer_info;
8595 pointer_info = _gdk_display_get_pointer_info (display, device);
8597 if (event_window == pointer_info->toplevel_under_pointer)
8599 _gdk_window_find_descendant_at (event_window,
8600 toplevel_x, toplevel_y,
8603 pointer_window = NULL;
8605 grab = _gdk_display_has_device_grab (display, device, serial);
8607 !grab->owner_events &&
8608 pointer_window != grab->window)
8609 pointer_window = NULL;
8611 return pointer_window;
8615 _gdk_display_set_window_under_pointer (GdkDisplay *display,
8619 GdkPointerWindowInfo *device_info;
8621 device_info = _gdk_display_get_pointer_info (display, device);
8623 if (device_info->window_under_pointer)
8624 g_object_unref (device_info->window_under_pointer);
8625 device_info->window_under_pointer = window;
8629 g_object_ref (window);
8630 update_cursor (display, device);
8633 _gdk_display_enable_motion_hints (display, device);
8638 * @window: the #GdkWindow which will own the grab (the grab window).
8639 * @owner_events: if %FALSE then all pointer events are reported with respect to
8640 * @window and are only reported if selected by @event_mask. If %TRUE then pointer
8641 * events for this application are reported as normal, but pointer events outside
8642 * this application are reported with respect to @window and only if selected by
8643 * @event_mask. In either mode, unreported events are discarded.
8644 * @event_mask: specifies the event mask, which is used in accordance with
8645 * @owner_events. Note that only pointer events (i.e. button and motion events)
8647 * @confine_to: (allow-none): If non-%NULL, the pointer will be confined to this
8648 * window during the grab. If the pointer is outside @confine_to, it will
8649 * automatically be moved to the closest edge of @confine_to and enter
8650 * and leave events will be generated as necessary.
8651 * @cursor: (allow-none): the cursor to display while the grab is active. If this is %NULL then
8652 * the normal cursors are used for @window and its descendants, and the cursor
8653 * for @window is used for all other windows.
8654 * @time_: the timestamp of the event which led to this pointer grab. This usually
8655 * comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
8656 * the time isn't known.
8658 * Grabs the pointer (usually a mouse) so that all events are passed to this
8659 * application until the pointer is ungrabbed with gdk_pointer_ungrab(), or
8660 * the grab window becomes unviewable.
8661 * This overrides any previous pointer grab by this client.
8663 * Pointer grabs are used for operations which need complete control over mouse
8664 * events, even if the mouse leaves the application.
8665 * For example in GTK+ it is used for Drag and Drop, for dragging the handle in
8666 * the #GtkHPaned and #GtkVPaned widgets.
8668 * Note that if the event mask of an X window has selected both button press and
8669 * button release events, then a button press event will cause an automatic
8670 * pointer grab until the button is released.
8671 * X does this automatically since most applications expect to receive button
8672 * press and release events in pairs.
8673 * It is equivalent to a pointer grab on the window with @owner_events set to
8676 * If you set up anything at the time you take the grab that needs to be cleaned
8677 * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8678 * are emitted when the grab ends unvoluntarily.
8680 * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8682 * Deprecated: 3.0: Use gdk_device_grab() instead.
8685 gdk_pointer_grab (GdkWindow * window,
8686 gboolean owner_events,
8687 GdkEventMask event_mask,
8688 GdkWindow * confine_to,
8693 GdkDisplay *display;
8694 GdkDeviceManager *device_manager;
8696 GdkGrabStatus res = 0;
8698 GList *devices, *dev;
8700 g_return_val_if_fail (window != NULL, 0);
8701 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8702 g_return_val_if_fail (confine_to == NULL || GDK_IS_WINDOW (confine_to), 0);
8704 /* We need a native window for confine to to work, ensure we have one */
8707 if (!gdk_window_ensure_native (confine_to))
8709 g_warning ("Can't confine to grabbed window, not native");
8714 /* Non-viewable client side window => fail */
8715 if (!_gdk_window_has_impl (window) &&
8716 !gdk_window_is_viewable (window))
8717 return GDK_GRAB_NOT_VIEWABLE;
8719 native = gdk_window_get_toplevel (window);
8720 while (gdk_window_is_offscreen (native))
8722 native = gdk_offscreen_window_get_embedder (native);
8724 if (native == NULL ||
8725 (!_gdk_window_has_impl (native) &&
8726 !gdk_window_is_viewable (native)))
8727 return GDK_GRAB_NOT_VIEWABLE;
8729 native = gdk_window_get_toplevel (native);
8732 display = gdk_window_get_display (window);
8734 serial = _gdk_display_get_next_serial (display);
8735 device_manager = gdk_display_get_device_manager (display);
8736 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8738 /* FIXME: Should this be generic to all backends? */
8739 /* FIXME: What happens with extended devices? */
8740 for (dev = devices; dev; dev = dev->next)
8744 if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
8747 res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8750 get_native_grab_event_mask (event_mask),
8755 if (res == GDK_GRAB_SUCCESS)
8756 _gdk_display_add_device_grab (display,
8768 /* FIXME: handle errors when grabbing */
8770 g_list_free (devices);
8776 * gdk_keyboard_grab:
8777 * @window: the #GdkWindow which will own the grab (the grab window).
8778 * @owner_events: if %FALSE then all keyboard events are reported with respect to
8779 * @window. If %TRUE then keyboard events for this application are
8780 * reported as normal, but keyboard events outside this application
8781 * are reported with respect to @window. Both key press and key
8782 * release events are always reported, independant of the event mask
8783 * set by the application.
8784 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
8787 * Grabs the keyboard so that all events are passed to this
8788 * application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
8789 * This overrides any previous keyboard grab by this client.
8791 * If you set up anything at the time you take the grab that needs to be cleaned
8792 * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8793 * are emitted when the grab ends unvoluntarily.
8795 * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8797 * Deprecated: 3.0: Use gdk_device_grab() instead.
8800 gdk_keyboard_grab (GdkWindow *window,
8801 gboolean owner_events,
8805 GdkDisplay *display;
8806 GdkDeviceManager *device_manager;
8808 GdkGrabStatus res = 0;
8810 GList *devices, *dev;
8812 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8814 /* Non-viewable client side window => fail */
8815 if (!_gdk_window_has_impl (window) &&
8816 !gdk_window_is_viewable (window))
8817 return GDK_GRAB_NOT_VIEWABLE;
8819 native = gdk_window_get_toplevel (window);
8821 while (gdk_window_is_offscreen (native))
8823 native = gdk_offscreen_window_get_embedder (native);
8825 if (native == NULL ||
8826 (!_gdk_window_has_impl (native) &&
8827 !gdk_window_is_viewable (native)))
8828 return GDK_GRAB_NOT_VIEWABLE;
8830 native = gdk_window_get_toplevel (native);
8833 display = gdk_window_get_display (window);
8834 serial = _gdk_display_get_next_serial (display);
8835 device_manager = gdk_display_get_device_manager (display);
8836 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8838 /* FIXME: Should this be generic to all backends? */
8839 /* FIXME: What happens with extended devices? */
8840 for (dev = devices; dev; dev = dev->next)
8844 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
8847 res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8850 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
8855 if (res == GDK_GRAB_SUCCESS)
8856 _gdk_display_add_device_grab (display,
8867 /* FIXME: handle errors when grabbing */
8869 g_list_free (devices);
8875 * gdk_window_geometry_changed:
8876 * @window: an embedded offscreen #GdkWindow
8878 * This function informs GDK that the geometry of an embedded
8879 * offscreen window has changed. This is necessary for GDK to keep
8880 * track of which offscreen window the pointer is in.
8885 gdk_window_geometry_changed (GdkWindow *window)
8887 _gdk_synthesize_crossing_events_for_geometry_change (window);
8891 source_events_device_added (GdkDeviceManager *device_manager,
8896 GdkEventMask event_mask;
8897 GdkInputSource source;
8899 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_FLOATING)
8903 source = gdk_device_get_source (device);
8905 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8906 GINT_TO_POINTER (source)));
8908 gdk_window_set_device_events (window, device, event_mask);
8912 source_events_device_changed (GdkDeviceManager *device_manager,
8917 GdkInputSource source;
8918 GdkEventMask event_mask;
8922 type = gdk_device_get_device_type (device);
8923 source = gdk_device_get_source (device);
8925 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8926 GINT_TO_POINTER (source)));
8931 if (type == GDK_DEVICE_TYPE_FLOATING)
8933 /* The device was just floated, enable its event mask */
8934 gdk_window_set_device_events (window, device, event_mask);
8936 else if (type == GDK_DEVICE_TYPE_SLAVE)
8937 gdk_window_set_device_events (window, device, 0);
8941 * gdk_window_set_source_events:
8942 * @window: a #GdkWindow
8943 * @source: a #GdkInputSource to define the source class.
8944 * @event_mask: event mask for @window
8946 * Sets the event mask for any floating device (i.e. not attached to any
8947 * visible pointer) that has the source defined as @source. This event
8948 * mask will be applied both to currently existing, newly added devices
8949 * after this call, and devices being attached/detached.
8954 gdk_window_set_source_events (GdkWindow *window,
8955 GdkInputSource source,
8956 GdkEventMask event_mask)
8958 GdkDeviceManager *device_manager;
8959 GdkDisplay *display;
8963 g_return_if_fail (GDK_IS_WINDOW (window));
8965 display = gdk_window_get_display (window);
8966 device_manager = gdk_display_get_device_manager (display);
8968 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING);
8970 /* Set event mask for existing devices */
8971 for (d = devices; d; d = d->next)
8973 GdkDevice *device = d->data;
8975 if (source == gdk_device_get_source (device))
8976 gdk_window_set_device_events (window, device, event_mask);
8979 g_list_free (devices);
8981 /* Update accounting */
8982 if (G_UNLIKELY (!window->source_event_masks))
8983 window->source_event_masks = g_hash_table_new (NULL, NULL);
8986 g_hash_table_insert (window->source_event_masks,
8987 GUINT_TO_POINTER (source),
8988 GUINT_TO_POINTER (event_mask));
8990 g_hash_table_remove (window->source_event_masks,
8991 GUINT_TO_POINTER (source));
8993 size = g_hash_table_size (window->source_event_masks);
8995 /* Update handler if needed */
8996 if (!window->device_added_handler_id && size > 0)
8998 window->device_added_handler_id =
8999 g_signal_connect (device_manager, "device-added",
9000 G_CALLBACK (source_events_device_added), window);
9001 window->device_changed_handler_id =
9002 g_signal_connect (device_manager, "device-changed",
9003 G_CALLBACK (source_events_device_changed), window);
9005 else if (window->device_added_handler_id && size == 0)
9006 g_signal_handler_disconnect (device_manager, window->device_added_handler_id);
9010 * gdk_window_get_source_events:
9011 * @window: a #GdkWindow
9012 * @source: a #GdkInputSource to define the source class.
9014 * Returns the event mask for @window corresponding to the device class specified
9017 * Returns: source event mask for @window
9020 gdk_window_get_source_events (GdkWindow *window,
9021 GdkInputSource source)
9023 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
9025 return GPOINTER_TO_UINT (g_hash_table_lookup (window->source_event_masks,
9026 GUINT_TO_POINTER (source)));
9030 do_synthesize_crossing_event (gpointer data)
9032 GdkDisplay *display;
9033 GdkWindow *changed_toplevel;
9034 GHashTableIter iter;
9035 gpointer key, value;
9038 changed_toplevel = data;
9040 changed_toplevel->synthesize_crossing_event_queued = FALSE;
9042 if (GDK_WINDOW_DESTROYED (changed_toplevel))
9045 display = gdk_window_get_display (changed_toplevel);
9046 serial = _gdk_display_get_next_serial (display);
9047 g_hash_table_iter_init (&iter, display->pointers_info);
9049 while (g_hash_table_iter_next (&iter, &key, &value))
9051 GdkWindow *new_window_under_pointer;
9052 GdkPointerWindowInfo *pointer_info = value;
9053 GdkDevice *device = key;
9055 if (changed_toplevel == pointer_info->toplevel_under_pointer)
9057 new_window_under_pointer =
9058 get_pointer_window (display, changed_toplevel,
9060 pointer_info->toplevel_x,
9061 pointer_info->toplevel_y,
9063 if (new_window_under_pointer != pointer_info->window_under_pointer)
9065 _gdk_synthesize_crossing_events (display,
9066 pointer_info->window_under_pointer,
9067 new_window_under_pointer,
9069 GDK_CROSSING_NORMAL,
9070 pointer_info->toplevel_x,
9071 pointer_info->toplevel_y,
9072 pointer_info->state,
9077 _gdk_display_set_window_under_pointer (display, device, new_window_under_pointer);
9086 _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window)
9088 GdkWindow *toplevel;
9090 toplevel = get_event_toplevel (changed_window);
9092 if (!toplevel->synthesize_crossing_event_queued)
9094 toplevel->synthesize_crossing_event_queued = TRUE;
9096 gdk_threads_add_idle_full (GDK_PRIORITY_EVENTS - 1,
9097 do_synthesize_crossing_event,
9098 g_object_ref (toplevel),
9103 /* Don't use for crossing events */
9105 get_event_window (GdkDisplay *display,
9107 GdkWindow *pointer_window,
9109 GdkModifierType mask,
9114 GdkWindow *grab_window;
9115 GdkDeviceGrabInfo *grab;
9117 grab = _gdk_display_has_device_grab (display, device, serial);
9119 if (grab != NULL && !grab->owner_events)
9121 evmask = grab->event_mask;
9122 evmask = update_evmask_for_button_motion (evmask, mask);
9124 grab_window = grab->window;
9126 if (evmask & type_masks[type])
9129 *evmask_out = evmask;
9136 while (pointer_window != NULL)
9138 evmask = pointer_window->event_mask;
9139 evmask = update_evmask_for_button_motion (evmask, mask);
9141 if (evmask & type_masks[type])
9144 *evmask_out = evmask;
9145 return pointer_window;
9148 pointer_window = get_event_parent (pointer_window);
9154 evmask = grab->event_mask;
9155 evmask = update_evmask_for_button_motion (evmask, mask);
9157 if (evmask & type_masks[type])
9160 *evmask_out = evmask;
9161 return grab->window;
9171 proxy_pointer_event (GdkDisplay *display,
9172 GdkEvent *source_event,
9175 GdkWindow *toplevel_window, *event_window;
9176 GdkWindow *pointer_window;
9177 GdkPointerWindowInfo *pointer_info;
9178 GdkDevice *device, *source_device;
9181 gdouble toplevel_x, toplevel_y;
9183 gboolean non_linear;
9185 event_window = source_event->any.window;
9186 gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9187 gdk_event_get_state (source_event, &state);
9188 time_ = gdk_event_get_time (source_event);
9189 device = gdk_event_get_device (source_event);
9190 source_device = gdk_event_get_source_device (source_event);
9191 pointer_info = _gdk_display_get_pointer_info (display, device);
9192 toplevel_window = convert_native_coords_to_toplevel (event_window,
9193 toplevel_x, toplevel_y,
9194 &toplevel_x, &toplevel_y);
9197 if ((source_event->type == GDK_LEAVE_NOTIFY ||
9198 source_event->type == GDK_ENTER_NOTIFY) &&
9199 (source_event->crossing.detail == GDK_NOTIFY_NONLINEAR ||
9200 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))
9203 /* If we get crossing events with subwindow unexpectedly being NULL
9204 that means there is a native subwindow that gdk doesn't know about.
9205 We track these and forward them, with the correct virtual window
9207 This is important to get right, as metacity uses gdk for the frame
9208 windows, but gdk doesn't know about the client windows reparented
9210 if (((source_event->type == GDK_LEAVE_NOTIFY &&
9211 source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9212 (source_event->type == GDK_ENTER_NOTIFY &&
9213 (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9214 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9215 source_event->crossing.subwindow == NULL)
9217 /* Left for an unknown (to gdk) subwindow */
9219 /* Send leave events from window under pointer to event window
9220 that will get the subwindow == NULL window */
9221 _gdk_synthesize_crossing_events (display,
9222 pointer_info->window_under_pointer,
9224 device, source_device,
9225 source_event->crossing.mode,
9226 toplevel_x, toplevel_y,
9232 /* Send subwindow == NULL event */
9233 send_crossing_event (display,
9237 source_event->crossing.mode,
9238 source_event->crossing.detail,
9240 device, source_device,
9241 toplevel_x, toplevel_y,
9246 _gdk_display_set_window_under_pointer (display, device, NULL);
9250 pointer_window = get_pointer_window (display, toplevel_window, device,
9251 toplevel_x, toplevel_y, serial);
9253 if (((source_event->type == GDK_ENTER_NOTIFY &&
9254 source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9255 (source_event->type == GDK_LEAVE_NOTIFY &&
9256 (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9257 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9258 source_event->crossing.subwindow == NULL)
9260 /* Entered from an unknown (to gdk) subwindow */
9262 /* Send subwindow == NULL event */
9263 send_crossing_event (display,
9267 source_event->crossing.mode,
9268 source_event->crossing.detail,
9270 device, source_device,
9271 toplevel_x, toplevel_y,
9276 /* Send enter events from event window to pointer_window */
9277 _gdk_synthesize_crossing_events (display,
9280 device, source_device,
9281 source_event->crossing.mode,
9282 toplevel_x, toplevel_y,
9285 serial, non_linear);
9286 _gdk_display_set_window_under_pointer (display, device, pointer_window);
9290 if (pointer_info->window_under_pointer != pointer_window)
9292 /* Either a toplevel crossing notify that ended up inside a child window,
9293 or a motion notify that got into another child window */
9295 /* Different than last time, send crossing events */
9296 _gdk_synthesize_crossing_events (display,
9297 pointer_info->window_under_pointer,
9299 device, source_device,
9300 GDK_CROSSING_NORMAL,
9301 toplevel_x, toplevel_y,
9304 serial, non_linear);
9305 _gdk_display_set_window_under_pointer (display, device, pointer_window);
9307 else if (source_event->type == GDK_MOTION_NOTIFY)
9309 GdkWindow *event_win;
9313 event_win = get_event_window (display,
9322 gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9323 gdk_window_get_device_events (event_win, device) == 0)
9329 (evmask & GDK_POINTER_MOTION_HINT_MASK))
9331 gulong *device_serial;
9333 device_serial = g_hash_table_lookup (display->motion_hint_info, device);
9335 if (!device_serial ||
9336 (*device_serial != 0 &&
9337 serial < *device_serial))
9338 event_win = NULL; /* Ignore event */
9342 *device_serial = G_MAXULONG;
9346 if (event_win && !display->ignore_core_events)
9348 event = _gdk_make_event (event_win, GDK_MOTION_NOTIFY, source_event, FALSE);
9349 event->motion.time = time_;
9350 convert_toplevel_coords_to_window (event_win,
9351 toplevel_x, toplevel_y,
9352 &event->motion.x, &event->motion.y);
9353 event->motion.x_root = source_event->motion.x_root;
9354 event->motion.y_root = source_event->motion.y_root;
9355 event->motion.state = state;
9356 event->motion.is_hint = is_hint;
9357 event->motion.device = source_event->motion.device;
9358 event->motion.axes = g_memdup (source_event->motion.axes,
9359 sizeof (gdouble) * gdk_device_get_n_axes (source_event->motion.device));
9360 gdk_event_set_source_device (event, source_device);
9364 /* unlink all move events from queue.
9365 We handle our own, including our emulated masks. */
9369 #define GDK_ANY_BUTTON_MASK (GDK_BUTTON1_MASK | \
9370 GDK_BUTTON2_MASK | \
9371 GDK_BUTTON3_MASK | \
9372 GDK_BUTTON4_MASK | \
9376 proxy_button_event (GdkEvent *source_event,
9379 GdkWindow *toplevel_window, *event_window;
9380 GdkWindow *event_win;
9381 GdkWindow *pointer_window;
9387 gdouble toplevel_x, toplevel_y;
9388 GdkDisplay *display;
9390 GdkDevice *device, *source_device;
9392 type = source_event->any.type;
9393 event_window = source_event->any.window;
9394 gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9395 gdk_event_get_state (source_event, &state);
9396 time_ = gdk_event_get_time (source_event);
9397 device = gdk_event_get_device (source_event);
9398 source_device = gdk_event_get_source_device (source_event);
9399 display = gdk_window_get_display (source_event->any.window);
9400 toplevel_window = convert_native_coords_to_toplevel (event_window,
9401 toplevel_x, toplevel_y,
9402 &toplevel_x, &toplevel_y);
9404 if (type == GDK_BUTTON_PRESS &&
9405 !source_event->any.send_event &&
9406 _gdk_display_has_device_grab (display, device, serial) == NULL)
9409 _gdk_window_find_descendant_at (toplevel_window,
9410 toplevel_x, toplevel_y,
9413 /* Find the event window, that gets the grab */
9416 (parent = get_event_parent (w)) != NULL &&
9417 parent->window_type != GDK_WINDOW_ROOT)
9419 if (w->event_mask & GDK_BUTTON_PRESS_MASK)
9423 pointer_window = (GdkWindow *)w;
9425 _gdk_display_add_device_grab (display,
9431 gdk_window_get_events (pointer_window),
9435 _gdk_display_device_grab_update (display, device, source_device, serial);
9438 pointer_window = get_pointer_window (display, toplevel_window, device,
9439 toplevel_x, toplevel_y,
9442 event_win = get_event_window (display,
9448 if (event_win == NULL || display->ignore_core_events)
9451 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9452 gdk_window_get_device_events (event_win, device) == 0)
9455 event = _gdk_make_event (event_win, type, source_event, FALSE);
9459 case GDK_BUTTON_PRESS:
9460 case GDK_BUTTON_RELEASE:
9461 event->button.button = source_event->button.button;
9462 convert_toplevel_coords_to_window (event_win,
9463 toplevel_x, toplevel_y,
9464 &event->button.x, &event->button.y);
9465 event->button.x_root = source_event->button.x_root;
9466 event->button.y_root = source_event->button.y_root;
9467 event->button.state = state;
9468 event->button.device = source_event->button.device;
9469 event->button.axes = g_memdup (source_event->button.axes,
9470 sizeof (gdouble) * gdk_device_get_n_axes (source_event->button.device));
9472 gdk_event_set_source_device (event, source_device);
9474 if (type == GDK_BUTTON_PRESS)
9475 _gdk_event_button_generate (display, event);
9479 event->scroll.direction = source_event->scroll.direction;
9480 convert_toplevel_coords_to_window (event_win,
9481 toplevel_x, toplevel_y,
9482 &event->scroll.x, &event->scroll.y);
9483 event->scroll.x_root = source_event->scroll.x_root;
9484 event->scroll.y_root = source_event->scroll.y_root;
9485 event->scroll.state = state;
9486 event->scroll.device = source_event->scroll.device;
9487 gdk_event_set_source_device (event, source_device);
9494 return TRUE; /* Always unlink original, we want to obey the emulated event mask */
9497 #ifdef DEBUG_WINDOW_PRINTING
9499 gdk_window_print (GdkWindow *window,
9503 const char *window_types[] = {
9513 g_print ("%*s%p: [%s] %d,%d %dx%d", indent, "", window,
9514 window->user_data ? g_type_name_from_instance (window->user_data) : "no widget",
9515 window->x, window->y,
9516 window->width, window->height
9519 if (gdk_window_has_impl (window))
9521 #ifdef GDK_WINDOWING_X11
9522 g_print (" impl(0x%lx)", gdk_x11_window_get_xid (window));
9526 if (window->window_type != GDK_WINDOW_CHILD)
9527 g_print (" %s", window_types[window->window_type]);
9529 if (window->input_only)
9530 g_print (" input-only");
9533 g_print (" shaped");
9535 if (!gdk_window_is_visible ((GdkWindow *)window))
9536 g_print (" hidden");
9538 g_print (" abs[%d,%d]",
9539 window->abs_x, window->abs_y);
9541 cairo_region_get_extents (window->clip_region, &r);
9542 if (cairo_region_is_empty (window->clip_region))
9543 g_print (" clipbox[empty]");
9545 g_print (" clipbox[%d,%d %dx%d]", r.x, r.y, r.width, r.height);
9552 gdk_window_print_tree (GdkWindow *window,
9554 gboolean include_input_only)
9558 if (window->input_only && !include_input_only)
9561 gdk_window_print (window, indent);
9563 for (l = window->children; l != NULL; l = l->next)
9564 gdk_window_print_tree (l->data, indent + 4, include_input_only);
9567 #endif /* DEBUG_WINDOW_PRINTING */
9570 _gdk_windowing_got_event (GdkDisplay *display,
9575 GdkWindow *event_window;
9577 gboolean unlink_event;
9578 guint old_state, old_button;
9579 GdkDeviceGrabInfo *button_release_grab;
9580 GdkPointerWindowInfo *pointer_info;
9581 GdkDevice *device, *source_device;
9582 gboolean is_toplevel;
9584 if (gdk_event_get_time (event) != GDK_CURRENT_TIME)
9585 display->last_event_time = gdk_event_get_time (event);
9587 device = gdk_event_get_device (event);
9588 source_device = gdk_event_get_source_device (event);
9594 g_object_get (device, "input-mode", &mode, NULL);
9595 _gdk_display_device_grab_update (display, device, source_device, serial);
9597 if (mode == GDK_MODE_DISABLED ||
9598 !_gdk_display_check_grab_ownership (display, device, serial))
9600 /* Device events are blocked by another
9601 * device grab, or the device is disabled
9603 unlink_event = TRUE;
9608 event_window = event->any.window;
9612 pointer_info = _gdk_display_get_pointer_info (display, device);
9614 #ifdef DEBUG_WINDOW_PRINTING
9615 if (event->type == GDK_KEY_PRESS &&
9616 (event->key.keyval == 0xa7 ||
9617 event->key.keyval == 0xbd))
9619 gdk_window_print_tree (event_window, 0,
9620 event->key.keyval == 0xbd);
9624 if (event->type == GDK_VISIBILITY_NOTIFY)
9626 event_window->native_visibility = event->visibility.state;
9627 gdk_window_update_visibility_recursively (event_window,
9632 if (!(is_button_type (event->type) ||
9633 is_motion_type (event->type)) ||
9634 event_window->window_type == GDK_WINDOW_ROOT)
9637 is_toplevel = gdk_window_is_toplevel (event_window);
9639 if ((event->type == GDK_ENTER_NOTIFY ||
9640 event->type == GDK_LEAVE_NOTIFY) &&
9641 (event->crossing.mode == GDK_CROSSING_GRAB ||
9642 event->crossing.mode == GDK_CROSSING_UNGRAB) &&
9643 (_gdk_display_has_device_grab (display, device, serial) ||
9644 event->crossing.detail == GDK_NOTIFY_INFERIOR))
9646 /* We synthesize all crossing events due to grabs ourselves,
9647 * so we ignore the native ones caused by our native pointer_grab
9648 * calls. Otherwise we would proxy these crossing event and cause
9649 * multiple copies of crossing events for grabs.
9651 * We do want to handle grabs from other clients though, as for
9652 * instance alt-tab in metacity causes grabs like these and
9653 * we want to handle those. Thus the has_pointer_grab check.
9655 * Implicit grabs on child windows create some grabbing events
9656 * that are sent before the button press. This means we can't
9657 * detect these with the has_pointer_grab check (as the implicit
9658 * grab is only noticed when we get button press event), so we
9659 * detect these events by checking for INFERIOR enter or leave
9660 * events. These should never be a problem to filter out.
9663 /* We ended up in this window after some (perhaps other clients)
9664 grab, so update the toplevel_under_window state */
9666 event->type == GDK_ENTER_NOTIFY &&
9667 event->crossing.mode == GDK_CROSSING_UNGRAB)
9669 if (pointer_info->toplevel_under_pointer)
9670 g_object_unref (pointer_info->toplevel_under_pointer);
9671 pointer_info->toplevel_under_pointer = g_object_ref (event_window);
9674 unlink_event = TRUE;
9678 /* Track toplevel_under_pointer */
9681 if (event->type == GDK_ENTER_NOTIFY &&
9682 event->crossing.detail != GDK_NOTIFY_INFERIOR)
9684 if (pointer_info->toplevel_under_pointer)
9685 g_object_unref (pointer_info->toplevel_under_pointer);
9686 pointer_info->toplevel_under_pointer = g_object_ref (event_window);
9688 else if (event->type == GDK_LEAVE_NOTIFY &&
9689 event->crossing.detail != GDK_NOTIFY_INFERIOR &&
9690 pointer_info->toplevel_under_pointer == event_window)
9692 if (pointer_info->toplevel_under_pointer)
9693 g_object_unref (pointer_info->toplevel_under_pointer);
9694 pointer_info->toplevel_under_pointer = NULL;
9698 /* Store last pointer window and position/state */
9699 old_state = pointer_info->state;
9700 old_button = pointer_info->button;
9702 gdk_event_get_coords (event, &x, &y);
9703 convert_native_coords_to_toplevel (event_window, x, y, &x, &y);
9704 pointer_info->toplevel_x = x;
9705 pointer_info->toplevel_y = y;
9706 gdk_event_get_state (event, &pointer_info->state);
9707 if (event->type == GDK_BUTTON_PRESS ||
9708 event->type == GDK_BUTTON_RELEASE)
9709 pointer_info->button = event->button.button;
9712 (pointer_info->state != old_state ||
9713 pointer_info->button != old_button))
9714 _gdk_display_enable_motion_hints (display, device);
9716 unlink_event = FALSE;
9717 if (is_motion_type (event->type))
9718 unlink_event = proxy_pointer_event (display,
9721 else if (is_button_type (event->type))
9722 unlink_event = proxy_button_event (event,
9725 if (event->type == GDK_BUTTON_RELEASE &&
9726 !event->any.send_event)
9728 button_release_grab =
9729 _gdk_display_has_device_grab (display, device, serial);
9730 if (button_release_grab &&
9731 button_release_grab->implicit &&
9732 (event->button.state & GDK_ANY_BUTTON_MASK & ~(GDK_BUTTON1_MASK << (event->button.button - 1))) == 0)
9734 button_release_grab->serial_end = serial;
9735 button_release_grab->implicit_ungrab = FALSE;
9736 _gdk_display_device_grab_update (display, device, source_device, serial);
9743 _gdk_event_queue_remove_link (display, event_link);
9744 g_list_free_1 (event_link);
9745 gdk_event_free (event);
9750 * gdk_window_create_similar_surface:
9751 * @window: window to make new surface similar to
9752 * @content: the content for the new surface
9753 * @width: width of the new surface
9754 * @height: height of the new surface
9756 * Create a new surface that is as compatible as possible with the
9757 * given @window. For example the new surface will have the same
9758 * fallback resolution and font options as @window. Generally, the new
9759 * surface will also use the same backend as @window, unless that is
9760 * not possible for some reason. The type of the returned surface may
9761 * be examined with cairo_surface_get_type().
9763 * Initially the surface contents are all 0 (transparent if contents
9764 * have transparency, black otherwise.)
9766 * Returns: a pointer to the newly allocated surface. The caller
9767 * owns the surface and should call cairo_surface_destroy() when done
9770 * This function always returns a valid pointer, but it will return a
9771 * pointer to a "nil" surface if @other is already in an error state
9772 * or any other error occurs.
9777 gdk_window_create_similar_surface (GdkWindow * window,
9778 cairo_content_t content,
9782 cairo_surface_t *window_surface, *surface;
9784 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
9786 window_surface = _gdk_window_ref_cairo_surface (window);
9788 switch (_gdk_rendering_mode)
9790 case GDK_RENDERING_MODE_RECORDING:
9792 cairo_rectangle_t rect = { 0, 0, width, height };
9793 surface = cairo_recording_surface_create (content, &rect);
9796 case GDK_RENDERING_MODE_IMAGE:
9797 surface = cairo_image_surface_create (content == CAIRO_CONTENT_COLOR ? CAIRO_FORMAT_RGB24 :
9798 content == CAIRO_CONTENT_ALPHA ? CAIRO_FORMAT_A8 : CAIRO_FORMAT_ARGB32,
9801 case GDK_RENDERING_MODE_SIMILAR:
9803 surface = cairo_surface_create_similar (window_surface,
9809 cairo_surface_destroy (window_surface);
9816 * @window: a #GdkWindow
9817 * @timestamp: timestamp of the event triggering the window focus
9819 * Sets keyboard focus to @window. In most cases, gtk_window_present()
9820 * should be used on a #GtkWindow, rather than calling this function.
9824 gdk_window_focus (GdkWindow *window,
9827 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->focus (window, timestamp);
9831 * gdk_window_set_type_hint:
9832 * @window: A toplevel #GdkWindow
9833 * @hint: A hint of the function this window will have
9835 * The application can use this call to provide a hint to the window
9836 * manager about the functionality of a window. The window manager
9837 * can use this information when determining the decoration and behaviour
9840 * The hint must be set before the window is mapped.
9843 gdk_window_set_type_hint (GdkWindow *window,
9844 GdkWindowTypeHint hint)
9846 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_type_hint (window, hint);
9850 * gdk_window_get_type_hint:
9851 * @window: A toplevel #GdkWindow
9853 * This function returns the type hint set for a window.
9855 * Return value: The type hint set for @window
9860 gdk_window_get_type_hint (GdkWindow *window)
9862 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_type_hint (window);
9866 * gdk_window_set_modal_hint:
9867 * @window: A toplevel #GdkWindow
9868 * @modal: %TRUE if the window is modal, %FALSE otherwise.
9870 * The application can use this hint to tell the window manager
9871 * that a certain window has modal behaviour. The window manager
9872 * can use this information to handle modal windows in a special
9875 * You should only use this on windows for which you have
9876 * previously called gdk_window_set_transient_for()
9879 gdk_window_set_modal_hint (GdkWindow *window,
9882 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_modal_hint (window, modal);
9886 * gdk_window_set_skip_taskbar_hint:
9887 * @window: a toplevel #GdkWindow
9888 * @skips_taskbar: %TRUE to skip the taskbar
9890 * Toggles whether a window should appear in a task list or window
9891 * list. If a window's semantic type as specified with
9892 * gdk_window_set_type_hint() already fully describes the window, this
9893 * function should <emphasis>not</emphasis> be called in addition,
9894 * instead you should allow the window to be treated according to
9895 * standard policy for its semantic type.
9900 gdk_window_set_skip_taskbar_hint (GdkWindow *window,
9901 gboolean skips_taskbar)
9903 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_taskbar_hint (window, skips_taskbar);
9907 * gdk_window_set_skip_pager_hint:
9908 * @window: a toplevel #GdkWindow
9909 * @skips_pager: %TRUE to skip the pager
9911 * Toggles whether a window should appear in a pager (workspace
9912 * switcher, or other desktop utility program that displays a small
9913 * thumbnail representation of the windows on the desktop). If a
9914 * window's semantic type as specified with gdk_window_set_type_hint()
9915 * already fully describes the window, this function should
9916 * <emphasis>not</emphasis> be called in addition, instead you should
9917 * allow the window to be treated according to standard policy for
9918 * its semantic type.
9923 gdk_window_set_skip_pager_hint (GdkWindow *window,
9924 gboolean skips_pager)
9926 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_pager_hint (window, skips_pager);
9930 * gdk_window_set_urgency_hint:
9931 * @window: a toplevel #GdkWindow
9932 * @urgent: %TRUE if the window is urgent
9934 * Toggles whether a window needs the user's
9940 gdk_window_set_urgency_hint (GdkWindow *window,
9943 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_urgency_hint (window, urgent);
9947 * gdk_window_set_geometry_hints:
9948 * @window: a toplevel #GdkWindow
9949 * @geometry: geometry hints
9950 * @geom_mask: bitmask indicating fields of @geometry to pay attention to
9952 * Sets the geometry hints for @window. Hints flagged in @geom_mask
9953 * are set, hints not flagged in @geom_mask are unset.
9954 * To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL.
9956 * This function provides hints to the windowing system about
9957 * acceptable sizes for a toplevel window. The purpose of
9958 * this is to constrain user resizing, but the windowing system
9959 * will typically (but is not required to) also constrain the
9960 * current size of the window to the provided values and
9961 * constrain programatic resizing via gdk_window_resize() or
9962 * gdk_window_move_resize().
9964 * Note that on X11, this effect has no effect on windows
9965 * of type %GDK_WINDOW_TEMP or windows where override redirect
9966 * has been turned on via gdk_window_set_override_redirect()
9967 * since these windows are not resizable by the user.
9969 * Since you can't count on the windowing system doing the
9970 * constraints for programmatic resizes, you should generally
9971 * call gdk_window_constrain_size() yourself to determine
9972 * appropriate sizes.
9976 gdk_window_set_geometry_hints (GdkWindow *window,
9977 const GdkGeometry *geometry,
9978 GdkWindowHints geom_mask)
9980 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_geometry_hints (window, geometry, geom_mask);
9984 * gdk_window_set_title:
9985 * @window: a toplevel #GdkWindow
9986 * @title: title of @window
9988 * Sets the title of a toplevel window, to be displayed in the titlebar.
9989 * If you haven't explicitly set the icon name for the window
9990 * (using gdk_window_set_icon_name()), the icon name will be set to
9991 * @title as well. @title must be in UTF-8 encoding (as with all
9992 * user-readable strings in GDK/GTK+). @title may not be %NULL.
9995 gdk_window_set_title (GdkWindow *window,
9998 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_title (window, title);
10002 * gdk_window_set_role:
10003 * @window: a toplevel #GdkWindow
10004 * @role: a string indicating its role
10006 * When using GTK+, typically you should use gtk_window_set_role() instead
10007 * of this low-level function.
10009 * The window manager and session manager use a window's role to
10010 * distinguish it from other kinds of window in the same application.
10011 * When an application is restarted after being saved in a previous
10012 * session, all windows with the same title and role are treated as
10013 * interchangeable. So if you have two windows with the same title
10014 * that should be distinguished for session management purposes, you
10015 * should set the role on those windows. It doesn't matter what string
10016 * you use for the role, as long as you have a different role for each
10017 * non-interchangeable kind of window.
10021 gdk_window_set_role (GdkWindow *window,
10024 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_role (window, role);
10028 * gdk_window_set_startup_id:
10029 * @window: a toplevel #GdkWindow
10030 * @startup_id: a string with startup-notification identifier
10032 * When using GTK+, typically you should use gtk_window_set_startup_id()
10033 * instead of this low-level function.
10039 gdk_window_set_startup_id (GdkWindow *window,
10040 const gchar *startup_id)
10042 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_startup_id (window, startup_id);
10046 * gdk_window_set_transient_for:
10047 * @window: a toplevel #GdkWindow
10048 * @parent: another toplevel #GdkWindow
10050 * Indicates to the window manager that @window is a transient dialog
10051 * associated with the application window @parent. This allows the
10052 * window manager to do things like center @window on @parent and
10053 * keep @window above @parent.
10055 * See gtk_window_set_transient_for() if you're using #GtkWindow or
10059 gdk_window_set_transient_for (GdkWindow *window,
10062 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_transient_for (window, parent);
10066 * gdk_window_get_root_origin:
10067 * @window: a toplevel #GdkWindow
10068 * @x: (out): return location for X position of window frame
10069 * @y: (out): return location for Y position of window frame
10071 * Obtains the top-left corner of the window manager frame in root
10072 * window coordinates.
10076 gdk_window_get_root_origin (GdkWindow *window,
10080 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_root_origin (window, x, y);
10084 * gdk_window_get_frame_extents:
10085 * @window: a toplevel #GdkWindow
10086 * @rect: rectangle to fill with bounding box of the window frame
10088 * Obtains the bounding box of the window, including window manager
10089 * titlebar/borders if any. The frame position is given in root window
10090 * coordinates. To get the position of the window itself (rather than
10091 * the frame) in root window coordinates, use gdk_window_get_origin().
10095 gdk_window_get_frame_extents (GdkWindow *window,
10096 GdkRectangle *rect)
10098 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_frame_extents (window, rect);
10102 * gdk_window_set_override_redirect:
10103 * @window: a toplevel #GdkWindow
10104 * @override_redirect: %TRUE if window should be override redirect
10106 * An override redirect window is not under the control of the window manager.
10107 * This means it won't have a titlebar, won't be minimizable, etc. - it will
10108 * be entirely under the control of the application. The window manager
10109 * can't see the override redirect window at all.
10111 * Override redirect should only be used for short-lived temporary
10112 * windows, such as popup menus. #GtkMenu uses an override redirect
10113 * window in its implementation, for example.
10117 gdk_window_set_override_redirect (GdkWindow *window,
10118 gboolean override_redirect)
10120 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_override_redirect (window, override_redirect);
10124 * gdk_window_set_accept_focus:
10125 * @window: a toplevel #GdkWindow
10126 * @accept_focus: %TRUE if the window should receive input focus
10128 * Setting @accept_focus to %FALSE hints the desktop environment that the
10129 * window doesn't want to receive input focus.
10131 * On X, it is the responsibility of the window manager to interpret this
10132 * hint. ICCCM-compliant window manager usually respect it.
10137 gdk_window_set_accept_focus (GdkWindow *window,
10138 gboolean accept_focus)
10140 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_accept_focus (window, accept_focus);
10144 * gdk_window_set_focus_on_map:
10145 * @window: a toplevel #GdkWindow
10146 * @focus_on_map: %TRUE if the window should receive input focus when mapped
10148 * Setting @focus_on_map to %FALSE hints the desktop environment that the
10149 * window doesn't want to receive input focus when it is mapped.
10150 * focus_on_map should be turned off for windows that aren't triggered
10151 * interactively (such as popups from network activity).
10153 * On X, it is the responsibility of the window manager to interpret
10154 * this hint. Window managers following the freedesktop.org window
10155 * manager extension specification should respect it.
10160 gdk_window_set_focus_on_map (GdkWindow *window,
10161 gboolean focus_on_map)
10163 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_focus_on_map (window, focus_on_map);
10167 * gdk_window_set_icon_list:
10168 * @window: The #GdkWindow toplevel window to set the icon of.
10169 * @pixbufs: (transfer none) (element-type GdkPixbuf):
10170 * A list of pixbufs, of different sizes.
10172 * Sets a list of icons for the window. One of these will be used
10173 * to represent the window when it has been iconified. The icon is
10174 * usually shown in an icon box or some sort of task bar. Which icon
10175 * size is shown depends on the window manager. The window manager
10176 * can scale the icon but setting several size icons can give better
10177 * image quality since the window manager may only need to scale the
10178 * icon by a small amount or not at all.
10182 gdk_window_set_icon_list (GdkWindow *window,
10185 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_list (window, pixbufs);
10189 * gdk_window_set_icon_name:
10190 * @window: a toplevel #GdkWindow
10191 * @name: (allow-none): name of window while iconified (minimized)
10193 * Windows may have a name used while minimized, distinct from the
10194 * name they display in their titlebar. Most of the time this is a bad
10195 * idea from a user interface standpoint. But you can set such a name
10196 * with this function, if you like.
10198 * After calling this with a non-%NULL @name, calls to gdk_window_set_title()
10199 * will not update the icon title.
10201 * Using %NULL for @name unsets the icon title; further calls to
10202 * gdk_window_set_title() will again update the icon title as well.
10205 gdk_window_set_icon_name (GdkWindow *window,
10208 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_name (window, name);
10212 * gdk_window_iconify:
10213 * @window: a toplevel #GdkWindow
10215 * Asks to iconify (minimize) @window. The window manager may choose
10216 * to ignore the request, but normally will honor it. Using
10217 * gtk_window_iconify() is preferred, if you have a #GtkWindow widget.
10219 * This function only makes sense when @window is a toplevel window.
10223 gdk_window_iconify (GdkWindow *window)
10225 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->iconify (window);
10229 * gdk_window_deiconify:
10230 * @window: a toplevel #GdkWindow
10232 * Attempt to deiconify (unminimize) @window. On X11 the window manager may
10233 * choose to ignore the request to deiconify. When using GTK+,
10234 * use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet,
10235 * you probably want to use gtk_window_present(), which raises the window, focuses it,
10236 * unminimizes it, and puts it on the current desktop.
10240 gdk_window_deiconify (GdkWindow *window)
10242 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->deiconify (window);
10246 * gdk_window_stick:
10247 * @window: a toplevel #GdkWindow
10249 * "Pins" a window such that it's on all workspaces and does not scroll
10250 * with viewports, for window managers that have scrollable viewports.
10251 * (When using #GtkWindow, gtk_window_stick() may be more useful.)
10253 * On the X11 platform, this function depends on window manager
10254 * support, so may have no effect with many window managers. However,
10255 * GDK will do the best it can to convince the window manager to stick
10256 * the window. For window managers that don't support this operation,
10257 * there's nothing you can do to force it to happen.
10261 gdk_window_stick (GdkWindow *window)
10263 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->stick (window);
10267 * gdk_window_unstick:
10268 * @window: a toplevel #GdkWindow
10270 * Reverse operation for gdk_window_stick(); see gdk_window_stick(),
10271 * and gtk_window_unstick().
10275 gdk_window_unstick (GdkWindow *window)
10277 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unstick (window);
10281 * gdk_window_maximize:
10282 * @window: a toplevel #GdkWindow
10284 * Maximizes the window. If the window was already maximized, then
10285 * this function does nothing.
10287 * On X11, asks the window manager to maximize @window, if the window
10288 * manager supports this operation. Not all window managers support
10289 * this, and some deliberately ignore it or don't have a concept of
10290 * "maximized"; so you can't rely on the maximization actually
10291 * happening. But it will happen with most standard window managers,
10292 * and GDK makes a best effort to get it to happen.
10294 * On Windows, reliably maximizes the window.
10298 gdk_window_maximize (GdkWindow *window)
10300 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->maximize (window);
10304 * gdk_window_unmaximize:
10305 * @window: a toplevel #GdkWindow
10307 * Unmaximizes the window. If the window wasn't maximized, then this
10308 * function does nothing.
10310 * On X11, asks the window manager to unmaximize @window, if the
10311 * window manager supports this operation. Not all window managers
10312 * support this, and some deliberately ignore it or don't have a
10313 * concept of "maximized"; so you can't rely on the unmaximization
10314 * actually happening. But it will happen with most standard window
10315 * managers, and GDK makes a best effort to get it to happen.
10317 * On Windows, reliably unmaximizes the window.
10321 gdk_window_unmaximize (GdkWindow *window)
10323 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unmaximize (window);
10327 * gdk_window_fullscreen:
10328 * @window: a toplevel #GdkWindow
10330 * Moves the window into fullscreen mode. This means the
10331 * window covers the entire screen and is above any panels
10334 * If the window was already fullscreen, then this function does nothing.
10336 * On X11, asks the window manager to put @window in a fullscreen
10337 * state, if the window manager supports this operation. Not all
10338 * window managers support this, and some deliberately ignore it or
10339 * don't have a concept of "fullscreen"; so you can't rely on the
10340 * fullscreenification actually happening. But it will happen with
10341 * most standard window managers, and GDK makes a best effort to get
10347 gdk_window_fullscreen (GdkWindow *window)
10349 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->fullscreen (window);
10353 * gdk_window_unfullscreen:
10354 * @window: a toplevel #GdkWindow
10356 * Moves the window out of fullscreen mode. If the window was not
10357 * fullscreen, does nothing.
10359 * On X11, asks the window manager to move @window out of the fullscreen
10360 * state, if the window manager supports this operation. Not all
10361 * window managers support this, and some deliberately ignore it or
10362 * don't have a concept of "fullscreen"; so you can't rely on the
10363 * unfullscreenification actually happening. But it will happen with
10364 * most standard window managers, and GDK makes a best effort to get
10370 gdk_window_unfullscreen (GdkWindow *window)
10372 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unfullscreen (window);
10376 * gdk_window_set_keep_above:
10377 * @window: a toplevel #GdkWindow
10378 * @setting: whether to keep @window above other windows
10380 * Set if @window must be kept above other windows. If the
10381 * window was already above, then this function does nothing.
10383 * On X11, asks the window manager to keep @window above, if the window
10384 * manager supports this operation. Not all window managers support
10385 * this, and some deliberately ignore it or don't have a concept of
10386 * "keep above"; so you can't rely on the window being kept above.
10387 * But it will happen with most standard window managers,
10388 * and GDK makes a best effort to get it to happen.
10393 gdk_window_set_keep_above (GdkWindow *window,
10396 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_above (window, setting);
10400 * gdk_window_set_keep_below:
10401 * @window: a toplevel #GdkWindow
10402 * @setting: whether to keep @window below other windows
10404 * Set if @window must be kept below other windows. If the
10405 * window was already below, then this function does nothing.
10407 * On X11, asks the window manager to keep @window below, if the window
10408 * manager supports this operation. Not all window managers support
10409 * this, and some deliberately ignore it or don't have a concept of
10410 * "keep below"; so you can't rely on the window being kept below.
10411 * But it will happen with most standard window managers,
10412 * and GDK makes a best effort to get it to happen.
10417 gdk_window_set_keep_below (GdkWindow *window, gboolean setting)
10419 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_below (window, setting);
10423 * gdk_window_get_group:
10424 * @window: a toplevel #GdkWindow
10426 * Returns the group leader window for @window. See gdk_window_set_group().
10428 * Return value: (transfer none): the group leader window for @window
10433 gdk_window_get_group (GdkWindow *window)
10435 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_group (window);
10439 * gdk_window_set_group:
10440 * @window: a toplevel #GdkWindow
10441 * @leader: (allow-none): group leader window, or %NULL to restore the default group leader window
10443 * Sets the group leader window for @window. By default,
10444 * GDK sets the group leader for all toplevel windows
10445 * to a global window implicitly created by GDK. With this function
10446 * you can override this default.
10448 * The group leader window allows the window manager to distinguish
10449 * all windows that belong to a single application. It may for example
10450 * allow users to minimize/unminimize all windows belonging to an
10451 * application at once. You should only set a non-default group window
10452 * if your application pretends to be multiple applications.
10455 gdk_window_set_group (GdkWindow *window,
10458 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_group (window, leader);
10462 * gdk_window_set_decorations:
10463 * @window: a toplevel #GdkWindow
10464 * @decorations: decoration hint mask
10466 * "Decorations" are the features the window manager adds to a toplevel #GdkWindow.
10467 * This function sets the traditional Motif window manager hints that tell the
10468 * window manager which decorations you would like your window to have.
10469 * Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of
10470 * using the GDK function directly.
10472 * The @decorations argument is the logical OR of the fields in
10473 * the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the
10474 * mask, the other bits indicate which decorations should be turned off.
10475 * If #GDK_DECOR_ALL is not included, then the other bits indicate
10476 * which decorations should be turned on.
10478 * Most window managers honor a decorations hint of 0 to disable all decorations,
10479 * but very few honor all possible combinations of bits.
10483 gdk_window_set_decorations (GdkWindow *window,
10484 GdkWMDecoration decorations)
10486 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_decorations (window, decorations);
10490 * gdk_window_get_decorations:
10491 * @window: The toplevel #GdkWindow to get the decorations from
10492 * @decorations: (out): The window decorations will be written here
10494 * Returns the decorations set on the GdkWindow with
10495 * gdk_window_set_decorations().
10497 * Returns: %TRUE if the window has decorations set, %FALSE otherwise.
10500 gdk_window_get_decorations(GdkWindow *window,
10501 GdkWMDecoration *decorations)
10503 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_decorations (window, decorations);
10507 * gdk_window_set_functions:
10508 * @window: a toplevel #GdkWindow
10509 * @functions: bitmask of operations to allow on @window
10511 * Sets hints about the window management functions to make available
10512 * via buttons on the window frame.
10514 * On the X backend, this function sets the traditional Motif window
10515 * manager hint for this purpose. However, few window managers do
10516 * anything reliable or interesting with this hint. Many ignore it
10519 * The @functions argument is the logical OR of values from the
10520 * #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL,
10521 * then the other bits indicate which functions to disable; if
10522 * it doesn't include #GDK_FUNC_ALL, it indicates which functions to
10527 gdk_window_set_functions (GdkWindow *window,
10528 GdkWMFunction functions)
10530 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_functions (window, functions);
10534 * gdk_window_begin_resize_drag_for_device:
10535 * @window: a toplevel #GdkWindow
10536 * @edge: the edge or corner from which the drag is started
10537 * @device: the device used for the operation
10538 * @button: the button being used to drag
10539 * @root_x: root window X coordinate of mouse click that began the drag
10540 * @root_y: root window Y coordinate of mouse click that began the drag
10541 * @timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())
10543 * Begins a window resize operation (for a toplevel window).
10544 * You might use this function to implement a "window resize grip," for
10545 * example; in fact #GtkStatusbar uses it. The function works best
10546 * with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a
10547 * fallback implementation for other window managers.
10552 gdk_window_begin_resize_drag_for_device (GdkWindow *window,
10553 GdkWindowEdge edge,
10560 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_resize_drag (window, edge, device, button, root_x, root_y, timestamp);
10564 * gdk_window_begin_resize_drag:
10565 * @window: a toplevel #GdkWindow
10566 * @edge: the edge or corner from which the drag is started
10567 * @button: the button being used to drag
10568 * @root_x: root window X coordinate of mouse click that began the drag
10569 * @root_y: root window Y coordinate of mouse click that began the drag
10570 * @timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())
10572 * Begins a window resize operation (for a toplevel window).
10574 * This function assumes that the drag is controlled by the
10575 * client pointer device, use gdk_window_begin_resize_drag_for_device()
10576 * to begin a drag with a different device.
10579 gdk_window_begin_resize_drag (GdkWindow *window,
10580 GdkWindowEdge edge,
10586 GdkDeviceManager *device_manager;
10589 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10590 device = gdk_device_manager_get_client_pointer (device_manager);
10591 gdk_window_begin_resize_drag_for_device (window, edge,
10592 device, button, root_x, root_y, timestamp);
10596 * gdk_window_begin_move_drag_for_device:
10597 * @window: a toplevel #GdkWindow
10598 * @device: the device used for the operation
10599 * @button: the button being used to drag
10600 * @root_x: root window X coordinate of mouse click that began the drag
10601 * @root_y: root window Y coordinate of mouse click that began the drag
10602 * @timestamp: timestamp of mouse click that began the drag
10604 * Begins a window move operation (for a toplevel window).
10605 * You might use this function to implement a "window move grip," for
10606 * example. The function works best with window managers that support
10607 * the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
10608 * Window Manager Hints</ulink>, but has a fallback implementation for
10609 * other window managers.
10614 gdk_window_begin_move_drag_for_device (GdkWindow *window,
10621 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_move_drag (window,
10622 device, button, root_x, root_y, timestamp);
10626 * gdk_window_begin_move_drag:
10627 * @window: a toplevel #GdkWindow
10628 * @button: the button being used to drag
10629 * @root_x: root window X coordinate of mouse click that began the drag
10630 * @root_y: root window Y coordinate of mouse click that began the drag
10631 * @timestamp: timestamp of mouse click that began the drag
10633 * Begins a window move operation (for a toplevel window).
10635 * This function assumes that the drag is controlled by the
10636 * client pointer device, use gdk_window_begin_move_drag_for_device()
10637 * to begin a drag with a different device.
10640 gdk_window_begin_move_drag (GdkWindow *window,
10646 GdkDeviceManager *device_manager;
10649 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10650 device = gdk_device_manager_get_client_pointer (device_manager);
10651 gdk_window_begin_move_drag_for_device (window, device, button, root_x, root_y, timestamp);
10655 * gdk_window_enable_synchronized_configure:
10656 * @window: a toplevel #GdkWindow
10658 * Indicates that the application will cooperate with the window
10659 * system in synchronizing the window repaint with the window
10660 * manager during resizing operations. After an application calls
10661 * this function, it must call gdk_window_configure_finished() every
10662 * time it has finished all processing associated with a set of
10663 * Configure events. Toplevel GTK+ windows automatically use this
10666 * On X, calling this function makes @window participate in the
10667 * _NET_WM_SYNC_REQUEST window manager protocol.
10672 gdk_window_enable_synchronized_configure (GdkWindow *window)
10674 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->enable_synchronized_configure (window);
10678 * gdk_window_configure_finished:
10679 * @window: a toplevel #GdkWindow
10681 * Signal to the window system that the application has finished
10682 * handling Configure events it has received. Window Managers can
10683 * use this to better synchronize the frame repaint with the
10684 * application. GTK+ applications will automatically call this
10685 * function when appropriate.
10687 * This function can only be called if gdk_window_enable_synchronized_configure()
10688 * was called previously.
10693 gdk_window_configure_finished (GdkWindow *window)
10695 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->configure_finished (window);
10699 * gdk_window_set_opacity:
10700 * @window: a top-level #GdkWindow
10701 * @opacity: opacity
10703 * Request the windowing system to make @window partially transparent,
10704 * with opacity 0 being fully transparent and 1 fully opaque. (Values
10705 * of the opacity parameter are clamped to the [0,1] range.)
10707 * On X11, this works only on X screens with a compositing manager
10710 * For setting up per-pixel alpha, see gdk_screen_get_rgba_visual().
10711 * For making non-toplevel windows translucent, see
10712 * gdk_window_set_composited().
10717 gdk_window_set_opacity (GdkWindow *window,
10720 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_opacity (window, opacity);
10723 /* This function is called when the XWindow is really gone.
10726 gdk_window_destroy_notify (GdkWindow *window)
10728 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->destroy_notify (window);
10732 * gdk_window_register_dnd:
10733 * @window: a #GdkWindow.
10735 * Registers a window as a potential drop destination.
10738 gdk_window_register_dnd (GdkWindow *window)
10740 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->register_dnd (window);
10744 * gdk_window_get_drag_protocol:
10745 * @window: the destination window
10746 * @target: (out) (allow-none) (transfer full): location of the window
10747 * where the drop should happen. This may be @window or a proxy window,
10748 * or %NULL if @window does not support Drag and Drop.
10750 * Finds out the DND protocol supported by a window.
10752 * Returns: the supported DND protocol.
10757 gdk_window_get_drag_protocol (GdkWindow *window,
10758 GdkWindow **target)
10760 g_return_val_if_fail (GDK_IS_WINDOW (window), GDK_DRAG_PROTO_NONE);
10762 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_drag_protocol (window, target);
10767 * @window: the source window for this drag.
10768 * @targets: (transfer none) (element-type GdkAtom): the offered targets,
10769 * as list of #GdkAtoms
10771 * Starts a drag and creates a new drag context for it.
10772 * This function assumes that the drag is controlled by the
10773 * client pointer device, use gdk_drag_begin_for_device() to
10774 * begin a drag with a different device.
10776 * This function is called by the drag source.
10778 * Return value: (transfer full): a newly created #GdkDragContext
10781 gdk_drag_begin (GdkWindow *window,
10784 GdkDeviceManager *device_manager;
10787 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10788 device = gdk_device_manager_get_client_pointer (device_manager);
10790 return gdk_drag_begin_for_device (window, device, targets);
10794 * gdk_drag_begin_for_device:
10795 * @window: the source window for this drag
10796 * @device: the device that controls this drag
10797 * @targets: (transfer none) (element-type GdkAtom): the offered targets,
10798 * as list of #GdkAtoms
10800 * Starts a drag and creates a new drag context for it.
10802 * This function is called by the drag source.
10804 * Return value: (transfer full): a newly created #GdkDragContext
10807 gdk_drag_begin_for_device (GdkWindow *window,
10811 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->drag_begin (window, device, targets);
10815 * gdk_test_render_sync:
10816 * @window: a mapped #GdkWindow
10818 * Retrieves a pixel from @window to force the windowing
10819 * system to carry out any pending rendering commands.
10821 * This function is intended to be used to synchronize with rendering
10822 * pipelines, to benchmark windowing system rendering operations.
10827 gdk_test_render_sync (GdkWindow *window)
10829 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->sync_rendering (window);
10833 * gdk_test_simulate_key:
10834 * @window: a #GdkWindow to simulate a key event for
10835 * @x: x coordinate within @window for the key event
10836 * @y: y coordinate within @window for the key event
10837 * @keyval: A GDK keyboard value
10838 * @modifiers: Keyboard modifiers the event is setup with
10839 * @key_pressrelease: either %GDK_KEY_PRESS or %GDK_KEY_RELEASE
10841 * This function is intended to be used in GTK+ test programs.
10842 * If (@x,@y) are > (-1,-1), it will warp the mouse pointer to
10843 * the given (@x,@y) coordinates within @window and simulate a
10844 * key press or release event.
10846 * When the mouse pointer is warped to the target location, use
10847 * of this function outside of test programs that run in their
10848 * own virtual windowing system (e.g. Xvfb) is not recommended.
10849 * If (@x,@y) are passed as (-1,-1), the mouse pointer will not
10850 * be warped and @window origin will be used as mouse pointer
10851 * location for the event.
10853 * Also, gdk_test_simulate_key() is a fairly low level function,
10854 * for most testing purposes, gtk_test_widget_send_key() is the
10855 * right function to call which will generate a key press event
10856 * followed by its accompanying key release event.
10858 * Returns: whether all actions necessary for a key event simulation
10859 * were carried out successfully
10864 gdk_test_simulate_key (GdkWindow *window,
10868 GdkModifierType modifiers,
10869 GdkEventType key_pressrelease)
10871 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10872 ->simulate_key (window, x, y, keyval, modifiers, key_pressrelease);
10876 * gdk_test_simulate_button:
10877 * @window: a #GdkWindow to simulate a button event for
10878 * @x: x coordinate within @window for the button event
10879 * @y: y coordinate within @window for the button event
10880 * @button: Number of the pointer button for the event, usually 1, 2 or 3
10881 * @modifiers: Keyboard modifiers the event is setup with
10882 * @button_pressrelease: either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
10884 * This function is intended to be used in GTK+ test programs.
10885 * It will warp the mouse pointer to the given (@x,@y) coordinates
10886 * within @window and simulate a button press or release event.
10887 * Because the mouse pointer needs to be warped to the target
10888 * location, use of this function outside of test programs that
10889 * run in their own virtual windowing system (e.g. Xvfb) is not
10892 * Also, gdk_test_simulate_button() is a fairly low level function,
10893 * for most testing purposes, gtk_test_widget_click() is the right
10894 * function to call which will generate a button press event followed
10895 * by its accompanying button release event.
10897 * Returns: whether all actions necessary for a button event simulation
10898 * were carried out successfully
10903 gdk_test_simulate_button (GdkWindow *window,
10906 guint button, /*1..3*/
10907 GdkModifierType modifiers,
10908 GdkEventType button_pressrelease)
10910 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10911 ->simulate_button (window, x, y, button, modifiers, button_pressrelease);
10915 * gdk_property_get:
10916 * @window: a #GdkWindow
10917 * @property: the property to retrieve
10918 * @type: the desired property type, or %GDK_NONE, if any type of data
10919 * is acceptable. If this does not match the actual
10920 * type, then @actual_format and @actual_length will
10921 * be filled in, a warning will be printed to stderr
10922 * and no data will be returned.
10923 * @offset: the offset into the property at which to begin
10924 * retrieving data, in 4 byte units.
10925 * @length: the length of the data to retrieve in bytes. Data is
10926 * considered to be retrieved in 4 byte chunks, so @length
10927 * will be rounded up to the next highest 4 byte boundary
10928 * (so be careful not to pass a value that might overflow
10929 * when rounded up).
10930 * @pdelete: if %TRUE, delete the property after retrieving the
10932 * @actual_property_type: (out) (transfer none): location to store the
10933 * actual type of the property.
10934 * @actual_format: (out): location to store the actual return format of the
10935 * data; either 8, 16 or 32 bits.
10936 * @actual_length: location to store the length of the retrieved data, in
10937 * bytes. Data returned in the 32 bit format is stored
10938 * in a long variable, so the actual number of 32 bit
10939 * elements should be be calculated via
10940 * @actual_length / sizeof(glong) to ensure portability to
10942 * @data: (out) (array length=actual_length) (transfer full): location
10943 * to store a pointer to the data. The retrieved data should be
10944 * freed with g_free() when you are finished using it.
10946 * Retrieves a portion of the contents of a property. If the
10947 * property does not exist, then the function returns %FALSE,
10948 * and %GDK_NONE will be stored in @actual_property_type.
10952 * The XGetWindowProperty() function that gdk_property_get()
10953 * uses has a very confusing and complicated set of semantics.
10954 * Unfortunately, gdk_property_get() makes the situation
10955 * worse instead of better (the semantics should be considered
10956 * undefined), and also prints warnings to stderr in cases where it
10957 * should return a useful error to the program. You are advised to use
10958 * XGetWindowProperty() directly until a replacement function for
10959 * gdk_property_get()
10964 * Returns: %TRUE if data was successfully received and stored
10965 * in @data, otherwise %FALSE.
10968 gdk_property_get (GdkWindow *window,
10974 GdkAtom *actual_property_type,
10975 gint *actual_format_type,
10976 gint *actual_length,
10979 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10980 ->get_property (window, property, type, offset, length, pdelete,
10981 actual_property_type, actual_format_type,
10982 actual_length, data);
10986 * gdk_property_change: (skip)
10987 * @window: a #GdkWindow
10988 * @property: the property to change
10989 * @type: the new type for the property. If @mode is
10990 * %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
10991 * must match the existing type or an error will occur.
10992 * @format: the new format for the property. If @mode is
10993 * %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
10994 * must match the existing format or an error will occur.
10995 * @mode: a value describing how the new data is to be combined
10996 * with the current data.
10997 * @data: the data (a <literal>guchar *</literal>
10998 * <literal>gushort *</literal>, or <literal>gulong *</literal>,
10999 * depending on @format), cast to a <literal>guchar *</literal>.
11000 * @nelements: the number of elements of size determined by the format,
11001 * contained in @data.
11003 * Changes the contents of a property on a window.
11006 gdk_property_change (GdkWindow *window,
11011 const guchar *data,
11014 GDK_WINDOW_IMPL_GET_CLASS (window->impl)
11015 ->change_property (window, property, type, format, mode, data, nelements);
11019 * gdk_property_delete:
11020 * @window: a #GdkWindow
11021 * @property: the property to delete
11023 * Deletes a property from a window.
11026 gdk_property_delete (GdkWindow *window,
11029 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->delete_property (window, property);