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;
212 cairo_region_t *dest_region; /* The destination region */
213 int dx, dy; /* The amount that the source was moved to reach dest_region */
214 } GdkWindowRegionMove;
218 static void gdk_window_drop_cairo_surface (GdkWindow *private);
220 static void gdk_window_free_paint_stack (GdkWindow *window);
222 static void gdk_window_finalize (GObject *object);
224 static void gdk_window_set_property (GObject *object,
228 static void gdk_window_get_property (GObject *object,
233 static void gdk_window_clear_backing_region (GdkWindow *window,
234 cairo_region_t *region);
236 static void recompute_visible_regions (GdkWindow *private,
237 gboolean recalculate_siblings,
238 gboolean recalculate_children);
239 static void gdk_window_flush_outstanding_moves (GdkWindow *window);
240 static void gdk_window_flush_recursive (GdkWindow *window);
241 static void do_move_region_bits_on_impl (GdkWindow *window,
242 cairo_region_t *region, /* In impl window coords */
244 static void gdk_window_invalidate_in_parent (GdkWindow *private);
245 static void move_native_children (GdkWindow *private);
246 static void update_cursor (GdkDisplay *display,
248 static void impl_window_add_update_area (GdkWindow *impl_window,
249 cairo_region_t *region);
250 static void gdk_window_region_move_free (GdkWindowRegionMove *move);
251 static void gdk_window_invalidate_region_full (GdkWindow *window,
252 const cairo_region_t *region,
253 gboolean invalidate_children,
255 static void gdk_window_invalidate_rect_full (GdkWindow *window,
256 const GdkRectangle *rect,
257 gboolean invalidate_children,
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;
267 new_region_tag (void)
269 static guint32 tag = 0;
274 G_DEFINE_ABSTRACT_TYPE (GdkWindow, gdk_window, G_TYPE_OBJECT)
277 _gdk_paintable_get_type (void)
279 static GType paintable_type = 0;
283 const GTypeInfo paintable_info =
285 sizeof (GdkPaintableIface), /* class_size */
286 NULL, /* base_init */
287 NULL, /* base_finalize */
290 paintable_type = g_type_register_static (G_TYPE_INTERFACE,
291 g_intern_static_string ("GdkPaintable"),
294 g_type_interface_add_prerequisite (paintable_type, G_TYPE_OBJECT);
297 return paintable_type;
301 gdk_window_init (GdkWindow *window)
303 /* 0-initialization is good for all other fields. */
305 window->window_type = GDK_WINDOW_CHILD;
307 window->state = GDK_WINDOW_STATE_WITHDRAWN;
310 window->toplevel_window_type = -1;
312 window->effective_visibility = GDK_VISIBILITY_NOT_VIEWABLE;
313 window->visibility = GDK_VISIBILITY_FULLY_OBSCURED;
314 /* Default to unobscured since some backends don't send visibility events */
315 window->native_visibility = GDK_VISIBILITY_UNOBSCURED;
317 window->device_cursor = g_hash_table_new_full (NULL, NULL,
318 NULL, g_object_unref);
321 /* Stop and return on the first non-NULL parent */
323 accumulate_get_window (GSignalInvocationHint *ihint,
325 const GValue *handler_return,
328 g_value_copy (handler_return, return_accu);
329 /* Continue while returning NULL */
330 return g_value_get_object (handler_return) == NULL;
334 create_surface_accumulator (GSignalInvocationHint *ihint,
336 const GValue *handler_return,
339 g_value_copy (handler_return, return_accu);
341 /* Stop on the first non-NULL return value */
342 return g_value_get_boxed (handler_return) == NULL;
345 static GQuark quark_pointer_window = 0;
348 gdk_window_class_init (GdkWindowClass *klass)
350 GObjectClass *object_class = G_OBJECT_CLASS (klass);
352 parent_class = g_type_class_peek_parent (klass);
354 object_class->finalize = gdk_window_finalize;
355 object_class->set_property = gdk_window_set_property;
356 object_class->get_property = gdk_window_get_property;
358 klass->create_surface = _gdk_offscreen_window_create_surface;
360 quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
368 * The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and
369 * gdk_window_get_cursor() for details.
373 g_object_class_install_property (object_class,
375 g_param_spec_object ("cursor",
382 * GdkWindow::pick-embedded-child:
383 * @window: the window on which the signal is emitted
384 * @x: x coordinate in the window
385 * @y: y coordinate in the window
387 * The ::pick-embedded-child signal is emitted to find an embedded
388 * child at the given position.
390 * Returns: (transfer none): the #GdkWindow of the embedded child at
395 signals[PICK_EMBEDDED_CHILD] =
396 g_signal_new (g_intern_static_string ("pick-embedded-child"),
397 G_OBJECT_CLASS_TYPE (object_class),
399 G_STRUCT_OFFSET (GdkWindowClass, pick_embedded_child),
400 accumulate_get_window, NULL,
401 _gdk_marshal_OBJECT__DOUBLE_DOUBLE,
408 * GdkWindow::to-embedder:
409 * @window: the offscreen window on which the signal is emitted
410 * @offscreen-x: x coordinate in the offscreen window
411 * @offscreen-y: y coordinate in the offscreen window
412 * @embedder-x: (out) (type double): return location for the x
413 * coordinate in the embedder window
414 * @embedder-y: (out) (type double): return location for the y
415 * coordinate in the embedder window
417 * The ::to-embedder signal is emitted to translate coordinates
418 * in an offscreen window to its embedder.
420 * See also #GtkWindow::from-embedder.
424 signals[TO_EMBEDDER] =
425 g_signal_new (g_intern_static_string ("to-embedder"),
426 G_OBJECT_CLASS_TYPE (object_class),
428 G_STRUCT_OFFSET (GdkWindowClass, to_embedder),
430 _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
439 * GdkWindow::from-embedder:
440 * @window: the offscreen window on which the signal is emitted
441 * @embedder-x: x coordinate in the embedder window
442 * @embedder-y: y coordinate in the embedder window
443 * @offscreen-x: (out) (type double): return location for the x
444 * coordinate in the offscreen window
445 * @offscreen-y: (out) (type double): return location for the y
446 * coordinate in the offscreen window
448 * The ::from-embedder signal is emitted to translate coordinates
449 * in the embedder of an offscreen window to the offscreen window.
451 * See also #GtkWindow::to-embedder.
455 signals[FROM_EMBEDDER] =
456 g_signal_new (g_intern_static_string ("from-embedder"),
457 G_OBJECT_CLASS_TYPE (object_class),
459 G_STRUCT_OFFSET (GdkWindowClass, from_embedder),
461 _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
470 * GdkWindow::create-surface:
471 * @window: the offscreen window on which the signal is emitted
472 * @width: the width of the offscreen surface to create
473 * @height: the height of the offscreen surface to create
475 * The ::create-surface signal is emitted when an offscreen window
476 * needs its surface (re)created, which happens either when the the
477 * window is first drawn to, or when the window is being
478 * resized. The first signal handler that returns a non-%NULL
479 * surface will stop any further signal emission, and its surface
482 * Note that it is not possible to access the window's previous
483 * surface from within any callback of this signal. Calling
484 * gdk_offscreen_window_get_surface() will lead to a crash.
486 * Returns: the newly created #cairo_surface_t for the offscreen window
490 signals[CREATE_SURFACE] =
491 g_signal_new (g_intern_static_string ("create-surface"),
492 G_OBJECT_CLASS_TYPE (object_class),
494 G_STRUCT_OFFSET (GdkWindowClass, create_surface),
495 create_surface_accumulator, NULL,
496 _gdk_marshal_BOXED__INT_INT,
497 CAIRO_GOBJECT_TYPE_SURFACE,
504 device_removed_cb (GdkDeviceManager *device_manager,
508 window->devices_inside = g_list_remove (window->devices_inside, device);
509 g_hash_table_remove (window->device_cursor, device);
511 if (window->device_events)
512 g_hash_table_remove (window->device_events, device);
516 gdk_window_finalize (GObject *object)
518 GdkWindow *window = GDK_WINDOW (object);
519 GdkDeviceManager *device_manager;
521 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
522 g_signal_handlers_disconnect_by_func (device_manager, device_removed_cb, window);
524 if (!GDK_WINDOW_DESTROYED (window))
526 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
528 g_warning ("losing last reference to undestroyed window\n");
529 _gdk_window_destroy (window, FALSE);
532 /* We use TRUE here, to keep us from actually calling
533 * XDestroyWindow() on the window
535 _gdk_window_destroy (window, TRUE);
538 gdk_window_drop_cairo_surface (window);
542 g_object_unref (window->impl);
546 if (window->impl_window != window)
548 g_object_unref (window->impl_window);
549 window->impl_window = NULL;
553 cairo_region_destroy (window->shape);
555 if (window->input_shape)
556 cairo_region_destroy (window->input_shape);
559 g_object_unref (window->cursor);
561 if (window->device_cursor)
562 g_hash_table_destroy (window->device_cursor);
564 if (window->device_events)
565 g_hash_table_destroy (window->device_events);
567 if (window->source_event_masks)
568 g_hash_table_destroy (window->source_event_masks);
570 if (window->devices_inside)
571 g_list_free (window->devices_inside);
573 G_OBJECT_CLASS (parent_class)->finalize (object);
577 gdk_window_set_property (GObject *object,
582 GdkWindow *window = (GdkWindow *)object;
587 gdk_window_set_cursor (window, g_value_get_object (value));
591 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
597 gdk_window_get_property (GObject *object,
602 GdkWindow *window = (GdkWindow *) object;
607 g_value_set_object (value, gdk_window_get_cursor (window));
611 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
617 gdk_window_is_offscreen (GdkWindow *window)
619 return window->window_type == GDK_WINDOW_OFFSCREEN;
623 gdk_window_get_impl_window (GdkWindow *window)
625 return window->impl_window;
629 _gdk_window_get_impl_window (GdkWindow *window)
631 return gdk_window_get_impl_window (window);
635 gdk_window_has_impl (GdkWindow *window)
637 return window->impl_window == window;
641 gdk_window_is_toplevel (GdkWindow *window)
644 window->parent == NULL ||
645 window->parent->window_type == GDK_WINDOW_ROOT;
649 _gdk_window_has_impl (GdkWindow *window)
651 return gdk_window_has_impl (window);
655 gdk_window_has_no_impl (GdkWindow *window)
657 return window->impl_window != window;
661 remove_child_area (GdkWindow *private,
664 cairo_region_t *region)
667 cairo_region_t *child_region;
670 cairo_region_t *shape;
672 for (l = private->children; l; l = l->next)
679 /* If region is empty already, no need to do
680 anything potentially costly */
681 if (cairo_region_is_empty (region))
684 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
687 /* Ignore offscreen children, as they don't draw in their parent and
688 * don't take part in the clipping */
689 if (gdk_window_is_offscreen (child))
694 r.width = child->width;
695 r.height = child->height;
697 /* Bail early if child totally outside region */
698 if (cairo_region_contains_rectangle (region, &r) == CAIRO_REGION_OVERLAP_OUT)
701 child_region = cairo_region_create_rectangle (&r);
705 /* Adjust shape region to parent window coords */
706 cairo_region_translate (child->shape, child->x, child->y);
707 cairo_region_intersect (child_region, child->shape);
708 cairo_region_translate (child->shape, -child->x, -child->y);
710 else if (private->window_type == GDK_WINDOW_FOREIGN)
712 shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_shape (child);
715 cairo_region_intersect (child_region, shape);
716 cairo_region_destroy (shape);
722 if (child->input_shape)
723 cairo_region_intersect (child_region, child->input_shape);
724 else if (private->window_type == GDK_WINDOW_FOREIGN)
726 shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_input_shape (child);
729 cairo_region_intersect (child_region, shape);
730 cairo_region_destroy (shape);
735 cairo_region_subtract (region, child_region);
736 cairo_region_destroy (child_region);
741 static GdkVisibilityState
742 effective_visibility (GdkWindow *window)
744 GdkVisibilityState native;
746 if (!gdk_window_is_viewable (window))
747 return GDK_VISIBILITY_NOT_VIEWABLE;
749 native = window->impl_window->native_visibility;
751 if (native == GDK_VISIBILITY_FULLY_OBSCURED ||
752 window->visibility == GDK_VISIBILITY_FULLY_OBSCURED)
753 return GDK_VISIBILITY_FULLY_OBSCURED;
754 else if (native == GDK_VISIBILITY_UNOBSCURED)
755 return window->visibility;
756 else /* native PARTIAL, private partial or unobscured */
757 return GDK_VISIBILITY_PARTIAL;
761 gdk_window_update_visibility (GdkWindow *window)
763 GdkVisibilityState new_visibility;
766 new_visibility = effective_visibility (window);
768 if (new_visibility != window->effective_visibility)
770 window->effective_visibility = new_visibility;
772 if (new_visibility != GDK_VISIBILITY_NOT_VIEWABLE &&
773 window->event_mask & GDK_VISIBILITY_NOTIFY)
775 event = _gdk_make_event (window, GDK_VISIBILITY_NOTIFY,
777 event->visibility.state = new_visibility;
783 gdk_window_update_visibility_recursively (GdkWindow *window,
784 GdkWindow *only_for_impl)
789 gdk_window_update_visibility (window);
790 for (l = window->children; l != NULL; l = l->next)
793 if ((only_for_impl == NULL) ||
794 (only_for_impl == child->impl_window))
795 gdk_window_update_visibility_recursively (child, only_for_impl);
800 should_apply_clip_as_shape (GdkWindow *window)
803 gdk_window_has_impl (window) &&
804 /* Not for offscreens */
805 !gdk_window_is_offscreen (window) &&
806 /* or for toplevels */
807 !gdk_window_is_toplevel (window) &&
808 /* or for foreign windows */
809 window->window_type != GDK_WINDOW_FOREIGN &&
810 /* or for the root window */
811 window->window_type != GDK_WINDOW_ROOT;
815 apply_shape (GdkWindow *window,
816 cairo_region_t *region)
818 GdkWindowImplClass *impl_class;
820 /* We trash whether we applied a shape so that
821 we can avoid unsetting it many times, which
822 could happen in e.g. apply_clip_as_shape as
823 windows get resized */
824 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
826 impl_class->shape_combine_region (window,
828 else if (window->applied_shape)
829 impl_class->shape_combine_region (window,
832 window->applied_shape = region != NULL;
836 region_rect_equal (const cairo_region_t *region,
837 const GdkRectangle *rect)
839 GdkRectangle extents;
841 if (cairo_region_num_rectangles (region) != 1)
844 cairo_region_get_extents (region, &extents);
846 return extents.x == rect->x &&
847 extents.y == rect->y &&
848 extents.width == rect->width &&
849 extents.height == rect->height;
853 apply_clip_as_shape (GdkWindow *window)
858 r.width = window->width;
859 r.height = window->height;
861 /* We only apply the clip region if would differ
862 from the actual clip region implied by the size
863 of the window. This is to avoid unneccessarily
864 adding meaningless shapes to all native subwindows */
865 if (!region_rect_equal (window->clip_region, &r))
866 apply_shape (window, window->clip_region);
868 apply_shape (window, NULL);
872 recompute_visible_regions_internal (GdkWindow *private,
873 gboolean recalculate_clip,
874 gboolean recalculate_siblings,
875 gboolean recalculate_children)
880 cairo_region_t *new_clip, *old_clip_region_with_children;
881 gboolean clip_region_changed;
882 gboolean abs_pos_changed;
883 int old_abs_x, old_abs_y;
885 old_abs_x = private->abs_x;
886 old_abs_y = private->abs_y;
888 /* Update absolute position */
889 if (gdk_window_has_impl (private))
891 /* Native window starts here */
897 private->abs_x = private->parent->abs_x + private->x;
898 private->abs_y = private->parent->abs_y + private->y;
902 private->abs_x != old_abs_x ||
903 private->abs_y != old_abs_y;
905 /* Update clip region based on:
908 * siblings in parents above window
910 clip_region_changed = FALSE;
911 if (recalculate_clip)
913 if (private->viewable)
915 /* Calculate visible region (sans children) in parent window coords */
918 r.width = private->width;
919 r.height = private->height;
920 new_clip = cairo_region_create_rectangle (&r);
922 if (!gdk_window_is_toplevel (private))
924 cairo_region_intersect (new_clip, private->parent->clip_region);
926 /* Remove all overlapping children from parent. */
927 remove_child_area (private->parent, private, FALSE, new_clip);
930 /* Convert from parent coords to window coords */
931 cairo_region_translate (new_clip, -private->x, -private->y);
934 cairo_region_intersect (new_clip, private->shape);
937 new_clip = cairo_region_create ();
939 if (private->clip_region == NULL ||
940 !cairo_region_equal (private->clip_region, new_clip))
941 clip_region_changed = TRUE;
943 if (private->clip_region)
944 cairo_region_destroy (private->clip_region);
945 private->clip_region = new_clip;
947 old_clip_region_with_children = private->clip_region_with_children;
948 private->clip_region_with_children = cairo_region_copy (private->clip_region);
949 if (private->window_type != GDK_WINDOW_ROOT)
950 remove_child_area (private, NULL, FALSE, private->clip_region_with_children);
952 if (clip_region_changed ||
953 !cairo_region_equal (private->clip_region_with_children, old_clip_region_with_children))
954 private->clip_tag = new_region_tag ();
956 if (old_clip_region_with_children)
957 cairo_region_destroy (old_clip_region_with_children);
960 if (clip_region_changed)
962 GdkVisibilityState visibility;
963 gboolean fully_visible;
965 if (cairo_region_is_empty (private->clip_region))
966 visibility = GDK_VISIBILITY_FULLY_OBSCURED;
971 fully_visible = cairo_region_equal (private->clip_region,
978 r.width = private->width;
979 r.height = private->height;
980 fully_visible = region_rect_equal (private->clip_region, &r);
984 visibility = GDK_VISIBILITY_UNOBSCURED;
986 visibility = GDK_VISIBILITY_PARTIAL;
989 if (private->visibility != visibility)
991 private->visibility = visibility;
992 gdk_window_update_visibility (private);
996 /* Update all children, recursively (except for root, where children are not exact). */
997 if ((abs_pos_changed || clip_region_changed || recalculate_children) &&
998 private->window_type != GDK_WINDOW_ROOT)
1000 for (l = private->children; l; l = l->next)
1003 /* Only recalculate clip if the the clip region changed, otherwise
1004 * there is no way the child clip region could change (its has not e.g. moved)
1005 * Except if recalculate_children is set to force child updates
1007 recompute_visible_regions_internal (child,
1008 recalculate_clip && (clip_region_changed || recalculate_children),
1013 if (clip_region_changed &&
1014 should_apply_clip_as_shape (private))
1015 apply_clip_as_shape (private);
1017 if (recalculate_siblings &&
1018 !gdk_window_is_toplevel (private))
1020 /* If we moved a child window in parent or changed the stacking order, then we
1021 * need to recompute the visible area of all the other children in the parent
1023 for (l = private->parent->children; l; l = l->next)
1027 if (child != private)
1028 recompute_visible_regions_internal (child, TRUE, FALSE, FALSE);
1031 /* We also need to recompute the _with_children clip for the parent */
1032 recompute_visible_regions_internal (private->parent, TRUE, FALSE, FALSE);
1035 if (private->cairo_surface && gdk_window_has_impl (private))
1037 GdkWindowImplClass *iface = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1039 private->cairo_surface = iface->resize_cairo_surface (private,
1040 private->cairo_surface,
1044 else if (private->cairo_surface)
1045 gdk_window_drop_cairo_surface (private);
1048 /* Call this when private has changed in one or more of these ways:
1052 * stacking order of window changed
1055 * It will recalculate abs_x/y and the clip regions
1057 * Unless the window didn't change stacking order or size/pos, pass in TRUE
1058 * for recalculate_siblings. (Mostly used internally for the recursion)
1060 * If a child window was removed (and you can't use that child for
1061 * recompute_visible_regions), pass in TRUE for recalculate_children on the parent
1064 recompute_visible_regions (GdkWindow *private,
1065 gboolean recalculate_siblings,
1066 gboolean recalculate_children)
1068 recompute_visible_regions_internal (private,
1070 recalculate_siblings,
1071 recalculate_children);
1075 _gdk_window_update_size (GdkWindow *window)
1077 recompute_visible_regions (window, TRUE, FALSE);
1080 /* Find the native window that would be just above "child"
1081 * in the native stacking order if "child" was a native window
1082 * (it doesn't have to be native). If there is no such native
1083 * window inside this native parent then NULL is returned.
1084 * If child is NULL, find lowest native window in parent.
1087 find_native_sibling_above_helper (GdkWindow *parent,
1095 l = g_list_find (parent->children, child);
1096 g_assert (l != NULL); /* Better be a child of its parent... */
1097 l = l->prev; /* Start looking at the one above the child */
1100 l = g_list_last (parent->children);
1102 for (; l != NULL; l = l->prev)
1106 if (gdk_window_has_impl (w))
1109 g_assert (parent != w);
1110 w = find_native_sibling_above_helper (w, NULL);
1120 find_native_sibling_above (GdkWindow *parent,
1125 w = find_native_sibling_above_helper (parent, child);
1129 if (gdk_window_has_impl (parent))
1132 return find_native_sibling_above (parent->parent, parent);
1136 get_native_device_event_mask (GdkWindow *private,
1139 GdkEventMask event_mask;
1142 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (private->device_events, device));
1144 event_mask = private->event_mask;
1146 if (private->window_type == GDK_WINDOW_ROOT ||
1147 private->window_type == GDK_WINDOW_FOREIGN)
1153 /* Do whatever the app asks to, since the app
1154 * may be asking for weird things for native windows,
1155 * but don't use motion hints as that may affect non-native
1156 * child windows that don't want it. Also, we need to
1157 * set all the app-specified masks since they will be picked
1158 * up by any implicit grabs (i.e. if they were not set as
1159 * native we would not get the events we need). */
1160 mask = private->event_mask & ~GDK_POINTER_MOTION_HINT_MASK;
1162 /* We need thse for all native windows so we can
1163 emulate events on children: */
1166 GDK_VISIBILITY_NOTIFY_MASK |
1167 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK;
1169 /* Additionally we select for pointer and button events
1170 * for toplevels as we need to get these to emulate
1171 * them for non-native subwindows. Even though we don't
1172 * select on them for all native windows we will get them
1173 * as the events are propagated out to the first window
1174 * that select for them.
1175 * Not selecting for button press on all windows is an
1176 * important thing, because in X only one client can do
1177 * so, and we don't want to unexpectedly prevent another
1178 * client from doing it.
1180 * We also need to do the same if the app selects for button presses
1181 * because then we will get implicit grabs for this window, and the
1182 * event mask used for that grab is based on the rest of the mask
1183 * for the window, but we might need more events than this window
1184 * lists due to some non-native child window.
1186 if (gdk_window_is_toplevel (private) ||
1187 mask & GDK_BUTTON_PRESS_MASK)
1189 GDK_POINTER_MOTION_MASK |
1190 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1198 get_native_grab_event_mask (GdkEventMask grab_mask)
1200 /* Similar to the above but for pointer events only */
1202 GDK_POINTER_MOTION_MASK |
1203 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1204 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1207 ~GDK_POINTER_MOTION_HINT_MASK);
1211 get_native_event_mask (GdkWindow *private)
1213 return get_native_device_event_mask (private, NULL);
1216 /* Puts the native window in the right order wrt the other native windows
1217 * in the hierarchy, given the position it has in the client side data.
1218 * This is useful if some operation changed the stacking order.
1219 * This calls assumes the native window is now topmost in its native parent.
1222 sync_native_window_stack_position (GdkWindow *window)
1225 GdkWindowImplClass *impl_class;
1226 GList listhead = {0};
1228 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1230 above = find_native_sibling_above (window->parent, window);
1233 listhead.data = window;
1234 impl_class->restack_under (above, &listhead);
1239 * gdk_window_new: (constructor)
1240 * @parent: (allow-none): a #GdkWindow, or %NULL to create the window as a child of
1241 * the default root window for the default display.
1242 * @attributes: attributes of the new window
1243 * @attributes_mask: mask indicating which fields in @attributes are valid
1245 * Creates a new #GdkWindow using the attributes from
1246 * @attributes. See #GdkWindowAttr and #GdkWindowAttributesType for
1247 * more details. Note: to use this on displays other than the default
1248 * display, @parent must be specified.
1250 * Return value: (transfer full): the new #GdkWindow
1253 gdk_window_new (GdkWindow *parent,
1254 GdkWindowAttr *attributes,
1255 gint attributes_mask)
1259 GdkDisplay *display;
1262 GdkEventMask event_mask;
1263 GdkWindow *real_parent;
1264 GdkDeviceManager *device_manager;
1266 g_return_val_if_fail (attributes != NULL, NULL);
1270 GDK_NOTE (MULTIHEAD,
1271 g_warning ("gdk_window_new(): no parent specified reverting to parent = default root window"));
1273 screen = gdk_screen_get_default ();
1274 parent = gdk_screen_get_root_window (screen);
1277 screen = gdk_window_get_screen (parent);
1279 g_return_val_if_fail (GDK_IS_WINDOW (parent), NULL);
1281 if (GDK_WINDOW_DESTROYED (parent))
1283 g_warning ("gdk_window_new(): parent is destroyed\n");
1287 display = gdk_screen_get_display (screen);
1289 window = _gdk_display_create_window (display);
1291 /* Windows with a foreign parent are treated as if they are children
1292 * of the root window, except for actual creation.
1294 real_parent = parent;
1295 if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_FOREIGN)
1296 parent = gdk_screen_get_root_window (screen);
1298 window->parent = parent;
1300 window->accept_focus = TRUE;
1301 window->focus_on_map = TRUE;
1303 if (attributes_mask & GDK_WA_X)
1308 if (attributes_mask & GDK_WA_Y)
1315 window->width = (attributes->width > 1) ? (attributes->width) : (1);
1316 window->height = (attributes->height > 1) ? (attributes->height) : (1);
1318 if (attributes->wclass == GDK_INPUT_ONLY)
1320 /* Backwards compatiblity - we've always ignored
1321 * attributes->window_type for input-only windows
1324 if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_ROOT)
1325 window->window_type = GDK_WINDOW_TEMP;
1327 window->window_type = GDK_WINDOW_CHILD;
1330 window->window_type = attributes->window_type;
1333 switch (window->window_type)
1335 case GDK_WINDOW_TOPLEVEL:
1336 case GDK_WINDOW_TEMP:
1337 case GDK_WINDOW_OFFSCREEN:
1338 if (GDK_WINDOW_TYPE (parent) != GDK_WINDOW_ROOT)
1339 g_warning (G_STRLOC "Toplevel windows must be created as children of\n"
1340 "of a window of type GDK_WINDOW_ROOT or GDK_WINDOW_FOREIGN");
1341 case GDK_WINDOW_CHILD:
1345 g_warning (G_STRLOC "cannot make windows of type %d", window->window_type);
1349 if (attributes_mask & GDK_WA_VISUAL)
1350 window->visual = attributes->visual;
1352 window->visual = gdk_screen_get_system_visual (screen);
1354 window->event_mask = attributes->event_mask;
1356 if (attributes->wclass == GDK_INPUT_OUTPUT)
1358 window->input_only = FALSE;
1359 window->depth = window->visual->depth;
1361 /* XXX: Cache this somehow? */
1362 window->background = cairo_pattern_create_rgb (0, 0, 0);
1367 window->input_only = TRUE;
1371 window->parent->children = g_list_prepend (window->parent->children, window);
1374 if (window->parent->window_type == GDK_WINDOW_ROOT)
1375 native = TRUE; /* Always use native windows for toplevels */
1376 else if (!window->input_only &&
1377 (attributes_mask & GDK_WA_VISUAL &&
1378 attributes->visual != gdk_window_get_visual (window->parent)))
1379 native = TRUE; /* InputOutput window with different visual than parent, needs native window */
1381 if (gdk_window_is_offscreen (window))
1383 _gdk_offscreen_window_new (window, attributes, attributes_mask);
1384 window->impl_window = window;
1388 event_mask = get_native_event_mask (window);
1390 /* Create the impl */
1391 _gdk_display_create_window_impl (display, window, real_parent, screen, event_mask, attributes, attributes_mask);
1392 window->impl_window = window;
1394 /* This will put the native window topmost in the native parent, which may
1395 * be wrong wrt other native windows in the non-native hierarchy, so restack */
1396 if (!_gdk_window_has_impl (real_parent))
1397 sync_native_window_stack_position (window);
1401 window->impl_window = g_object_ref (window->parent->impl_window);
1402 window->impl = g_object_ref (window->impl_window->impl);
1405 recompute_visible_regions (window, TRUE, FALSE);
1407 gdk_window_set_cursor (window, ((attributes_mask & GDK_WA_CURSOR) ?
1408 (attributes->cursor) :
1411 device_manager = gdk_display_get_device_manager (gdk_window_get_display (parent));
1412 g_signal_connect (device_manager, "device-removed",
1413 G_CALLBACK (device_removed_cb), window);
1419 is_parent_of (GdkWindow *parent,
1430 w = gdk_window_get_parent (w);
1437 change_impl (GdkWindow *private,
1438 GdkWindow *impl_window,
1443 GdkWindowImpl *old_impl;
1444 GdkWindow *old_impl_window;
1446 old_impl = private->impl;
1447 old_impl_window = private->impl_window;
1448 if (private != impl_window)
1449 private->impl_window = g_object_ref (impl_window);
1451 private->impl_window = private;
1452 private->impl = g_object_ref (new);
1453 if (old_impl_window != private)
1454 g_object_unref (old_impl_window);
1455 g_object_unref (old_impl);
1457 for (l = private->children; l != NULL; l = l->next)
1461 if (child->impl == old_impl)
1462 change_impl (child, impl_window, new);
1467 reparent_to_impl (GdkWindow *private)
1472 GdkWindowImplClass *impl_class;
1474 impl_class = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1476 /* Enumerate in reverse order so we get the right order for the native
1477 windows (first in childrens list is topmost, and reparent places on top) */
1478 for (l = g_list_last (private->children); l != NULL; l = l->prev)
1482 if (child->impl == private->impl)
1483 reparent_to_impl (child);
1486 show = impl_class->reparent ((GdkWindow *)child,
1487 (GdkWindow *)private,
1488 child->x, child->y);
1490 gdk_window_show_unraised ((GdkWindow *)child);
1497 * gdk_window_reparent:
1498 * @window: a #GdkWindow
1499 * @new_parent: new parent to move @window into
1500 * @x: X location inside the new parent
1501 * @y: Y location inside the new parent
1503 * Reparents @window into the given @new_parent. The window being
1504 * reparented will be unmapped as a side effect.
1508 gdk_window_reparent (GdkWindow *window,
1509 GdkWindow *new_parent,
1513 GdkWindow *old_parent;
1515 gboolean show, was_mapped, applied_clip_as_shape;
1516 gboolean do_reparent_to_impl;
1517 GdkEventMask old_native_event_mask;
1518 GdkWindowImplClass *impl_class;
1520 g_return_if_fail (GDK_IS_WINDOW (window));
1521 g_return_if_fail (new_parent == NULL || GDK_IS_WINDOW (new_parent));
1522 g_return_if_fail (GDK_WINDOW_TYPE (window) != GDK_WINDOW_ROOT);
1524 if (GDK_WINDOW_DESTROYED (window) ||
1525 (new_parent && GDK_WINDOW_DESTROYED (new_parent)))
1528 screen = gdk_window_get_screen (window);
1530 new_parent = gdk_screen_get_root_window (screen);
1532 /* No input-output children of input-only windows */
1533 if (new_parent->input_only && !window->input_only)
1536 /* Don't create loops in hierarchy */
1537 if (is_parent_of (window, new_parent))
1540 /* This might be wrong in the new parent, e.g. for non-native surfaces.
1541 To make sure we're ok, just wipe it. */
1542 gdk_window_drop_cairo_surface (window);
1544 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1545 old_parent = window->parent;
1547 was_mapped = GDK_WINDOW_IS_MAPPED (window);
1550 /* Reparenting to toplevel. Ensure we have a native window so this can work */
1551 if (new_parent->window_type == GDK_WINDOW_ROOT ||
1552 new_parent->window_type == GDK_WINDOW_FOREIGN)
1553 gdk_window_ensure_native (window);
1555 applied_clip_as_shape = should_apply_clip_as_shape (window);
1557 old_native_event_mask = 0;
1558 do_reparent_to_impl = FALSE;
1559 if (gdk_window_has_impl (window))
1561 old_native_event_mask = get_native_event_mask (window);
1563 show = impl_class->reparent (window, new_parent, x, y);
1567 /* This shouldn't happen, as we created a native in this case, check anyway to see if that ever fails */
1568 g_assert (new_parent->window_type != GDK_WINDOW_ROOT &&
1569 new_parent->window_type != GDK_WINDOW_FOREIGN);
1572 gdk_window_hide (window);
1574 do_reparent_to_impl = TRUE;
1575 change_impl (window,
1576 new_parent->impl_window,
1580 /* From here on, we treat parents of type GDK_WINDOW_FOREIGN like
1583 if (GDK_WINDOW_TYPE (new_parent) == GDK_WINDOW_FOREIGN)
1585 new_parent = gdk_screen_get_root_window (screen);
1589 old_parent->children = g_list_remove (old_parent->children, window);
1591 window->parent = new_parent;
1595 new_parent->children = g_list_prepend (new_parent->children, window);
1597 /* Switch the window type as appropriate */
1599 switch (GDK_WINDOW_TYPE (new_parent))
1601 case GDK_WINDOW_ROOT:
1602 case GDK_WINDOW_FOREIGN:
1603 if (window->toplevel_window_type != -1)
1604 GDK_WINDOW_TYPE (window) = window->toplevel_window_type;
1605 else if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_CHILD)
1606 GDK_WINDOW_TYPE (window) = GDK_WINDOW_TOPLEVEL;
1608 case GDK_WINDOW_OFFSCREEN:
1609 case GDK_WINDOW_TOPLEVEL:
1610 case GDK_WINDOW_CHILD:
1611 case GDK_WINDOW_TEMP:
1612 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_CHILD && \
1613 GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
1615 /* Save the original window type so we can restore it if the
1616 * window is reparented back to be a toplevel
1618 window->toplevel_window_type = GDK_WINDOW_TYPE (window);
1619 GDK_WINDOW_TYPE (window) = GDK_WINDOW_CHILD;
1623 /* We might have changed window type for a native windows, so we
1624 need to change the event mask too. */
1625 if (gdk_window_has_impl (window))
1627 GdkEventMask native_event_mask = get_native_event_mask (window);
1629 if (native_event_mask != old_native_event_mask)
1630 impl_class->set_events (window, native_event_mask);
1633 _gdk_window_update_viewable (window);
1635 recompute_visible_regions (window, TRUE, FALSE);
1636 if (old_parent && GDK_WINDOW_TYPE (old_parent) != GDK_WINDOW_ROOT)
1637 recompute_visible_regions (old_parent, FALSE, TRUE);
1639 /* We used to apply the clip as the shape, but no more.
1640 Reset this to the real shape */
1641 if (gdk_window_has_impl (window) &&
1642 applied_clip_as_shape &&
1643 !should_apply_clip_as_shape (window))
1644 apply_shape (window, window->shape);
1646 if (do_reparent_to_impl)
1647 reparent_to_impl (window);
1650 /* The reparent will have put the native window topmost in the native parent,
1651 * which may be wrong wrt other native windows in the non-native hierarchy,
1653 if (!gdk_window_has_impl (new_parent))
1654 sync_native_window_stack_position (window);
1658 gdk_window_show_unraised (window);
1660 _gdk_synthesize_crossing_events_for_geometry_change (window);
1664 * gdk_window_ensure_native:
1665 * @window: a #GdkWindow
1667 * Tries to ensure that there is a window-system native window for this
1668 * GdkWindow. This may fail in some situations, returning %FALSE.
1670 * Offscreen window and children of them can never have native windows.
1672 * Some backends may not support native child windows.
1674 * Returns: %TRUE if the window has a native window, %FALSE otherwise
1679 gdk_window_ensure_native (GdkWindow *window)
1681 GdkWindow *impl_window;
1682 GdkWindowImpl *new_impl, *old_impl;
1683 GdkDisplay *display;
1687 GdkWindowImplClass *impl_class;
1689 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
1691 if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_ROOT ||
1692 GDK_WINDOW_DESTROYED (window))
1695 impl_window = gdk_window_get_impl_window (window);
1697 if (gdk_window_is_offscreen (impl_window))
1698 return FALSE; /* native in offscreens not supported */
1700 if (impl_window == window)
1701 /* Already has an impl, and its not offscreen . */
1704 /* Need to create a native window */
1706 gdk_window_drop_cairo_surface (window);
1708 screen = gdk_window_get_screen (window);
1709 display = gdk_screen_get_display (screen);
1711 old_impl = window->impl;
1712 _gdk_display_create_window_impl (display,
1713 window, window->parent,
1715 get_native_event_mask (window),
1717 new_impl = window->impl;
1719 window->impl = old_impl;
1720 change_impl (window, window, new_impl);
1722 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1724 /* Native window creation will put the native window topmost in the
1725 * native parent, which may be wrong wrt the position of the previous
1726 * non-native window wrt to the other non-native children, so correct this.
1728 above = find_native_sibling_above (window->parent, window);
1731 listhead.data = window;
1732 listhead.prev = NULL;
1733 listhead.next = NULL;
1734 impl_class->restack_under ((GdkWindow *)above, &listhead);
1737 recompute_visible_regions (window, FALSE, FALSE);
1739 /* The shape may not have been set, as the clip region doesn't actually
1740 change, so do it here manually */
1741 if (should_apply_clip_as_shape (window))
1742 apply_clip_as_shape (window);
1744 reparent_to_impl (window);
1746 if (!window->input_only)
1747 impl_class->set_background (window, window->background);
1749 impl_class->input_shape_combine_region (window,
1750 window->input_shape,
1753 if (gdk_window_is_viewable (window))
1754 impl_class->show (window, FALSE);
1760 * _gdk_event_filter_unref:
1761 * @window: (allow-none): A #GdkWindow, or %NULL to be the global window
1762 * @filter: A window filter
1764 * Release a reference to @filter. Note this function may
1765 * mutate the list storage, so you need to handle this
1766 * if iterating over a list of filters.
1769 _gdk_event_filter_unref (GdkWindow *window,
1770 GdkEventFilter *filter)
1776 filters = &_gdk_default_filters;
1778 filters = &window->filters;
1780 tmp_list = *filters;
1783 GdkEventFilter *iter_filter = tmp_list->data;
1787 tmp_list = tmp_list->next;
1789 if (iter_filter != filter)
1792 g_assert (iter_filter->ref_count > 0);
1794 filter->ref_count--;
1795 if (filter->ref_count != 0)
1798 *filters = g_list_remove_link (*filters, node);
1800 g_list_free_1 (node);
1805 window_remove_filters (GdkWindow *window)
1807 while (window->filters)
1808 _gdk_event_filter_unref (window, window->filters->data);
1812 update_pointer_info_foreach (GdkDisplay *display,
1814 GdkPointerWindowInfo *pointer_info,
1817 GdkWindow *window = user_data;
1819 if (pointer_info->toplevel_under_pointer == window)
1821 g_object_unref (pointer_info->toplevel_under_pointer);
1822 pointer_info->toplevel_under_pointer = NULL;
1827 window_remove_from_pointer_info (GdkWindow *window,
1828 GdkDisplay *display)
1830 _gdk_display_pointer_info_foreach (display,
1831 update_pointer_info_foreach,
1836 * _gdk_window_destroy_hierarchy:
1837 * @window: a #GdkWindow
1838 * @recursing: If TRUE, then this is being called because a parent
1840 * @recursing_native: If TRUE, then this is being called because a native parent
1841 * was destroyed. This generally means that the call to the
1842 * windowing system to destroy the window can be omitted, since
1843 * it will be destroyed as a result of the parent being destroyed.
1844 * Unless @foreign_destroy.
1845 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
1846 * external agency. The window has already been destroyed and no
1847 * windowing system calls should be made. (This may never happen
1848 * for some windowing systems.)
1850 * Internal function to destroy a window. Like gdk_window_destroy(),
1851 * but does not drop the reference count created by gdk_window_new().
1854 _gdk_window_destroy_hierarchy (GdkWindow *window,
1856 gboolean recursing_native,
1857 gboolean foreign_destroy)
1859 GdkWindowImplClass *impl_class;
1860 GdkWindow *temp_window;
1862 GdkDisplay *display;
1866 g_return_if_fail (GDK_IS_WINDOW (window));
1868 if (GDK_WINDOW_DESTROYED (window))
1871 display = gdk_window_get_display (window);
1872 screen = gdk_window_get_screen (window);
1873 temp_window = g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
1874 if (temp_window == window)
1875 g_object_set_qdata (G_OBJECT (screen), quark_pointer_window, NULL);
1878 switch (window->window_type)
1880 case GDK_WINDOW_ROOT:
1881 if (!screen->closed)
1883 g_error ("attempted to destroy root window");
1886 /* else fall thru */
1887 case GDK_WINDOW_TOPLEVEL:
1888 case GDK_WINDOW_CHILD:
1889 case GDK_WINDOW_TEMP:
1890 case GDK_WINDOW_FOREIGN:
1891 case GDK_WINDOW_OFFSCREEN:
1892 if (window->window_type == GDK_WINDOW_FOREIGN && !foreign_destroy)
1894 /* Logically, it probably makes more sense to send
1895 * a "destroy yourself" message to the foreign window
1896 * whether or not it's in our hierarchy; but for historical
1897 * reasons, we only send "destroy yourself" messages to
1898 * foreign windows in our hierarchy.
1902 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1904 if (gdk_window_has_impl (window))
1905 impl_class->destroy_foreign (window);
1908 /* Also for historical reasons, we remove any filters
1909 * on a foreign window when it or a parent is destroyed;
1910 * this likely causes problems if two separate portions
1911 * of code are maintaining filter lists on a foreign window.
1913 window_remove_filters (window);
1919 if (window->parent->children)
1920 window->parent->children = g_list_remove (window->parent->children, window);
1923 GDK_WINDOW_IS_MAPPED (window))
1925 recompute_visible_regions (window, TRUE, FALSE);
1926 gdk_window_invalidate_in_parent (window);
1930 gdk_window_free_paint_stack (window);
1932 if (window->background)
1934 cairo_pattern_destroy (window->background);
1935 window->background = NULL;
1938 if (window->window_type == GDK_WINDOW_FOREIGN)
1939 g_assert (window->children == NULL);
1942 children = tmp = window->children;
1943 window->children = NULL;
1947 temp_window = tmp->data;
1951 _gdk_window_destroy_hierarchy (temp_window,
1953 recursing_native || gdk_window_has_impl (window),
1957 g_list_free (children);
1960 _gdk_window_clear_update_area (window);
1962 gdk_window_drop_cairo_surface (window);
1964 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1966 if (gdk_window_has_impl (window))
1967 impl_class->destroy (window, recursing_native,
1971 /* hide to make sure we repaint and break grabs */
1972 gdk_window_hide (window);
1975 window->state |= GDK_WINDOW_STATE_WITHDRAWN;
1976 window->parent = NULL;
1977 window->destroyed = TRUE;
1979 window_remove_filters (window);
1981 window_remove_from_pointer_info (window, display);
1983 if (window->clip_region)
1985 cairo_region_destroy (window->clip_region);
1986 window->clip_region = NULL;
1989 if (window->clip_region_with_children)
1991 cairo_region_destroy (window->clip_region_with_children);
1992 window->clip_region_with_children = NULL;
1995 if (window->outstanding_moves)
1997 g_list_foreach (window->outstanding_moves, (GFunc)gdk_window_region_move_free, NULL);
1998 g_list_free (window->outstanding_moves);
1999 window->outstanding_moves = NULL;
2007 * _gdk_window_destroy:
2008 * @window: a #GdkWindow
2009 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
2010 * external agency. The window has already been destroyed and no
2011 * windowing system calls should be made. (This may never happen
2012 * for some windowing systems.)
2014 * Internal function to destroy a window. Like gdk_window_destroy(),
2015 * but does not drop the reference count created by gdk_window_new().
2018 _gdk_window_destroy (GdkWindow *window,
2019 gboolean foreign_destroy)
2021 _gdk_window_destroy_hierarchy (window, FALSE, FALSE, foreign_destroy);
2025 * gdk_window_destroy:
2026 * @window: a #GdkWindow
2028 * Destroys the window system resources associated with @window and decrements @window's
2029 * reference count. The window system resources for all children of @window are also
2030 * destroyed, but the children's reference counts are not decremented.
2032 * Note that a window will not be destroyed automatically when its reference count
2033 * reaches zero. You must call this function yourself before that happens.
2037 gdk_window_destroy (GdkWindow *window)
2039 _gdk_window_destroy_hierarchy (window, FALSE, FALSE, FALSE);
2040 g_object_unref (window);
2044 * gdk_window_set_user_data:
2045 * @window: a #GdkWindow
2046 * @user_data: (allow-none): user data
2048 * For most purposes this function is deprecated in favor of
2049 * g_object_set_data(). However, for historical reasons GTK+ stores
2050 * the #GtkWidget that owns a #GdkWindow as user data on the
2051 * #GdkWindow. So, custom widget implementations should use
2052 * this function for that. If GTK+ receives an event for a #GdkWindow,
2053 * and the user data for the window is non-%NULL, GTK+ will assume the
2054 * user data is a #GtkWidget, and forward the event to that widget.
2058 gdk_window_set_user_data (GdkWindow *window,
2061 g_return_if_fail (GDK_IS_WINDOW (window));
2063 window->user_data = user_data;
2067 * gdk_window_get_user_data:
2068 * @window: a #GdkWindow
2069 * @data: (out): return location for user data
2071 * Retrieves the user data for @window, which is normally the widget
2072 * that @window belongs to. See gdk_window_set_user_data().
2076 gdk_window_get_user_data (GdkWindow *window,
2079 g_return_if_fail (GDK_IS_WINDOW (window));
2081 *data = window->user_data;
2085 * gdk_window_get_window_type:
2086 * @window: a #GdkWindow
2088 * Gets the type of the window. See #GdkWindowType.
2090 * Return value: type of window
2093 gdk_window_get_window_type (GdkWindow *window)
2095 g_return_val_if_fail (GDK_IS_WINDOW (window), (GdkWindowType) -1);
2097 return GDK_WINDOW_TYPE (window);
2101 * gdk_window_get_visual:
2102 * @window: a #GdkWindow
2104 * Gets the #GdkVisual describing the pixel format of @window.
2106 * Return value: (transfer none): a #GdkVisual
2111 gdk_window_get_visual (GdkWindow *window)
2113 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2115 return window->visual;
2119 * gdk_window_get_screen:
2120 * @window: a #GdkWindow
2122 * Gets the #GdkScreen associated with a #GdkWindow.
2124 * Return value: (transfer none): the #GdkScreen associated with @window
2129 gdk_window_get_screen (GdkWindow *window)
2131 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2133 return gdk_visual_get_screen (window->visual);
2137 * gdk_window_get_display:
2138 * @window: a #GdkWindow
2140 * Gets the #GdkDisplay associated with a #GdkWindow.
2142 * Return value: (transfer none): the #GdkDisplay associated with @window
2147 gdk_window_get_display (GdkWindow *window)
2149 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2151 return gdk_screen_get_display (gdk_visual_get_screen (window->visual));
2154 * gdk_window_is_destroyed:
2155 * @window: a #GdkWindow
2157 * Check to see if a window is destroyed..
2159 * Return value: %TRUE if the window is destroyed
2164 gdk_window_is_destroyed (GdkWindow *window)
2166 return GDK_WINDOW_DESTROYED (window);
2170 to_embedder (GdkWindow *window,
2171 gdouble offscreen_x,
2172 gdouble offscreen_y,
2173 gdouble *embedder_x,
2174 gdouble *embedder_y)
2176 g_signal_emit (window, signals[TO_EMBEDDER], 0,
2177 offscreen_x, offscreen_y,
2178 embedder_x, embedder_y);
2182 from_embedder (GdkWindow *window,
2185 gdouble *offscreen_x,
2186 gdouble *offscreen_y)
2188 g_signal_emit (window, signals[FROM_EMBEDDER], 0,
2189 embedder_x, embedder_y,
2190 offscreen_x, offscreen_y);
2194 * gdk_window_has_native:
2195 * @window: a #GdkWindow
2197 * Checks whether the window has a native window or not. Note that
2198 * you can use gdk_window_ensure_native() if a native window is needed.
2200 * Returns: %TRUE if the %window has a native window, %FALSE otherwise.
2205 gdk_window_has_native (GdkWindow *window)
2207 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2209 return window->parent == NULL || window->parent->impl != window->impl;
2213 * gdk_window_get_position:
2214 * @window: a #GdkWindow
2215 * @x: (out) (allow-none): X coordinate of window
2216 * @y: (out) (allow-none): Y coordinate of window
2218 * Obtains the position of the window as reported in the
2219 * most-recently-processed #GdkEventConfigure. Contrast with
2220 * gdk_window_get_geometry() which queries the X server for the
2221 * current window position, regardless of which events have been
2222 * received or processed.
2224 * The position coordinates are relative to the window's parent window.
2228 gdk_window_get_position (GdkWindow *window,
2232 g_return_if_fail (GDK_IS_WINDOW (window));
2241 * gdk_window_get_parent:
2242 * @window: a #GdkWindow
2244 * Obtains the parent of @window, as known to GDK. Does not query the
2245 * X server; thus this returns the parent as passed to gdk_window_new(),
2246 * not the actual parent. This should never matter unless you're using
2247 * Xlib calls mixed with GDK calls on the X11 platform. It may also
2248 * matter for toplevel windows, because the window manager may choose
2251 * Note that you should use gdk_window_get_effective_parent() when
2252 * writing generic code that walks up a window hierarchy, because
2253 * gdk_window_get_parent() will most likely not do what you expect if
2254 * there are offscreen windows in the hierarchy.
2256 * Return value: (transfer none): parent of @window
2259 gdk_window_get_parent (GdkWindow *window)
2261 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2263 return window->parent;
2267 * gdk_window_get_effective_parent:
2268 * @window: a #GdkWindow
2270 * Obtains the parent of @window, as known to GDK. Works like
2271 * gdk_window_get_parent() for normal windows, but returns the
2272 * window's embedder for offscreen windows.
2274 * See also: gdk_offscreen_window_get_embedder()
2276 * Return value: (transfer none): effective parent of @window
2281 gdk_window_get_effective_parent (GdkWindow *window)
2283 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2285 if (gdk_window_is_offscreen (window))
2286 return gdk_offscreen_window_get_embedder (window);
2288 return window->parent;
2292 * gdk_window_get_toplevel:
2293 * @window: a #GdkWindow
2295 * Gets the toplevel window that's an ancestor of @window.
2297 * Any window type but %GDK_WINDOW_CHILD is considered a
2298 * toplevel window, as is a %GDK_WINDOW_CHILD window that
2299 * has a root window as parent.
2301 * Note that you should use gdk_window_get_effective_toplevel() when
2302 * you want to get to a window's toplevel as seen on screen, because
2303 * gdk_window_get_toplevel() will most likely not do what you expect
2304 * if there are offscreen windows in the hierarchy.
2306 * Return value: (transfer none): the toplevel window containing @window
2309 gdk_window_get_toplevel (GdkWindow *window)
2311 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2313 while (window->window_type == GDK_WINDOW_CHILD)
2315 if (gdk_window_is_toplevel (window))
2317 window = window->parent;
2324 * gdk_window_get_effective_toplevel:
2325 * @window: a #GdkWindow
2327 * Gets the toplevel window that's an ancestor of @window.
2329 * Works like gdk_window_get_toplevel(), but treats an offscreen window's
2330 * embedder as its parent, using gdk_window_get_effective_parent().
2332 * See also: gdk_offscreen_window_get_embedder()
2334 * Return value: (transfer none): the effective toplevel window containing @window
2339 gdk_window_get_effective_toplevel (GdkWindow *window)
2343 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2345 while ((parent = gdk_window_get_effective_parent (window)) != NULL &&
2346 (gdk_window_get_window_type (parent) != GDK_WINDOW_ROOT))
2353 * gdk_window_get_children:
2354 * @window: a #GdkWindow
2356 * Gets the list of children of @window known to GDK.
2357 * This function only returns children created via GDK,
2358 * so for example it's useless when used with the root window;
2359 * it only returns windows an application created itself.
2361 * The returned list must be freed, but the elements in the
2364 * Return value: (transfer container) (element-type GdkWindow):
2365 * list of child windows inside @window
2368 gdk_window_get_children (GdkWindow *window)
2370 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2372 if (GDK_WINDOW_DESTROYED (window))
2375 return g_list_copy (window->children);
2379 * gdk_window_peek_children:
2380 * @window: a #GdkWindow
2382 * Like gdk_window_get_children(), but does not copy the list of
2383 * children, so the list does not need to be freed.
2385 * Return value: (transfer none) (element-type GdkWindow):
2386 * a reference to the list of child windows in @window
2389 gdk_window_peek_children (GdkWindow *window)
2391 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2393 if (GDK_WINDOW_DESTROYED (window))
2396 return window->children;
2400 * gdk_window_add_filter: (skip)
2401 * @window: (allow-none): a #GdkWindow
2402 * @function: filter callback
2403 * @data: data to pass to filter callback
2405 * Adds an event filter to @window, allowing you to intercept events
2406 * before they reach GDK. This is a low-level operation and makes it
2407 * easy to break GDK and/or GTK+, so you have to know what you're
2408 * doing. Pass %NULL for @window to get all events for all windows,
2409 * instead of events for a specific window.
2411 * See gdk_display_add_client_message_filter() if you are interested
2412 * in X ClientMessage events.
2415 gdk_window_add_filter (GdkWindow *window,
2416 GdkFilterFunc function,
2420 GdkEventFilter *filter;
2422 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2424 if (window && GDK_WINDOW_DESTROYED (window))
2427 /* Filters are for the native events on the native window, so
2428 ensure there is a native window. */
2430 gdk_window_ensure_native (window);
2433 tmp_list = window->filters;
2435 tmp_list = _gdk_default_filters;
2439 filter = (GdkEventFilter *)tmp_list->data;
2440 if ((filter->function == function) && (filter->data == data))
2442 filter->ref_count++;
2445 tmp_list = tmp_list->next;
2448 filter = g_new (GdkEventFilter, 1);
2449 filter->function = function;
2450 filter->data = data;
2451 filter->ref_count = 1;
2455 window->filters = g_list_append (window->filters, filter);
2457 _gdk_default_filters = g_list_append (_gdk_default_filters, filter);
2461 * gdk_window_remove_filter: (skip)
2462 * @window: a #GdkWindow
2463 * @function: previously-added filter function
2464 * @data: user data for previously-added filter function
2466 * Remove a filter previously added with gdk_window_add_filter().
2469 gdk_window_remove_filter (GdkWindow *window,
2470 GdkFilterFunc function,
2474 GdkEventFilter *filter;
2476 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2479 tmp_list = window->filters;
2481 tmp_list = _gdk_default_filters;
2485 filter = (GdkEventFilter *)tmp_list->data;
2486 tmp_list = tmp_list->next;
2488 if ((filter->function == function) && (filter->data == data))
2490 filter->flags |= GDK_EVENT_FILTER_REMOVED;
2492 _gdk_event_filter_unref (window, filter);
2500 * gdk_screen_get_toplevel_windows:
2501 * @screen: The #GdkScreen where the toplevels are located.
2503 * Obtains a list of all toplevel windows known to GDK on the screen @screen.
2504 * A toplevel window is a child of the root window (see
2505 * gdk_get_default_root_window()).
2507 * The returned list should be freed with g_list_free(), but
2508 * its elements need not be freed.
2510 * Return value: (transfer container) (element-type GdkWindow):
2511 * list of toplevel windows, free with g_list_free()
2516 gdk_screen_get_toplevel_windows (GdkScreen *screen)
2518 GdkWindow * root_window;
2519 GList *new_list = NULL;
2522 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
2524 root_window = gdk_screen_get_root_window (screen);
2526 tmp_list = root_window->children;
2529 GdkWindow *w = tmp_list->data;
2531 if (w->window_type != GDK_WINDOW_FOREIGN)
2532 new_list = g_list_prepend (new_list, w);
2533 tmp_list = tmp_list->next;
2540 * gdk_window_is_visible:
2541 * @window: a #GdkWindow
2543 * Checks whether the window has been mapped (with gdk_window_show() or
2544 * gdk_window_show_unraised()).
2546 * Return value: %TRUE if the window is mapped
2549 gdk_window_is_visible (GdkWindow *window)
2551 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2553 return GDK_WINDOW_IS_MAPPED (window);
2557 * gdk_window_is_viewable:
2558 * @window: a #GdkWindow
2560 * Check if the window and all ancestors of the window are
2561 * mapped. (This is not necessarily "viewable" in the X sense, since
2562 * we only check as far as we have GDK window parents, not to the root
2565 * Return value: %TRUE if the window is viewable
2568 gdk_window_is_viewable (GdkWindow *window)
2570 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2572 if (window->destroyed)
2575 return window->viewable;
2579 * gdk_window_get_state:
2580 * @window: a #GdkWindow
2582 * Gets the bitwise OR of the currently active window state flags,
2583 * from the #GdkWindowState enumeration.
2585 * Return value: window state bitfield
2588 gdk_window_get_state (GdkWindow *window)
2590 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2592 return window->state;
2595 static cairo_content_t
2596 gdk_window_get_content (GdkWindow *window)
2598 cairo_surface_t *surface;
2599 cairo_content_t content;
2601 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
2603 surface = _gdk_window_ref_cairo_surface (window);
2604 content = cairo_surface_get_content (surface);
2605 cairo_surface_destroy (surface);
2610 /* This creates an empty "implicit" paint region for the impl window.
2611 * By itself this does nothing, but real paints to this window
2612 * or children of it can use this surface as backing to avoid allocating
2613 * multiple surfaces for subwindow rendering. When doing so they
2614 * add to the region of the implicit paint region, which will be
2615 * pushed to the window when the implicit paint region is ended.
2616 * Such paints should not copy anything to the window on paint end, but
2617 * should rely on the implicit paint end.
2618 * The implicit paint will be automatically ended if someone draws
2619 * directly to the window or a child window.
2622 gdk_window_begin_implicit_paint (GdkWindow *window, GdkRectangle *rect)
2624 GdkWindowPaint *paint;
2626 g_assert (gdk_window_has_impl (window));
2628 if (GDK_IS_PAINTABLE (window->impl))
2629 return FALSE; /* Implementation does double buffering */
2631 if (window->paint_stack != NULL ||
2632 window->implicit_paint != NULL)
2633 return FALSE; /* Don't stack implicit paints */
2635 /* Never do implicit paints for foreign windows, they don't need
2636 * double buffer combination since they have no client side children,
2637 * and creating surfaces for them is risky since they could disappear
2640 if (window->window_type == GDK_WINDOW_FOREIGN)
2643 paint = g_new (GdkWindowPaint, 1);
2644 paint->region = cairo_region_create (); /* Empty */
2645 paint->uses_implicit = FALSE;
2646 paint->flushed = FALSE;
2647 paint->surface = gdk_window_create_similar_surface (window,
2648 gdk_window_get_content (window),
2649 MAX (rect->width, 1),
2650 MAX (rect->height, 1));
2651 cairo_surface_set_device_offset (paint->surface, -rect->x, -rect->y);
2653 window->implicit_paint = paint;
2658 static cairo_surface_t *
2659 gdk_window_ref_impl_surface (GdkWindow *window)
2661 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->ref_cairo_surface (gdk_window_get_impl_window (window));
2665 gdk_cairo_create_for_impl (GdkWindow *window)
2667 cairo_surface_t *surface;
2670 surface = gdk_window_ref_impl_surface (window);
2671 cr = cairo_create (surface);
2673 cairo_surface_destroy (surface);
2678 /* Ensure that all content related to this (sub)window is pushed to the
2679 native region. If there is an active paint then that area is not
2680 pushed, in order to not show partially finished double buffers. */
2682 gdk_window_flush_implicit_paint (GdkWindow *window)
2684 GdkWindow *impl_window;
2685 GdkWindowPaint *paint;
2686 cairo_region_t *region;
2689 impl_window = gdk_window_get_impl_window (window);
2690 if (impl_window->implicit_paint == NULL)
2693 paint = impl_window->implicit_paint;
2694 paint->flushed = TRUE;
2695 region = cairo_region_copy (window->clip_region_with_children);
2697 /* Don't flush active double buffers, as that may show partially done
2699 for (list = window->paint_stack; list != NULL; list = list->next)
2701 GdkWindowPaint *tmp_paint = list->data;
2703 cairo_region_subtract (region, tmp_paint->region);
2706 cairo_region_translate (region, -window->abs_x, -window->abs_y);
2707 cairo_region_intersect (region, paint->region);
2709 if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (region))
2713 /* Remove flushed region from the implicit paint */
2714 cairo_region_subtract (paint->region, region);
2716 /* Some regions are valid, push these to window now */
2717 cr = gdk_cairo_create_for_impl (window);
2718 gdk_cairo_region (cr, region);
2720 cairo_set_source_surface (cr, paint->surface, 0, 0);
2721 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2726 cairo_region_destroy (region);
2729 /* Ends an implicit paint, paired with gdk_window_begin_implicit_paint returning TRUE */
2731 gdk_window_end_implicit_paint (GdkWindow *window)
2733 GdkWindowPaint *paint;
2735 g_assert (gdk_window_has_impl (window));
2737 g_assert (window->implicit_paint != NULL);
2739 paint = window->implicit_paint;
2741 window->implicit_paint = NULL;
2743 if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (paint->region))
2747 /* Some regions are valid, push these to window now */
2748 cr = gdk_cairo_create_for_impl (window);
2749 gdk_cairo_region (cr, paint->region);
2751 cairo_set_source_surface (cr, paint->surface, 0, 0);
2752 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2757 cairo_region_destroy (paint->region);
2759 cairo_surface_destroy (paint->surface);
2764 * gdk_window_begin_paint_rect:
2765 * @window: a #GdkWindow
2766 * @rectangle: rectangle you intend to draw to
2768 * A convenience wrapper around gdk_window_begin_paint_region() which
2769 * creates a rectangular region for you. See
2770 * gdk_window_begin_paint_region() for details.
2774 gdk_window_begin_paint_rect (GdkWindow *window,
2775 const GdkRectangle *rectangle)
2777 cairo_region_t *region;
2779 g_return_if_fail (GDK_IS_WINDOW (window));
2781 region = cairo_region_create_rectangle (rectangle);
2782 gdk_window_begin_paint_region (window, region);
2783 cairo_region_destroy (region);
2787 * gdk_window_begin_paint_region:
2788 * @window: a #GdkWindow
2789 * @region: region you intend to draw to
2791 * Indicates that you are beginning the process of redrawing @region.
2792 * A backing store (offscreen buffer) large enough to contain @region
2793 * will be created. The backing store will be initialized with the
2794 * background color or background surface for @window. Then, all
2795 * drawing operations performed on @window will be diverted to the
2796 * backing store. When you call gdk_window_end_paint(), the backing
2797 * store will be copied to @window, making it visible onscreen. Only
2798 * the part of @window contained in @region will be modified; that is,
2799 * drawing operations are clipped to @region.
2801 * The net result of all this is to remove flicker, because the user
2802 * sees the finished product appear all at once when you call
2803 * gdk_window_end_paint(). If you draw to @window directly without
2804 * calling gdk_window_begin_paint_region(), the user may see flicker
2805 * as individual drawing operations are performed in sequence. The
2806 * clipping and background-initializing features of
2807 * gdk_window_begin_paint_region() are conveniences for the
2808 * programmer, so you can avoid doing that work yourself.
2810 * When using GTK+, the widget system automatically places calls to
2811 * gdk_window_begin_paint_region() and gdk_window_end_paint() around
2812 * emissions of the expose_event signal. That is, if you're writing an
2813 * expose event handler, you can assume that the exposed area in
2814 * #GdkEventExpose has already been cleared to the window background,
2815 * is already set as the clip region, and already has a backing store.
2816 * Therefore in most cases, application code need not call
2817 * gdk_window_begin_paint_region(). (You can disable the automatic
2818 * calls around expose events on a widget-by-widget basis by calling
2819 * gtk_widget_set_double_buffered().)
2821 * If you call this function multiple times before calling the
2822 * matching gdk_window_end_paint(), the backing stores are pushed onto
2823 * a stack. gdk_window_end_paint() copies the topmost backing store
2824 * onscreen, subtracts the topmost region from all other regions in
2825 * the stack, and pops the stack. All drawing operations affect only
2826 * the topmost backing store in the stack. One matching call to
2827 * gdk_window_end_paint() is required for each call to
2828 * gdk_window_begin_paint_region().
2832 gdk_window_begin_paint_region (GdkWindow *window,
2833 const cairo_region_t *region)
2835 #ifdef USE_BACKING_STORE
2836 GdkRectangle clip_box;
2837 GdkWindowPaint *paint, *implicit_paint;
2838 GdkWindow *impl_window;
2841 g_return_if_fail (GDK_IS_WINDOW (window));
2843 if (GDK_WINDOW_DESTROYED (window))
2846 if (GDK_IS_PAINTABLE (window->impl))
2848 GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
2850 if (iface->begin_paint_region)
2851 iface->begin_paint_region ((GdkPaintable*)window->impl, window, region);
2856 impl_window = gdk_window_get_impl_window (window);
2857 implicit_paint = impl_window->implicit_paint;
2859 paint = g_new (GdkWindowPaint, 1);
2860 paint->region = cairo_region_copy (region);
2861 paint->region_tag = new_region_tag ();
2863 cairo_region_intersect (paint->region, window->clip_region_with_children);
2864 cairo_region_get_extents (paint->region, &clip_box);
2866 cairo_region_translate (paint->region, window->abs_x, window->abs_y);
2868 /* Mark the region as valid on the implicit paint */
2871 cairo_region_union (implicit_paint->region, paint->region);
2873 /* Convert back to normal coords */
2874 cairo_region_translate (paint->region, -window->abs_x, -window->abs_y);
2878 paint->uses_implicit = TRUE;
2879 paint->surface = cairo_surface_create_for_rectangle (implicit_paint->surface,
2880 window->abs_x + clip_box.x,
2881 window->abs_y + clip_box.y,
2882 MAX (clip_box.width, 1),
2883 MAX (clip_box.height, 1));
2887 paint->uses_implicit = FALSE;
2888 paint->surface = gdk_window_create_similar_surface (window,
2889 gdk_window_get_content (window),
2890 MAX (clip_box.width, 1),
2891 MAX (clip_box.height, 1));
2893 cairo_surface_set_device_offset (paint->surface, -clip_box.x, -clip_box.y);
2895 for (list = window->paint_stack; list != NULL; list = list->next)
2897 GdkWindowPaint *tmp_paint = list->data;
2899 cairo_region_subtract (tmp_paint->region, paint->region);
2902 window->paint_stack = g_slist_prepend (window->paint_stack, paint);
2904 if (!cairo_region_is_empty (paint->region))
2906 gdk_window_clear_backing_region (window,
2910 #endif /* USE_BACKING_STORE */
2914 * gdk_window_end_paint:
2915 * @window: a #GdkWindow
2917 * Indicates that the backing store created by the most recent call to
2918 * gdk_window_begin_paint_region() should be copied onscreen and
2919 * deleted, leaving the next-most-recent backing store or no backing
2920 * store at all as the active paint region. See
2921 * gdk_window_begin_paint_region() for full details. It is an error to
2922 * call this function without a matching
2923 * gdk_window_begin_paint_region() first.
2927 gdk_window_end_paint (GdkWindow *window)
2929 #ifdef USE_BACKING_STORE
2930 GdkWindow *composited;
2931 GdkWindowPaint *paint;
2932 GdkRectangle clip_box;
2933 cairo_region_t *full_clip;
2935 g_return_if_fail (GDK_IS_WINDOW (window));
2937 if (GDK_WINDOW_DESTROYED (window))
2940 if (GDK_IS_PAINTABLE (window->impl))
2942 GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
2944 if (iface->end_paint)
2945 iface->end_paint ((GdkPaintable*)window->impl);
2949 if (window->paint_stack == NULL)
2951 g_warning (G_STRLOC": no preceding call to gdk_window_begin_paint_region(), see documentation");
2955 paint = window->paint_stack->data;
2957 window->paint_stack = g_slist_delete_link (window->paint_stack,
2958 window->paint_stack);
2960 cairo_region_get_extents (paint->region, &clip_box);
2962 if (!paint->uses_implicit)
2966 gdk_window_flush_outstanding_moves (window);
2968 full_clip = cairo_region_copy (window->clip_region_with_children);
2969 cairo_region_intersect (full_clip, paint->region);
2971 cr = gdk_cairo_create (window);
2972 cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2973 cairo_set_source_surface (cr, paint->surface, 0, 0);
2974 gdk_cairo_region (cr, full_clip);
2978 cairo_region_destroy (full_clip);
2981 cairo_surface_destroy (paint->surface);
2982 cairo_region_destroy (paint->region);
2985 /* find a composited window in our hierarchy to signal its
2986 * parent to redraw, calculating the clip box as we go...
2988 * stop if parent becomes NULL since then we'd have nowhere
2989 * to draw (ie: 'composited' will always be non-NULL here).
2991 for (composited = window;
2993 composited = composited->parent)
2995 clip_box.x += composited->x;
2996 clip_box.y += composited->y;
2997 clip_box.width = MIN (clip_box.width, composited->parent->width - clip_box.x);
2998 clip_box.height = MIN (clip_box.height, composited->parent->height - clip_box.y);
3000 if (composited->composited)
3002 gdk_window_invalidate_rect (GDK_WINDOW (composited->parent),
3007 #endif /* USE_BACKING_STORE */
3011 gdk_window_free_paint_stack (GdkWindow *window)
3013 if (window->paint_stack)
3015 GSList *tmp_list = window->paint_stack;
3019 GdkWindowPaint *paint = tmp_list->data;
3021 if (tmp_list == window->paint_stack)
3022 cairo_surface_destroy (paint->surface);
3024 cairo_region_destroy (paint->region);
3027 tmp_list = tmp_list->next;
3030 g_slist_free (window->paint_stack);
3031 window->paint_stack = NULL;
3036 do_move_region_bits_on_impl (GdkWindow *impl_window,
3037 cairo_region_t *dest_region, /* In impl window coords */
3040 GdkWindowImplClass *impl_class;
3042 impl_class = GDK_WINDOW_IMPL_GET_CLASS (impl_window->impl);
3044 impl_class->translate (impl_window, dest_region, dx, dy);
3047 static GdkWindowRegionMove *
3048 gdk_window_region_move_new (cairo_region_t *region,
3051 GdkWindowRegionMove *move;
3053 move = g_slice_new (GdkWindowRegionMove);
3054 move->dest_region = cairo_region_copy (region);
3062 gdk_window_region_move_free (GdkWindowRegionMove *move)
3064 cairo_region_destroy (move->dest_region);
3065 g_slice_free (GdkWindowRegionMove, move);
3069 append_move_region (GdkWindow *impl_window,
3070 cairo_region_t *new_dest_region,
3073 GdkWindowRegionMove *move, *old_move;
3074 cairo_region_t *new_total_region, *old_total_region;
3075 cairo_region_t *source_overlaps_destination;
3076 cairo_region_t *non_overwritten;
3077 gboolean added_move;
3080 if (cairo_region_is_empty (new_dest_region))
3083 /* In principle this could just append the move to the list of outstanding
3084 moves that will be replayed before drawing anything when we're handling
3085 exposes. However, we'd like to do a bit better since its commonly the case
3086 that we get multiple copies where A is copied to B and then B is copied
3087 to C, and we'd like to express this as a simple copy A to C operation. */
3089 /* We approach this by taking the new move and pushing it ahead of moves
3090 starting at the end of the list and stopping when its not safe to do so.
3091 It's not safe to push past a move if either the source of the new move
3092 is in the destination of the old move, or if the destination of the new
3093 move is in the source of the new move, or if the destination of the new
3094 move overlaps the destination of the old move. We simplify this by
3095 just comparing the total regions (src + dest) */
3096 new_total_region = cairo_region_copy (new_dest_region);
3097 cairo_region_translate (new_total_region, -dx, -dy);
3098 cairo_region_union (new_total_region, new_dest_region);
3101 for (l = g_list_last (impl_window->outstanding_moves); l != NULL; l = prev)
3106 old_total_region = cairo_region_copy (old_move->dest_region);
3107 cairo_region_translate (old_total_region, -old_move->dx, -old_move->dy);
3108 cairo_region_union (old_total_region, old_move->dest_region);
3110 cairo_region_intersect (old_total_region, new_total_region);
3111 /* If these regions intersect then its not safe to push the
3112 new region before the old one */
3113 if (!cairo_region_is_empty (old_total_region))
3115 /* The area where the new moves source overlaps the old ones
3117 source_overlaps_destination = cairo_region_copy (new_dest_region);
3118 cairo_region_translate (source_overlaps_destination, -dx, -dy);
3119 cairo_region_intersect (source_overlaps_destination, old_move->dest_region);
3120 cairo_region_translate (source_overlaps_destination, dx, dy);
3122 /* We can do all sort of optimizations here, but to do things safely it becomes
3123 quite complicated. However, a very common case is that you copy something first,
3124 then copy all that or a subset of it to a new location (i.e. if you scroll twice
3125 in the same direction). We'd like to detect this case and optimize it to one
3127 if (cairo_region_equal (source_overlaps_destination, new_dest_region))
3129 /* This means we might be able to replace the old move and the new one
3130 with the new one read from the old ones source, and a second copy of
3131 the non-overwritten parts of the old move. However, such a split
3132 is only valid if the source in the old move isn't overwritten
3133 by the destination of the new one */
3135 /* the new destination of old move if split is ok: */
3136 non_overwritten = cairo_region_copy (old_move->dest_region);
3137 cairo_region_subtract (non_overwritten, new_dest_region);
3138 /* move to source region */
3139 cairo_region_translate (non_overwritten, -old_move->dx, -old_move->dy);
3141 cairo_region_intersect (non_overwritten, new_dest_region);
3142 if (cairo_region_is_empty (non_overwritten))
3145 move = gdk_window_region_move_new (new_dest_region,
3149 impl_window->outstanding_moves =
3150 g_list_insert_before (impl_window->outstanding_moves,
3152 cairo_region_subtract (old_move->dest_region, new_dest_region);
3154 cairo_region_destroy (non_overwritten);
3157 cairo_region_destroy (source_overlaps_destination);
3158 cairo_region_destroy (old_total_region);
3161 cairo_region_destroy (old_total_region);
3164 cairo_region_destroy (new_total_region);
3168 move = gdk_window_region_move_new (new_dest_region, dx, dy);
3171 impl_window->outstanding_moves =
3172 g_list_prepend (impl_window->outstanding_moves,
3175 impl_window->outstanding_moves =
3176 g_list_insert_before (impl_window->outstanding_moves,
3181 /* Moves bits and update area by dx/dy in impl window.
3182 Takes ownership of region to avoid copy (because we may change it) */
3184 move_region_on_impl (GdkWindow *impl_window,
3185 cairo_region_t *region, /* In impl window coords */
3188 if ((dx == 0 && dy == 0) ||
3189 cairo_region_is_empty (region))
3191 cairo_region_destroy (region);
3195 g_assert (impl_window == gdk_window_get_impl_window (impl_window));
3197 /* Move any old invalid regions in the copy source area by dx/dy */
3198 if (impl_window->update_area)
3200 cairo_region_t *update_area;
3202 update_area = cairo_region_copy (region);
3204 /* Convert from target to source */
3205 cairo_region_translate (update_area, -dx, -dy);
3206 cairo_region_intersect (update_area, impl_window->update_area);
3207 /* We only copy the area, so keep the old update area invalid.
3208 It would be safe to remove it too, as code that uses
3209 move_region_on_impl generally also invalidate the source
3210 area. However, it would just use waste cycles. */
3213 cairo_region_translate (update_area, dx, dy);
3214 cairo_region_union (impl_window->update_area, update_area);
3216 /* This area of the destination is now invalid,
3217 so no need to copy to it. */
3218 cairo_region_subtract (region, update_area);
3220 cairo_region_destroy (update_area);
3223 /* If we're currently exposing this window, don't copy to this
3224 destination, as it will be overdrawn when the expose is done,
3225 instead invalidate it and repaint later. */
3226 if (impl_window->implicit_paint)
3228 GdkWindowPaint *implicit_paint = impl_window->implicit_paint;
3229 cairo_region_t *exposing;
3231 exposing = cairo_region_copy (implicit_paint->region);
3232 cairo_region_intersect (exposing, region);
3233 cairo_region_subtract (region, exposing);
3235 impl_window_add_update_area (impl_window, exposing);
3236 cairo_region_destroy (exposing);
3239 append_move_region (impl_window, region, dx, dy);
3241 cairo_region_destroy (region);
3244 /* Flushes all outstanding changes to the window, call this
3245 * before drawing directly to the window (i.e. outside a begin/end_paint pair).
3248 gdk_window_flush_outstanding_moves (GdkWindow *window)
3250 GdkWindow *impl_window;
3251 GList *l, *outstanding;
3252 GdkWindowRegionMove *move;
3254 impl_window = gdk_window_get_impl_window (window);
3255 outstanding = impl_window->outstanding_moves;
3256 impl_window->outstanding_moves = NULL;
3258 for (l = outstanding; l != NULL; l = l->next)
3262 do_move_region_bits_on_impl (impl_window,
3263 move->dest_region, move->dx, move->dy);
3265 gdk_window_region_move_free (move);
3268 g_list_free (outstanding);
3273 * @window: a #GdkWindow
3275 * Flush all outstanding cached operations on a window, leaving the
3276 * window in a state which reflects all that has been drawn before.
3278 * Gdk uses multiple kinds of caching to get better performance and
3279 * nicer drawing. For instance, during exposes all paints to a window
3280 * using double buffered rendering are keep on a surface until the last
3281 * window has been exposed. It also delays window moves/scrolls until
3282 * as long as possible until next update to avoid tearing when moving
3285 * Normally this should be completely invisible to applications, as
3286 * we automatically flush the windows when required, but this might
3287 * be needed if you for instance mix direct native drawing with
3288 * gdk drawing. For Gtk widgets that don't use double buffering this
3289 * will be called automatically before sending the expose event.
3294 gdk_window_flush (GdkWindow *window)
3296 gdk_window_flush_outstanding_moves (window);
3297 gdk_window_flush_implicit_paint (window);
3300 /* If we're about to move/resize or otherwise change the
3301 * hierarchy of a client side window in an impl and we're
3302 * called from an expose event handler then we need to
3303 * flush any already painted parts of the implicit paint
3304 * that are not part of the current paint, as these may
3305 * be used when scrolling or may overdraw the changes
3306 * caused by the hierarchy change.
3309 gdk_window_flush_if_exposing (GdkWindow *window)
3311 GdkWindow *impl_window;
3313 impl_window = gdk_window_get_impl_window (window);
3315 /* If we're in an implicit paint (i.e. in an expose handler, flush
3316 all the already finished exposes to get things to an uptodate state. */
3317 if (impl_window->implicit_paint)
3318 gdk_window_flush (window);
3323 gdk_window_flush_recursive_helper (GdkWindow *window,
3324 GdkWindowImpl *impl)
3329 for (l = window->children; l != NULL; l = l->next)
3333 if (child->impl == impl)
3334 /* Same impl, ignore */
3335 gdk_window_flush_recursive_helper (child, impl);
3337 gdk_window_flush_recursive (child);
3342 gdk_window_flush_recursive (GdkWindow *window)
3344 gdk_window_flush (window);
3345 gdk_window_flush_recursive_helper (window, window->impl);
3349 * gdk_window_get_clip_region:
3350 * @window: a #GdkWindow
3352 * Computes the region of a window that potentially can be written
3353 * to by drawing primitives. This region may not take into account
3354 * other factors such as if the window is obscured by other windows,
3355 * but no area outside of this region will be affected by drawing
3358 * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3359 * when you are done.
3362 gdk_window_get_clip_region (GdkWindow *window)
3364 cairo_region_t *result;
3366 g_return_val_if_fail (GDK_WINDOW (window), NULL);
3368 result = cairo_region_copy (window->clip_region);
3370 if (window->paint_stack)
3372 cairo_region_t *paint_region = cairo_region_create ();
3373 GSList *tmp_list = window->paint_stack;
3377 GdkWindowPaint *paint = tmp_list->data;
3379 cairo_region_union (paint_region, paint->region);
3381 tmp_list = tmp_list->next;
3384 cairo_region_intersect (result, paint_region);
3385 cairo_region_destroy (paint_region);
3392 * gdk_window_get_visible_region:
3393 * @window: a #GdkWindow
3395 * Computes the region of the @window that is potentially visible.
3396 * This does not necessarily take into account if the window is
3397 * obscured by other windows, but no area outside of this region
3400 * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3401 * when you are done.
3404 gdk_window_get_visible_region (GdkWindow *window)
3406 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3408 return cairo_region_copy (window->clip_region);
3412 setup_backing_rect (GdkWindow *window, GdkWindowPaint *paint, int x_offset_cairo, int y_offset_cairo)
3414 GdkWindow *bg_window;
3415 cairo_pattern_t *pattern = NULL;
3416 int x_offset = 0, y_offset = 0;
3419 cr = cairo_create (paint->surface);
3421 for (bg_window = window; bg_window; bg_window = bg_window->parent)
3423 pattern = gdk_window_get_background_pattern (bg_window);
3427 x_offset += bg_window->x;
3428 y_offset += bg_window->y;
3433 cairo_translate (cr, -x_offset, -y_offset);
3434 cairo_set_source (cr, pattern);
3435 cairo_translate (cr, x_offset, y_offset);
3438 cairo_set_source_rgb (cr, 0, 0, 0);
3444 gdk_window_clear_backing_region (GdkWindow *window,
3445 cairo_region_t *region)
3447 GdkWindowPaint *paint = window->paint_stack->data;
3448 cairo_region_t *clip;
3449 GdkRectangle clipbox;
3452 if (GDK_WINDOW_DESTROYED (window))
3455 cr = setup_backing_rect (window, paint, 0, 0);
3457 clip = cairo_region_copy (paint->region);
3458 cairo_region_intersect (clip, region);
3459 cairo_region_get_extents (clip, &clipbox);
3461 gdk_cairo_region (cr, clip);
3466 cairo_region_destroy (clip);
3470 gdk_window_clear_backing_region_direct (GdkWindow *window,
3471 cairo_region_t *region)
3473 GdkWindowPaint paint;
3474 cairo_region_t *clip;
3475 GdkRectangle clipbox;
3478 if (GDK_WINDOW_DESTROYED (window))
3481 paint.surface = _gdk_window_ref_cairo_surface (window);
3483 cr = setup_backing_rect (window, &paint, 0, 0);
3485 clip = cairo_region_copy (window->clip_region_with_children);
3486 cairo_region_intersect (clip, region);
3487 cairo_region_get_extents (clip, &clipbox);
3489 gdk_cairo_region (cr, clip);
3494 cairo_region_destroy (clip);
3495 cairo_surface_destroy (paint.surface);
3500 gdk_window_clear_region_internal (GdkWindow *window,
3501 cairo_region_t *region)
3503 if (window->paint_stack)
3504 gdk_window_clear_backing_region (window, region);
3506 gdk_window_clear_backing_region_direct (window, region);
3510 gdk_window_drop_cairo_surface (GdkWindow *window)
3512 if (window->cairo_surface)
3514 cairo_surface_finish (window->cairo_surface);
3515 cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3517 window->cairo_surface = NULL;
3522 gdk_window_cairo_surface_destroy (void *data)
3524 GdkWindow *window = data;
3526 window->cairo_surface = NULL;
3529 static cairo_surface_t *
3530 gdk_window_create_cairo_surface (GdkWindow *window,
3534 cairo_surface_t *surface, *subsurface;
3536 surface = gdk_window_ref_impl_surface (window);
3537 if (gdk_window_has_impl (window))
3540 subsurface = cairo_surface_create_for_rectangle (surface,
3545 cairo_surface_destroy (surface);
3551 _gdk_window_ref_cairo_surface (GdkWindow *window)
3553 cairo_surface_t *surface;
3555 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3557 if (window->paint_stack)
3559 GdkWindowPaint *paint = window->paint_stack->data;
3561 surface = paint->surface;
3562 cairo_surface_reference (surface);
3567 /* This will be drawing directly to the window, so flush implicit paint */
3568 gdk_window_flush (window);
3570 if (!window->cairo_surface)
3572 window->cairo_surface = gdk_window_create_cairo_surface (window,
3576 if (window->cairo_surface)
3578 cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3579 window, gdk_window_cairo_surface_destroy);
3583 cairo_surface_reference (window->cairo_surface);
3585 surface = window->cairo_surface;
3593 * @window: a #GdkWindow
3595 * Creates a Cairo context for drawing to @window.
3598 * Note that calling cairo_reset_clip() on the resulting #cairo_t will
3599 * produce undefined results, so avoid it at all costs.
3602 * Return value: A newly created Cairo context. Free with
3603 * cairo_destroy() when you are done drawing.
3608 gdk_cairo_create (GdkWindow *window)
3610 cairo_surface_t *surface;
3613 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3615 surface = _gdk_window_ref_cairo_surface (window);
3616 cr = cairo_create (surface);
3618 if (!window->paint_stack)
3620 gdk_cairo_region (cr, window->clip_region_with_children);
3625 GdkWindowPaint *paint = window->paint_stack->data;
3627 /* Only needs to clip to region if piggybacking
3628 on an implicit paint */
3629 if (paint->uses_implicit)
3631 gdk_cairo_region (cr, paint->region);
3636 cairo_surface_destroy (surface);
3641 /* Code for dirty-region queueing
3643 static GSList *update_windows = NULL;
3644 static guint update_idle = 0;
3645 static gboolean debug_updates = FALSE;
3647 static inline gboolean
3648 gdk_window_is_ancestor (GdkWindow *window,
3649 GdkWindow *ancestor)
3653 GdkWindow *parent = window->parent;
3655 if (parent == ancestor)
3665 gdk_window_add_update_window (GdkWindow *window)
3668 GSList *prev = NULL;
3669 gboolean has_ancestor_in_list = FALSE;
3671 for (tmp = update_windows; tmp; tmp = tmp->next)
3673 GdkWindow *parent = window->parent;
3675 /* check if tmp is an ancestor of "window"; if it is, set a
3676 * flag indicating that all following windows are either
3677 * children of "window" or from a differen hierarchy
3679 if (!has_ancestor_in_list && gdk_window_is_ancestor (window, tmp->data))
3680 has_ancestor_in_list = TRUE;
3682 /* insert in reverse stacking order when adding around siblings,
3683 * so processing updates properly paints over lower stacked windows
3685 if (parent == GDK_WINDOW (tmp->data)->parent)
3687 gint index = g_list_index (parent->children, window);
3688 for (; tmp && parent == GDK_WINDOW (tmp->data)->parent; tmp = tmp->next)
3690 gint sibling_index = g_list_index (parent->children, tmp->data);
3691 if (index > sibling_index)
3695 /* here, tmp got advanced past all lower stacked siblings */
3696 tmp = g_slist_prepend (tmp, window);
3700 update_windows = tmp;
3704 /* if "window" has an ancestor in the list and tmp is one of
3705 * "window's" children, insert "window" before tmp
3707 if (has_ancestor_in_list && gdk_window_is_ancestor (tmp->data, window))
3709 tmp = g_slist_prepend (tmp, window);
3714 update_windows = tmp;
3718 /* if we're at the end of the list and had an ancestor it it,
3719 * append to the list
3721 if (! tmp->next && has_ancestor_in_list)
3723 tmp = g_slist_append (tmp, window);
3730 /* if all above checks failed ("window" is from a different
3731 * hierarchy than what is already in the list) or the list is
3734 update_windows = g_slist_prepend (update_windows, window);
3738 gdk_window_remove_update_window (GdkWindow *window)
3740 update_windows = g_slist_remove (update_windows, window);
3744 gdk_window_update_idle (gpointer data)
3746 gdk_window_process_all_updates ();
3752 gdk_window_is_toplevel_frozen (GdkWindow *window)
3754 GdkWindow *toplevel;
3756 toplevel = gdk_window_get_toplevel (window);
3758 return toplevel->update_and_descendants_freeze_count > 0;
3762 gdk_window_schedule_update (GdkWindow *window)
3765 (window->update_freeze_count ||
3766 gdk_window_is_toplevel_frozen (window)))
3771 gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
3772 gdk_window_update_idle,
3777 _gdk_window_process_updates_recurse (GdkWindow *window,
3778 cairo_region_t *expose_region)
3781 cairo_region_t *child_region;
3783 GList *l, *children;
3785 if (cairo_region_is_empty (expose_region))
3788 if (gdk_window_is_offscreen (window->impl_window) &&
3789 window == window->impl_window)
3790 _gdk_window_add_damage ((GdkWindow *) window->impl_window, expose_region);
3792 /* Make this reentrancy safe for expose handlers freeing windows */
3793 children = g_list_copy (window->children);
3794 g_list_foreach (children, (GFunc)g_object_ref, NULL);
3796 /* Iterate over children, starting at topmost */
3797 for (l = children; l != NULL; l = l->next)
3801 if (child->destroyed || !GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
3804 /* Ignore offscreen children, as they don't draw in their parent and
3805 * don't take part in the clipping */
3806 if (gdk_window_is_offscreen (child))
3811 r.width = child->width;
3812 r.height = child->height;
3814 child_region = cairo_region_create_rectangle (&r);
3817 /* Adjust shape region to parent window coords */
3818 cairo_region_translate (child->shape, child->x, child->y);
3819 cairo_region_intersect (child_region, child->shape);
3820 cairo_region_translate (child->shape, -child->x, -child->y);
3823 if (child->impl == window->impl)
3825 /* Client side child, expose */
3826 cairo_region_intersect (child_region, expose_region);
3827 cairo_region_subtract (expose_region, child_region);
3828 cairo_region_translate (child_region, -child->x, -child->y);
3829 _gdk_window_process_updates_recurse ((GdkWindow *)child, child_region);
3833 /* Native child, just remove area from expose region */
3834 cairo_region_subtract (expose_region, child_region);
3836 cairo_region_destroy (child_region);
3839 g_list_foreach (children, (GFunc)g_object_unref, NULL);
3840 g_list_free (children);
3842 if (!cairo_region_is_empty (expose_region) &&
3845 if (window->event_mask & GDK_EXPOSURE_MASK)
3849 event.expose.type = GDK_EXPOSE;
3850 event.expose.window = g_object_ref (window);
3851 event.expose.send_event = FALSE;
3852 event.expose.count = 0;
3853 event.expose.region = expose_region;
3854 cairo_region_get_extents (expose_region, &event.expose.area);
3856 _gdk_event_emit (&event);
3858 g_object_unref (window);
3860 else if (window->window_type != GDK_WINDOW_FOREIGN)
3862 /* No exposure mask set, so nothing will be drawn, the
3863 * app relies on the background being what it specified
3864 * for the window. So, we need to clear this manually.
3866 * For foreign windows if expose is not set that generally
3867 * means some other client paints them, so don't clear
3870 * We use begin/end_paint around the clear so that we can
3871 * piggyback on the implicit paint */
3873 gdk_window_begin_paint_region (window, expose_region);
3874 gdk_window_clear_region_internal (window, expose_region);
3875 gdk_window_end_paint (window);
3880 /* Process and remove any invalid area on the native window by creating
3881 * expose events for the window and all non-native descendants.
3882 * Also processes any outstanding moves on the window before doing
3883 * any drawing. Note that its possible to have outstanding moves without
3884 * any invalid area as we use the update idle mechanism to coalesce
3885 * multiple moves as well as multiple invalidations.
3888 gdk_window_process_updates_internal (GdkWindow *window)
3890 GdkWindowImplClass *impl_class;
3891 gboolean save_region = FALSE;
3892 GdkRectangle clip_box;
3894 /* Ensure the window lives while updating it */
3895 g_object_ref (window);
3897 /* If an update got queued during update processing, we can get a
3898 * window in the update queue that has an empty update_area.
3901 if (window->update_area)
3903 cairo_region_t *update_area = window->update_area;
3904 window->update_area = NULL;
3906 if (gdk_window_is_viewable (window))
3908 cairo_region_t *expose_region;
3909 gboolean end_implicit;
3911 /* Clip to part visible in toplevel */
3912 cairo_region_intersect (update_area, window->clip_region);
3916 /* Make sure we see the red invalid area before redrawing. */
3917 gdk_display_sync (gdk_window_get_display (window));
3921 /* At this point we will be completely redrawing all of update_area.
3922 * If we have any outstanding moves that end up moving stuff inside
3923 * this area we don't actually need to move that as that part would
3924 * be overdrawn by the expose anyway. So, in order to copy less data
3925 * we remove these areas from the outstanding moves.
3927 if (window->outstanding_moves)
3929 GdkWindowRegionMove *move;
3930 cairo_region_t *remove;
3933 remove = cairo_region_copy (update_area);
3934 /* We iterate backwards, starting from the state that would be
3935 if we had applied all the moves. */
3936 for (l = g_list_last (window->outstanding_moves); l != NULL; l = prev)
3941 /* Don't need this area */
3942 cairo_region_subtract (move->dest_region, remove);
3944 /* However if any of the destination we do need has a source
3945 in the updated region we do need that as a destination for
3946 the earlier moves */
3947 cairo_region_translate (move->dest_region, -move->dx, -move->dy);
3948 cairo_region_subtract (remove, move->dest_region);
3950 if (cairo_region_is_empty (move->dest_region))
3952 gdk_window_region_move_free (move);
3953 window->outstanding_moves =
3954 g_list_delete_link (window->outstanding_moves, l);
3956 else /* move back */
3957 cairo_region_translate (move->dest_region, move->dx, move->dy);
3959 cairo_region_destroy (remove);
3962 /* By now we a set of window moves that should be applied, and then
3963 * an update region that should be repainted. A trivial implementation
3964 * would just do that in order, however in order to get nicer drawing
3965 * we do some tricks:
3967 * First of all, each subwindow expose may be double buffered by
3968 * itself (depending on widget setting) via
3969 * gdk_window_begin/end_paint(). But we also do an "implicit" paint,
3970 * creating a single surface the size of the invalid area on the
3971 * native window which all the individual normal paints will draw
3972 * into. This way in the normal case there will be only one surface
3973 * allocated and only once surface draw done for all the windows
3974 * in this native window.
3975 * There are a couple of reasons this may fail, for instance, some
3976 * backends (like quartz) do its own double buffering, so we disable
3977 * gdk double buffering there. Secondly, some subwindow could be
3978 * non-double buffered and draw directly to the window outside a
3979 * begin/end_paint pair. That will be lead to a gdk_window_flush
3980 * which immediately executes all outstanding moves and paints+removes
3981 * the implicit paint (further paints will allocate their own surfaces).
3983 * Secondly, in the case of implicit double buffering we expose all
3984 * the child windows into the implicit surface before we execute
3985 * the outstanding moves. This way we minimize the time between
3986 * doing the moves and rendering the new update area, thus minimizing
3987 * flashing. Of course, if any subwindow is non-double buffered we
3988 * well flush earlier than that.
3990 * Thirdly, after having done the outstanding moves we queue an
3991 * "antiexpose" on the area that will be drawn by the expose, which
3992 * means that any invalid region on the native window side before
3993 * the first expose drawing operation will be discarded, as it
3994 * has by then been overdrawn with valid data. This means we can
3995 * avoid doing the unnecessary repaint any outstanding expose events.
3998 cairo_region_get_extents (update_area, &clip_box);
3999 end_implicit = gdk_window_begin_implicit_paint (window, &clip_box);
4000 expose_region = cairo_region_copy (update_area);
4001 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
4004 /* Rendering is not double buffered by gdk, do outstanding
4005 * moves and queue antiexposure immediately. No need to do
4007 gdk_window_flush_outstanding_moves (window);
4008 save_region = impl_class->queue_antiexpose (window, update_area);
4010 /* Render the invalid areas to the implicit paint, by sending exposes.
4011 * May flush if non-double buffered widget draw. */
4012 impl_class->process_updates_recurse (window, expose_region);
4016 /* Do moves right before exposes are rendered to the window */
4017 gdk_window_flush_outstanding_moves (window);
4019 /* By this time we know that any outstanding expose for this
4020 * area is invalid and we can avoid it, so queue an antiexpose.
4021 * we have already started drawing to the window, so it would
4022 * be to late to anti-expose now. Since this is merely an
4023 * optimization we just avoid doing it at all in that case.
4025 if (window->implicit_paint != NULL && !window->implicit_paint->flushed)
4026 save_region = impl_class->queue_antiexpose (window, update_area);
4028 gdk_window_end_implicit_paint (window);
4030 cairo_region_destroy (expose_region);
4033 cairo_region_destroy (update_area);
4036 if (window->outstanding_moves)
4038 /* Flush any outstanding moves, may happen if we moved a window but got
4039 no actual invalid area */
4040 gdk_window_flush_outstanding_moves (window);
4043 g_object_unref (window);
4047 flush_all_displays (void)
4049 GSList *displays, *l;
4051 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4052 for (l = displays; l; l = l->next)
4053 gdk_display_flush (l->data);
4055 g_slist_free (displays);
4059 before_process_all_updates (void)
4061 GSList *displays, *l;
4062 GdkDisplayClass *display_class;
4064 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4065 display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4066 for (l = displays; l; l = l->next)
4067 display_class->before_process_all_updates (l->data);
4069 g_slist_free (displays);
4073 after_process_all_updates (void)
4075 GSList *displays, *l;
4076 GdkDisplayClass *display_class;
4078 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4079 display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4080 for (l = displays; l; l = l->next)
4081 display_class->after_process_all_updates (l->data);
4083 g_slist_free (displays);
4086 /* Currently it is not possible to override
4087 * gdk_window_process_all_updates in the same manner as
4088 * gdk_window_process_updates and gdk_window_invalidate_maybe_recurse
4089 * by implementing the GdkPaintable interface. If in the future a
4090 * backend would need this, the right solution would be to add a
4091 * method to GdkDisplay that can be optionally
4092 * NULL. gdk_window_process_all_updates can then walk the list of open
4093 * displays and call the mehod.
4097 * gdk_window_process_all_updates:
4099 * Calls gdk_window_process_updates() for all windows (see #GdkWindow)
4100 * in the application.
4104 gdk_window_process_all_updates (void)
4106 GSList *old_update_windows = update_windows;
4107 GSList *tmp_list = update_windows;
4108 static gboolean in_process_all_updates = FALSE;
4109 static gboolean got_recursive_update = FALSE;
4111 if (in_process_all_updates)
4113 /* We can't do this now since that would recurse, so
4114 delay it until after the recursion is done. */
4115 got_recursive_update = TRUE;
4120 in_process_all_updates = TRUE;
4121 got_recursive_update = FALSE;
4124 g_source_remove (update_idle);
4126 update_windows = NULL;
4129 before_process_all_updates ();
4131 g_slist_foreach (old_update_windows, (GFunc)g_object_ref, NULL);
4135 GdkWindow *window = tmp_list->data;
4137 if (!GDK_WINDOW_DESTROYED (window))
4139 if (window->update_freeze_count ||
4140 gdk_window_is_toplevel_frozen (window))
4141 gdk_window_add_update_window (window);
4143 gdk_window_process_updates_internal (window);
4146 g_object_unref (window);
4147 tmp_list = tmp_list->next;
4150 g_slist_free (old_update_windows);
4152 flush_all_displays ();
4154 after_process_all_updates ();
4156 in_process_all_updates = FALSE;
4158 /* If we ignored a recursive call, schedule a
4159 redraw now so that it eventually happens,
4160 otherwise we could miss an update if nothing
4161 else schedules an update. */
4162 if (got_recursive_update && !update_idle)
4164 gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
4165 gdk_window_update_idle,
4170 * gdk_window_process_updates:
4171 * @window: a #GdkWindow
4172 * @update_children: whether to also process updates for child windows
4174 * Sends one or more expose events to @window. The areas in each
4175 * expose event will cover the entire update area for the window (see
4176 * gdk_window_invalidate_region() for details). Normally GDK calls
4177 * gdk_window_process_all_updates() on your behalf, so there's no
4178 * need to call this function unless you want to force expose events
4179 * to be delivered immediately and synchronously (vs. the usual
4180 * case, where GDK delivers them in an idle handler). Occasionally
4181 * this is useful to produce nicer scrolling behavior, for example.
4185 gdk_window_process_updates (GdkWindow *window,
4186 gboolean update_children)
4188 GdkWindow *impl_window;
4190 g_return_if_fail (GDK_IS_WINDOW (window));
4192 if (GDK_WINDOW_DESTROYED (window))
4195 /* Make sure the window lives during the expose callouts */
4196 g_object_ref (window);
4198 impl_window = gdk_window_get_impl_window (window);
4199 if ((impl_window->update_area ||
4200 impl_window->outstanding_moves) &&
4201 !impl_window->update_freeze_count &&
4202 !gdk_window_is_toplevel_frozen (window) &&
4204 /* Don't recurse into process_updates_internal, we'll
4205 * do the update later when idle instead. */
4206 impl_window->implicit_paint == NULL)
4208 gdk_window_process_updates_internal ((GdkWindow *)impl_window);
4209 gdk_window_remove_update_window ((GdkWindow *)impl_window);
4212 if (update_children)
4214 /* process updates in reverse stacking order so composition or
4215 * painting over achieves the desired effect for offscreen windows
4217 GList *node, *children;
4219 children = g_list_copy (window->children);
4220 g_list_foreach (children, (GFunc)g_object_ref, NULL);
4222 for (node = g_list_last (children); node; node = node->prev)
4224 gdk_window_process_updates (node->data, TRUE);
4225 g_object_unref (node->data);
4228 g_list_free (children);
4231 g_object_unref (window);
4235 gdk_window_invalidate_rect_full (GdkWindow *window,
4236 const GdkRectangle *rect,
4237 gboolean invalidate_children,
4240 GdkRectangle window_rect;
4241 cairo_region_t *region;
4243 g_return_if_fail (GDK_IS_WINDOW (window));
4245 if (GDK_WINDOW_DESTROYED (window))
4248 if (window->input_only || !window->viewable)
4255 window_rect.width = window->width;
4256 window_rect.height = window->height;
4257 rect = &window_rect;
4260 region = cairo_region_create_rectangle (rect);
4261 gdk_window_invalidate_region_full (window, region, invalidate_children, clear_bg);
4262 cairo_region_destroy (region);
4266 * gdk_window_invalidate_rect:
4267 * @window: a #GdkWindow
4268 * @rect: (allow-none): rectangle to invalidate or %NULL to invalidate the whole
4270 * @invalidate_children: whether to also invalidate child windows
4272 * A convenience wrapper around gdk_window_invalidate_region() which
4273 * invalidates a rectangular region. See
4274 * gdk_window_invalidate_region() for details.
4277 gdk_window_invalidate_rect (GdkWindow *window,
4278 const GdkRectangle *rect,
4279 gboolean invalidate_children)
4281 gdk_window_invalidate_rect_full (window, rect, invalidate_children, CLEAR_BG_NONE);
4285 draw_ugly_color (GdkWindow *window,
4286 const cairo_region_t *region)
4290 cr = gdk_cairo_create (window);
4291 /* Draw ugly color all over the newly-invalid region */
4292 cairo_set_source_rgb (cr, 50000/65535., 10000/65535., 10000/65535.);
4293 gdk_cairo_region (cr, region);
4300 impl_window_add_update_area (GdkWindow *impl_window,
4301 cairo_region_t *region)
4303 if (impl_window->update_area)
4304 cairo_region_union (impl_window->update_area, region);
4307 gdk_window_add_update_window (impl_window);
4308 impl_window->update_area = cairo_region_copy (region);
4309 gdk_window_schedule_update (impl_window);
4313 /* clear_bg controls if the region will be cleared to
4314 * the background pattern if the exposure mask is not
4315 * set for the window, whereas this might not otherwise be
4316 * done (unless necessary to emulate background settings).
4317 * Set this to CLEAR_BG_WINCLEARED or CLEAR_BG_ALL if you
4318 * need to clear the background, such as when exposing the area beneath a
4319 * hidden or moved window, but not when an app requests repaint or when the
4320 * windowing system exposes a newly visible area (because then the windowing
4321 * system has already cleared the area).
4324 gdk_window_invalidate_maybe_recurse_full (GdkWindow *window,
4325 const cairo_region_t *region,
4327 GdkWindowChildFunc child_func,
4330 GdkWindow *impl_window;
4331 cairo_region_t *visible_region;
4334 g_return_if_fail (GDK_IS_WINDOW (window));
4336 if (GDK_WINDOW_DESTROYED (window))
4339 if (window->input_only ||
4340 !window->viewable ||
4341 cairo_region_is_empty (region) ||
4342 window->window_type == GDK_WINDOW_ROOT)
4345 visible_region = gdk_window_get_visible_region (window);
4346 cairo_region_intersect (visible_region, region);
4348 tmp_list = window->children;
4351 GdkWindow *child = tmp_list->data;
4353 if (!child->input_only)
4355 cairo_region_t *child_region;
4356 GdkRectangle child_rect;
4358 child_rect.x = child->x;
4359 child_rect.y = child->y;
4360 child_rect.width = child->width;
4361 child_rect.height = child->height;
4362 child_region = cairo_region_create_rectangle (&child_rect);
4364 /* remove child area from the invalid area of the parent */
4365 if (GDK_WINDOW_IS_MAPPED (child) && !child->shaped &&
4366 !child->composited &&
4367 !gdk_window_is_offscreen (child))
4368 cairo_region_subtract (visible_region, child_region);
4370 if (child_func && (*child_func) ((GdkWindow *)child, user_data))
4372 cairo_region_t *tmp = cairo_region_copy (region);
4374 cairo_region_translate (tmp, - child_rect.x, - child_rect.y);
4375 cairo_region_translate (child_region, - child_rect.x, - child_rect.y);
4376 cairo_region_intersect (child_region, tmp);
4378 gdk_window_invalidate_maybe_recurse_full ((GdkWindow *)child,
4379 child_region, clear_bg, child_func, user_data);
4381 cairo_region_destroy (tmp);
4384 cairo_region_destroy (child_region);
4387 tmp_list = tmp_list->next;
4390 impl_window = gdk_window_get_impl_window (window);
4392 if (!cairo_region_is_empty (visible_region) ||
4393 /* Even if we're not exposing anything, make sure we process
4394 idles for windows with outstanding moves */
4395 (impl_window->outstanding_moves != NULL &&
4396 impl_window->update_area == NULL))
4399 draw_ugly_color (window, region);
4401 /* Convert to impl coords */
4402 cairo_region_translate (visible_region, window->abs_x, window->abs_y);
4404 /* Only invalidate area if app requested expose events or if
4405 we need to clear the area (by request or to emulate background
4406 clearing for non-native windows or native windows with no support
4407 for window backgrounds */
4408 if (window->event_mask & GDK_EXPOSURE_MASK ||
4409 clear_bg == CLEAR_BG_ALL ||
4410 clear_bg == CLEAR_BG_WINCLEARED)
4411 impl_window_add_update_area (impl_window, visible_region);
4414 cairo_region_destroy (visible_region);
4418 * gdk_window_invalidate_maybe_recurse:
4419 * @window: a #GdkWindow
4420 * @region: a #cairo_region_t
4421 * @child_func: (scope call) (allow-none): function to use to decide if to
4422 * recurse to a child, %NULL means never recurse.
4423 * @user_data: data passed to @child_func
4425 * Adds @region to the update area for @window. The update area is the
4426 * region that needs to be redrawn, or "dirty region." The call
4427 * gdk_window_process_updates() sends one or more expose events to the
4428 * window, which together cover the entire update area. An
4429 * application would normally redraw the contents of @window in
4430 * response to those expose events.
4432 * GDK will call gdk_window_process_all_updates() on your behalf
4433 * whenever your program returns to the main loop and becomes idle, so
4434 * normally there's no need to do that manually, you just need to
4435 * invalidate regions that you know should be redrawn.
4437 * The @child_func parameter controls whether the region of
4438 * each child window that intersects @region will also be invalidated.
4439 * Only children for which @child_func returns TRUE will have the area
4443 gdk_window_invalidate_maybe_recurse (GdkWindow *window,
4444 const cairo_region_t *region,
4445 GdkWindowChildFunc child_func,
4448 gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_NONE,
4449 child_func, user_data);
4453 true_predicate (GdkWindow *window,
4460 gdk_window_invalidate_region_full (GdkWindow *window,
4461 const cairo_region_t *region,
4462 gboolean invalidate_children,
4465 gdk_window_invalidate_maybe_recurse_full (window, region, clear_bg,
4466 invalidate_children ?
4467 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4472 * gdk_window_invalidate_region:
4473 * @window: a #GdkWindow
4474 * @region: a #cairo_region_t
4475 * @invalidate_children: %TRUE to also invalidate child windows
4477 * Adds @region to the update area for @window. The update area is the
4478 * region that needs to be redrawn, or "dirty region." The call
4479 * gdk_window_process_updates() sends one or more expose events to the
4480 * window, which together cover the entire update area. An
4481 * application would normally redraw the contents of @window in
4482 * response to those expose events.
4484 * GDK will call gdk_window_process_all_updates() on your behalf
4485 * whenever your program returns to the main loop and becomes idle, so
4486 * normally there's no need to do that manually, you just need to
4487 * invalidate regions that you know should be redrawn.
4489 * The @invalidate_children parameter controls whether the region of
4490 * each child window that intersects @region will also be invalidated.
4491 * If %FALSE, then the update area for child windows will remain
4492 * unaffected. See gdk_window_invalidate_maybe_recurse if you need
4493 * fine grained control over which children are invalidated.
4496 gdk_window_invalidate_region (GdkWindow *window,
4497 const cairo_region_t *region,
4498 gboolean invalidate_children)
4500 gdk_window_invalidate_maybe_recurse (window, region,
4501 invalidate_children ?
4502 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4507 * _gdk_window_invalidate_for_expose:
4508 * @window: a #GdkWindow
4509 * @region: a #cairo_region_t
4511 * Adds @region to the update area for @window. The update area is the
4512 * region that needs to be redrawn, or "dirty region." The call
4513 * gdk_window_process_updates() sends one or more expose events to the
4514 * window, which together cover the entire update area. An
4515 * application would normally redraw the contents of @window in
4516 * response to those expose events.
4518 * GDK will call gdk_window_process_all_updates() on your behalf
4519 * whenever your program returns to the main loop and becomes idle, so
4520 * normally there's no need to do that manually, you just need to
4521 * invalidate regions that you know should be redrawn.
4523 * This version of invalidation is used when you recieve expose events
4524 * from the native window system. It exposes the native window, plus
4525 * any non-native child windows (but not native child windows, as those would
4526 * have gotten their own expose events).
4529 _gdk_window_invalidate_for_expose (GdkWindow *window,
4530 cairo_region_t *region)
4532 GdkWindowRegionMove *move;
4533 cairo_region_t *move_region;
4536 /* Any invalidations comming from the windowing system will
4537 be in areas that may be moved by outstanding moves,
4538 so we need to modify the expose region correspondingly,
4539 otherwise we would expose in the wrong place, as the
4540 outstanding moves will be copied before we draw the
4542 for (l = window->outstanding_moves; l != NULL; l = l->next)
4546 /* covert to move source region */
4547 move_region = cairo_region_copy (move->dest_region);
4548 cairo_region_translate (move_region, -move->dx, -move->dy);
4550 /* Move area of region that intersects with move source
4551 by dx, dy of the move*/
4552 cairo_region_intersect (move_region, region);
4553 cairo_region_subtract (region, move_region);
4554 cairo_region_translate (move_region, move->dx, move->dy);
4555 cairo_region_union (region, move_region);
4557 cairo_region_destroy (move_region);
4560 gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_WINCLEARED,
4561 (gboolean (*) (GdkWindow *, gpointer))gdk_window_has_no_impl,
4567 * gdk_window_get_update_area:
4568 * @window: a #GdkWindow
4570 * Transfers ownership of the update area from @window to the caller
4571 * of the function. That is, after calling this function, @window will
4572 * no longer have an invalid/dirty region; the update area is removed
4573 * from @window and handed to you. If a window has no update area,
4574 * gdk_window_get_update_area() returns %NULL. You are responsible for
4575 * calling cairo_region_destroy() on the returned region if it's non-%NULL.
4577 * Return value: the update area for @window
4580 gdk_window_get_update_area (GdkWindow *window)
4582 GdkWindow *impl_window;
4583 cairo_region_t *tmp_region;
4585 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4587 impl_window = gdk_window_get_impl_window (window);
4589 if (impl_window->update_area)
4591 tmp_region = cairo_region_copy (window->clip_region_with_children);
4592 /* Convert to impl coords */
4593 cairo_region_translate (tmp_region, window->abs_x, window->abs_y);
4594 cairo_region_intersect (tmp_region, impl_window->update_area);
4596 if (cairo_region_is_empty (tmp_region))
4598 cairo_region_destroy (tmp_region);
4603 cairo_region_subtract (impl_window->update_area, tmp_region);
4605 if (cairo_region_is_empty (impl_window->update_area) &&
4606 impl_window->outstanding_moves == NULL)
4608 cairo_region_destroy (impl_window->update_area);
4609 impl_window->update_area = NULL;
4611 gdk_window_remove_update_window ((GdkWindow *)impl_window);
4614 /* Convert from impl coords */
4615 cairo_region_translate (tmp_region, -window->abs_x, -window->abs_y);
4625 * _gdk_window_clear_update_area:
4626 * @window: a #GdkWindow.
4628 * Internal function to clear the update area for a window. This
4629 * is called when the window is hidden or destroyed.
4632 _gdk_window_clear_update_area (GdkWindow *window)
4634 g_return_if_fail (GDK_IS_WINDOW (window));
4636 if (window->update_area)
4638 gdk_window_remove_update_window (window);
4640 cairo_region_destroy (window->update_area);
4641 window->update_area = NULL;
4646 * gdk_window_freeze_updates:
4647 * @window: a #GdkWindow
4649 * Temporarily freezes a window such that it won't receive expose
4650 * events. The window will begin receiving expose events again when
4651 * gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
4652 * has been called more than once, gdk_window_thaw_updates() must be called
4653 * an equal number of times to begin processing exposes.
4656 gdk_window_freeze_updates (GdkWindow *window)
4658 GdkWindow *impl_window;
4660 g_return_if_fail (GDK_IS_WINDOW (window));
4662 impl_window = gdk_window_get_impl_window (window);
4663 impl_window->update_freeze_count++;
4667 * gdk_window_thaw_updates:
4668 * @window: a #GdkWindow
4670 * Thaws a window frozen with gdk_window_freeze_updates().
4673 gdk_window_thaw_updates (GdkWindow *window)
4675 GdkWindow *impl_window;
4677 g_return_if_fail (GDK_IS_WINDOW (window));
4679 impl_window = gdk_window_get_impl_window (window);
4681 g_return_if_fail (impl_window->update_freeze_count > 0);
4683 if (--impl_window->update_freeze_count == 0)
4684 gdk_window_schedule_update (GDK_WINDOW (impl_window));
4688 * gdk_window_freeze_toplevel_updates_libgtk_only:
4689 * @window: a #GdkWindow
4691 * Temporarily freezes a window and all its descendants such that it won't
4692 * receive expose events. The window will begin receiving expose events
4693 * again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If
4694 * gdk_window_freeze_toplevel_updates_libgtk_only()
4695 * has been called more than once,
4696 * gdk_window_thaw_toplevel_updates_libgtk_only() must be called
4697 * an equal number of times to begin processing exposes.
4699 * This function is not part of the GDK public API and is only
4703 gdk_window_freeze_toplevel_updates_libgtk_only (GdkWindow *window)
4705 g_return_if_fail (GDK_IS_WINDOW (window));
4706 g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4708 window->update_and_descendants_freeze_count++;
4712 * gdk_window_thaw_toplevel_updates_libgtk_only:
4713 * @window: a #GdkWindow
4715 * Thaws a window frozen with
4716 * gdk_window_freeze_toplevel_updates_libgtk_only().
4718 * This function is not part of the GDK public API and is only
4722 gdk_window_thaw_toplevel_updates_libgtk_only (GdkWindow *window)
4724 g_return_if_fail (GDK_IS_WINDOW (window));
4725 g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4726 g_return_if_fail (window->update_and_descendants_freeze_count > 0);
4728 window->update_and_descendants_freeze_count--;
4730 gdk_window_schedule_update (window);
4734 * gdk_window_set_debug_updates:
4735 * @setting: %TRUE to turn on update debugging
4737 * With update debugging enabled, calls to
4738 * gdk_window_invalidate_region() clear the invalidated region of the
4739 * screen to a noticeable color, and GDK pauses for a short time
4740 * before sending exposes to windows during
4741 * gdk_window_process_updates(). The net effect is that you can see
4742 * the invalid region for each window and watch redraws as they
4743 * occur. This allows you to diagnose inefficiencies in your application.
4745 * In essence, because the GDK rendering model prevents all flicker,
4746 * if you are redrawing the same region 400 times you may never
4747 * notice, aside from noticing a speed problem. Enabling update
4748 * debugging causes GTK to flicker slowly and noticeably, so you can
4749 * see exactly what's being redrawn when, in what order.
4751 * The --gtk-debug=updates command line option passed to GTK+ programs
4752 * enables this debug option at application startup time. That's
4753 * usually more useful than calling gdk_window_set_debug_updates()
4754 * yourself, though you might want to use this function to enable
4755 * updates sometime after application startup time.
4759 gdk_window_set_debug_updates (gboolean setting)
4761 debug_updates = setting;
4765 * gdk_window_constrain_size:
4766 * @geometry: a #GdkGeometry structure
4767 * @flags: a mask indicating what portions of @geometry are set
4768 * @width: desired width of window
4769 * @height: desired height of the window
4770 * @new_width: (out): location to store resulting width
4771 * @new_height: (out): location to store resulting height
4773 * Constrains a desired width and height according to a
4774 * set of geometry hints (such as minimum and maximum size).
4777 gdk_window_constrain_size (GdkGeometry *geometry,
4784 /* This routine is partially borrowed from fvwm.
4786 * Copyright 1993, Robert Nation
4787 * You may use this code for any purpose, as long as the original
4788 * copyright remains in the source code and all documentation
4790 * which in turn borrows parts of the algorithm from uwm
4793 gint min_height = 0;
4794 gint base_width = 0;
4795 gint base_height = 0;
4798 gint max_width = G_MAXINT;
4799 gint max_height = G_MAXINT;
4801 #define FLOOR(value, base) ( ((gint) ((value) / (base))) * (base) )
4803 if ((flags & GDK_HINT_BASE_SIZE) && (flags & GDK_HINT_MIN_SIZE))
4805 base_width = geometry->base_width;
4806 base_height = geometry->base_height;
4807 min_width = geometry->min_width;
4808 min_height = geometry->min_height;
4810 else if (flags & GDK_HINT_BASE_SIZE)
4812 base_width = geometry->base_width;
4813 base_height = geometry->base_height;
4814 min_width = geometry->base_width;
4815 min_height = geometry->base_height;
4817 else if (flags & GDK_HINT_MIN_SIZE)
4819 base_width = geometry->min_width;
4820 base_height = geometry->min_height;
4821 min_width = geometry->min_width;
4822 min_height = geometry->min_height;
4825 if (flags & GDK_HINT_MAX_SIZE)
4827 max_width = geometry->max_width ;
4828 max_height = geometry->max_height;
4831 if (flags & GDK_HINT_RESIZE_INC)
4833 xinc = MAX (xinc, geometry->width_inc);
4834 yinc = MAX (yinc, geometry->height_inc);
4837 /* clamp width and height to min and max values
4839 width = CLAMP (width, min_width, max_width);
4840 height = CLAMP (height, min_height, max_height);
4842 /* shrink to base + N * inc
4844 width = base_width + FLOOR (width - base_width, xinc);
4845 height = base_height + FLOOR (height - base_height, yinc);
4847 /* constrain aspect ratio, according to:
4850 * min_aspect <= -------- <= max_aspect
4854 if (flags & GDK_HINT_ASPECT &&
4855 geometry->min_aspect > 0 &&
4856 geometry->max_aspect > 0)
4860 if (geometry->min_aspect * height > width)
4862 delta = FLOOR (height - width / geometry->min_aspect, yinc);
4863 if (height - delta >= min_height)
4867 delta = FLOOR (height * geometry->min_aspect - width, xinc);
4868 if (width + delta <= max_width)
4873 if (geometry->max_aspect * height < width)
4875 delta = FLOOR (width - height * geometry->max_aspect, xinc);
4876 if (width - delta >= min_width)
4880 delta = FLOOR (width / geometry->max_aspect - height, yinc);
4881 if (height + delta <= max_height)
4890 *new_height = height;
4894 * gdk_window_get_pointer:
4895 * @window: a #GdkWindow
4896 * @x: (out) (allow-none): return location for X coordinate of pointer or %NULL to not
4897 * return the X coordinate
4898 * @y: (out) (allow-none): return location for Y coordinate of pointer or %NULL to not
4899 * return the Y coordinate
4900 * @mask: (out) (allow-none): return location for modifier mask or %NULL to not return the
4903 * Obtains the current pointer position and modifier state.
4904 * The position is given in coordinates relative to the upper left
4905 * corner of @window.
4907 * Return value: (transfer none): the window containing the pointer (as with
4908 * gdk_window_at_pointer()), or %NULL if the window containing the
4909 * pointer isn't known to GDK
4911 * Deprecated: 3.0: Use gdk_window_get_device_position() instead.
4914 gdk_window_get_pointer (GdkWindow *window,
4917 GdkModifierType *mask)
4919 GdkDisplay *display;
4921 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4923 display = gdk_window_get_display (window);
4925 return gdk_window_get_device_position (window, display->core_pointer, x, y, mask);
4929 * gdk_window_get_device_position:
4930 * @window: a #GdkWindow.
4931 * @device: pointer #GdkDevice to query to.
4932 * @x: (out) (allow-none): return location for the X coordinate of @device, or %NULL.
4933 * @y: (out) (allow-none): return location for the Y coordinate of @device, or %NULL.
4934 * @mask: (out) (allow-none): return location for the modifier mask, or %NULL.
4936 * Obtains the current device position and modifier state.
4937 * The position is given in coordinates relative to the upper left
4938 * corner of @window.
4940 * Return value: (transfer none): The window underneath @device (as with
4941 * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.
4946 gdk_window_get_device_position (GdkWindow *window,
4950 GdkModifierType *mask)
4953 GdkModifierType tmp_mask;
4954 gboolean normal_child;
4956 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4957 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
4958 g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
4960 normal_child = GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_device_state (window,
4964 /* We got the coords on the impl, convert to the window */
4965 tmp_x -= window->abs_x;
4966 tmp_y -= window->abs_y;
4975 _gdk_display_enable_motion_hints (gdk_window_get_display (window), device);
4978 return _gdk_window_find_child_at (window, tmp_x, tmp_y);
4983 * gdk_window_at_pointer:
4984 * @win_x: (out) (allow-none): return location for origin of the window under the pointer
4985 * @win_y: (out) (allow-none): return location for origin of the window under the pointer
4987 * Obtains the window underneath the mouse pointer, returning the
4988 * location of that window in @win_x, @win_y. Returns %NULL if the
4989 * window under the mouse pointer is not known to GDK (if the window
4990 * belongs to another application and a #GdkWindow hasn't been created
4991 * for it with gdk_window_foreign_new())
4993 * NOTE: For multihead-aware widgets or applications use
4994 * gdk_display_get_window_at_pointer() instead.
4996 * Return value: (transfer none): window under the mouse pointer
4998 * Deprecated: 3.0: Use gdk_device_get_window_at_position() instead.
5001 gdk_window_at_pointer (gint *win_x,
5004 return gdk_display_get_window_at_pointer (gdk_display_get_default (), win_x, win_y);
5008 * gdk_get_default_root_window:
5010 * Obtains the root window (parent all other windows are inside)
5011 * for the default display and screen.
5013 * Return value: (transfer none): the default root window
5016 gdk_get_default_root_window (void)
5018 return gdk_screen_get_root_window (gdk_screen_get_default ());
5022 get_all_native_children (GdkWindow *window,
5028 for (l = window->children; l != NULL; l = l->next)
5032 if (gdk_window_has_impl (child))
5033 *native = g_list_prepend (*native, child);
5035 get_all_native_children (child, native);
5041 gdk_window_raise_internal (GdkWindow *window)
5043 GdkWindow *parent = window->parent;
5045 GList *native_children;
5047 GdkWindowImplClass *impl_class;
5051 parent->children = g_list_remove (parent->children, window);
5052 parent->children = g_list_prepend (parent->children, window);
5055 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5056 /* Just do native raise for toplevels */
5057 if (gdk_window_is_toplevel (window) ||
5058 /* The restack_under codepath should work correctly even if the parent
5059 is native, but it relies on the order of ->children to be correct,
5060 and some apps like SWT reorder the x windows without gdks knowledge,
5061 so we use raise directly in order to make these behave as before
5062 when using native windows */
5063 (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5065 impl_class->raise (window);
5067 else if (gdk_window_has_impl (window))
5069 above = find_native_sibling_above (parent, window);
5072 listhead.data = window;
5073 listhead.next = NULL;
5074 listhead.prev = NULL;
5075 impl_class->restack_under ((GdkWindow *)above,
5079 impl_class->raise (window);
5083 native_children = NULL;
5084 get_all_native_children (window, &native_children);
5085 if (native_children != NULL)
5087 above = find_native_sibling_above (parent, window);
5090 impl_class->restack_under (above, native_children);
5093 /* Right order, since native_children is bottom-topmost first */
5094 for (l = native_children; l != NULL; l = l->next)
5095 impl_class->raise (l->data);
5098 g_list_free (native_children);
5104 /* Returns TRUE If the native window was mapped or unmapped */
5106 set_viewable (GdkWindow *w,
5110 GdkWindowImplClass *impl_class;
5113 if (w->viewable == val)
5119 recompute_visible_regions (w, FALSE, FALSE);
5121 for (l = w->children; l != NULL; l = l->next)
5125 if (GDK_WINDOW_IS_MAPPED (child) &&
5126 child->window_type != GDK_WINDOW_FOREIGN)
5127 set_viewable (child, val);
5130 if (gdk_window_has_impl (w) &&
5131 w->window_type != GDK_WINDOW_FOREIGN &&
5132 !gdk_window_is_toplevel (w))
5134 /* For most native windows we show/hide them not when they are
5135 * mapped/unmapped, because that may not produce the correct results.
5136 * For instance, if a native window have a non-native parent which is
5137 * hidden, but its native parent is viewable then showing the window
5138 * would make it viewable to X but its not viewable wrt the non-native
5139 * hierarchy. In order to handle this we track the gdk side viewability
5140 * and only map really viewable windows.
5142 * There are two exceptions though:
5144 * For foreign windows we don't want ever change the mapped state
5145 * except when explicitly done via gdk_window_show/hide, as this may
5146 * cause problems for client owning the foreign window when its window
5147 * is suddenly mapped or unmapped.
5149 * For toplevel windows embedded in a foreign window (e.g. a plug)
5150 * we sometimes synthesize a map of a window, but the native
5151 * window is really shown by the embedder, so we don't want to
5152 * do the show ourselves. We can't really tell this case from the normal
5153 * toplevel show as such toplevels are seen by gdk as parents of the
5154 * root window, so we make an exception for all toplevels.
5157 impl_class = GDK_WINDOW_IMPL_GET_CLASS (w->impl);
5159 impl_class->show ((GdkWindow *)w, FALSE);
5161 impl_class->hide ((GdkWindow *)w);
5169 /* Returns TRUE If the native window was mapped or unmapped */
5171 _gdk_window_update_viewable (GdkWindow *window)
5175 if (window->window_type == GDK_WINDOW_FOREIGN ||
5176 window->window_type == GDK_WINDOW_ROOT)
5178 else if (gdk_window_is_toplevel (window) ||
5179 window->parent->viewable)
5180 viewable = GDK_WINDOW_IS_MAPPED (window);
5184 return set_viewable (window, viewable);
5188 gdk_window_show_internal (GdkWindow *window, gboolean raise)
5190 GdkWindowImplClass *impl_class;
5191 gboolean was_mapped, was_viewable;
5194 g_return_if_fail (GDK_IS_WINDOW (window));
5196 if (window->destroyed)
5199 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5200 was_viewable = window->viewable;
5203 /* Keep children in (reverse) stacking order */
5204 gdk_window_raise_internal (window);
5206 if (gdk_window_has_impl (window))
5209 gdk_synthesize_window_state (window,
5210 GDK_WINDOW_STATE_WITHDRAWN,
5218 did_show = _gdk_window_update_viewable (window);
5220 /* If it was already viewable the backend show op won't be called, call it
5221 again to ensure things happen right if the mapped tracking was not right
5222 for e.g. a foreign window.
5223 Dunno if this is strictly needed but its what happened pre-csw.
5224 Also show if not done by gdk_window_update_viewable. */
5225 if (gdk_window_has_impl (window) && (was_viewable || !did_show))
5227 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5228 impl_class->show (window, !did_show ? was_mapped : TRUE);
5231 if (!was_mapped && !gdk_window_has_impl (window))
5233 if (window->event_mask & GDK_STRUCTURE_MASK)
5234 _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5236 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5237 _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5240 if (!was_mapped || raise)
5242 recompute_visible_regions (window, TRUE, FALSE);
5244 /* If any decendants became visible we need to send visibility notify */
5245 gdk_window_update_visibility_recursively (window, NULL);
5247 if (gdk_window_is_viewable (window))
5249 _gdk_synthesize_crossing_events_for_geometry_change (window);
5250 gdk_window_invalidate_rect_full (window, NULL, TRUE, CLEAR_BG_ALL);
5256 * gdk_window_show_unraised:
5257 * @window: a #GdkWindow
5259 * Shows a #GdkWindow onscreen, but does not modify its stacking
5260 * order. In contrast, gdk_window_show() will raise the window
5261 * to the top of the window stack.
5263 * On the X11 platform, in Xlib terms, this function calls
5264 * XMapWindow() (it also updates some internal GDK state, which means
5265 * that you can't really use XMapWindow() directly on a GDK window).
5268 gdk_window_show_unraised (GdkWindow *window)
5270 gdk_window_show_internal (window, FALSE);
5275 * @window: a #GdkWindow
5277 * Raises @window to the top of the Z-order (stacking order), so that
5278 * other windows with the same parent window appear below @window.
5279 * This is true whether or not the windows are visible.
5281 * If @window is a toplevel, the window manager may choose to deny the
5282 * request to move the window in the Z-order, gdk_window_raise() only
5283 * requests the restack, does not guarantee it.
5286 gdk_window_raise (GdkWindow *window)
5288 cairo_region_t *old_region, *new_region;
5290 g_return_if_fail (GDK_IS_WINDOW (window));
5292 if (window->destroyed)
5295 gdk_window_flush_if_exposing (window);
5298 if (gdk_window_is_viewable (window) &&
5299 !window->input_only)
5300 old_region = cairo_region_copy (window->clip_region);
5302 /* Keep children in (reverse) stacking order */
5303 gdk_window_raise_internal (window);
5305 recompute_visible_regions (window, TRUE, FALSE);
5309 new_region = cairo_region_copy (window->clip_region);
5311 cairo_region_subtract (new_region, old_region);
5312 gdk_window_invalidate_region_full (window, new_region, TRUE, CLEAR_BG_ALL);
5314 cairo_region_destroy (old_region);
5315 cairo_region_destroy (new_region);
5320 gdk_window_lower_internal (GdkWindow *window)
5322 GdkWindow *parent = window->parent;
5323 GdkWindowImplClass *impl_class;
5325 GList *native_children;
5330 parent->children = g_list_remove (parent->children, window);
5331 parent->children = g_list_append (parent->children, window);
5334 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5335 /* Just do native lower for toplevels */
5336 if (gdk_window_is_toplevel (window) ||
5337 /* The restack_under codepath should work correctly even if the parent
5338 is native, but it relies on the order of ->children to be correct,
5339 and some apps like SWT reorder the x windows without gdks knowledge,
5340 so we use lower directly in order to make these behave as before
5341 when using native windows */
5342 (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5344 impl_class->lower (window);
5346 else if (gdk_window_has_impl (window))
5348 above = find_native_sibling_above (parent, window);
5351 listhead.data = window;
5352 listhead.next = NULL;
5353 listhead.prev = NULL;
5354 impl_class->restack_under ((GdkWindow *)above, &listhead);
5357 impl_class->raise (window);
5361 native_children = NULL;
5362 get_all_native_children (window, &native_children);
5363 if (native_children != NULL)
5365 above = find_native_sibling_above (parent, window);
5368 impl_class->restack_under ((GdkWindow *)above,
5372 /* Right order, since native_children is bottom-topmost first */
5373 for (l = native_children; l != NULL; l = l->next)
5374 impl_class->raise (l->data);
5377 g_list_free (native_children);
5384 gdk_window_invalidate_in_parent (GdkWindow *private)
5386 GdkRectangle r, child;
5388 if (gdk_window_is_toplevel (private))
5391 /* get the visible rectangle of the parent */
5393 r.width = private->parent->width;
5394 r.height = private->parent->height;
5396 child.x = private->x;
5397 child.y = private->y;
5398 child.width = private->width;
5399 child.height = private->height;
5400 gdk_rectangle_intersect (&r, &child, &r);
5402 gdk_window_invalidate_rect_full (private->parent, &r, TRUE, CLEAR_BG_ALL);
5408 * @window: a #GdkWindow
5410 * Lowers @window to the bottom of the Z-order (stacking order), so that
5411 * other windows with the same parent window appear above @window.
5412 * This is true whether or not the other windows are visible.
5414 * If @window is a toplevel, the window manager may choose to deny the
5415 * request to move the window in the Z-order, gdk_window_lower() only
5416 * requests the restack, does not guarantee it.
5418 * Note that gdk_window_show() raises the window again, so don't call this
5419 * function before gdk_window_show(). (Try gdk_window_show_unraised().)
5422 gdk_window_lower (GdkWindow *window)
5424 g_return_if_fail (GDK_IS_WINDOW (window));
5426 if (window->destroyed)
5429 gdk_window_flush_if_exposing (window);
5431 /* Keep children in (reverse) stacking order */
5432 gdk_window_lower_internal (window);
5434 recompute_visible_regions (window, TRUE, FALSE);
5436 _gdk_synthesize_crossing_events_for_geometry_change (window);
5437 gdk_window_invalidate_in_parent (window);
5441 * gdk_window_restack:
5442 * @window: a #GdkWindow
5443 * @sibling: (allow-none): a #GdkWindow that is a sibling of @window, or %NULL
5446 * Changes the position of @window in the Z-order (stacking order), so that
5447 * it is above @sibling (if @above is %TRUE) or below @sibling (if @above is
5450 * If @sibling is %NULL, then this either raises (if @above is %TRUE) or
5451 * lowers the window.
5453 * If @window is a toplevel, the window manager may choose to deny the
5454 * request to move the window in the Z-order, gdk_window_restack() only
5455 * requests the restack, does not guarantee it.
5460 gdk_window_restack (GdkWindow *window,
5464 GdkWindowImplClass *impl_class;
5466 GdkWindow *above_native;
5467 GList *sibling_link;
5468 GList *native_children;
5471 g_return_if_fail (GDK_IS_WINDOW (window));
5472 g_return_if_fail (sibling == NULL || GDK_IS_WINDOW (sibling));
5474 if (window->destroyed)
5477 if (sibling == NULL)
5480 gdk_window_raise (window);
5482 gdk_window_lower (window);
5486 gdk_window_flush_if_exposing (window);
5488 if (gdk_window_is_toplevel (window))
5490 g_return_if_fail (gdk_window_is_toplevel (sibling));
5491 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5492 impl_class->restack_toplevel (window, sibling, above);
5496 parent = window->parent;
5499 sibling_link = g_list_find (parent->children, sibling);
5500 g_return_if_fail (sibling_link != NULL);
5501 if (sibling_link == NULL)
5504 parent->children = g_list_remove (parent->children, window);
5506 parent->children = g_list_insert_before (parent->children,
5510 parent->children = g_list_insert_before (parent->children,
5514 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5515 if (gdk_window_has_impl (window))
5517 above_native = find_native_sibling_above (parent, window);
5520 listhead.data = window;
5521 listhead.next = NULL;
5522 listhead.prev = NULL;
5523 impl_class->restack_under (above_native, &listhead);
5526 impl_class->raise (window);
5530 native_children = NULL;
5531 get_all_native_children (window, &native_children);
5532 if (native_children != NULL)
5534 above_native = find_native_sibling_above (parent, window);
5536 impl_class->restack_under (above_native,
5540 /* Right order, since native_children is bottom-topmost first */
5541 for (l = native_children; l != NULL; l = l->next)
5542 impl_class->raise (l->data);
5545 g_list_free (native_children);
5550 recompute_visible_regions (window, TRUE, FALSE);
5552 _gdk_synthesize_crossing_events_for_geometry_change (window);
5553 gdk_window_invalidate_in_parent (window);
5559 * @window: a #GdkWindow
5561 * Like gdk_window_show_unraised(), but also raises the window to the
5562 * top of the window stack (moves the window to the front of the
5565 * This function maps a window so it's visible onscreen. Its opposite
5566 * is gdk_window_hide().
5568 * When implementing a #GtkWidget, you should call this function on the widget's
5569 * #GdkWindow as part of the "map" method.
5572 gdk_window_show (GdkWindow *window)
5574 gdk_window_show_internal (window, TRUE);
5579 * @window: a #GdkWindow
5581 * For toplevel windows, withdraws them, so they will no longer be
5582 * known to the window manager; for all windows, unmaps them, so
5583 * they won't be displayed. Normally done automatically as
5584 * part of gtk_widget_hide().
5587 gdk_window_hide (GdkWindow *window)
5589 GdkWindowImplClass *impl_class;
5590 gboolean was_mapped, did_hide;
5592 g_return_if_fail (GDK_IS_WINDOW (window));
5594 if (window->destroyed)
5597 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5599 if (gdk_window_has_impl (window))
5602 if (GDK_WINDOW_IS_MAPPED (window))
5603 gdk_synthesize_window_state (window,
5605 GDK_WINDOW_STATE_WITHDRAWN);
5607 else if (was_mapped)
5609 GdkDisplay *display;
5610 GdkDeviceManager *device_manager;
5613 /* May need to break grabs on children */
5614 display = gdk_window_get_display (window);
5615 device_manager = gdk_display_get_device_manager (display);
5617 /* Get all devices */
5618 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
5619 devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_SLAVE));
5620 devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING));
5622 for (d = devices; d; d = d->next)
5624 GdkDevice *device = d->data;
5626 if (_gdk_display_end_device_grab (display,
5628 _gdk_display_get_next_serial (display),
5631 gdk_device_ungrab (device, GDK_CURRENT_TIME);
5634 window->state = GDK_WINDOW_STATE_WITHDRAWN;
5635 g_list_free (devices);
5638 did_hide = _gdk_window_update_viewable (window);
5640 /* Hide foreign window as those are not handled by update_viewable. */
5641 if (gdk_window_has_impl (window) && (!did_hide))
5643 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5644 impl_class->hide (window);
5647 recompute_visible_regions (window, TRUE, FALSE);
5649 /* all decendants became non-visible, we need to send visibility notify */
5650 gdk_window_update_visibility_recursively (window, NULL);
5652 if (was_mapped && !gdk_window_has_impl (window))
5654 if (window->event_mask & GDK_STRUCTURE_MASK)
5655 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5657 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5658 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5660 _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5663 /* Invalidate the rect */
5665 gdk_window_invalidate_in_parent (window);
5669 * gdk_window_withdraw:
5670 * @window: a toplevel #GdkWindow
5672 * Withdraws a window (unmaps it and asks the window manager to forget about it).
5673 * This function is not really useful as gdk_window_hide() automatically
5674 * withdraws toplevel windows before hiding them.
5677 gdk_window_withdraw (GdkWindow *window)
5679 GdkWindowImplClass *impl_class;
5680 gboolean was_mapped;
5682 g_return_if_fail (GDK_IS_WINDOW (window));
5684 if (window->destroyed)
5687 was_mapped = GDK_WINDOW_IS_MAPPED (window);
5689 if (gdk_window_has_impl (window))
5691 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5692 impl_class->withdraw (window);
5696 if (window->event_mask & GDK_STRUCTURE_MASK)
5697 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5699 if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5700 _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5702 _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5705 recompute_visible_regions (window, TRUE, FALSE);
5710 * gdk_window_set_events:
5711 * @window: a #GdkWindow
5712 * @event_mask: event mask for @window
5714 * The event mask for a window determines which events will be reported
5715 * for that window from all master input devices. For example, an event mask
5716 * including #GDK_BUTTON_PRESS_MASK means the window should report button
5717 * press events. The event mask is the bitwise OR of values from the
5718 * #GdkEventMask enumeration.
5721 gdk_window_set_events (GdkWindow *window,
5722 GdkEventMask event_mask)
5724 GdkWindowImplClass *impl_class;
5725 GdkDisplay *display;
5727 g_return_if_fail (GDK_IS_WINDOW (window));
5729 if (window->destroyed)
5732 /* If motion hint is disabled, enable motion events again */
5733 display = gdk_window_get_display (window);
5734 if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5735 !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5737 GList *devices = window->devices_inside;
5741 _gdk_display_enable_motion_hints (display, (GdkDevice *) devices->data);
5742 devices = devices->next;
5746 window->event_mask = event_mask;
5748 if (gdk_window_has_impl (window))
5750 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5751 impl_class->set_events (window,
5752 get_native_event_mask (window));
5758 * gdk_window_get_events:
5759 * @window: a #GdkWindow
5761 * Gets the event mask for @window for all master input devices. See
5762 * gdk_window_set_events().
5764 * Return value: event mask for @window
5767 gdk_window_get_events (GdkWindow *window)
5769 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5771 if (window->destroyed)
5774 return window->event_mask;
5778 * gdk_window_set_device_events:
5779 * @window: a #GdkWindow
5780 * @device: #GdkDevice to enable events for.
5781 * @event_mask: event mask for @window
5783 * Sets the event mask for a given device (Normally a floating device, not
5784 * attached to any visible pointer) to @window. For example, an event mask
5785 * including #GDK_BUTTON_PRESS_MASK means the window should report button
5786 * press events. The event mask is the bitwise OR of values from the
5787 * #GdkEventMask enumeration.
5792 gdk_window_set_device_events (GdkWindow *window,
5794 GdkEventMask event_mask)
5796 GdkEventMask device_mask;
5797 GdkDisplay *display;
5800 g_return_if_fail (GDK_IS_WINDOW (window));
5801 g_return_if_fail (GDK_IS_DEVICE (device));
5803 if (GDK_WINDOW_DESTROYED (window))
5806 /* If motion hint is disabled, enable motion events again */
5807 display = gdk_window_get_display (window);
5808 if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5809 !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5810 _gdk_display_enable_motion_hints (display, device);
5812 if (G_UNLIKELY (!window->device_events))
5813 window->device_events = g_hash_table_new (NULL, NULL);
5815 if (event_mask == 0)
5817 /* FIXME: unsetting events on a master device
5818 * would restore window->event_mask
5820 g_hash_table_remove (window->device_events, device);
5823 g_hash_table_insert (window->device_events, device,
5824 GINT_TO_POINTER (event_mask));
5826 native = gdk_window_get_toplevel (window);
5828 while (gdk_window_is_offscreen (native))
5830 native = gdk_offscreen_window_get_embedder (native);
5832 if (native == NULL ||
5833 (!_gdk_window_has_impl (native) &&
5834 !gdk_window_is_viewable (native)))
5837 native = gdk_window_get_toplevel (native);
5840 device_mask = get_native_device_event_mask (window, device);
5841 GDK_DEVICE_GET_CLASS (device)->select_window_events (device, native, device_mask);
5845 * gdk_window_get_device_events:
5846 * @window: a #GdkWindow.
5847 * @device: a #GdkDevice.
5849 * Returns the event mask for @window corresponding to an specific device.
5851 * Returns: device event mask for @window
5856 gdk_window_get_device_events (GdkWindow *window,
5861 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5862 g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
5864 if (GDK_WINDOW_DESTROYED (window))
5867 if (!window->device_events)
5870 mask = GPOINTER_TO_INT (g_hash_table_lookup (window->device_events, device));
5872 /* FIXME: device could be controlled by window->event_mask */
5878 gdk_window_move_resize_toplevel (GdkWindow *window,
5885 cairo_region_t *old_region, *new_region;
5886 GdkWindowImplClass *impl_class;
5893 is_resize = (width != -1) || (height != -1);
5895 if (gdk_window_is_viewable (window) &&
5896 !window->input_only)
5899 old_region = cairo_region_copy (window->clip_region);
5902 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5903 impl_class->move_resize (window, with_move, x, y, width, height);
5905 /* Avoid recomputing for pure toplevel moves, for performance reasons */
5907 recompute_visible_regions (window, TRUE, FALSE);
5911 new_region = cairo_region_copy (window->clip_region);
5913 /* This is the newly exposed area (due to any resize),
5914 * X will expose it, but lets do that without the roundtrip
5916 cairo_region_subtract (new_region, old_region);
5917 gdk_window_invalidate_region_full (window, new_region, TRUE, CLEAR_BG_WINCLEARED);
5919 cairo_region_destroy (old_region);
5920 cairo_region_destroy (new_region);
5923 _gdk_synthesize_crossing_events_for_geometry_change (window);
5928 move_native_children (GdkWindow *private)
5932 GdkWindowImplClass *impl_class;
5934 for (l = private->children; l; l = l->next)
5938 if (child->impl != private->impl)
5940 impl_class = GDK_WINDOW_IMPL_GET_CLASS (child->impl);
5941 impl_class->move_resize (child, TRUE,
5943 child->width, child->height);
5946 move_native_children (child);
5951 collect_native_child_region_helper (GdkWindow *window,
5952 GdkWindowImpl *impl,
5953 cairo_region_t **region,
5958 cairo_region_t *tmp;
5961 for (l = window->children; l != NULL; l = l->next)
5965 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only)
5968 if (child->impl != impl)
5970 tmp = cairo_region_copy (child->clip_region);
5971 cairo_region_translate (tmp,
5972 x_offset + child->x,
5973 y_offset + child->y);
5974 if (*region == NULL)
5978 cairo_region_union (*region, tmp);
5979 cairo_region_destroy (tmp);
5983 collect_native_child_region_helper (child, impl, region,
5984 x_offset + child->x,
5985 y_offset + child->y);
5991 static cairo_region_t *
5992 collect_native_child_region (GdkWindow *window,
5993 gboolean include_this)
5995 cairo_region_t *region;
5997 if (include_this && gdk_window_has_impl (window) && window->viewable)
5998 return cairo_region_copy (window->clip_region);
6002 collect_native_child_region_helper (window, window->impl, ®ion, 0, 0);
6009 gdk_window_move_resize_internal (GdkWindow *window,
6016 cairo_region_t *old_region, *new_region, *copy_area;
6017 cairo_region_t *old_native_child_region, *new_native_child_region;
6018 GdkWindow *impl_window;
6019 GdkWindowImplClass *impl_class;
6021 int old_x, old_y, old_abs_x, old_abs_y;
6024 g_return_if_fail (GDK_IS_WINDOW (window));
6026 if (window->destroyed)
6029 if (gdk_window_is_toplevel (window))
6031 gdk_window_move_resize_toplevel (window, with_move, x, y, width, height);
6035 /* Bail early if no change */
6036 if (window->width == width &&
6037 window->height == height &&
6043 gdk_window_flush_if_exposing (window);
6045 /* Handle child windows */
6050 impl_window = gdk_window_get_impl_window (window);
6055 old_native_child_region = NULL;
6056 if (gdk_window_is_viewable (window) &&
6057 !window->input_only)
6061 old_region = cairo_region_copy (window->clip_region);
6062 /* Adjust region to parent window coords */
6063 cairo_region_translate (old_region, window->x, window->y);
6065 old_native_child_region = collect_native_child_region (window, TRUE);
6066 if (old_native_child_region)
6068 /* Adjust region to parent window coords */
6069 cairo_region_translate (old_native_child_region, window->x, window->y);
6071 /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6072 * source or destination for a delayed GdkWindowRegionMove. So, we need
6073 * to flush those here for the parent window and all overlapped subwindows
6074 * of it. And we need to do this before setting the new clips as those will be
6077 gdk_window_flush_recursive (window->parent);
6081 /* Set the new position and size */
6087 if (!(width < 0 && height < 0))
6091 window->width = width;
6094 window->height = height;
6097 dx = window->x - old_x;
6098 dy = window->y - old_y;
6100 old_abs_x = window->abs_x;
6101 old_abs_y = window->abs_y;
6103 recompute_visible_regions (window, TRUE, FALSE);
6105 new_native_child_region = NULL;
6106 if (old_native_child_region)
6108 new_native_child_region = collect_native_child_region (window, TRUE);
6109 /* Adjust region to parent window coords */
6110 cairo_region_translate (new_native_child_region, window->x, window->y);
6113 if (gdk_window_has_impl (window))
6115 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6117 /* Do the actual move after recomputing things, as this will have set the shape to
6118 the now correct one, thus avoiding copying regions that should not be copied. */
6119 impl_class->move_resize (window, TRUE,
6120 window->x, window->y,
6121 window->width, window->height);
6123 else if (old_abs_x != window->abs_x ||
6124 old_abs_y != window->abs_y)
6125 move_native_children (window);
6129 new_region = cairo_region_copy (window->clip_region);
6130 /* Adjust region to parent window coords */
6131 cairo_region_translate (new_region, window->x, window->y);
6134 * Part of the data at the new location can be copied from the
6135 * old location, this area is the intersection of the old region
6136 * moved as the copy will move it and then intersected with
6140 * Everything in the old and new regions that is not copied must be
6141 * invalidated (including children) as this is newly exposed
6143 copy_area = cairo_region_copy (new_region);
6145 cairo_region_union (new_region, old_region);
6147 if (old_native_child_region)
6149 /* Don't copy from inside native children, as this is copied by
6150 * the native window move.
6152 cairo_region_subtract (old_region, old_native_child_region);
6154 cairo_region_translate (old_region, dx, dy);
6156 cairo_region_intersect (copy_area, old_region);
6158 if (new_native_child_region)
6160 /* Don't copy any bits that would cause a read from the moved
6161 native windows, as we can't read that data */
6162 cairo_region_translate (new_native_child_region, dx, dy);
6163 cairo_region_subtract (copy_area, new_native_child_region);
6164 cairo_region_translate (new_native_child_region, -dx, -dy);
6167 cairo_region_subtract (new_region, copy_area);
6169 /* Convert old region to impl coords */
6170 cairo_region_translate (old_region, -dx + window->abs_x - window->x, -dy + window->abs_y - window->y);
6172 /* convert from parent coords to impl */
6173 cairo_region_translate (copy_area, window->abs_x - window->x, window->abs_y - window->y);
6175 move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6177 /* Invalidate affected part in the parent window
6178 * (no higher window should be affected)
6179 * We also invalidate any children in that area, which could include
6180 * this window if it still overlaps that area.
6182 if (old_native_child_region)
6184 /* No need to expose the region that the native window move copies */
6185 cairo_region_translate (old_native_child_region, dx, dy);
6186 cairo_region_intersect (old_native_child_region, new_native_child_region);
6187 cairo_region_subtract (new_region, old_native_child_region);
6189 gdk_window_invalidate_region_full (window->parent, new_region, TRUE, CLEAR_BG_ALL);
6191 cairo_region_destroy (old_region);
6192 cairo_region_destroy (new_region);
6195 if (old_native_child_region)
6197 cairo_region_destroy (old_native_child_region);
6198 cairo_region_destroy (new_native_child_region);
6201 _gdk_synthesize_crossing_events_for_geometry_change (window);
6208 * @window: a #GdkWindow
6209 * @x: X coordinate relative to window's parent
6210 * @y: Y coordinate relative to window's parent
6212 * Repositions a window relative to its parent window.
6213 * For toplevel windows, window managers may ignore or modify the move;
6214 * you should probably use gtk_window_move() on a #GtkWindow widget
6215 * anyway, instead of using GDK functions. For child windows,
6216 * the move will reliably succeed.
6218 * If you're also planning to resize the window, use gdk_window_move_resize()
6219 * to both move and resize simultaneously, for a nicer visual effect.
6222 gdk_window_move (GdkWindow *window,
6226 gdk_window_move_resize_internal (window, TRUE, x, y, -1, -1);
6230 * gdk_window_resize:
6231 * @window: a #GdkWindow
6232 * @width: new width of the window
6233 * @height: new height of the window
6235 * Resizes @window; for toplevel windows, asks the window manager to resize
6236 * the window. The window manager may not allow the resize. When using GTK+,
6237 * use gtk_window_resize() instead of this low-level GDK function.
6239 * Windows may not be resized below 1x1.
6241 * If you're also planning to move the window, use gdk_window_move_resize()
6242 * to both move and resize simultaneously, for a nicer visual effect.
6245 gdk_window_resize (GdkWindow *window,
6249 gdk_window_move_resize_internal (window, FALSE, 0, 0, width, height);
6254 * gdk_window_move_resize:
6255 * @window: a #GdkWindow
6256 * @x: new X position relative to window's parent
6257 * @y: new Y position relative to window's parent
6259 * @height: new height
6261 * Equivalent to calling gdk_window_move() and gdk_window_resize(),
6262 * except that both operations are performed at once, avoiding strange
6263 * visual effects. (i.e. the user may be able to see the window first
6264 * move, then resize, if you don't use gdk_window_move_resize().)
6267 gdk_window_move_resize (GdkWindow *window,
6273 gdk_window_move_resize_internal (window, TRUE, x, y, width, height);
6278 * gdk_window_scroll:
6279 * @window: a #GdkWindow
6280 * @dx: Amount to scroll in the X direction
6281 * @dy: Amount to scroll in the Y direction
6283 * Scroll the contents of @window, both pixels and children, by the
6284 * given amount. @window itself does not move. Portions of the window
6285 * that the scroll operation brings in from offscreen areas are
6286 * invalidated. The invalidated region may be bigger than what would
6287 * strictly be necessary.
6289 * For X11, a minimum area will be invalidated if the window has no
6290 * subwindows, or if the edges of the window's parent do not extend
6291 * beyond the edges of the window. In other cases, a multi-step process
6292 * is used to scroll the window which may produce temporary visual
6293 * artifacts and unnecessary invalidations.
6296 gdk_window_scroll (GdkWindow *window,
6300 GdkWindow *impl_window;
6301 cairo_region_t *copy_area, *noncopy_area;
6302 cairo_region_t *old_native_child_region, *new_native_child_region;
6305 g_return_if_fail (GDK_IS_WINDOW (window));
6307 if (dx == 0 && dy == 0)
6310 if (window->destroyed)
6313 gdk_window_flush_if_exposing (window);
6315 old_native_child_region = collect_native_child_region (window, FALSE);
6316 if (old_native_child_region)
6318 /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6319 * source or destination for a delayed GdkWindowRegionMove. So, we need
6320 * to flush those here for the window and all overlapped subwindows
6321 * of it. And we need to do this before setting the new clips as those will be
6324 gdk_window_flush_recursive (window);
6328 /* First move all child windows, without causing invalidation */
6330 tmp_list = window->children;
6333 GdkWindow *child = GDK_WINDOW (tmp_list->data);
6335 /* Just update the positions, the bits will move with the copy */
6339 tmp_list = tmp_list->next;
6342 recompute_visible_regions (window, FALSE, TRUE);
6344 new_native_child_region = NULL;
6345 if (old_native_child_region)
6346 new_native_child_region = collect_native_child_region (window, FALSE);
6348 move_native_children (window);
6350 /* Then copy the actual bits of the window w/ child windows */
6352 impl_window = gdk_window_get_impl_window (window);
6354 /* Calculate the area that can be gotten by copying the old area */
6355 copy_area = cairo_region_copy (window->clip_region);
6356 if (old_native_child_region)
6358 /* Don't copy from inside native children, as this is copied by
6359 * the native window move.
6361 cairo_region_subtract (copy_area, old_native_child_region);
6363 /* Don't copy any bits that would cause a read from the moved
6364 native windows, as we can't read that data */
6365 cairo_region_subtract (copy_area, new_native_child_region);
6367 cairo_region_translate (copy_area, dx, dy);
6368 cairo_region_intersect (copy_area, window->clip_region);
6370 /* And the rest need to be invalidated */
6371 noncopy_area = cairo_region_copy (window->clip_region);
6372 cairo_region_subtract (noncopy_area, copy_area);
6374 /* convert from window coords to impl */
6375 cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6377 move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6379 /* Invalidate not copied regions */
6380 if (old_native_child_region)
6382 /* No need to expose the region that the native window move copies */
6383 cairo_region_translate (old_native_child_region, dx, dy);
6384 cairo_region_intersect (old_native_child_region, new_native_child_region);
6385 cairo_region_subtract (noncopy_area, old_native_child_region);
6387 gdk_window_invalidate_region_full (window, noncopy_area, TRUE, CLEAR_BG_ALL);
6389 cairo_region_destroy (noncopy_area);
6391 if (old_native_child_region)
6393 cairo_region_destroy (old_native_child_region);
6394 cairo_region_destroy (new_native_child_region);
6397 _gdk_synthesize_crossing_events_for_geometry_change (window);
6401 * gdk_window_move_region:
6402 * @window: a #GdkWindow
6403 * @region: The #cairo_region_t to move
6404 * @dx: Amount to move in the X direction
6405 * @dy: Amount to move in the Y direction
6407 * Move the part of @window indicated by @region by @dy pixels in the Y
6408 * direction and @dx pixels in the X direction. The portions of @region
6409 * that not covered by the new position of @region are invalidated.
6411 * Child windows are not moved.
6416 gdk_window_move_region (GdkWindow *window,
6417 const cairo_region_t *region,
6421 GdkWindow *impl_window;
6422 cairo_region_t *nocopy_area;
6423 cairo_region_t *copy_area;
6425 g_return_if_fail (GDK_IS_WINDOW (window));
6426 g_return_if_fail (region != NULL);
6428 if (dx == 0 && dy == 0)
6431 if (window->destroyed)
6434 impl_window = gdk_window_get_impl_window (window);
6436 /* compute source regions */
6437 copy_area = cairo_region_copy (region);
6438 cairo_region_intersect (copy_area, window->clip_region_with_children);
6440 /* compute destination regions */
6441 cairo_region_translate (copy_area, dx, dy);
6442 cairo_region_intersect (copy_area, window->clip_region_with_children);
6444 /* Invalidate parts of the region (source and dest) not covered
6446 nocopy_area = cairo_region_copy (region);
6447 cairo_region_translate (nocopy_area, dx, dy);
6448 cairo_region_union (nocopy_area, region);
6449 cairo_region_subtract (nocopy_area, copy_area);
6451 /* convert from window coords to impl */
6452 cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6453 move_region_on_impl (impl_window, copy_area, dx, dy); /* Takes ownership of copy_area */
6455 gdk_window_invalidate_region_full (window, nocopy_area, FALSE, CLEAR_BG_ALL);
6456 cairo_region_destroy (nocopy_area);
6460 * gdk_window_set_background:
6461 * @window: a #GdkWindow
6462 * @color: a #GdkColor
6464 * Sets the background color of @window. (However, when using GTK+,
6465 * set the background of a widget with gtk_widget_modify_bg() - if
6466 * you're an application - or gtk_style_set_background() - if you're
6467 * implementing a custom widget.)
6469 * See also gdk_window_set_background_pattern().
6472 gdk_window_set_background (GdkWindow *window,
6473 const GdkColor *color)
6475 cairo_pattern_t *pattern;
6477 g_return_if_fail (GDK_IS_WINDOW (window));
6479 pattern = cairo_pattern_create_rgb (color->red / 65535.,
6480 color->green / 65535.,
6481 color->blue / 65535.);
6483 gdk_window_set_background_pattern (window, pattern);
6485 cairo_pattern_destroy (pattern);
6489 * gdk_window_set_background_rgba:
6490 * @window: a #GdkWindow
6491 * @rgba: a #GdkRGBA color
6493 * Sets the background color of @window.
6495 * See also gdk_window_set_background_pattern().
6498 gdk_window_set_background_rgba (GdkWindow *window,
6501 cairo_pattern_t *pattern;
6503 g_return_if_fail (GDK_IS_WINDOW (window));
6504 g_return_if_fail (rgba != NULL);
6506 pattern = cairo_pattern_create_rgba (rgba->red, rgba->green,
6507 rgba->blue, rgba->alpha);
6509 gdk_window_set_background_pattern (window, pattern);
6511 cairo_pattern_destroy (pattern);
6515 * gdk_window_set_background_pattern:
6516 * @window: a #GdkWindow
6517 * @pattern: (allow-none): a pattern to use, or %NULL
6519 * Sets the background of @window.
6521 * A background of %NULL means that the window will inherit its
6522 * background form its parent window.
6524 * The windowing system will normally fill a window with its background
6525 * when the window is obscured then exposed.
6528 gdk_window_set_background_pattern (GdkWindow *window,
6529 cairo_pattern_t *pattern)
6531 g_return_if_fail (GDK_IS_WINDOW (window));
6534 cairo_pattern_reference (pattern);
6535 if (window->background)
6536 cairo_pattern_destroy (window->background);
6537 window->background = pattern;
6539 if (gdk_window_has_impl (window) &&
6540 !window->input_only)
6542 GdkWindowImplClass *impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6543 impl_class->set_background (window, pattern);
6548 * gdk_window_get_background_pattern:
6551 * Gets the pattern used to clear the background on @window. If @window
6552 * does not have its own background and reuses the parent's, %NULL is
6553 * returned and you'll have to query it yourself.
6555 * Returns: (transfer none): The pattern to use for the background or
6556 * %NULL to use the parent's background.
6561 gdk_window_get_background_pattern (GdkWindow *window)
6563 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6565 return window->background;
6569 gdk_window_set_cursor_internal (GdkWindow *window,
6573 if (GDK_WINDOW_DESTROYED (window))
6576 if (window->window_type == GDK_WINDOW_ROOT ||
6577 window->window_type == GDK_WINDOW_FOREIGN)
6578 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_device_cursor (window, device, cursor);
6581 GdkPointerWindowInfo *pointer_info;
6582 GdkDisplay *display;
6584 display = gdk_window_get_display (window);
6585 pointer_info = _gdk_display_get_pointer_info (display, device);
6587 if (_gdk_window_event_parent_of (window, pointer_info->window_under_pointer))
6588 update_cursor (display, device);
6593 * gdk_window_get_cursor:
6594 * @window: a #GdkWindow
6596 * Retrieves a #GdkCursor pointer for the cursor currently set on the
6597 * specified #GdkWindow, or %NULL. If the return value is %NULL then
6598 * there is no custom cursor set on the specified window, and it is
6599 * using the cursor for its parent window.
6601 * Return value: (transfer none): a #GdkCursor, or %NULL. The returned
6602 * object is owned by the #GdkWindow and should not be unreferenced
6603 * directly. Use gdk_window_set_cursor() to unset the cursor of the
6609 gdk_window_get_cursor (GdkWindow *window)
6611 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6613 return window->cursor;
6617 * gdk_window_set_cursor:
6618 * @window: a #GdkWindow
6619 * @cursor: (allow-none): a cursor
6621 * Sets the default mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display()
6622 * or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor
6623 * invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument
6624 * to gdk_window_set_cursor() means that @window will use the cursor of its
6625 * parent window. Most windows should use this default.
6628 gdk_window_set_cursor (GdkWindow *window,
6631 GdkDisplay *display;
6633 g_return_if_fail (GDK_IS_WINDOW (window));
6635 display = gdk_window_get_display (window);
6639 g_object_unref (window->cursor);
6640 window->cursor = NULL;
6643 if (!GDK_WINDOW_DESTROYED (window))
6645 GdkDeviceManager *device_manager;
6649 window->cursor = g_object_ref (cursor);
6651 device_manager = gdk_display_get_device_manager (display);
6652 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
6654 for (d = devices; d; d = d->next)
6660 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
6663 gdk_window_set_cursor_internal (window, device, window->cursor);
6666 g_list_free (devices);
6667 g_object_notify (G_OBJECT (window), "cursor");
6672 * gdk_window_get_device_cursor:
6673 * @window: a #GdkWindow.
6674 * @device: a master, pointer #GdkDevice.
6676 * Retrieves a #GdkCursor pointer for the @device currently set on the
6677 * specified #GdkWindow, or %NULL. If the return value is %NULL then
6678 * there is no custom cursor set on the specified window, and it is
6679 * using the cursor for its parent window.
6681 * Returns: (transfer none): a #GdkCursor, or %NULL. The returned
6682 * object is owned by the #GdkWindow and should not be unreferenced
6683 * directly. Use gdk_window_set_cursor() to unset the cursor of the
6689 gdk_window_get_device_cursor (GdkWindow *window,
6692 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6693 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
6694 g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
6695 g_return_val_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER, NULL);
6697 return g_hash_table_lookup (window->device_cursor, device);
6701 * gdk_window_set_device_cursor:
6702 * @window: a #Gdkwindow
6703 * @device: a master, pointer #GdkDevice
6704 * @cursor: a #GdkCursor
6706 * Sets a specific #GdkCursor for a given device when it gets inside @window.
6707 * Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create
6708 * the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing
6709 * %NULL for the @cursor argument to gdk_window_set_cursor() means that
6710 * @window will use the cursor of its parent window. Most windows should
6716 gdk_window_set_device_cursor (GdkWindow *window,
6720 g_return_if_fail (GDK_IS_WINDOW (window));
6721 g_return_if_fail (GDK_IS_DEVICE (device));
6722 g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
6723 g_return_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER);
6726 g_hash_table_remove (window->device_cursor, device);
6728 g_hash_table_replace (window->device_cursor, device, g_object_ref (cursor));
6730 gdk_window_set_cursor_internal (window, device, cursor);
6734 * gdk_window_get_geometry:
6735 * @window: a #GdkWindow
6736 * @x: (out) (allow-none): return location for X coordinate of window (relative to its parent)
6737 * @y: (out) (allow-none): return location for Y coordinate of window (relative to its parent)
6738 * @width: (out) (allow-none): return location for width of window
6739 * @height: (out) (allow-none): return location for height of window
6741 * Any of the return location arguments to this function may be %NULL,
6742 * if you aren't interested in getting the value of that field.
6744 * The X and Y coordinates returned are relative to the parent window
6745 * of @window, which for toplevels usually means relative to the
6746 * window decorations (titlebar, etc.) rather than relative to the
6747 * root window (screen-size background window).
6749 * On the X11 platform, the geometry is obtained from the X server,
6750 * so reflects the latest position of @window; this may be out-of-sync
6751 * with the position of @window delivered in the most-recently-processed
6752 * #GdkEventConfigure. gdk_window_get_position() in contrast gets the
6753 * position from the most recent configure event.
6756 * If @window is not a toplevel, it is <emphasis>much</emphasis> better
6757 * to call gdk_window_get_position(), gdk_window_get_width() and
6758 * gdk_window_get_height() instead, because it avoids the roundtrip to
6759 * the X server and because these functions support the full 32-bit
6760 * coordinate space, whereas gdk_window_get_geometry() is restricted to
6761 * the 16-bit coordinates of X11.
6765 gdk_window_get_geometry (GdkWindow *window,
6772 GdkWindowImplClass *impl_class;
6776 GDK_NOTE (MULTIHEAD,
6777 g_message ("gdk_window_get_geometry(): Window needs "
6778 "to be non-NULL to be multi head safe"));
6779 window = gdk_screen_get_root_window ((gdk_screen_get_default ()));
6782 g_return_if_fail (GDK_IS_WINDOW (window));
6784 if (!GDK_WINDOW_DESTROYED (window))
6786 if (gdk_window_has_impl (window))
6788 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6789 impl_class->get_geometry (window, x, y,
6791 /* This reports the position wrt to the native parent, we need to convert
6792 it to be relative to the client side parent */
6793 parent = window->parent;
6794 if (parent && !gdk_window_has_impl (parent))
6797 *x -= parent->abs_x;
6799 *y -= parent->abs_y;
6809 *width = window->width;
6811 *height = window->height;
6817 * gdk_window_get_width:
6818 * @window: a #GdkWindow
6820 * Returns the width of the given @window.
6822 * On the X11 platform the returned size is the size reported in the
6823 * most-recently-processed configure event, rather than the current
6824 * size on the X server.
6826 * Returns: The width of @window
6831 gdk_window_get_width (GdkWindow *window)
6833 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
6835 return window->width;
6839 * gdk_window_get_height:
6840 * @window: a #GdkWindow
6842 * Returns the height of the given @window.
6844 * On the X11 platform the returned size is the size reported in the
6845 * most-recently-processed configure event, rather than the current
6846 * size on the X server.
6848 * Returns: The height of @window
6853 gdk_window_get_height (GdkWindow *window)
6855 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
6857 return window->height;
6861 * gdk_window_get_origin:
6862 * @window: a #GdkWindow
6863 * @x: (out) (allow-none): return location for X coordinate
6864 * @y: (out) (allow-none): return location for Y coordinate
6866 * Obtains the position of a window in root window coordinates.
6867 * (Compare with gdk_window_get_position() and
6868 * gdk_window_get_geometry() which return the position of a window
6869 * relative to its parent window.)
6871 * Return value: not meaningful, ignore
6874 gdk_window_get_origin (GdkWindow *window,
6878 GdkWindowImplClass *impl_class;
6880 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
6882 if (GDK_WINDOW_DESTROYED (window))
6891 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6892 impl_class->get_root_coords (window,
6901 * gdk_window_get_root_coords:
6902 * @window: a #GdkWindow
6903 * @x: X coordinate in window
6904 * @y: Y coordinate in window
6905 * @root_x: (out): return location for X coordinate
6906 * @root_y: (out): return location for Y coordinate
6908 * Obtains the position of a window position in root
6909 * window coordinates. This is similar to
6910 * gdk_window_get_origin() but allows you go pass
6911 * in any position in the window, not just the origin.
6916 gdk_window_get_root_coords (GdkWindow *window,
6922 GdkWindowImplClass *impl_class;
6924 g_return_if_fail (GDK_IS_WINDOW (window));
6926 if (GDK_WINDOW_DESTROYED (window))
6935 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6936 impl_class->get_root_coords (window,
6943 * gdk_window_coords_to_parent:
6944 * @window: a child window
6945 * @x: X coordinate in child's coordinate system
6946 * @y: Y coordinate in child's coordinate system
6947 * @parent_x: (out) (allow-none): return location for X coordinate
6948 * in parent's coordinate system, or %NULL
6949 * @parent_y: (out) (allow-none): return location for Y coordinate
6950 * in parent's coordinate system, or %NULL
6952 * Transforms window coordinates from a child window to its parent
6953 * window, where the parent window is the normal parent as returned by
6954 * gdk_window_get_parent() for normal windows, and the window's
6955 * embedder as returned by gdk_offscreen_window_get_embedder() for
6956 * offscreen windows.
6958 * For normal windows, calling this function is equivalent to adding
6959 * the return values of gdk_window_get_position() to the child coordinates.
6960 * For offscreen windows however (which can be arbitrarily transformed),
6961 * this function calls the GdkWindow::to-embedder: signal to translate
6964 * You should always use this function when writing generic code that
6965 * walks up a window hierarchy.
6967 * See also: gdk_window_coords_from_parent()
6972 gdk_window_coords_to_parent (GdkWindow *window,
6978 g_return_if_fail (GDK_IS_WINDOW (window));
6980 if (gdk_window_is_offscreen (window))
6984 to_embedder (window, x, y, &px, &py);
6995 *parent_x = x + window->x;
6998 *parent_y = y + window->y;
7003 * gdk_window_coords_from_parent:
7004 * @window: a child window
7005 * @parent_x: X coordinate in parent's coordinate system
7006 * @parent_y: Y coordinate in parent's coordinate system
7007 * @x: (out) (allow-none): return location for X coordinate in child's coordinate system
7008 * @y: (out) (allow-none): return location for Y coordinate in child's coordinate system
7010 * Transforms window coordinates from a parent window to a child
7011 * window, where the parent window is the normal parent as returned by
7012 * gdk_window_get_parent() for normal windows, and the window's
7013 * embedder as returned by gdk_offscreen_window_get_embedder() for
7014 * offscreen windows.
7016 * For normal windows, calling this function is equivalent to subtracting
7017 * the return values of gdk_window_get_position() from the parent coordinates.
7018 * For offscreen windows however (which can be arbitrarily transformed),
7019 * this function calls the GdkWindow::from-embedder: signal to translate
7022 * You should always use this function when writing generic code that
7023 * walks down a window hierarchy.
7025 * See also: gdk_window_coords_to_parent()
7030 gdk_window_coords_from_parent (GdkWindow *window,
7036 g_return_if_fail (GDK_IS_WINDOW (window));
7038 if (gdk_window_is_offscreen (window))
7042 from_embedder (window, parent_x, parent_y, &cx, &cy);
7053 *x = parent_x - window->x;
7056 *y = parent_y - window->y;
7061 * gdk_window_shape_combine_region:
7062 * @window: a #GdkWindow
7063 * @shape_region: (allow-none): region of window to be non-transparent
7064 * @offset_x: X position of @shape_region in @window coordinates
7065 * @offset_y: Y position of @shape_region in @window coordinates
7067 * Makes pixels in @window outside @shape_region be transparent,
7068 * so that the window may be nonrectangular.
7070 * If @shape_region is %NULL, the shape will be unset, so the whole
7071 * window will be opaque again. @offset_x and @offset_y are ignored
7072 * if @shape_region is %NULL.
7074 * On the X11 platform, this uses an X server extension which is
7075 * widely available on most common platforms, but not available on
7076 * very old X servers, and occasionally the implementation will be
7077 * buggy. On servers without the shape extension, this function
7080 * This function works on both toplevel and child windows.
7083 gdk_window_shape_combine_region (GdkWindow *window,
7084 const cairo_region_t *shape_region,
7088 cairo_region_t *old_region, *new_region, *diff;
7090 g_return_if_fail (GDK_IS_WINDOW (window));
7092 if (GDK_WINDOW_DESTROYED (window))
7095 if (!window->shape && shape_region == NULL)
7098 window->shaped = (shape_region != NULL);
7101 cairo_region_destroy (window->shape);
7104 if (GDK_WINDOW_IS_MAPPED (window))
7105 old_region = cairo_region_copy (window->clip_region);
7109 window->shape = cairo_region_copy (shape_region);
7110 cairo_region_translate (window->shape, offset_x, offset_y);
7113 window->shape = NULL;
7115 recompute_visible_regions (window, TRUE, FALSE);
7117 if (gdk_window_has_impl (window) &&
7118 !should_apply_clip_as_shape (window))
7119 apply_shape (window, window->shape);
7123 new_region = cairo_region_copy (window->clip_region);
7125 /* New area in the window, needs invalidation */
7126 diff = cairo_region_copy (new_region);
7127 cairo_region_subtract (diff, old_region);
7129 gdk_window_invalidate_region_full (window, diff, TRUE, CLEAR_BG_ALL);
7131 cairo_region_destroy (diff);
7133 if (!gdk_window_is_toplevel (window))
7135 /* New area in the non-root parent window, needs invalidation */
7136 diff = cairo_region_copy (old_region);
7137 cairo_region_subtract (diff, new_region);
7139 /* Adjust region to parent window coords */
7140 cairo_region_translate (diff, window->x, window->y);
7142 gdk_window_invalidate_region_full (window->parent, diff, TRUE, CLEAR_BG_ALL);
7144 cairo_region_destroy (diff);
7147 cairo_region_destroy (new_region);
7148 cairo_region_destroy (old_region);
7153 do_child_shapes (GdkWindow *window,
7157 cairo_region_t *region;
7161 r.width = window->width;
7162 r.height = window->height;
7164 region = cairo_region_create_rectangle (&r);
7165 remove_child_area (window, NULL, FALSE, region);
7167 if (merge && window->shape)
7168 cairo_region_subtract (region, window->shape);
7170 gdk_window_shape_combine_region (window, region, 0, 0);
7174 * gdk_window_set_child_shapes:
7175 * @window: a #GdkWindow
7177 * Sets the shape mask of @window to the union of shape masks
7178 * for all children of @window, ignoring the shape mask of @window
7179 * itself. Contrast with gdk_window_merge_child_shapes() which includes
7180 * the shape mask of @window in the masks to be merged.
7183 gdk_window_set_child_shapes (GdkWindow *window)
7185 g_return_if_fail (GDK_IS_WINDOW (window));
7187 do_child_shapes (window, FALSE);
7191 * gdk_window_merge_child_shapes:
7192 * @window: a #GdkWindow
7194 * Merges the shape masks for any child windows into the
7195 * shape mask for @window. i.e. the union of all masks
7196 * for @window and its children will become the new mask
7197 * for @window. See gdk_window_shape_combine_region().
7199 * This function is distinct from gdk_window_set_child_shapes()
7200 * because it includes @window's shape mask in the set of shapes to
7204 gdk_window_merge_child_shapes (GdkWindow *window)
7206 g_return_if_fail (GDK_IS_WINDOW (window));
7208 do_child_shapes (window, TRUE);
7212 * gdk_window_input_shape_combine_region:
7213 * @window: a #GdkWindow
7214 * @shape_region: region of window to be non-transparent
7215 * @offset_x: X position of @shape_region in @window coordinates
7216 * @offset_y: Y position of @shape_region in @window coordinates
7218 * Like gdk_window_shape_combine_region(), but the shape applies
7219 * only to event handling. Mouse events which happen while
7220 * the pointer position corresponds to an unset bit in the
7221 * mask will be passed on the window below @window.
7223 * An input shape is typically used with RGBA windows.
7224 * The alpha channel of the window defines which pixels are
7225 * invisible and allows for nicely antialiased borders,
7226 * and the input shape controls where the window is
7229 * On the X11 platform, this requires version 1.1 of the
7232 * On the Win32 platform, this functionality is not present and the
7233 * function does nothing.
7238 gdk_window_input_shape_combine_region (GdkWindow *window,
7239 const cairo_region_t *shape_region,
7243 GdkWindowImplClass *impl_class;
7245 g_return_if_fail (GDK_IS_WINDOW (window));
7247 if (GDK_WINDOW_DESTROYED (window))
7250 if (window->input_shape)
7251 cairo_region_destroy (window->input_shape);
7255 window->input_shape = cairo_region_copy (shape_region);
7256 cairo_region_translate (window->input_shape, offset_x, offset_y);
7259 window->input_shape = NULL;
7261 if (gdk_window_has_impl (window))
7263 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7264 impl_class->input_shape_combine_region (window, window->input_shape, 0, 0);
7267 /* Pointer may have e.g. moved outside window due to the input mask change */
7268 _gdk_synthesize_crossing_events_for_geometry_change (window);
7272 do_child_input_shapes (GdkWindow *window,
7276 cairo_region_t *region;
7280 r.width = window->width;
7281 r.height = window->height;
7283 region = cairo_region_create_rectangle (&r);
7284 remove_child_area (window, NULL, TRUE, region);
7286 if (merge && window->shape)
7287 cairo_region_subtract (region, window->shape);
7288 if (merge && window->input_shape)
7289 cairo_region_subtract (region, window->input_shape);
7291 gdk_window_input_shape_combine_region (window, region, 0, 0);
7296 * gdk_window_set_child_input_shapes:
7297 * @window: a #GdkWindow
7299 * Sets the input shape mask of @window to the union of input shape masks
7300 * for all children of @window, ignoring the input shape mask of @window
7301 * itself. Contrast with gdk_window_merge_child_input_shapes() which includes
7302 * the input shape mask of @window in the masks to be merged.
7307 gdk_window_set_child_input_shapes (GdkWindow *window)
7309 g_return_if_fail (GDK_IS_WINDOW (window));
7311 do_child_input_shapes (window, FALSE);
7315 * gdk_window_merge_child_input_shapes:
7316 * @window: a #GdkWindow
7318 * Merges the input shape masks for any child windows into the
7319 * input shape mask for @window. i.e. the union of all input masks
7320 * for @window and its children will become the new input mask
7321 * for @window. See gdk_window_input_shape_combine_region().
7323 * This function is distinct from gdk_window_set_child_input_shapes()
7324 * because it includes @window's input shape mask in the set of
7325 * shapes to be merged.
7330 gdk_window_merge_child_input_shapes (GdkWindow *window)
7332 g_return_if_fail (GDK_IS_WINDOW (window));
7334 do_child_input_shapes (window, TRUE);
7339 * gdk_window_set_static_gravities:
7340 * @window: a #GdkWindow
7341 * @use_static: %TRUE to turn on static gravity
7343 * Set the bit gravity of the given window to static, and flag it so
7344 * all children get static subwindow gravity. This is used if you are
7345 * implementing scary features that involve deep knowledge of the
7346 * windowing system. Don't worry about it unless you have to.
7348 * Return value: %TRUE if the server supports static gravity
7351 gdk_window_set_static_gravities (GdkWindow *window,
7352 gboolean use_static)
7354 GdkWindowImplClass *impl_class;
7356 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7358 if (gdk_window_has_impl (window))
7360 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7361 return impl_class->set_static_gravities (window, use_static);
7368 * gdk_window_get_composited:
7369 * @window: a #GdkWindow
7371 * Determines whether @window is composited.
7373 * See gdk_window_set_composited().
7375 * Returns: %TRUE if the window is composited.
7380 gdk_window_get_composited (GdkWindow *window)
7382 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7384 return window->composited;
7388 * gdk_window_set_composited:
7389 * @window: a #GdkWindow
7390 * @composited: %TRUE to set the window as composited
7392 * Sets a #GdkWindow as composited, or unsets it. Composited
7393 * windows do not automatically have their contents drawn to
7394 * the screen. Drawing is redirected to an offscreen buffer
7395 * and an expose event is emitted on the parent of the composited
7396 * window. It is the responsibility of the parent's expose handler
7397 * to manually merge the off-screen content onto the screen in
7398 * whatever way it sees fit. See <xref linkend="composited-window-example"/>
7401 * It only makes sense for child windows to be composited; see
7402 * gdk_window_set_opacity() if you need translucent toplevel
7405 * An additional effect of this call is that the area of this
7406 * window is no longer clipped from regions marked for
7407 * invalidation on its parent. Draws done on the parent
7408 * window are also no longer clipped by the child.
7410 * This call is only supported on some systems (currently,
7411 * only X11 with new enough Xcomposite and Xdamage extensions).
7412 * You must call gdk_display_supports_composite() to check if
7413 * setting a window as composited is supported before
7414 * attempting to do so.
7419 gdk_window_set_composited (GdkWindow *window,
7420 gboolean composited)
7422 GdkDisplay *display;
7423 GdkWindowImplClass *impl_class;
7425 g_return_if_fail (GDK_IS_WINDOW (window));
7427 composited = composited != FALSE;
7429 if (window->composited == composited)
7433 gdk_window_ensure_native (window);
7435 display = gdk_window_get_display (window);
7437 impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7439 if (composited && (!gdk_display_supports_composite (display) || !impl_class->set_composited))
7441 g_warning ("gdk_window_set_composited called but "
7442 "compositing is not supported");
7446 impl_class->set_composited (window, composited);
7448 recompute_visible_regions (window, TRUE, FALSE);
7450 if (GDK_WINDOW_IS_MAPPED (window))
7451 gdk_window_invalidate_in_parent (window);
7453 window->composited = composited;
7457 * gdk_window_get_modal_hint:
7458 * @window: A toplevel #GdkWindow.
7460 * Determines whether or not the window manager is hinted that @window
7461 * has modal behaviour.
7463 * Return value: whether or not the window has the modal hint set.
7468 gdk_window_get_modal_hint (GdkWindow *window)
7470 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7472 return window->modal_hint;
7476 * gdk_window_get_accept_focus:
7477 * @window: a toplevel #GdkWindow.
7479 * Determines whether or not the desktop environment shuld be hinted that
7480 * the window does not want to receive input focus.
7482 * Return value: whether or not the window should receive input focus.
7487 gdk_window_get_accept_focus (GdkWindow *window)
7489 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7491 return window->accept_focus;
7495 * gdk_window_get_focus_on_map:
7496 * @window: a toplevel #GdkWindow.
7498 * Determines whether or not the desktop environment should be hinted that the
7499 * window does not want to receive input focus when it is mapped.
7501 * Return value: whether or not the window wants to receive input focus when
7507 gdk_window_get_focus_on_map (GdkWindow *window)
7509 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7511 return window->focus_on_map;
7515 * gdk_window_is_input_only:
7516 * @window: a toplevel #GdkWindow
7518 * Determines whether or not the window is an input only window.
7520 * Return value: %TRUE if @window is input only
7525 gdk_window_is_input_only (GdkWindow *window)
7527 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7529 return window->input_only;
7533 * gdk_window_is_shaped:
7534 * @window: a toplevel #GdkWindow
7536 * Determines whether or not the window is shaped.
7538 * Return value: %TRUE if @window is shaped
7543 gdk_window_is_shaped (GdkWindow *window)
7545 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7547 return window->shaped;
7551 window_get_size_rectangle (GdkWindow *window,
7554 rect->x = rect->y = 0;
7555 rect->width = window->width;
7556 rect->height = window->height;
7559 /* Calculates the real clipping region for a window, in window coordinates,
7560 * taking into account other windows, gc clip region and gc clip mask.
7563 _gdk_window_calculate_full_clip_region (GdkWindow *window,
7564 GdkWindow *base_window,
7565 gboolean do_children,
7566 gint *base_x_offset,
7567 gint *base_y_offset)
7569 GdkRectangle visible_rect;
7570 cairo_region_t *real_clip_region;
7571 gint x_offset, y_offset;
7572 GdkWindow *parentwin, *lastwin;
7579 if (!window->viewable || window->input_only)
7580 return cairo_region_create ();
7582 window_get_size_rectangle (window, &visible_rect);
7584 /* real_clip_region is in window coordinates */
7585 real_clip_region = cairo_region_create_rectangle (&visible_rect);
7587 x_offset = y_offset = 0;
7591 parentwin = lastwin;
7593 parentwin = lastwin->parent;
7595 /* Remove the areas of all overlapping windows above parentwin in the hiearachy */
7596 for (; parentwin != NULL &&
7597 (parentwin == window || lastwin != base_window);
7598 lastwin = parentwin, parentwin = lastwin->parent)
7601 GdkRectangle real_clip_rect;
7603 if (parentwin != window)
7605 x_offset += lastwin->x;
7606 y_offset += lastwin->y;
7609 /* children is ordered in reverse stack order */
7610 for (cur = parentwin->children;
7611 cur && cur->data != lastwin;
7614 GdkWindow *child = cur->data;
7616 if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only)
7619 /* Ignore offscreen children, as they don't draw in their parent and
7620 * don't take part in the clipping */
7621 if (gdk_window_is_offscreen (child))
7624 window_get_size_rectangle (child, &visible_rect);
7626 /* Convert rect to "window" coords */
7627 visible_rect.x += child->x - x_offset;
7628 visible_rect.y += child->y - y_offset;
7630 /* This shortcut is really necessary for performance when there are a lot of windows */
7631 cairo_region_get_extents (real_clip_region, &real_clip_rect);
7632 if (visible_rect.x >= real_clip_rect.x + real_clip_rect.width ||
7633 visible_rect.x + visible_rect.width <= real_clip_rect.x ||
7634 visible_rect.y >= real_clip_rect.y + real_clip_rect.height ||
7635 visible_rect.y + visible_rect.height <= real_clip_rect.y)
7638 cairo_region_subtract_rectangle (real_clip_region, &visible_rect);
7641 /* Clip to the parent */
7642 window_get_size_rectangle ((GdkWindow *)parentwin, &visible_rect);
7643 /* Convert rect to "window" coords */
7644 visible_rect.x += - x_offset;
7645 visible_rect.y += - y_offset;
7647 cairo_region_intersect_rectangle (real_clip_region, &visible_rect);
7651 *base_x_offset = x_offset;
7653 *base_y_offset = y_offset;
7655 return real_clip_region;
7659 _gdk_window_add_damage (GdkWindow *toplevel,
7660 cairo_region_t *damaged_region)
7662 GdkDisplay *display;
7663 GdkEvent event = { 0, };
7664 event.expose.type = GDK_DAMAGE;
7665 event.expose.window = toplevel;
7666 event.expose.send_event = FALSE;
7667 event.expose.region = damaged_region;
7668 cairo_region_get_extents (event.expose.region, &event.expose.area);
7669 display = gdk_window_get_display (event.expose.window);
7670 _gdk_event_queue_append (display, gdk_event_copy (&event));
7673 /* Gets the toplevel for a window as used for events,
7674 i.e. including offscreen parents */
7676 get_event_parent (GdkWindow *window)
7678 if (gdk_window_is_offscreen (window))
7679 return gdk_offscreen_window_get_embedder ((GdkWindow *)window);
7681 return window->parent;
7684 /* Gets the toplevel for a window as used for events,
7685 i.e. including offscreen parents going up to the native
7688 get_event_toplevel (GdkWindow *window)
7692 while ((parent = get_event_parent (window)) != NULL &&
7693 (parent->window_type != GDK_WINDOW_ROOT))
7700 _gdk_window_event_parent_of (GdkWindow *parent,
7711 w = get_event_parent (w);
7718 update_cursor (GdkDisplay *display,
7721 GdkWindow *cursor_window, *parent, *toplevel;
7722 GdkWindow *pointer_window;
7723 GdkWindowImplClass *impl_class;
7724 GdkPointerWindowInfo *pointer_info;
7725 GdkDeviceGrabInfo *grab;
7728 pointer_info = _gdk_display_get_pointer_info (display, device);
7729 pointer_window = pointer_info->window_under_pointer;
7731 /* We ignore the serials here and just pick the last grab
7732 we've sent, as that would shortly be used anyway. */
7733 grab = _gdk_display_get_last_device_grab (display, device);
7736 /* the pointer is not in a descendant of the grab window */
7737 !_gdk_window_event_parent_of (grab->window, pointer_window))
7739 /* use the cursor from the grab window */
7740 cursor_window = grab->window;
7744 /* otherwise use the cursor from the pointer window */
7745 cursor_window = pointer_window;
7748 /* Find the first window with the cursor actually set, as
7749 the cursor is inherited from the parent */
7750 while (cursor_window->cursor == NULL &&
7751 (parent = get_event_parent (cursor_window)) != NULL &&
7752 parent->window_type != GDK_WINDOW_ROOT)
7753 cursor_window = parent;
7755 cursor = g_hash_table_lookup (cursor_window->device_cursor, device);
7758 cursor = cursor_window->cursor;
7760 /* Set all cursors on toplevel, otherwise its tricky to keep track of
7761 * which native window has what cursor set. */
7762 toplevel = get_event_toplevel (pointer_window);
7763 impl_class = GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl);
7764 impl_class->set_device_cursor (toplevel, device, cursor);
7768 point_in_window (GdkWindow *window,
7773 x >= 0 && x < window->width &&
7774 y >= 0 && y < window->height &&
7775 (window->shape == NULL ||
7776 cairo_region_contains_point (window->shape,
7778 (window->input_shape == NULL ||
7779 cairo_region_contains_point (window->input_shape,
7784 convert_native_coords_to_toplevel (GdkWindow *window,
7787 gdouble *toplevel_x,
7788 gdouble *toplevel_y)
7795 while (!gdk_window_is_toplevel (window))
7799 window = window->parent;
7809 convert_toplevel_coords_to_window (GdkWindow *window,
7817 GList *children, *l;
7823 while ((parent = get_event_parent (window)) != NULL &&
7824 (parent->window_type != GDK_WINDOW_ROOT))
7826 children = g_list_prepend (children, window);
7830 for (l = children; l != NULL; l = l->next)
7831 gdk_window_coords_from_parent (l->data, x, y, &x, &y);
7833 g_list_free (children);
7840 pick_embedded_child (GdkWindow *window,
7847 g_signal_emit (window,
7848 signals[PICK_EMBEDDED_CHILD], 0,
7855 _gdk_window_find_child_at (GdkWindow *window,
7860 double child_x, child_y;
7863 if (point_in_window (window, x, y))
7865 /* Children is ordered in reverse stack order, i.e. first is topmost */
7866 for (l = window->children; l != NULL; l = l->next)
7870 if (!GDK_WINDOW_IS_MAPPED (sub))
7873 gdk_window_coords_from_parent ((GdkWindow *)sub,
7875 &child_x, &child_y);
7876 if (point_in_window (sub, child_x, child_y))
7877 return (GdkWindow *)sub;
7880 if (window->num_offscreen_children > 0)
7882 sub = pick_embedded_child (window,
7885 return (GdkWindow *)sub;
7893 _gdk_window_find_descendant_at (GdkWindow *window,
7900 gdouble child_x, child_y;
7904 if (point_in_window (window, x, y))
7909 /* Children is ordered in reverse stack order, i.e. first is topmost */
7910 for (l = window->children; l != NULL; l = l->next)
7914 if (!GDK_WINDOW_IS_MAPPED (sub))
7917 gdk_window_coords_from_parent ((GdkWindow *)sub,
7919 &child_x, &child_y);
7920 if (point_in_window (sub, child_x, child_y))
7930 window->num_offscreen_children > 0)
7932 sub = pick_embedded_child (window,
7938 from_embedder (sub, x, y, &x, &y);
7946 /* Not in window at all */
7960 * @window: a toplevel #GdkWindow
7962 * Emits a short beep associated to @window in the appropriate
7963 * display, if supported. Otherwise, emits a short beep on
7964 * the display just as gdk_display_beep().
7969 gdk_window_beep (GdkWindow *window)
7971 GdkDisplay *display;
7972 GdkWindow *toplevel;
7974 g_return_if_fail (GDK_IS_WINDOW (window));
7976 if (GDK_WINDOW_DESTROYED (window))
7979 toplevel = get_event_toplevel (window);
7980 display = gdk_window_get_display (window);
7984 if (GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl)->beep (toplevel))
7988 /* If windows fail to beep, we beep the display. */
7989 gdk_display_beep (display);
7993 * gdk_window_set_support_multidevice:
7994 * @window: a #GdkWindow.
7995 * @support_multidevice: %TRUE to enable multidevice support in @window.
7997 * This function will enable multidevice features in @window.
7999 * Multidevice aware windows will need to handle properly multiple,
8000 * per device enter/leave events, device grabs and grab ownerships.
8005 gdk_window_set_support_multidevice (GdkWindow *window,
8006 gboolean support_multidevice)
8008 g_return_if_fail (GDK_IS_WINDOW (window));
8010 if (GDK_WINDOW_DESTROYED (window))
8013 if (window->support_multidevice == support_multidevice)
8016 window->support_multidevice = support_multidevice;
8018 /* FIXME: What to do if called when some pointers are inside the window ? */
8022 * gdk_window_get_support_multidevice:
8023 * @window: a #GdkWindow.
8025 * Returns %TRUE if the window is aware of the existence of multiple
8028 * Returns: %TRUE if the window handles multidevice features.
8033 gdk_window_get_support_multidevice (GdkWindow *window)
8035 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
8037 if (GDK_WINDOW_DESTROYED (window))
8040 return window->support_multidevice;
8043 static const guint type_masks[] = {
8044 GDK_SUBSTRUCTURE_MASK, /* GDK_DELETE = 0 */
8045 GDK_STRUCTURE_MASK, /* GDK_DESTROY = 1 */
8046 GDK_EXPOSURE_MASK, /* GDK_EXPOSE = 2 */
8047 GDK_POINTER_MOTION_MASK, /* GDK_MOTION_NOTIFY = 3 */
8048 GDK_BUTTON_PRESS_MASK, /* GDK_BUTTON_PRESS = 4 */
8049 GDK_BUTTON_PRESS_MASK, /* GDK_2BUTTON_PRESS = 5 */
8050 GDK_BUTTON_PRESS_MASK, /* GDK_3BUTTON_PRESS = 6 */
8051 GDK_BUTTON_RELEASE_MASK, /* GDK_BUTTON_RELEASE = 7 */
8052 GDK_KEY_PRESS_MASK, /* GDK_KEY_PRESS = 8 */
8053 GDK_KEY_RELEASE_MASK, /* GDK_KEY_RELEASE = 9 */
8054 GDK_ENTER_NOTIFY_MASK, /* GDK_ENTER_NOTIFY = 10 */
8055 GDK_LEAVE_NOTIFY_MASK, /* GDK_LEAVE_NOTIFY = 11 */
8056 GDK_FOCUS_CHANGE_MASK, /* GDK_FOCUS_CHANGE = 12 */
8057 GDK_STRUCTURE_MASK, /* GDK_CONFIGURE = 13 */
8058 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_MAP = 14 */
8059 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_UNMAP = 15 */
8060 GDK_PROPERTY_CHANGE_MASK, /* GDK_PROPERTY_NOTIFY = 16 */
8061 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_CLEAR = 17 */
8062 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_REQUEST = 18 */
8063 GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_NOTIFY = 19 */
8064 GDK_PROXIMITY_IN_MASK, /* GDK_PROXIMITY_IN = 20 */
8065 GDK_PROXIMITY_OUT_MASK, /* GDK_PROXIMITY_OUT = 21 */
8066 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_ENTER = 22 */
8067 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_LEAVE = 23 */
8068 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_MOTION = 24 */
8069 GDK_ALL_EVENTS_MASK, /* GDK_DRAG_STATUS = 25 */
8070 GDK_ALL_EVENTS_MASK, /* GDK_DROP_START = 26 */
8071 GDK_ALL_EVENTS_MASK, /* GDK_DROP_FINISHED = 27 */
8072 GDK_ALL_EVENTS_MASK, /* GDK_CLIENT_EVENT = 28 */
8073 GDK_VISIBILITY_NOTIFY_MASK, /* GDK_VISIBILITY_NOTIFY = 29 */
8074 GDK_EXPOSURE_MASK, /* GDK_NO_EXPOSE = 30 */
8075 GDK_SCROLL_MASK | GDK_BUTTON_PRESS_MASK,/* GDK_SCROLL= 31 */
8076 0, /* GDK_WINDOW_STATE = 32 */
8077 0, /* GDK_SETTING = 33 */
8078 0, /* GDK_OWNER_CHANGE = 34 */
8079 0, /* GDK_GRAB_BROKEN = 35 */
8080 0, /* GDK_DAMAGE = 36 */
8082 G_STATIC_ASSERT (G_N_ELEMENTS (type_masks) == GDK_EVENT_LAST);
8084 /* send motion events if the right buttons are down */
8086 update_evmask_for_button_motion (guint evmask,
8087 GdkModifierType mask)
8089 if (evmask & GDK_BUTTON_MOTION_MASK &&
8090 mask & (GDK_BUTTON1_MASK |
8095 evmask |= GDK_POINTER_MOTION_MASK;
8097 if ((evmask & GDK_BUTTON1_MOTION_MASK && mask & GDK_BUTTON1_MASK) ||
8098 (evmask & GDK_BUTTON2_MOTION_MASK && mask & GDK_BUTTON2_MASK) ||
8099 (evmask & GDK_BUTTON3_MOTION_MASK && mask & GDK_BUTTON3_MASK))
8100 evmask |= GDK_POINTER_MOTION_MASK;
8106 is_button_type (GdkEventType type)
8108 return type == GDK_BUTTON_PRESS ||
8109 type == GDK_2BUTTON_PRESS ||
8110 type == GDK_3BUTTON_PRESS ||
8111 type == GDK_BUTTON_RELEASE ||
8116 is_motion_type (GdkEventType type)
8118 return type == GDK_MOTION_NOTIFY ||
8119 type == GDK_ENTER_NOTIFY ||
8120 type == GDK_LEAVE_NOTIFY;
8124 find_common_ancestor (GdkWindow *win1,
8128 GList *path1 = NULL, *path2 = NULL;
8129 GList *list1, *list2;
8132 while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8134 path1 = g_list_prepend (path1, tmp);
8135 tmp = get_event_parent (tmp);
8139 while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8141 path2 = g_list_prepend (path2, tmp);
8142 tmp = get_event_parent (tmp);
8148 while (list1 && list2 && (list1->data == list2->data))
8151 list1 = g_list_next (list1);
8152 list2 = g_list_next (list2);
8154 g_list_free (path1);
8155 g_list_free (path2);
8161 _gdk_make_event (GdkWindow *window,
8163 GdkEvent *event_in_queue,
8164 gboolean before_event)
8166 GdkEvent *event = gdk_event_new (type);
8168 GdkModifierType the_state;
8170 the_time = gdk_event_get_time (event_in_queue);
8171 gdk_event_get_state (event_in_queue, &the_state);
8173 event->any.window = g_object_ref (window);
8174 event->any.send_event = FALSE;
8175 if (event_in_queue && event_in_queue->any.send_event)
8176 event->any.send_event = TRUE;
8180 case GDK_MOTION_NOTIFY:
8181 event->motion.time = the_time;
8182 event->motion.axes = NULL;
8183 event->motion.state = the_state;
8186 case GDK_BUTTON_PRESS:
8187 case GDK_2BUTTON_PRESS:
8188 case GDK_3BUTTON_PRESS:
8189 case GDK_BUTTON_RELEASE:
8190 event->button.time = the_time;
8191 event->button.axes = NULL;
8192 event->button.state = the_state;
8196 event->scroll.time = the_time;
8197 event->scroll.state = the_state;
8201 case GDK_KEY_RELEASE:
8202 event->key.time = the_time;
8203 event->key.state = the_state;
8206 case GDK_ENTER_NOTIFY:
8207 case GDK_LEAVE_NOTIFY:
8208 event->crossing.time = the_time;
8209 event->crossing.state = the_state;
8212 case GDK_PROPERTY_NOTIFY:
8213 event->property.time = the_time;
8214 event->property.state = the_state;
8217 case GDK_SELECTION_CLEAR:
8218 case GDK_SELECTION_REQUEST:
8219 case GDK_SELECTION_NOTIFY:
8220 event->selection.time = the_time;
8223 case GDK_PROXIMITY_IN:
8224 case GDK_PROXIMITY_OUT:
8225 event->proximity.time = the_time;
8228 case GDK_DRAG_ENTER:
8229 case GDK_DRAG_LEAVE:
8230 case GDK_DRAG_MOTION:
8231 case GDK_DRAG_STATUS:
8232 case GDK_DROP_START:
8233 case GDK_DROP_FINISHED:
8234 event->dnd.time = the_time;
8237 case GDK_FOCUS_CHANGE:
8241 case GDK_CLIENT_EVENT:
8242 case GDK_VISIBILITY_NOTIFY:
8253 _gdk_event_queue_insert_before (gdk_window_get_display (window), event_in_queue, event);
8255 _gdk_event_queue_insert_after (gdk_window_get_display (window), event_in_queue, event);
8258 _gdk_event_queue_append (gdk_window_get_display (window), event);
8264 send_crossing_event (GdkDisplay *display,
8265 GdkWindow *toplevel,
8268 GdkCrossingMode mode,
8269 GdkNotifyType notify_type,
8270 GdkWindow *subwindow,
8272 GdkDevice *source_device,
8275 GdkModifierType mask,
8277 GdkEvent *event_in_queue,
8281 guint32 window_event_mask, type_event_mask;
8282 GdkDeviceGrabInfo *grab;
8283 gboolean block_event = FALSE;
8285 grab = _gdk_display_has_device_grab (display, device, serial);
8288 !grab->owner_events)
8290 /* !owner_event => only report events wrt grab window, ignore rest */
8291 if ((GdkWindow *)window != grab->window)
8293 window_event_mask = grab->event_mask;
8296 window_event_mask = window->event_mask;
8298 if (type == GDK_LEAVE_NOTIFY)
8300 type_event_mask = GDK_LEAVE_NOTIFY_MASK;
8301 window->devices_inside = g_list_remove (window->devices_inside, device);
8303 if (!window->support_multidevice && window->devices_inside)
8305 /* Block leave events unless it's the last pointer */
8311 type_event_mask = GDK_ENTER_NOTIFY_MASK;
8313 if (!window->support_multidevice && window->devices_inside)
8315 /* Only emit enter events for the first device */
8319 if (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER &&
8320 gdk_device_get_mode (device) != GDK_MODE_DISABLED &&
8321 !g_list_find (window->devices_inside, device))
8322 window->devices_inside = g_list_prepend (window->devices_inside, device);
8328 if (window_event_mask & type_event_mask)
8330 event = _gdk_make_event ((GdkWindow *)window, type, event_in_queue, TRUE);
8331 gdk_event_set_device (event, device);
8334 gdk_event_set_source_device (event, source_device);
8336 event->crossing.time = time_;
8337 event->crossing.subwindow = subwindow;
8339 g_object_ref (subwindow);
8340 convert_toplevel_coords_to_window ((GdkWindow *)window,
8341 toplevel_x, toplevel_y,
8342 &event->crossing.x, &event->crossing.y);
8343 event->crossing.x_root = toplevel_x + toplevel->x;
8344 event->crossing.y_root = toplevel_y + toplevel->y;
8345 event->crossing.mode = mode;
8346 event->crossing.detail = notify_type;
8347 event->crossing.focus = FALSE;
8348 event->crossing.state = mask;
8353 /* The coordinates are in the toplevel window that src/dest are in.
8354 * src and dest are always (if != NULL) in the same toplevel, as
8355 * we get a leave-notify and set the window_under_pointer to null
8356 * before crossing to another toplevel.
8359 _gdk_synthesize_crossing_events (GdkDisplay *display,
8363 GdkDevice *source_device,
8364 GdkCrossingMode mode,
8367 GdkModifierType mask,
8369 GdkEvent *event_in_queue,
8371 gboolean non_linear)
8374 GdkWindow *win, *last, *next;
8378 GdkWindow *toplevel;
8379 GdkNotifyType notify_type;
8381 /* TODO: Don't send events to toplevel, as we get those from the windowing system */
8386 return; /* No crossings generated between src and dest */
8388 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER)
8390 if (a && gdk_window_get_device_events (src, device) == 0)
8393 if (b && gdk_window_get_device_events (dest, device) == 0)
8400 c = find_common_ancestor (a, b);
8402 non_linear |= (c != a) && (c != b);
8404 if (a) /* There might not be a source (i.e. if no previous pointer_in_window) */
8406 toplevel = gdk_window_get_toplevel (a);
8408 /* Traverse up from a to (excluding) c sending leave events */
8410 notify_type = GDK_NOTIFY_NONLINEAR;
8412 notify_type = GDK_NOTIFY_INFERIOR;
8414 notify_type = GDK_NOTIFY_ANCESTOR;
8415 send_crossing_event (display, toplevel,
8416 a, GDK_LEAVE_NOTIFY,
8419 NULL, device, source_device,
8420 toplevel_x, toplevel_y,
8428 notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8430 notify_type = GDK_NOTIFY_VIRTUAL;
8433 win = get_event_parent (a);
8434 while (win != c && win->window_type != GDK_WINDOW_ROOT)
8436 send_crossing_event (display, toplevel,
8437 win, GDK_LEAVE_NOTIFY,
8441 device, source_device,
8442 toplevel_x, toplevel_y,
8448 win = get_event_parent (win);
8453 if (b) /* Might not be a dest, e.g. if we're moving out of the window */
8455 toplevel = gdk_window_get_toplevel ((GdkWindow *)b);
8457 /* Traverse down from c to b */
8461 win = get_event_parent (b);
8462 while (win != c && win->window_type != GDK_WINDOW_ROOT)
8464 path = g_list_prepend (path, win);
8465 win = get_event_parent (win);
8469 notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8471 notify_type = GDK_NOTIFY_VIRTUAL;
8477 list = g_list_next (list);
8483 send_crossing_event (display, toplevel,
8484 win, GDK_ENTER_NOTIFY,
8488 device, source_device,
8489 toplevel_x, toplevel_y,
8499 notify_type = GDK_NOTIFY_NONLINEAR;
8501 notify_type = GDK_NOTIFY_ANCESTOR;
8503 notify_type = GDK_NOTIFY_INFERIOR;
8505 send_crossing_event (display, toplevel,
8506 b, GDK_ENTER_NOTIFY,
8510 device, source_device,
8511 toplevel_x, toplevel_y,
8518 /* Returns the window inside the event window with the pointer in it
8519 * at the specified coordinates, or NULL if its not in any child of
8520 * the toplevel. It also takes into account !owner_events grabs.
8523 get_pointer_window (GdkDisplay *display,
8524 GdkWindow *event_window,
8530 GdkWindow *pointer_window;
8531 GdkDeviceGrabInfo *grab;
8532 GdkPointerWindowInfo *pointer_info;
8534 pointer_info = _gdk_display_get_pointer_info (display, device);
8536 if (event_window == pointer_info->toplevel_under_pointer)
8538 _gdk_window_find_descendant_at (event_window,
8539 toplevel_x, toplevel_y,
8542 pointer_window = NULL;
8544 grab = _gdk_display_has_device_grab (display, device, serial);
8546 !grab->owner_events &&
8547 pointer_window != grab->window)
8548 pointer_window = NULL;
8550 return pointer_window;
8554 _gdk_display_set_window_under_pointer (GdkDisplay *display,
8558 GdkPointerWindowInfo *device_info;
8560 device_info = _gdk_display_get_pointer_info (display, device);
8562 if (device_info->window_under_pointer)
8563 g_object_unref (device_info->window_under_pointer);
8564 device_info->window_under_pointer = window;
8568 g_object_ref (window);
8569 update_cursor (display, device);
8572 _gdk_display_enable_motion_hints (display, device);
8577 * @window: the #GdkWindow which will own the grab (the grab window).
8578 * @owner_events: if %FALSE then all pointer events are reported with respect to
8579 * @window and are only reported if selected by @event_mask. If %TRUE then pointer
8580 * events for this application are reported as normal, but pointer events outside
8581 * this application are reported with respect to @window and only if selected by
8582 * @event_mask. In either mode, unreported events are discarded.
8583 * @event_mask: specifies the event mask, which is used in accordance with
8584 * @owner_events. Note that only pointer events (i.e. button and motion events)
8586 * @confine_to: (allow-none): If non-%NULL, the pointer will be confined to this
8587 * window during the grab. If the pointer is outside @confine_to, it will
8588 * automatically be moved to the closest edge of @confine_to and enter
8589 * and leave events will be generated as necessary.
8590 * @cursor: (allow-none): the cursor to display while the grab is active. If this is %NULL then
8591 * the normal cursors are used for @window and its descendants, and the cursor
8592 * for @window is used for all other windows.
8593 * @time_: the timestamp of the event which led to this pointer grab. This usually
8594 * comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
8595 * the time isn't known.
8597 * Grabs the pointer (usually a mouse) so that all events are passed to this
8598 * application until the pointer is ungrabbed with gdk_pointer_ungrab(), or
8599 * the grab window becomes unviewable.
8600 * This overrides any previous pointer grab by this client.
8602 * Pointer grabs are used for operations which need complete control over mouse
8603 * events, even if the mouse leaves the application.
8604 * For example in GTK+ it is used for Drag and Drop, for dragging the handle in
8605 * the #GtkHPaned and #GtkVPaned widgets.
8607 * Note that if the event mask of an X window has selected both button press and
8608 * button release events, then a button press event will cause an automatic
8609 * pointer grab until the button is released.
8610 * X does this automatically since most applications expect to receive button
8611 * press and release events in pairs.
8612 * It is equivalent to a pointer grab on the window with @owner_events set to
8615 * If you set up anything at the time you take the grab that needs to be cleaned
8616 * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8617 * are emitted when the grab ends unvoluntarily.
8619 * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8621 * Deprecated: 3.0: Use gdk_device_grab() instead.
8624 gdk_pointer_grab (GdkWindow * window,
8625 gboolean owner_events,
8626 GdkEventMask event_mask,
8627 GdkWindow * confine_to,
8632 GdkDisplay *display;
8633 GdkDeviceManager *device_manager;
8635 GdkGrabStatus res = 0;
8637 GList *devices, *dev;
8639 g_return_val_if_fail (window != NULL, 0);
8640 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8641 g_return_val_if_fail (confine_to == NULL || GDK_IS_WINDOW (confine_to), 0);
8643 /* We need a native window for confine to to work, ensure we have one */
8646 if (!gdk_window_ensure_native (confine_to))
8648 g_warning ("Can't confine to grabbed window, not native");
8653 /* Non-viewable client side window => fail */
8654 if (!_gdk_window_has_impl (window) &&
8655 !gdk_window_is_viewable (window))
8656 return GDK_GRAB_NOT_VIEWABLE;
8658 native = gdk_window_get_toplevel (window);
8659 while (gdk_window_is_offscreen (native))
8661 native = gdk_offscreen_window_get_embedder (native);
8663 if (native == NULL ||
8664 (!_gdk_window_has_impl (native) &&
8665 !gdk_window_is_viewable (native)))
8666 return GDK_GRAB_NOT_VIEWABLE;
8668 native = gdk_window_get_toplevel (native);
8671 display = gdk_window_get_display (window);
8673 serial = _gdk_display_get_next_serial (display);
8674 device_manager = gdk_display_get_device_manager (display);
8675 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8677 /* FIXME: Should this be generic to all backends? */
8678 /* FIXME: What happens with extended devices? */
8679 for (dev = devices; dev; dev = dev->next)
8683 if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
8686 res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8689 get_native_grab_event_mask (event_mask),
8694 if (res == GDK_GRAB_SUCCESS)
8695 _gdk_display_add_device_grab (display,
8707 /* FIXME: handle errors when grabbing */
8709 g_list_free (devices);
8715 * gdk_keyboard_grab:
8716 * @window: the #GdkWindow which will own the grab (the grab window).
8717 * @owner_events: if %FALSE then all keyboard events are reported with respect to
8718 * @window. If %TRUE then keyboard events for this application are
8719 * reported as normal, but keyboard events outside this application
8720 * are reported with respect to @window. Both key press and key
8721 * release events are always reported, independant of the event mask
8722 * set by the application.
8723 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
8726 * Grabs the keyboard so that all events are passed to this
8727 * application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
8728 * This overrides any previous keyboard grab by this client.
8730 * If you set up anything at the time you take the grab that needs to be cleaned
8731 * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8732 * are emitted when the grab ends unvoluntarily.
8734 * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8736 * Deprecated: 3.0: Use gdk_device_grab() instead.
8739 gdk_keyboard_grab (GdkWindow *window,
8740 gboolean owner_events,
8744 GdkDisplay *display;
8745 GdkDeviceManager *device_manager;
8747 GdkGrabStatus res = 0;
8749 GList *devices, *dev;
8751 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8753 /* Non-viewable client side window => fail */
8754 if (!_gdk_window_has_impl (window) &&
8755 !gdk_window_is_viewable (window))
8756 return GDK_GRAB_NOT_VIEWABLE;
8758 native = gdk_window_get_toplevel (window);
8760 while (gdk_window_is_offscreen (native))
8762 native = gdk_offscreen_window_get_embedder (native);
8764 if (native == NULL ||
8765 (!_gdk_window_has_impl (native) &&
8766 !gdk_window_is_viewable (native)))
8767 return GDK_GRAB_NOT_VIEWABLE;
8769 native = gdk_window_get_toplevel (native);
8772 display = gdk_window_get_display (window);
8773 serial = _gdk_display_get_next_serial (display);
8774 device_manager = gdk_display_get_device_manager (display);
8775 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8777 /* FIXME: Should this be generic to all backends? */
8778 /* FIXME: What happens with extended devices? */
8779 for (dev = devices; dev; dev = dev->next)
8783 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
8786 res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8789 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
8794 if (res == GDK_GRAB_SUCCESS)
8795 _gdk_display_add_device_grab (display,
8806 /* FIXME: handle errors when grabbing */
8808 g_list_free (devices);
8814 * gdk_window_geometry_changed:
8815 * @window: an embedded offscreen #GdkWindow
8817 * This function informs GDK that the geometry of an embedded
8818 * offscreen window has changed. This is necessary for GDK to keep
8819 * track of which offscreen window the pointer is in.
8824 gdk_window_geometry_changed (GdkWindow *window)
8826 _gdk_synthesize_crossing_events_for_geometry_change (window);
8830 source_events_device_added (GdkDeviceManager *device_manager,
8835 GdkEventMask event_mask;
8836 GdkInputSource source;
8838 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_FLOATING)
8842 source = gdk_device_get_source (device);
8844 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8845 GINT_TO_POINTER (source)));
8847 gdk_window_set_device_events (window, device, event_mask);
8851 source_events_device_changed (GdkDeviceManager *device_manager,
8856 GdkInputSource source;
8857 GdkEventMask event_mask;
8861 type = gdk_device_get_device_type (device);
8862 source = gdk_device_get_source (device);
8864 event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8865 GINT_TO_POINTER (source)));
8870 if (type == GDK_DEVICE_TYPE_FLOATING)
8872 /* The device was just floated, enable its event mask */
8873 gdk_window_set_device_events (window, device, event_mask);
8875 else if (type == GDK_DEVICE_TYPE_SLAVE)
8876 gdk_window_set_device_events (window, device, 0);
8880 * gdk_window_set_source_events:
8881 * @window: a #GdkWindow
8882 * @source: a #GdkInputSource to define the source class.
8883 * @event_mask: event mask for @window
8885 * Sets the event mask for any floating device (i.e. not attached to any
8886 * visible pointer) that has the source defined as @source. This event
8887 * mask will be applied both to currently existing, newly added devices
8888 * after this call, and devices being attached/detached.
8893 gdk_window_set_source_events (GdkWindow *window,
8894 GdkInputSource source,
8895 GdkEventMask event_mask)
8897 GdkDeviceManager *device_manager;
8898 GdkDisplay *display;
8902 g_return_if_fail (GDK_IS_WINDOW (window));
8904 display = gdk_window_get_display (window);
8905 device_manager = gdk_display_get_device_manager (display);
8907 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING);
8909 /* Set event mask for existing devices */
8910 for (d = devices; d; d = d->next)
8912 GdkDevice *device = d->data;
8914 if (source == gdk_device_get_source (device))
8915 gdk_window_set_device_events (window, device, event_mask);
8918 g_list_free (devices);
8920 /* Update accounting */
8921 if (G_UNLIKELY (!window->source_event_masks))
8922 window->source_event_masks = g_hash_table_new (NULL, NULL);
8925 g_hash_table_insert (window->source_event_masks,
8926 GUINT_TO_POINTER (source),
8927 GUINT_TO_POINTER (event_mask));
8929 g_hash_table_remove (window->source_event_masks,
8930 GUINT_TO_POINTER (source));
8932 size = g_hash_table_size (window->source_event_masks);
8934 /* Update handler if needed */
8935 if (!window->device_added_handler_id && size > 0)
8937 window->device_added_handler_id =
8938 g_signal_connect (device_manager, "device-added",
8939 G_CALLBACK (source_events_device_added), window);
8940 window->device_changed_handler_id =
8941 g_signal_connect (device_manager, "device-changed",
8942 G_CALLBACK (source_events_device_changed), window);
8944 else if (window->device_added_handler_id && size == 0)
8945 g_signal_handler_disconnect (device_manager, window->device_added_handler_id);
8949 * gdk_window_get_source_events:
8950 * @window: a #GdkWindow
8951 * @source: a #GdkInputSource to define the source class.
8953 * Returns the event mask for @window corresponding to the device class specified
8956 * Returns: source event mask for @window
8959 gdk_window_get_source_events (GdkWindow *window,
8960 GdkInputSource source)
8962 g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8964 return GPOINTER_TO_UINT (g_hash_table_lookup (window->source_event_masks,
8965 GUINT_TO_POINTER (source)));
8969 do_synthesize_crossing_event (gpointer data)
8971 GdkDisplay *display;
8972 GdkWindow *changed_toplevel;
8973 GHashTableIter iter;
8974 gpointer key, value;
8977 changed_toplevel = data;
8979 changed_toplevel->synthesize_crossing_event_queued = FALSE;
8981 if (GDK_WINDOW_DESTROYED (changed_toplevel))
8984 display = gdk_window_get_display (changed_toplevel);
8985 serial = _gdk_display_get_next_serial (display);
8986 g_hash_table_iter_init (&iter, display->pointers_info);
8988 while (g_hash_table_iter_next (&iter, &key, &value))
8990 GdkWindow *new_window_under_pointer;
8991 GdkPointerWindowInfo *pointer_info = value;
8992 GdkDevice *device = key;
8994 if (changed_toplevel == pointer_info->toplevel_under_pointer)
8996 new_window_under_pointer =
8997 get_pointer_window (display, changed_toplevel,
8999 pointer_info->toplevel_x,
9000 pointer_info->toplevel_y,
9002 if (new_window_under_pointer != pointer_info->window_under_pointer)
9004 _gdk_synthesize_crossing_events (display,
9005 pointer_info->window_under_pointer,
9006 new_window_under_pointer,
9008 GDK_CROSSING_NORMAL,
9009 pointer_info->toplevel_x,
9010 pointer_info->toplevel_y,
9011 pointer_info->state,
9016 _gdk_display_set_window_under_pointer (display, device, new_window_under_pointer);
9025 _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window)
9027 GdkWindow *toplevel;
9029 toplevel = get_event_toplevel (changed_window);
9031 if (!toplevel->synthesize_crossing_event_queued)
9033 toplevel->synthesize_crossing_event_queued = TRUE;
9035 gdk_threads_add_idle_full (GDK_PRIORITY_EVENTS - 1,
9036 do_synthesize_crossing_event,
9037 g_object_ref (toplevel),
9042 /* Don't use for crossing events */
9044 get_event_window (GdkDisplay *display,
9046 GdkWindow *pointer_window,
9048 GdkModifierType mask,
9053 GdkWindow *grab_window;
9054 GdkDeviceGrabInfo *grab;
9056 grab = _gdk_display_has_device_grab (display, device, serial);
9058 if (grab != NULL && !grab->owner_events)
9060 evmask = grab->event_mask;
9061 evmask = update_evmask_for_button_motion (evmask, mask);
9063 grab_window = grab->window;
9065 if (evmask & type_masks[type])
9068 *evmask_out = evmask;
9075 while (pointer_window != NULL)
9077 evmask = pointer_window->event_mask;
9078 evmask = update_evmask_for_button_motion (evmask, mask);
9080 if (evmask & type_masks[type])
9083 *evmask_out = evmask;
9084 return pointer_window;
9087 pointer_window = get_event_parent (pointer_window);
9093 evmask = grab->event_mask;
9094 evmask = update_evmask_for_button_motion (evmask, mask);
9096 if (evmask & type_masks[type])
9099 *evmask_out = evmask;
9100 return grab->window;
9110 proxy_pointer_event (GdkDisplay *display,
9111 GdkEvent *source_event,
9114 GdkWindow *toplevel_window, *event_window;
9115 GdkWindow *pointer_window;
9116 GdkPointerWindowInfo *pointer_info;
9117 GdkDevice *device, *source_device;
9120 gdouble toplevel_x, toplevel_y;
9122 gboolean non_linear;
9124 event_window = source_event->any.window;
9125 gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9126 gdk_event_get_state (source_event, &state);
9127 time_ = gdk_event_get_time (source_event);
9128 device = gdk_event_get_device (source_event);
9129 source_device = gdk_event_get_source_device (source_event);
9130 pointer_info = _gdk_display_get_pointer_info (display, device);
9131 toplevel_window = convert_native_coords_to_toplevel (event_window,
9132 toplevel_x, toplevel_y,
9133 &toplevel_x, &toplevel_y);
9136 if ((source_event->type == GDK_LEAVE_NOTIFY ||
9137 source_event->type == GDK_ENTER_NOTIFY) &&
9138 (source_event->crossing.detail == GDK_NOTIFY_NONLINEAR ||
9139 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))
9142 /* If we get crossing events with subwindow unexpectedly being NULL
9143 that means there is a native subwindow that gdk doesn't know about.
9144 We track these and forward them, with the correct virtual window
9146 This is important to get right, as metacity uses gdk for the frame
9147 windows, but gdk doesn't know about the client windows reparented
9149 if (((source_event->type == GDK_LEAVE_NOTIFY &&
9150 source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9151 (source_event->type == GDK_ENTER_NOTIFY &&
9152 (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9153 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9154 source_event->crossing.subwindow == NULL)
9156 /* Left for an unknown (to gdk) subwindow */
9158 /* Send leave events from window under pointer to event window
9159 that will get the subwindow == NULL window */
9160 _gdk_synthesize_crossing_events (display,
9161 pointer_info->window_under_pointer,
9163 device, source_device,
9164 source_event->crossing.mode,
9165 toplevel_x, toplevel_y,
9171 /* Send subwindow == NULL event */
9172 send_crossing_event (display,
9176 source_event->crossing.mode,
9177 source_event->crossing.detail,
9179 device, source_device,
9180 toplevel_x, toplevel_y,
9185 _gdk_display_set_window_under_pointer (display, device, NULL);
9189 pointer_window = get_pointer_window (display, toplevel_window, device,
9190 toplevel_x, toplevel_y, serial);
9192 if (((source_event->type == GDK_ENTER_NOTIFY &&
9193 source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9194 (source_event->type == GDK_LEAVE_NOTIFY &&
9195 (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9196 source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9197 source_event->crossing.subwindow == NULL)
9199 /* Entered from an unknown (to gdk) subwindow */
9201 /* Send subwindow == NULL event */
9202 send_crossing_event (display,
9206 source_event->crossing.mode,
9207 source_event->crossing.detail,
9209 device, source_device,
9210 toplevel_x, toplevel_y,
9215 /* Send enter events from event window to pointer_window */
9216 _gdk_synthesize_crossing_events (display,
9219 device, source_device,
9220 source_event->crossing.mode,
9221 toplevel_x, toplevel_y,
9224 serial, non_linear);
9225 _gdk_display_set_window_under_pointer (display, device, pointer_window);
9229 if (pointer_info->window_under_pointer != pointer_window)
9231 /* Either a toplevel crossing notify that ended up inside a child window,
9232 or a motion notify that got into another child window */
9234 /* Different than last time, send crossing events */
9235 _gdk_synthesize_crossing_events (display,
9236 pointer_info->window_under_pointer,
9238 device, source_device,
9239 GDK_CROSSING_NORMAL,
9240 toplevel_x, toplevel_y,
9243 serial, non_linear);
9244 _gdk_display_set_window_under_pointer (display, device, pointer_window);
9246 else if (source_event->type == GDK_MOTION_NOTIFY)
9248 GdkWindow *event_win;
9252 event_win = get_event_window (display,
9261 gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9262 gdk_window_get_device_events (event_win, device) == 0)
9268 (evmask & GDK_POINTER_MOTION_HINT_MASK))
9270 gulong *device_serial;
9272 device_serial = g_hash_table_lookup (display->motion_hint_info, device);
9274 if (!device_serial ||
9275 (*device_serial != 0 &&
9276 serial < *device_serial))
9277 event_win = NULL; /* Ignore event */
9281 *device_serial = G_MAXULONG;
9285 if (event_win && !display->ignore_core_events)
9287 event = _gdk_make_event (event_win, GDK_MOTION_NOTIFY, source_event, FALSE);
9288 event->motion.time = time_;
9289 convert_toplevel_coords_to_window (event_win,
9290 toplevel_x, toplevel_y,
9291 &event->motion.x, &event->motion.y);
9292 event->motion.x_root = source_event->motion.x_root;
9293 event->motion.y_root = source_event->motion.y_root;
9294 event->motion.state = state;
9295 event->motion.is_hint = is_hint;
9296 event->motion.device = source_event->motion.device;
9297 event->motion.axes = g_memdup (source_event->motion.axes,
9298 sizeof (gdouble) * gdk_device_get_n_axes (source_event->motion.device));
9299 gdk_event_set_source_device (event, source_device);
9303 /* unlink all move events from queue.
9304 We handle our own, including our emulated masks. */
9308 #define GDK_ANY_BUTTON_MASK (GDK_BUTTON1_MASK | \
9309 GDK_BUTTON2_MASK | \
9310 GDK_BUTTON3_MASK | \
9311 GDK_BUTTON4_MASK | \
9315 proxy_button_event (GdkEvent *source_event,
9318 GdkWindow *toplevel_window, *event_window;
9319 GdkWindow *event_win;
9320 GdkWindow *pointer_window;
9326 gdouble toplevel_x, toplevel_y;
9327 GdkDisplay *display;
9329 GdkDevice *device, *source_device;
9331 type = source_event->any.type;
9332 event_window = source_event->any.window;
9333 gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9334 gdk_event_get_state (source_event, &state);
9335 time_ = gdk_event_get_time (source_event);
9336 device = gdk_event_get_device (source_event);
9337 source_device = gdk_event_get_source_device (source_event);
9338 display = gdk_window_get_display (source_event->any.window);
9339 toplevel_window = convert_native_coords_to_toplevel (event_window,
9340 toplevel_x, toplevel_y,
9341 &toplevel_x, &toplevel_y);
9343 if (type == GDK_BUTTON_PRESS &&
9344 !source_event->any.send_event &&
9345 _gdk_display_has_device_grab (display, device, serial) == NULL)
9348 _gdk_window_find_descendant_at (toplevel_window,
9349 toplevel_x, toplevel_y,
9352 /* Find the event window, that gets the grab */
9355 (parent = get_event_parent (w)) != NULL &&
9356 parent->window_type != GDK_WINDOW_ROOT)
9358 if (w->event_mask & GDK_BUTTON_PRESS_MASK)
9362 pointer_window = (GdkWindow *)w;
9364 _gdk_display_add_device_grab (display,
9370 gdk_window_get_events (pointer_window),
9374 _gdk_display_device_grab_update (display, device, source_device, serial);
9377 pointer_window = get_pointer_window (display, toplevel_window, device,
9378 toplevel_x, toplevel_y,
9381 event_win = get_event_window (display,
9387 if (event_win == NULL || display->ignore_core_events)
9390 if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9391 gdk_window_get_device_events (event_win, device) == 0)
9394 event = _gdk_make_event (event_win, type, source_event, FALSE);
9398 case GDK_BUTTON_PRESS:
9399 case GDK_BUTTON_RELEASE:
9400 event->button.button = source_event->button.button;
9401 convert_toplevel_coords_to_window (event_win,
9402 toplevel_x, toplevel_y,
9403 &event->button.x, &event->button.y);
9404 event->button.x_root = source_event->button.x_root;
9405 event->button.y_root = source_event->button.y_root;
9406 event->button.state = state;
9407 event->button.device = source_event->button.device;
9408 event->button.axes = g_memdup (source_event->button.axes,
9409 sizeof (gdouble) * gdk_device_get_n_axes (source_event->button.device));
9411 gdk_event_set_source_device (event, source_device);
9413 if (type == GDK_BUTTON_PRESS)
9414 _gdk_event_button_generate (display, event);
9418 event->scroll.direction = source_event->scroll.direction;
9419 convert_toplevel_coords_to_window (event_win,
9420 toplevel_x, toplevel_y,
9421 &event->scroll.x, &event->scroll.y);
9422 event->scroll.x_root = source_event->scroll.x_root;
9423 event->scroll.y_root = source_event->scroll.y_root;
9424 event->scroll.state = state;
9425 event->scroll.device = source_event->scroll.device;
9426 gdk_event_set_source_device (event, source_device);
9433 return TRUE; /* Always unlink original, we want to obey the emulated event mask */
9436 #ifdef DEBUG_WINDOW_PRINTING
9438 gdk_window_print (GdkWindow *window,
9442 const char *window_types[] = {
9452 g_print ("%*s%p: [%s] %d,%d %dx%d", indent, "", window,
9453 window->user_data ? g_type_name_from_instance (window->user_data) : "no widget",
9454 window->x, window->y,
9455 window->width, window->height
9458 if (gdk_window_has_impl (window))
9460 #ifdef GDK_WINDOWING_X11
9461 g_print (" impl(0x%lx)", gdk_x11_window_get_xid (window));
9465 if (window->window_type != GDK_WINDOW_CHILD)
9466 g_print (" %s", window_types[window->window_type]);
9468 if (window->input_only)
9469 g_print (" input-only");
9472 g_print (" shaped");
9474 if (!gdk_window_is_visible ((GdkWindow *)window))
9475 g_print (" hidden");
9477 g_print (" abs[%d,%d]",
9478 window->abs_x, window->abs_y);
9480 cairo_region_get_extents (window->clip_region, &r);
9481 if (cairo_region_is_empty (window->clip_region))
9482 g_print (" clipbox[empty]");
9484 g_print (" clipbox[%d,%d %dx%d]", r.x, r.y, r.width, r.height);
9491 gdk_window_print_tree (GdkWindow *window,
9493 gboolean include_input_only)
9497 if (window->input_only && !include_input_only)
9500 gdk_window_print (window, indent);
9502 for (l = window->children; l != NULL; l = l->next)
9503 gdk_window_print_tree (l->data, indent + 4, include_input_only);
9506 #endif /* DEBUG_WINDOW_PRINTING */
9509 _gdk_windowing_got_event (GdkDisplay *display,
9514 GdkWindow *event_window;
9516 gboolean unlink_event;
9517 guint old_state, old_button;
9518 GdkDeviceGrabInfo *button_release_grab;
9519 GdkPointerWindowInfo *pointer_info;
9520 GdkDevice *device, *source_device;
9521 gboolean is_toplevel;
9523 if (gdk_event_get_time (event) != GDK_CURRENT_TIME)
9524 display->last_event_time = gdk_event_get_time (event);
9526 device = gdk_event_get_device (event);
9527 source_device = gdk_event_get_source_device (event);
9533 g_object_get (device, "input-mode", &mode, NULL);
9534 _gdk_display_device_grab_update (display, device, source_device, serial);
9536 if (mode == GDK_MODE_DISABLED ||
9537 !_gdk_display_check_grab_ownership (display, device, serial))
9539 /* Device events are blocked by another
9540 * device grab, or the device is disabled
9542 unlink_event = TRUE;
9547 event_window = event->any.window;
9551 pointer_info = _gdk_display_get_pointer_info (display, device);
9553 #ifdef DEBUG_WINDOW_PRINTING
9554 if (event->type == GDK_KEY_PRESS &&
9555 (event->key.keyval == 0xa7 ||
9556 event->key.keyval == 0xbd))
9558 gdk_window_print_tree (event_window, 0,
9559 event->key.keyval == 0xbd);
9563 if (event->type == GDK_VISIBILITY_NOTIFY)
9565 event_window->native_visibility = event->visibility.state;
9566 gdk_window_update_visibility_recursively (event_window,
9571 if (!(is_button_type (event->type) ||
9572 is_motion_type (event->type)) ||
9573 event_window->window_type == GDK_WINDOW_ROOT)
9576 is_toplevel = gdk_window_is_toplevel (event_window);
9578 if ((event->type == GDK_ENTER_NOTIFY ||
9579 event->type == GDK_LEAVE_NOTIFY) &&
9580 (event->crossing.mode == GDK_CROSSING_GRAB ||
9581 event->crossing.mode == GDK_CROSSING_UNGRAB) &&
9582 (_gdk_display_has_device_grab (display, device, serial) ||
9583 event->crossing.detail == GDK_NOTIFY_INFERIOR))
9585 /* We synthesize all crossing events due to grabs ourselves,
9586 * so we ignore the native ones caused by our native pointer_grab
9587 * calls. Otherwise we would proxy these crossing event and cause
9588 * multiple copies of crossing events for grabs.
9590 * We do want to handle grabs from other clients though, as for
9591 * instance alt-tab in metacity causes grabs like these and
9592 * we want to handle those. Thus the has_pointer_grab check.
9594 * Implicit grabs on child windows create some grabbing events
9595 * that are sent before the button press. This means we can't
9596 * detect these with the has_pointer_grab check (as the implicit
9597 * grab is only noticed when we get button press event), so we
9598 * detect these events by checking for INFERIOR enter or leave
9599 * events. These should never be a problem to filter out.
9602 /* We ended up in this window after some (perhaps other clients)
9603 grab, so update the toplevel_under_window state */
9605 event->type == GDK_ENTER_NOTIFY &&
9606 event->crossing.mode == GDK_CROSSING_UNGRAB)
9608 if (pointer_info->toplevel_under_pointer)
9609 g_object_unref (pointer_info->toplevel_under_pointer);
9610 pointer_info->toplevel_under_pointer = g_object_ref (event_window);
9613 unlink_event = TRUE;
9617 /* Track toplevel_under_pointer */
9620 if (event->type == GDK_ENTER_NOTIFY &&
9621 event->crossing.detail != GDK_NOTIFY_INFERIOR)
9623 if (pointer_info->toplevel_under_pointer)
9624 g_object_unref (pointer_info->toplevel_under_pointer);
9625 pointer_info->toplevel_under_pointer = g_object_ref (event_window);
9627 else if (event->type == GDK_LEAVE_NOTIFY &&
9628 event->crossing.detail != GDK_NOTIFY_INFERIOR &&
9629 pointer_info->toplevel_under_pointer == event_window)
9631 if (pointer_info->toplevel_under_pointer)
9632 g_object_unref (pointer_info->toplevel_under_pointer);
9633 pointer_info->toplevel_under_pointer = NULL;
9637 /* Store last pointer window and position/state */
9638 old_state = pointer_info->state;
9639 old_button = pointer_info->button;
9641 gdk_event_get_coords (event, &x, &y);
9642 convert_native_coords_to_toplevel (event_window, x, y, &x, &y);
9643 pointer_info->toplevel_x = x;
9644 pointer_info->toplevel_y = y;
9645 gdk_event_get_state (event, &pointer_info->state);
9646 if (event->type == GDK_BUTTON_PRESS ||
9647 event->type == GDK_BUTTON_RELEASE)
9648 pointer_info->button = event->button.button;
9651 (pointer_info->state != old_state ||
9652 pointer_info->button != old_button))
9653 _gdk_display_enable_motion_hints (display, device);
9655 unlink_event = FALSE;
9656 if (is_motion_type (event->type))
9657 unlink_event = proxy_pointer_event (display,
9660 else if (is_button_type (event->type))
9661 unlink_event = proxy_button_event (event,
9664 if (event->type == GDK_BUTTON_RELEASE &&
9665 !event->any.send_event)
9667 button_release_grab =
9668 _gdk_display_has_device_grab (display, device, serial);
9669 if (button_release_grab &&
9670 button_release_grab->implicit &&
9671 (event->button.state & GDK_ANY_BUTTON_MASK & ~(GDK_BUTTON1_MASK << (event->button.button - 1))) == 0)
9673 button_release_grab->serial_end = serial;
9674 button_release_grab->implicit_ungrab = FALSE;
9675 _gdk_display_device_grab_update (display, device, source_device, serial);
9682 _gdk_event_queue_remove_link (display, event_link);
9683 g_list_free_1 (event_link);
9684 gdk_event_free (event);
9689 * gdk_window_create_similar_surface:
9690 * @window: window to make new surface similar to
9691 * @content: the content for the new surface
9692 * @width: width of the new surface
9693 * @height: height of the new surface
9695 * Create a new surface that is as compatible as possible with the
9696 * given @window. For example the new surface will have the same
9697 * fallback resolution and font options as @window. Generally, the new
9698 * surface will also use the same backend as @window, unless that is
9699 * not possible for some reason. The type of the returned surface may
9700 * be examined with cairo_surface_get_type().
9702 * Initially the surface contents are all 0 (transparent if contents
9703 * have transparency, black otherwise.)
9705 * Returns: a pointer to the newly allocated surface. The caller
9706 * owns the surface and should call cairo_surface_destroy() when done
9709 * This function always returns a valid pointer, but it will return a
9710 * pointer to a "nil" surface if @other is already in an error state
9711 * or any other error occurs.
9716 gdk_window_create_similar_surface (GdkWindow * window,
9717 cairo_content_t content,
9721 cairo_surface_t *window_surface, *surface;
9723 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
9725 window_surface = _gdk_window_ref_cairo_surface (window);
9727 switch (_gdk_rendering_mode)
9729 case GDK_RENDERING_MODE_RECORDING:
9731 cairo_rectangle_t rect = { 0, 0, width, height };
9732 surface = cairo_recording_surface_create (content, &rect);
9735 case GDK_RENDERING_MODE_IMAGE:
9736 surface = cairo_image_surface_create (content == CAIRO_CONTENT_COLOR ? CAIRO_FORMAT_RGB24 :
9737 content == CAIRO_CONTENT_ALPHA ? CAIRO_FORMAT_A8 : CAIRO_FORMAT_ARGB32,
9740 case GDK_RENDERING_MODE_SIMILAR:
9742 surface = cairo_surface_create_similar (window_surface,
9748 cairo_surface_destroy (window_surface);
9755 * @window: a #GdkWindow
9756 * @timestamp: timestamp of the event triggering the window focus
9758 * Sets keyboard focus to @window. In most cases, gtk_window_present()
9759 * should be used on a #GtkWindow, rather than calling this function.
9763 gdk_window_focus (GdkWindow *window,
9766 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->focus (window, timestamp);
9770 * gdk_window_set_type_hint:
9771 * @window: A toplevel #GdkWindow
9772 * @hint: A hint of the function this window will have
9774 * The application can use this call to provide a hint to the window
9775 * manager about the functionality of a window. The window manager
9776 * can use this information when determining the decoration and behaviour
9779 * The hint must be set before the window is mapped.
9782 gdk_window_set_type_hint (GdkWindow *window,
9783 GdkWindowTypeHint hint)
9785 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_type_hint (window, hint);
9789 * gdk_window_get_type_hint:
9790 * @window: A toplevel #GdkWindow
9792 * This function returns the type hint set for a window.
9794 * Return value: The type hint set for @window
9799 gdk_window_get_type_hint (GdkWindow *window)
9801 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_type_hint (window);
9805 * gdk_window_set_modal_hint:
9806 * @window: A toplevel #GdkWindow
9807 * @modal: %TRUE if the window is modal, %FALSE otherwise.
9809 * The application can use this hint to tell the window manager
9810 * that a certain window has modal behaviour. The window manager
9811 * can use this information to handle modal windows in a special
9814 * You should only use this on windows for which you have
9815 * previously called gdk_window_set_transient_for()
9818 gdk_window_set_modal_hint (GdkWindow *window,
9821 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_modal_hint (window, modal);
9825 * gdk_window_set_skip_taskbar_hint:
9826 * @window: a toplevel #GdkWindow
9827 * @skips_taskbar: %TRUE to skip the taskbar
9829 * Toggles whether a window should appear in a task list or window
9830 * list. If a window's semantic type as specified with
9831 * gdk_window_set_type_hint() already fully describes the window, this
9832 * function should <emphasis>not</emphasis> be called in addition,
9833 * instead you should allow the window to be treated according to
9834 * standard policy for its semantic type.
9839 gdk_window_set_skip_taskbar_hint (GdkWindow *window,
9840 gboolean skips_taskbar)
9842 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_taskbar_hint (window, skips_taskbar);
9846 * gdk_window_set_skip_pager_hint:
9847 * @window: a toplevel #GdkWindow
9848 * @skips_pager: %TRUE to skip the pager
9850 * Toggles whether a window should appear in a pager (workspace
9851 * switcher, or other desktop utility program that displays a small
9852 * thumbnail representation of the windows on the desktop). If a
9853 * window's semantic type as specified with gdk_window_set_type_hint()
9854 * already fully describes the window, this function should
9855 * <emphasis>not</emphasis> be called in addition, instead you should
9856 * allow the window to be treated according to standard policy for
9857 * its semantic type.
9862 gdk_window_set_skip_pager_hint (GdkWindow *window,
9863 gboolean skips_pager)
9865 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_pager_hint (window, skips_pager);
9869 * gdk_window_set_urgency_hint:
9870 * @window: a toplevel #GdkWindow
9871 * @urgent: %TRUE if the window is urgent
9873 * Toggles whether a window needs the user's
9879 gdk_window_set_urgency_hint (GdkWindow *window,
9882 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_urgency_hint (window, urgent);
9886 * gdk_window_set_geometry_hints:
9887 * @window: a toplevel #GdkWindow
9888 * @geometry: geometry hints
9889 * @geom_mask: bitmask indicating fields of @geometry to pay attention to
9891 * Sets the geometry hints for @window. Hints flagged in @geom_mask
9892 * are set, hints not flagged in @geom_mask are unset.
9893 * To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL.
9895 * This function provides hints to the windowing system about
9896 * acceptable sizes for a toplevel window. The purpose of
9897 * this is to constrain user resizing, but the windowing system
9898 * will typically (but is not required to) also constrain the
9899 * current size of the window to the provided values and
9900 * constrain programatic resizing via gdk_window_resize() or
9901 * gdk_window_move_resize().
9903 * Note that on X11, this effect has no effect on windows
9904 * of type %GDK_WINDOW_TEMP or windows where override redirect
9905 * has been turned on via gdk_window_set_override_redirect()
9906 * since these windows are not resizable by the user.
9908 * Since you can't count on the windowing system doing the
9909 * constraints for programmatic resizes, you should generally
9910 * call gdk_window_constrain_size() yourself to determine
9911 * appropriate sizes.
9915 gdk_window_set_geometry_hints (GdkWindow *window,
9916 const GdkGeometry *geometry,
9917 GdkWindowHints geom_mask)
9919 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_geometry_hints (window, geometry, geom_mask);
9923 * gdk_window_set_title:
9924 * @window: a toplevel #GdkWindow
9925 * @title: title of @window
9927 * Sets the title of a toplevel window, to be displayed in the titlebar.
9928 * If you haven't explicitly set the icon name for the window
9929 * (using gdk_window_set_icon_name()), the icon name will be set to
9930 * @title as well. @title must be in UTF-8 encoding (as with all
9931 * user-readable strings in GDK/GTK+). @title may not be %NULL.
9934 gdk_window_set_title (GdkWindow *window,
9937 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_title (window, title);
9941 * gdk_window_set_role:
9942 * @window: a toplevel #GdkWindow
9943 * @role: a string indicating its role
9945 * When using GTK+, typically you should use gtk_window_set_role() instead
9946 * of this low-level function.
9948 * The window manager and session manager use a window's role to
9949 * distinguish it from other kinds of window in the same application.
9950 * When an application is restarted after being saved in a previous
9951 * session, all windows with the same title and role are treated as
9952 * interchangeable. So if you have two windows with the same title
9953 * that should be distinguished for session management purposes, you
9954 * should set the role on those windows. It doesn't matter what string
9955 * you use for the role, as long as you have a different role for each
9956 * non-interchangeable kind of window.
9960 gdk_window_set_role (GdkWindow *window,
9963 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_role (window, role);
9967 * gdk_window_set_startup_id:
9968 * @window: a toplevel #GdkWindow
9969 * @startup_id: a string with startup-notification identifier
9971 * When using GTK+, typically you should use gtk_window_set_startup_id()
9972 * instead of this low-level function.
9978 gdk_window_set_startup_id (GdkWindow *window,
9979 const gchar *startup_id)
9981 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_startup_id (window, startup_id);
9985 * gdk_window_set_transient_for:
9986 * @window: a toplevel #GdkWindow
9987 * @parent: another toplevel #GdkWindow
9989 * Indicates to the window manager that @window is a transient dialog
9990 * associated with the application window @parent. This allows the
9991 * window manager to do things like center @window on @parent and
9992 * keep @window above @parent.
9994 * See gtk_window_set_transient_for() if you're using #GtkWindow or
9998 gdk_window_set_transient_for (GdkWindow *window,
10001 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_transient_for (window, parent);
10005 * gdk_window_get_root_origin:
10006 * @window: a toplevel #GdkWindow
10007 * @x: (out): return location for X position of window frame
10008 * @y: (out): return location for Y position of window frame
10010 * Obtains the top-left corner of the window manager frame in root
10011 * window coordinates.
10015 gdk_window_get_root_origin (GdkWindow *window,
10019 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_root_origin (window, x, y);
10023 * gdk_window_get_frame_extents:
10024 * @window: a toplevel #GdkWindow
10025 * @rect: rectangle to fill with bounding box of the window frame
10027 * Obtains the bounding box of the window, including window manager
10028 * titlebar/borders if any. The frame position is given in root window
10029 * coordinates. To get the position of the window itself (rather than
10030 * the frame) in root window coordinates, use gdk_window_get_origin().
10034 gdk_window_get_frame_extents (GdkWindow *window,
10035 GdkRectangle *rect)
10037 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_frame_extents (window, rect);
10041 * gdk_window_set_override_redirect:
10042 * @window: a toplevel #GdkWindow
10043 * @override_redirect: %TRUE if window should be override redirect
10045 * An override redirect window is not under the control of the window manager.
10046 * This means it won't have a titlebar, won't be minimizable, etc. - it will
10047 * be entirely under the control of the application. The window manager
10048 * can't see the override redirect window at all.
10050 * Override redirect should only be used for short-lived temporary
10051 * windows, such as popup menus. #GtkMenu uses an override redirect
10052 * window in its implementation, for example.
10056 gdk_window_set_override_redirect (GdkWindow *window,
10057 gboolean override_redirect)
10059 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_override_redirect (window, override_redirect);
10063 * gdk_window_set_accept_focus:
10064 * @window: a toplevel #GdkWindow
10065 * @accept_focus: %TRUE if the window should receive input focus
10067 * Setting @accept_focus to %FALSE hints the desktop environment that the
10068 * window doesn't want to receive input focus.
10070 * On X, it is the responsibility of the window manager to interpret this
10071 * hint. ICCCM-compliant window manager usually respect it.
10076 gdk_window_set_accept_focus (GdkWindow *window,
10077 gboolean accept_focus)
10079 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_accept_focus (window, accept_focus);
10083 * gdk_window_set_focus_on_map:
10084 * @window: a toplevel #GdkWindow
10085 * @focus_on_map: %TRUE if the window should receive input focus when mapped
10087 * Setting @focus_on_map to %FALSE hints the desktop environment that the
10088 * window doesn't want to receive input focus when it is mapped.
10089 * focus_on_map should be turned off for windows that aren't triggered
10090 * interactively (such as popups from network activity).
10092 * On X, it is the responsibility of the window manager to interpret
10093 * this hint. Window managers following the freedesktop.org window
10094 * manager extension specification should respect it.
10099 gdk_window_set_focus_on_map (GdkWindow *window,
10100 gboolean focus_on_map)
10102 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_focus_on_map (window, focus_on_map);
10106 * gdk_window_set_icon_list:
10107 * @window: The #GdkWindow toplevel window to set the icon of.
10108 * @pixbufs: (transfer none) (element-type GdkPixbuf):
10109 * A list of pixbufs, of different sizes.
10111 * Sets a list of icons for the window. One of these will be used
10112 * to represent the window when it has been iconified. The icon is
10113 * usually shown in an icon box or some sort of task bar. Which icon
10114 * size is shown depends on the window manager. The window manager
10115 * can scale the icon but setting several size icons can give better
10116 * image quality since the window manager may only need to scale the
10117 * icon by a small amount or not at all.
10121 gdk_window_set_icon_list (GdkWindow *window,
10124 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_list (window, pixbufs);
10128 * gdk_window_set_icon_name:
10129 * @window: a toplevel #GdkWindow
10130 * @name: (allow-none): name of window while iconified (minimized)
10132 * Windows may have a name used while minimized, distinct from the
10133 * name they display in their titlebar. Most of the time this is a bad
10134 * idea from a user interface standpoint. But you can set such a name
10135 * with this function, if you like.
10137 * After calling this with a non-%NULL @name, calls to gdk_window_set_title()
10138 * will not update the icon title.
10140 * Using %NULL for @name unsets the icon title; further calls to
10141 * gdk_window_set_title() will again update the icon title as well.
10144 gdk_window_set_icon_name (GdkWindow *window,
10147 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_name (window, name);
10151 * gdk_window_iconify:
10152 * @window: a toplevel #GdkWindow
10154 * Asks to iconify (minimize) @window. The window manager may choose
10155 * to ignore the request, but normally will honor it. Using
10156 * gtk_window_iconify() is preferred, if you have a #GtkWindow widget.
10158 * This function only makes sense when @window is a toplevel window.
10162 gdk_window_iconify (GdkWindow *window)
10164 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->iconify (window);
10168 * gdk_window_deiconify:
10169 * @window: a toplevel #GdkWindow
10171 * Attempt to deiconify (unminimize) @window. On X11 the window manager may
10172 * choose to ignore the request to deiconify. When using GTK+,
10173 * use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet,
10174 * you probably want to use gtk_window_present(), which raises the window, focuses it,
10175 * unminimizes it, and puts it on the current desktop.
10179 gdk_window_deiconify (GdkWindow *window)
10181 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->deiconify (window);
10185 * gdk_window_stick:
10186 * @window: a toplevel #GdkWindow
10188 * "Pins" a window such that it's on all workspaces and does not scroll
10189 * with viewports, for window managers that have scrollable viewports.
10190 * (When using #GtkWindow, gtk_window_stick() may be more useful.)
10192 * On the X11 platform, this function depends on window manager
10193 * support, so may have no effect with many window managers. However,
10194 * GDK will do the best it can to convince the window manager to stick
10195 * the window. For window managers that don't support this operation,
10196 * there's nothing you can do to force it to happen.
10200 gdk_window_stick (GdkWindow *window)
10202 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->stick (window);
10206 * gdk_window_unstick:
10207 * @window: a toplevel #GdkWindow
10209 * Reverse operation for gdk_window_stick(); see gdk_window_stick(),
10210 * and gtk_window_unstick().
10214 gdk_window_unstick (GdkWindow *window)
10216 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unstick (window);
10220 * gdk_window_maximize:
10221 * @window: a toplevel #GdkWindow
10223 * Maximizes the window. If the window was already maximized, then
10224 * this function does nothing.
10226 * On X11, asks the window manager to maximize @window, if the window
10227 * manager supports this operation. Not all window managers support
10228 * this, and some deliberately ignore it or don't have a concept of
10229 * "maximized"; so you can't rely on the maximization actually
10230 * happening. But it will happen with most standard window managers,
10231 * and GDK makes a best effort to get it to happen.
10233 * On Windows, reliably maximizes the window.
10237 gdk_window_maximize (GdkWindow *window)
10239 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->maximize (window);
10243 * gdk_window_unmaximize:
10244 * @window: a toplevel #GdkWindow
10246 * Unmaximizes the window. If the window wasn't maximized, then this
10247 * function does nothing.
10249 * On X11, asks the window manager to unmaximize @window, if the
10250 * window manager supports this operation. Not all window managers
10251 * support this, and some deliberately ignore it or don't have a
10252 * concept of "maximized"; so you can't rely on the unmaximization
10253 * actually happening. But it will happen with most standard window
10254 * managers, and GDK makes a best effort to get it to happen.
10256 * On Windows, reliably unmaximizes the window.
10260 gdk_window_unmaximize (GdkWindow *window)
10262 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unmaximize (window);
10266 * gdk_window_fullscreen:
10267 * @window: a toplevel #GdkWindow
10269 * Moves the window into fullscreen mode. This means the
10270 * window covers the entire screen and is above any panels
10273 * If the window was already fullscreen, then this function does nothing.
10275 * On X11, asks the window manager to put @window in a fullscreen
10276 * state, if the window manager supports this operation. Not all
10277 * window managers support this, and some deliberately ignore it or
10278 * don't have a concept of "fullscreen"; so you can't rely on the
10279 * fullscreenification actually happening. But it will happen with
10280 * most standard window managers, and GDK makes a best effort to get
10286 gdk_window_fullscreen (GdkWindow *window)
10288 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->fullscreen (window);
10292 * gdk_window_unfullscreen:
10293 * @window: a toplevel #GdkWindow
10295 * Moves the window out of fullscreen mode. If the window was not
10296 * fullscreen, does nothing.
10298 * On X11, asks the window manager to move @window out of the fullscreen
10299 * state, if the window manager supports this operation. Not all
10300 * window managers support this, and some deliberately ignore it or
10301 * don't have a concept of "fullscreen"; so you can't rely on the
10302 * unfullscreenification actually happening. But it will happen with
10303 * most standard window managers, and GDK makes a best effort to get
10309 gdk_window_unfullscreen (GdkWindow *window)
10311 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unfullscreen (window);
10315 * gdk_window_set_keep_above:
10316 * @window: a toplevel #GdkWindow
10317 * @setting: whether to keep @window above other windows
10319 * Set if @window must be kept above other windows. If the
10320 * window was already above, then this function does nothing.
10322 * On X11, asks the window manager to keep @window above, if the window
10323 * manager supports this operation. Not all window managers support
10324 * this, and some deliberately ignore it or don't have a concept of
10325 * "keep above"; so you can't rely on the window being kept above.
10326 * But it will happen with most standard window managers,
10327 * and GDK makes a best effort to get it to happen.
10332 gdk_window_set_keep_above (GdkWindow *window,
10335 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_above (window, setting);
10339 * gdk_window_set_keep_below:
10340 * @window: a toplevel #GdkWindow
10341 * @setting: whether to keep @window below other windows
10343 * Set if @window must be kept below other windows. If the
10344 * window was already below, then this function does nothing.
10346 * On X11, asks the window manager to keep @window below, if the window
10347 * manager supports this operation. Not all window managers support
10348 * this, and some deliberately ignore it or don't have a concept of
10349 * "keep below"; so you can't rely on the window being kept below.
10350 * But it will happen with most standard window managers,
10351 * and GDK makes a best effort to get it to happen.
10356 gdk_window_set_keep_below (GdkWindow *window, gboolean setting)
10358 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_below (window, setting);
10362 * gdk_window_get_group:
10363 * @window: a toplevel #GdkWindow
10365 * Returns the group leader window for @window. See gdk_window_set_group().
10367 * Return value: (transfer none): the group leader window for @window
10372 gdk_window_get_group (GdkWindow *window)
10374 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_group (window);
10378 * gdk_window_set_group:
10379 * @window: a toplevel #GdkWindow
10380 * @leader: (allow-none): group leader window, or %NULL to restore the default group leader window
10382 * Sets the group leader window for @window. By default,
10383 * GDK sets the group leader for all toplevel windows
10384 * to a global window implicitly created by GDK. With this function
10385 * you can override this default.
10387 * The group leader window allows the window manager to distinguish
10388 * all windows that belong to a single application. It may for example
10389 * allow users to minimize/unminimize all windows belonging to an
10390 * application at once. You should only set a non-default group window
10391 * if your application pretends to be multiple applications.
10394 gdk_window_set_group (GdkWindow *window,
10397 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_group (window, leader);
10401 * gdk_window_set_decorations:
10402 * @window: a toplevel #GdkWindow
10403 * @decorations: decoration hint mask
10405 * "Decorations" are the features the window manager adds to a toplevel #GdkWindow.
10406 * This function sets the traditional Motif window manager hints that tell the
10407 * window manager which decorations you would like your window to have.
10408 * Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of
10409 * using the GDK function directly.
10411 * The @decorations argument is the logical OR of the fields in
10412 * the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the
10413 * mask, the other bits indicate which decorations should be turned off.
10414 * If #GDK_DECOR_ALL is not included, then the other bits indicate
10415 * which decorations should be turned on.
10417 * Most window managers honor a decorations hint of 0 to disable all decorations,
10418 * but very few honor all possible combinations of bits.
10422 gdk_window_set_decorations (GdkWindow *window,
10423 GdkWMDecoration decorations)
10425 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_decorations (window, decorations);
10429 * gdk_window_get_decorations:
10430 * @window: The toplevel #GdkWindow to get the decorations from
10431 * @decorations: (out): The window decorations will be written here
10433 * Returns the decorations set on the GdkWindow with
10434 * gdk_window_set_decorations().
10436 * Returns: %TRUE if the window has decorations set, %FALSE otherwise.
10439 gdk_window_get_decorations(GdkWindow *window,
10440 GdkWMDecoration *decorations)
10442 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_decorations (window, decorations);
10446 * gdk_window_set_functions:
10447 * @window: a toplevel #GdkWindow
10448 * @functions: bitmask of operations to allow on @window
10450 * Sets hints about the window management functions to make available
10451 * via buttons on the window frame.
10453 * On the X backend, this function sets the traditional Motif window
10454 * manager hint for this purpose. However, few window managers do
10455 * anything reliable or interesting with this hint. Many ignore it
10458 * The @functions argument is the logical OR of values from the
10459 * #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL,
10460 * then the other bits indicate which functions to disable; if
10461 * it doesn't include #GDK_FUNC_ALL, it indicates which functions to
10466 gdk_window_set_functions (GdkWindow *window,
10467 GdkWMFunction functions)
10469 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_functions (window, functions);
10473 * gdk_window_begin_resize_drag:
10474 * @window: a toplevel #GdkWindow
10475 * @edge: the edge or corner from which the drag is started
10476 * @button: the button being used to drag
10477 * @root_x: root window X coordinate of mouse click that began the drag
10478 * @root_y: root window Y coordinate of mouse click that began the drag
10479 * @timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())
10481 * Begins a window resize operation (for a toplevel window).
10482 * You might use this function to implement a "window resize grip," for
10483 * example; in fact #GtkStatusbar uses it. The function works best
10484 * with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a
10485 * fallback implementation for other window managers.
10489 gdk_window_begin_resize_drag (GdkWindow *window,
10490 GdkWindowEdge edge,
10496 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_resize_drag (window, edge, button, root_x, root_y, timestamp);
10500 * gdk_window_begin_move_drag:
10501 * @window: a toplevel #GdkWindow
10502 * @button: the button being used to drag
10503 * @root_x: root window X coordinate of mouse click that began the drag
10504 * @root_y: root window Y coordinate of mouse click that began the drag
10505 * @timestamp: timestamp of mouse click that began the drag
10507 * Begins a window move operation (for a toplevel window). You might
10508 * use this function to implement a "window move grip," for
10509 * example. The function works best with window managers that support
10510 * the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
10511 * Window Manager Hints</ulink>, but has a fallback implementation for
10512 * other window managers.
10516 gdk_window_begin_move_drag (GdkWindow *window,
10522 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_move_drag (window, button, root_x, root_y, timestamp);
10526 * gdk_window_enable_synchronized_configure:
10527 * @window: a toplevel #GdkWindow
10529 * Indicates that the application will cooperate with the window
10530 * system in synchronizing the window repaint with the window
10531 * manager during resizing operations. After an application calls
10532 * this function, it must call gdk_window_configure_finished() every
10533 * time it has finished all processing associated with a set of
10534 * Configure events. Toplevel GTK+ windows automatically use this
10537 * On X, calling this function makes @window participate in the
10538 * _NET_WM_SYNC_REQUEST window manager protocol.
10543 gdk_window_enable_synchronized_configure (GdkWindow *window)
10545 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->enable_synchronized_configure (window);
10549 * gdk_window_configure_finished:
10550 * @window: a toplevel #GdkWindow
10552 * Signal to the window system that the application has finished
10553 * handling Configure events it has received. Window Managers can
10554 * use this to better synchronize the frame repaint with the
10555 * application. GTK+ applications will automatically call this
10556 * function when appropriate.
10558 * This function can only be called if gdk_window_enable_synchronized_configure()
10559 * was called previously.
10564 gdk_window_configure_finished (GdkWindow *window)
10566 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->configure_finished (window);
10570 * gdk_window_set_opacity:
10571 * @window: a top-level #GdkWindow
10572 * @opacity: opacity
10574 * Request the windowing system to make @window partially transparent,
10575 * with opacity 0 being fully transparent and 1 fully opaque. (Values
10576 * of the opacity parameter are clamped to the [0,1] range.)
10578 * On X11, this works only on X screens with a compositing manager
10581 * For setting up per-pixel alpha, see gdk_screen_get_rgba_visual().
10582 * For making non-toplevel windows translucent, see
10583 * gdk_window_set_composited().
10588 gdk_window_set_opacity (GdkWindow *window,
10591 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_opacity (window, opacity);
10594 /* This function is called when the XWindow is really gone.
10597 gdk_window_destroy_notify (GdkWindow *window)
10599 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->destroy_notify (window);
10603 * gdk_window_register_dnd:
10604 * @window: a #GdkWindow.
10606 * Registers a window as a potential drop destination.
10609 gdk_window_register_dnd (GdkWindow *window)
10611 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->register_dnd (window);
10615 * gdk_window_get_drag_protocol:
10616 * @window: the destination window
10617 * @target: (out) (allow-none) (transfer full): location of the window
10618 * where the drop should happen. This may be @window or a proxy window,
10619 * or %NULL if @window does not support Drag and Drop.
10621 * Finds out the DND protocol supported by a window.
10623 * Returns: the supported DND protocol.
10628 gdk_window_get_drag_protocol (GdkWindow *window,
10629 GdkWindow **target)
10631 g_return_val_if_fail (GDK_IS_WINDOW (window), GDK_DRAG_PROTO_NONE);
10633 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_drag_protocol (window, target);
10638 * @window: the source window for this drag.
10639 * @targets: (transfer none) (element-type GdkAtom): the offered targets,
10640 * as list of #GdkAtoms
10642 * Starts a drag and creates a new drag context for it.
10643 * This function assumes that the drag is controlled by the
10644 * client pointer device, use gdk_drag_begin_for_device() to
10645 * begin a drag with a different device.
10647 * This function is called by the drag source.
10649 * Return value: (transfer full): a newly created #GdkDragContext
10652 gdk_drag_begin (GdkWindow *window,
10655 GdkDeviceManager *device_manager;
10658 device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10659 device = gdk_device_manager_get_client_pointer (device_manager);
10661 return gdk_drag_begin_for_device (window, device, targets);
10665 * gdk_drag_begin_for_device:
10666 * @window: the source window for this drag
10667 * @device: the device that controls this drag
10668 * @targets: (transfer none) (element-type GdkAtom): the offered targets,
10669 * as list of #GdkAtoms
10671 * Starts a drag and creates a new drag context for it.
10673 * This function is called by the drag source.
10675 * Return value: (transfer full): a newly created #GdkDragContext
10678 gdk_drag_begin_for_device (GdkWindow *window,
10682 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->drag_begin (window, device, targets);
10686 * gdk_test_render_sync:
10687 * @window: a mapped #GdkWindow
10689 * Retrieves a pixel from @window to force the windowing
10690 * system to carry out any pending rendering commands.
10692 * This function is intended to be used to synchronize with rendering
10693 * pipelines, to benchmark windowing system rendering operations.
10698 gdk_test_render_sync (GdkWindow *window)
10700 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->sync_rendering (window);
10704 * gdk_test_simulate_key:
10705 * @window: a #GdkWindow to simulate a key event for
10706 * @x: x coordinate within @window for the key event
10707 * @y: y coordinate within @window for the key event
10708 * @keyval: A GDK keyboard value
10709 * @modifiers: Keyboard modifiers the event is setup with
10710 * @key_pressrelease: either %GDK_KEY_PRESS or %GDK_KEY_RELEASE
10712 * This function is intended to be used in GTK+ test programs.
10713 * If (@x,@y) are > (-1,-1), it will warp the mouse pointer to
10714 * the given (@x,@y) coordinates within @window and simulate a
10715 * key press or release event.
10717 * When the mouse pointer is warped to the target location, use
10718 * of this function outside of test programs that run in their
10719 * own virtual windowing system (e.g. Xvfb) is not recommended.
10720 * If (@x,@y) are passed as (-1,-1), the mouse pointer will not
10721 * be warped and @window origin will be used as mouse pointer
10722 * location for the event.
10724 * Also, gdk_test_simulate_key() is a fairly low level function,
10725 * for most testing purposes, gtk_test_widget_send_key() is the
10726 * right function to call which will generate a key press event
10727 * followed by its accompanying key release event.
10729 * Returns: whether all actions necessary for a key event simulation
10730 * were carried out successfully
10735 gdk_test_simulate_key (GdkWindow *window,
10739 GdkModifierType modifiers,
10740 GdkEventType key_pressrelease)
10742 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10743 ->simulate_key (window, x, y, keyval, modifiers, key_pressrelease);
10747 * gdk_test_simulate_button:
10748 * @window: a #GdkWindow to simulate a button event for
10749 * @x: x coordinate within @window for the button event
10750 * @y: y coordinate within @window for the button event
10751 * @button: Number of the pointer button for the event, usually 1, 2 or 3
10752 * @modifiers: Keyboard modifiers the event is setup with
10753 * @button_pressrelease: either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
10755 * This function is intended to be used in GTK+ test programs.
10756 * It will warp the mouse pointer to the given (@x,@y) coordinates
10757 * within @window and simulate a button press or release event.
10758 * Because the mouse pointer needs to be warped to the target
10759 * location, use of this function outside of test programs that
10760 * run in their own virtual windowing system (e.g. Xvfb) is not
10763 * Also, gdk_test_simulate_button() is a fairly low level function,
10764 * for most testing purposes, gtk_test_widget_click() is the right
10765 * function to call which will generate a button press event followed
10766 * by its accompanying button release event.
10768 * Returns: whether all actions necessary for a button event simulation
10769 * were carried out successfully
10774 gdk_test_simulate_button (GdkWindow *window,
10777 guint button, /*1..3*/
10778 GdkModifierType modifiers,
10779 GdkEventType button_pressrelease)
10781 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10782 ->simulate_button (window, x, y, button, modifiers, button_pressrelease);
10786 * gdk_property_get:
10787 * @window: a #GdkWindow
10788 * @property: the property to retrieve
10789 * @type: the desired property type, or %GDK_NONE, if any type of data
10790 * is acceptable. If this does not match the actual
10791 * type, then @actual_format and @actual_length will
10792 * be filled in, a warning will be printed to stderr
10793 * and no data will be returned.
10794 * @offset: the offset into the property at which to begin
10795 * retrieving data, in 4 byte units.
10796 * @length: the length of the data to retrieve in bytes. Data is
10797 * considered to be retrieved in 4 byte chunks, so @length
10798 * will be rounded up to the next highest 4 byte boundary
10799 * (so be careful not to pass a value that might overflow
10800 * when rounded up).
10801 * @pdelete: if %TRUE, delete the property after retrieving the
10803 * @actual_property_type: (out) (transfer none): location to store the
10804 * actual type of the property.
10805 * @actual_format: (out): location to store the actual return format of the
10806 * data; either 8, 16 or 32 bits.
10807 * @actual_length: location to store the length of the retrieved data, in
10808 * bytes. Data returned in the 32 bit format is stored
10809 * in a long variable, so the actual number of 32 bit
10810 * elements should be be calculated via
10811 * @actual_length / sizeof(glong) to ensure portability to
10813 * @data: (out) (array length=actual_length) (transfer full): location
10814 * to store a pointer to the data. The retrieved data should be
10815 * freed with g_free() when you are finished using it.
10817 * Retrieves a portion of the contents of a property. If the
10818 * property does not exist, then the function returns %FALSE,
10819 * and %GDK_NONE will be stored in @actual_property_type.
10823 * The XGetWindowProperty() function that gdk_property_get()
10824 * uses has a very confusing and complicated set of semantics.
10825 * uses has a very confusing and complicated set of semantics.
10826 * Unfortunately, gdk_property_get() makes the situation
10827 * worse instead of better (the semantics should be considered
10828 * undefined), and also prints warnings to stderr in cases where it
10829 * should return a useful error to the program. You are advised to use
10830 * XGetWindowProperty() directly until a replacement function for
10831 * gdk_property_get()
10836 * Returns: %TRUE if data was successfully received and stored
10837 * in @data, otherwise %FALSE.
10840 gdk_property_get (GdkWindow *window,
10846 GdkAtom *actual_property_type,
10847 gint *actual_format_type,
10848 gint *actual_length,
10851 return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10852 ->get_property (window, property, type, offset, length, pdelete,
10853 actual_property_type, actual_format_type,
10854 actual_length, data);
10858 * gdk_property_change: (skip)
10859 * @window: a #GdkWindow
10860 * @property: the property to change
10861 * @type: the new type for the property. If @mode is
10862 * %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
10863 * must match the existing type or an error will occur.
10864 * @format: the new format for the property. If @mode is
10865 * %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
10866 * must match the existing format or an error will occur.
10867 * @mode: a value describing how the new data is to be combined
10868 * with the current data.
10869 * @data: the data (a <literal>guchar *</literal>
10870 * <literal>gushort *</literal>, or <literal>gulong *</literal>,
10871 * depending on @format), cast to a <literal>guchar *</literal>.
10872 * @nelements: the number of elements of size determined by the format,
10873 * contained in @data.
10875 * Changes the contents of a property on a window.
10878 gdk_property_change (GdkWindow *window,
10883 const guchar *data,
10886 GDK_WINDOW_IMPL_GET_CLASS (window->impl)
10887 ->change_property (window, property, type, format, mode, data, nelements);
10891 * gdk_property_delete:
10892 * @window: a #GdkWindow
10893 * @property: the property to delete
10895 * Deletes a property from a window.
10898 gdk_property_delete (GdkWindow *window,
10901 GDK_WINDOW_IMPL_GET_CLASS (window->impl)->delete_property (window, property);