1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #include "gdkwindow.h"
28 #include "gdkinternals.h"
29 #include "gdk.h" /* For gdk_rectangle_union() */
30 #include "gdkpixmap.h"
31 #include "gdkdrawable.h"
32 #include "gdkpixmap.h"
33 #include "gdkscreen.h"
35 #define USE_BACKING_STORE /* Appears to work on Win32, too, now. */
37 typedef struct _GdkWindowPaint GdkWindowPaint;
39 struct _GdkWindowPaint
47 static GdkGC *gdk_window_create_gc (GdkDrawable *drawable,
49 GdkGCValuesMask mask);
50 static void gdk_window_draw_rectangle (GdkDrawable *drawable,
57 static void gdk_window_draw_arc (GdkDrawable *drawable,
66 static void gdk_window_draw_polygon (GdkDrawable *drawable,
71 static void gdk_window_draw_text (GdkDrawable *drawable,
78 static void gdk_window_draw_text_wc (GdkDrawable *drawable,
85 static void gdk_window_draw_drawable (GdkDrawable *drawable,
94 static void gdk_window_draw_points (GdkDrawable *drawable,
98 static void gdk_window_draw_segments (GdkDrawable *drawable,
102 static void gdk_window_draw_lines (GdkDrawable *drawable,
106 static void gdk_window_draw_glyphs (GdkDrawable *drawable,
111 PangoGlyphString *glyphs);
113 static void gdk_window_draw_image (GdkDrawable *drawable,
123 static void gdk_window_draw_pixbuf (GdkDrawable *drawable,
136 static GdkImage* gdk_window_copy_to_image (GdkDrawable *drawable,
145 static void gdk_window_real_get_size (GdkDrawable *drawable,
149 static GdkVisual* gdk_window_real_get_visual (GdkDrawable *drawable);
150 static gint gdk_window_real_get_depth (GdkDrawable *drawable);
151 static GdkScreen* gdk_window_real_get_screen (GdkDrawable *drawable);
152 static void gdk_window_real_set_colormap (GdkDrawable *drawable,
154 static GdkColormap* gdk_window_real_get_colormap (GdkDrawable *drawable);
156 static GdkDrawable* gdk_window_get_composite_drawable (GdkDrawable *drawable,
161 gint *composite_x_offset,
162 gint *composite_y_offset);
163 static GdkRegion* gdk_window_get_clip_region (GdkDrawable *drawable);
164 static GdkRegion* gdk_window_get_visible_region (GdkDrawable *drawable);
166 static void gdk_window_free_paint_stack (GdkWindow *window);
168 static void gdk_window_init (GdkWindowObject *window);
169 static void gdk_window_class_init (GdkWindowObjectClass *klass);
170 static void gdk_window_finalize (GObject *object);
172 static gpointer parent_class = NULL;
175 gdk_window_object_get_type (void)
177 static GType object_type = 0;
181 static const GTypeInfo object_info =
183 sizeof (GdkWindowObjectClass),
184 (GBaseInitFunc) NULL,
185 (GBaseFinalizeFunc) NULL,
186 (GClassInitFunc) gdk_window_class_init,
187 NULL, /* class_finalize */
188 NULL, /* class_data */
189 sizeof (GdkWindowObject),
191 (GInstanceInitFunc) gdk_window_init,
194 object_type = g_type_register_static (GDK_TYPE_DRAWABLE,
203 gdk_window_init (GdkWindowObject *window)
205 /* 0-initialization is good for all other fields. */
207 window->window_type = GDK_WINDOW_CHILD;
209 window->state = GDK_WINDOW_STATE_WITHDRAWN;
211 window->impl = g_object_new (_gdk_window_impl_get_type (), NULL);
215 gdk_window_class_init (GdkWindowObjectClass *klass)
217 GObjectClass *object_class = G_OBJECT_CLASS (klass);
218 GdkDrawableClass *drawable_class = GDK_DRAWABLE_CLASS (klass);
220 parent_class = g_type_class_peek_parent (klass);
222 object_class->finalize = gdk_window_finalize;
224 drawable_class->create_gc = gdk_window_create_gc;
225 drawable_class->draw_rectangle = gdk_window_draw_rectangle;
226 drawable_class->draw_arc = gdk_window_draw_arc;
227 drawable_class->draw_polygon = gdk_window_draw_polygon;
228 drawable_class->draw_text = gdk_window_draw_text;
229 drawable_class->draw_text_wc = gdk_window_draw_text_wc;
230 drawable_class->draw_drawable = gdk_window_draw_drawable;
231 drawable_class->draw_points = gdk_window_draw_points;
232 drawable_class->draw_segments = gdk_window_draw_segments;
233 drawable_class->draw_lines = gdk_window_draw_lines;
234 drawable_class->draw_glyphs = gdk_window_draw_glyphs;
235 drawable_class->draw_image = gdk_window_draw_image;
236 drawable_class->draw_pixbuf = gdk_window_draw_pixbuf;
237 drawable_class->get_depth = gdk_window_real_get_depth;
238 drawable_class->get_screen = gdk_window_real_get_screen;
239 drawable_class->get_size = gdk_window_real_get_size;
240 drawable_class->set_colormap = gdk_window_real_set_colormap;
241 drawable_class->get_colormap = gdk_window_real_get_colormap;
242 drawable_class->get_visual = gdk_window_real_get_visual;
243 drawable_class->_copy_to_image = gdk_window_copy_to_image;
244 drawable_class->get_clip_region = gdk_window_get_clip_region;
245 drawable_class->get_visible_region = gdk_window_get_visible_region;
246 drawable_class->get_composite_drawable = gdk_window_get_composite_drawable;
250 gdk_window_finalize (GObject *object)
252 GdkWindow *window = GDK_WINDOW (object);
253 GdkWindowObject *obj = (GdkWindowObject *) object;
255 if (!GDK_WINDOW_DESTROYED (window))
257 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
259 g_warning ("losing last reference to undestroyed window\n");
260 _gdk_window_destroy (window, FALSE);
263 /* We use TRUE here, to keep us from actually calling
264 * XDestroyWindow() on the window
266 _gdk_window_destroy (window, TRUE);
269 g_object_unref (obj->impl);
272 G_OBJECT_CLASS (parent_class)->finalize (object);
276 * _gdk_window_destroy_hierarchy:
277 * @window: a #GdkWindow
278 * @recursing: If TRUE, then this is being called because a parent
279 * was destroyed. This generally means that the call to the
280 * windowing system to destroy the window can be omitted, since
281 * it will be destroyed as a result of the parent being destroyed.
282 * Unless @foreign_destroy.
283 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
284 * external agency. The window has already been destroyed and no
285 * windowing system calls should be made. (This may never happen
286 * for some windowing systems.)
288 * Internal function to destroy a window. Like gdk_window_destroy(),
289 * but does not drop the reference count created by gdk_window_new().
292 _gdk_window_destroy_hierarchy (GdkWindow *window,
294 gboolean foreign_destroy)
296 GdkWindowObject *private;
297 GdkWindowObject *temp_private;
298 GdkWindow *temp_window;
302 g_return_if_fail (window != NULL);
304 private = (GdkWindowObject*) window;
306 switch (GDK_WINDOW_TYPE (window))
308 case GDK_WINDOW_TOPLEVEL:
309 case GDK_WINDOW_CHILD:
310 case GDK_WINDOW_DIALOG:
311 case GDK_WINDOW_TEMP:
312 case GDK_WINDOW_FOREIGN:
313 if (!GDK_WINDOW_DESTROYED (window))
315 private->state |= GDK_WINDOW_STATE_WITHDRAWN;
319 GdkWindowObject *parent_private = (GdkWindowObject *)private->parent;
320 if (parent_private->children)
321 parent_private->children = g_list_remove (parent_private->children, window);
324 _gdk_window_clear_update_area (window);
325 gdk_window_free_paint_stack (window);
327 if (private->bg_pixmap &&
328 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
329 private->bg_pixmap != GDK_NO_BG)
331 g_object_unref (private->bg_pixmap);
332 private->bg_pixmap = NULL;
335 if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_FOREIGN)
336 g_assert (private->children == NULL);
339 children = tmp = private->children;
340 private->children = NULL;
344 temp_window = tmp->data;
347 temp_private = (GdkWindowObject*) temp_window;
349 _gdk_window_destroy_hierarchy (temp_window,
350 TRUE, foreign_destroy);
353 g_list_free (children);
356 _gdk_windowing_window_destroy (window, recursing, foreign_destroy);
357 private->destroyed = TRUE;
359 if (private->filters)
361 tmp = private->filters;
369 g_list_free (private->filters);
370 private->filters = NULL;
373 gdk_drawable_set_colormap (GDK_DRAWABLE (window), NULL);
377 case GDK_WINDOW_ROOT:
378 g_error ("attempted to destroy root window");
384 * _gdk_window_destroy:
385 * @window: a #GdkWindow
386 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
387 * external agency. The window has already been destroyed and no
388 * windowing system calls should be made. (This may never happen
389 * for some windowing systems.)
391 * Internal function to destroy a window. Like gdk_window_destroy(),
392 * but does not drop the reference count created by gdk_window_new().
395 _gdk_window_destroy (GdkWindow *window,
396 gboolean foreign_destroy)
398 _gdk_window_destroy_hierarchy (window, FALSE, foreign_destroy);
402 * gdk_window_destroy:
403 * @window: a #GdkWindow
405 * Destroys the window system resources associated with @window and decrements @window's
406 * reference count. The window system resources for all children of @window are also
407 * destroyed, but the children's reference counts are not decremented.
409 * Note that a window will not be destroyed automatically when its reference count
410 * reaches zero. You must call this function yourself before that happens.
414 gdk_window_destroy (GdkWindow *window)
416 _gdk_window_destroy_hierarchy (window, FALSE, FALSE);
417 g_object_unref (window);
421 * gdk_window_set_user_data:
422 * @window: a #GdkWindow
423 * @user_data: user data
425 * For most purposes this function is deprecated in favor of
426 * g_object_set_data(). However, for historical reasons GTK+ stores
427 * the #GtkWidget that owns a #GdkWindow as user data on the
428 * #GdkWindow. So, custom widget implementations should use
429 * this function for that. If GTK+ receives an event for a #GdkWindow,
430 * and the user data for the window is non-%NULL, GTK+ will assume the
431 * user data is a #GtkWidget, and forward the event to that widget.
435 gdk_window_set_user_data (GdkWindow *window,
438 g_return_if_fail (window != NULL);
440 ((GdkWindowObject*)window)->user_data = user_data;
444 * gdk_window_get_user_data:
445 * @window: a #GdkWindow
446 * @data: return location for user data
448 * Retrieves the user data for @window, which is normally the widget
449 * that @window belongs to. See gdk_window_set_user_data().
453 gdk_window_get_user_data (GdkWindow *window,
456 g_return_if_fail (window != NULL);
458 *data = ((GdkWindowObject*)window)->user_data;
462 * gdk_window_get_window_type:
463 * @window: a #GdkWindow
465 * Gets the type of the window. See #GdkWindowType.
467 * Return value: type of window
470 gdk_window_get_window_type (GdkWindow *window)
472 g_return_val_if_fail (GDK_IS_WINDOW (window), (GdkWindowType) -1);
474 return GDK_WINDOW_TYPE (window);
478 * gdk_window_get_position:
479 * @window: a #GdkWindow
480 * @x: X coordinate of window
481 * @y: Y coordinate of window
483 * Obtains the position of the window as reported in the
484 * most-recently-processed #GdkEventConfigure. Contrast with
485 * gdk_window_get_geometry() which queries the X server for the
486 * current window position, regardless of which events have been
487 * received or processed.
489 * The position coordinates are relative to the window's parent window.
493 gdk_window_get_position (GdkWindow *window,
497 GdkWindowObject *obj;
499 g_return_if_fail (GDK_IS_WINDOW (window));
501 obj = (GdkWindowObject*) window;
510 * gdk_window_get_parent:
511 * @window: a #GdkWindow
513 * Obtains the parent of @window, as known to GDK. Does not query the
514 * X server; thus this returns the parent as passed to gdk_window_new(),
515 * not the actual parent. This should never matter unless you're using
516 * Xlib calls mixed with GDK calls on the X11 platform. It may also
517 * matter for toplevel windows, because the window manager may choose
520 * Return value: parent of @window
523 gdk_window_get_parent (GdkWindow *window)
525 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
527 return (GdkWindow*) ((GdkWindowObject*) window)->parent;
531 * gdk_window_get_toplevel:
532 * @window: a #GdkWindow
534 * Gets the toplevel window that's an ancestor of @window.
536 * Return value: the toplevel window containing @window
539 gdk_window_get_toplevel (GdkWindow *window)
541 GdkWindowObject *obj;
543 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
545 obj = (GdkWindowObject *)window;
546 while (GDK_WINDOW_TYPE (obj) == GDK_WINDOW_CHILD)
547 obj = (GdkWindowObject *)obj->parent;
549 return GDK_WINDOW (obj);
553 * gdk_window_get_children:
554 * @window: a #GdkWindow
556 * Gets the list of children of @window known to GDK.
557 * This function only returns children created via GDK,
558 * so for example it's useless when used with the root window;
559 * it only returns windows an application created itself.
561 * The returned list must be freed, but the elements in the
564 * Return value: list of child windows inside @window
567 gdk_window_get_children (GdkWindow *window)
569 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
571 if (GDK_WINDOW_DESTROYED (window))
574 return g_list_copy (GDK_WINDOW_OBJECT (window)->children);
578 * gdk_window_peek_children:
579 * @window: a #GdkWindow
581 * Like gdk_window_get_children(), but does not copy the list of
582 * children, so the list does not need to be freed.
584 * Return value: a reference to the list of child windows in @window
587 gdk_window_peek_children (GdkWindow *window)
589 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
591 if (GDK_WINDOW_DESTROYED (window))
594 return GDK_WINDOW_OBJECT (window)->children;
598 * gdk_window_add_filter:
599 * @window: a #GdkWindow
600 * @function: filter callback
601 * @data: data to pass to filter callback
603 * Adds an event filter to @window, allowing you to intercept events
604 * before they reach GDK. This is a low-level operation and makes it
605 * easy to break GDK and/or GTK+, so you have to know what you're
606 * doing. Pass %NULL for @window to get all events for all windows,
607 * instead of events for a specific window.
611 gdk_window_add_filter (GdkWindow *window,
612 GdkFilterFunc function,
615 GdkWindowObject *private;
617 GdkEventFilter *filter;
619 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
621 private = (GdkWindowObject*) window;
622 if (private && GDK_WINDOW_DESTROYED (window))
626 tmp_list = private->filters;
628 tmp_list = _gdk_default_filters;
632 filter = (GdkEventFilter *)tmp_list->data;
633 if ((filter->function == function) && (filter->data == data))
635 tmp_list = tmp_list->next;
638 filter = g_new (GdkEventFilter, 1);
639 filter->function = function;
643 private->filters = g_list_append (private->filters, filter);
645 _gdk_default_filters = g_list_append (_gdk_default_filters, filter);
649 * gdk_window_remove_filter:
650 * @window: a #GdkWindow
651 * @function: previously-added filter function
652 * @data: user data for previously-added filter function
654 * Remove a filter previously added with gdk_window_add_filter().
658 gdk_window_remove_filter (GdkWindow *window,
659 GdkFilterFunc function,
662 GdkWindowObject *private;
663 GList *tmp_list, *node;
664 GdkEventFilter *filter;
666 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
668 private = (GdkWindowObject*) window;
671 tmp_list = private->filters;
673 tmp_list = _gdk_default_filters;
677 filter = (GdkEventFilter *)tmp_list->data;
679 tmp_list = tmp_list->next;
681 if ((filter->function == function) && (filter->data == data))
684 private->filters = g_list_remove_link (private->filters, node);
686 _gdk_default_filters = g_list_remove_link (_gdk_default_filters, node);
687 g_list_free_1 (node);
696 * gdk_screen_get_toplevel_windows:
697 * @screen : The #GdkScreen where the toplevels are located.
699 * Obtains a list of all toplevel windows known to GDK on the screen @screen.
700 * A toplevel window is a child of the root window (see
701 * gdk_get_default_root_window()).
703 * The returned list should be freed with g_list_free(), but
704 * its elements need not be freed.
706 * Return value: list of toplevel windows, free with g_list_free()
709 gdk_screen_get_toplevel_windows (GdkScreen *screen)
711 GdkWindow * root_window;
712 GList *new_list = NULL;
715 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
717 root_window = gdk_screen_get_root_window (screen);
719 tmp_list = ((GdkWindowObject *)root_window)->children;
722 if (GDK_WINDOW_TYPE (tmp_list->data) != GDK_WINDOW_FOREIGN)
723 new_list = g_list_prepend (new_list, tmp_list->data);
724 tmp_list = tmp_list->next;
731 * gdk_window_get_toplevels:
733 * Obtains a list of all toplevel windows known to GDK on the default
734 * screen (see gdk_window_get_toplevels_for_screen()).
735 * A toplevel window is a child of the root window (see
736 * gdk_get_default_root_window()).
738 * The returned list should be freed with g_list_free(), but
739 * its elements need not be freed.
741 * Return value: list of toplevel windows, free with g_list_free()
744 gdk_window_get_toplevels (void)
746 return gdk_screen_get_toplevel_windows (gdk_screen_get_default ());
750 * gdk_window_is_visible:
751 * @window: a #GdkWindow
753 * Checks whether the window has been mapped (with gdk_window_show() or
754 * gdk_window_show_unraised()).
756 * Return value: %TRUE if the window is mapped
759 gdk_window_is_visible (GdkWindow *window)
761 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
763 return GDK_WINDOW_IS_MAPPED (window);
767 * gdk_window_is_viewable:
768 * @window: a #GdkWindow
770 * Check if the window and all ancestors of the window are
771 * mapped. (This is not necessarily "viewable" in the X sense, since
772 * we only check as far as we have GDK window parents, not to the root
775 * Return value: %TRUE if the window is viewable
778 gdk_window_is_viewable (GdkWindow *window)
780 GdkWindowObject *private = (GdkWindowObject *)window;
781 GdkScreen *screen = gdk_drawable_get_screen (window);
782 GdkWindow *root_window = gdk_screen_get_root_window (screen);
784 g_return_val_if_fail (window != NULL, FALSE);
785 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
788 (private != (GdkWindowObject *)root_window) &&
789 (GDK_WINDOW_TYPE (private) != GDK_WINDOW_FOREIGN))
791 if (!GDK_WINDOW_IS_MAPPED (window))
794 private = (GdkWindowObject *)private->parent;
801 * gdk_window_get_state:
802 * @window: a #GdkWindow
804 * Gets the bitwise OR of the currently active window state flags,
805 * from the #GdkWindowState enumeration.
807 * Return value: window state bitfield
810 gdk_window_get_state (GdkWindow *window)
812 GdkWindowObject *private = (GdkWindowObject *)window;
814 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
816 return private->state;
820 * gdk_window_begin_paint_rect:
821 * @window: a #GdkWindow
822 * @rectangle: rectangle you intend to draw to
824 * A convenience wrapper around gdk_window_begin_paint_region() which
825 * creates a rectangular region for you. See
826 * gdk_window_begin_paint_region() for details.
830 gdk_window_begin_paint_rect (GdkWindow *window,
831 GdkRectangle *rectangle)
835 g_return_if_fail (window != NULL);
836 g_return_if_fail (GDK_IS_WINDOW (window));
838 region = gdk_region_rectangle (rectangle);
839 gdk_window_begin_paint_region (window, region);
840 gdk_region_destroy (region);
844 gdk_window_get_bg_gc (GdkWindow *window, GdkWindowPaint *paint)
846 GdkWindowObject *private = (GdkWindowObject *)window;
849 GdkGCValues gc_values;
851 if (private->bg_pixmap == GDK_PARENT_RELATIVE_BG && private->parent)
853 GdkWindowPaint tmp_paint = *paint;
854 tmp_paint.x_offset += private->x;
855 tmp_paint.y_offset += private->y;
857 return gdk_window_get_bg_gc (GDK_WINDOW (private->parent), &tmp_paint);
859 else if (private->bg_pixmap &&
860 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
861 private->bg_pixmap != GDK_NO_BG)
863 gc_values.fill = GDK_TILED;
864 gc_values.tile = private->bg_pixmap;
865 gc_values.ts_x_origin = - paint->x_offset;
866 gc_values.ts_y_origin = - paint->y_offset;
868 gc_mask = (GDK_GC_FILL | GDK_GC_TILE |
869 GDK_GC_TS_X_ORIGIN | GDK_GC_TS_Y_ORIGIN);
873 gc_values.foreground = private->bg_color;
874 gc_mask = GDK_GC_FOREGROUND;
877 return gdk_gc_new_with_values (paint->pixmap, &gc_values, gc_mask);
881 gdk_window_paint_init_bg (GdkWindow *window,
882 GdkWindowPaint *paint,
883 GdkRegion *init_region)
887 tmp_gc = gdk_window_get_bg_gc (window, paint);
889 gdk_region_offset (init_region,
892 gdk_gc_set_clip_region (tmp_gc, init_region);
894 gdk_draw_rectangle (paint->pixmap, tmp_gc, TRUE, 0, 0, -1, -1);
895 g_object_unref (tmp_gc);
898 #ifdef GDK_WINDOWING_X11
899 #include "x11/gdkx.h"
903 * gdk_window_begin_paint_region:
904 * @window: a #GdkWindow
905 * @region: region you intend to draw to
907 * Indicates that you are beginning the process of redrawing @region.
908 * A backing store (offscreen buffer) large enough to contain @region
909 * will be created. The backing store will be initialized with the
910 * background color or background pixmap for @window. Then, all
911 * drawing operations performed on @window will be diverted to the
912 * backing store. When you call gdk_window_end_paint(), the backing
913 * store will be copied to @window, making it visible onscreen. Only
914 * the part of @window contained in @region will be modified; that is,
915 * drawing operations are clipped to @region.
917 * The net result of all this is to remove flicker, because the user
918 * sees the finished product appear all at once when you call
919 * gdk_window_end_paint(). If you draw to @window directly without
920 * calling gdk_window_begin_paint_region(), the user may see flicker
921 * as individual drawing operations are performed in sequence. The
922 * clipping and background-initializing features of
923 * gdk_window_begin_paint_region() are conveniences for the
924 * programmer, so you can avoid doing that work yourself.
926 * When using GTK+, the widget system automatically places calls to
927 * gdk_window_begin_paint_region() and gdk_window_end_paint() around
928 * emissions of the expose_event signal. That is, if you're writing an
929 * expose event handler, you can assume that the exposed area in
930 * #GdkEventExpose has already been cleared to the window background,
931 * is already set as the clip region, and already has a backing store.
932 * Therefore in most cases, application code need not call
933 * gdk_window_begin_paint_region(). (You can disable the automatic
934 * calls around expose events on a widget-by-widget basis by calling
935 * gtk_widget_set_double_buffered().)
937 * If you call this function multiple times before calling the
938 * matching gdk_window_end_paint(), the backing stores are pushed onto
939 * a stack. gdk_window_end_paint() copies the topmost backing store
940 * onscreen, subtracts the topmost region from all other regions in
941 * the stack, and pops the stack. All drawing operations affect only
942 * the topmost backing store in the stack. One matching call to
943 * gdk_window_end_paint() is required for each call to
944 * gdk_window_begin_paint_region().
948 gdk_window_begin_paint_region (GdkWindow *window,
951 #ifdef USE_BACKING_STORE
952 GdkWindowObject *private = (GdkWindowObject *)window;
953 GdkRectangle clip_box;
954 GdkWindowPaint *paint;
955 GdkRegion *init_region;
958 g_return_if_fail (window != NULL);
959 g_return_if_fail (GDK_IS_WINDOW (window));
961 if (GDK_WINDOW_DESTROYED (window))
964 paint = g_new (GdkWindowPaint, 1);
966 paint->region = gdk_region_copy (region);
968 init_region = gdk_region_copy (region);
969 gdk_region_get_clipbox (paint->region, &clip_box);
971 if (private->paint_stack)
973 gint old_width, old_height;
974 GdkWindowPaint *tmp_paint = private->paint_stack->data;
975 GdkRectangle old_rect, new_rect;
978 gdk_drawable_get_size (tmp_paint->pixmap, &old_width, &old_height);
979 old_rect.x = tmp_paint->x_offset;
980 old_rect.y = tmp_paint->y_offset;
981 old_rect.width = old_width;
982 old_rect.height = old_height;
984 gdk_rectangle_union (&clip_box, &old_rect, &new_rect);
986 if (new_rect.width > old_rect.width || new_rect.height > old_rect.height)
988 paint->pixmap = gdk_pixmap_new (window,
989 new_rect.width, new_rect.height, -1);
990 tmp_gc = gdk_gc_new (paint->pixmap);
991 gdk_draw_drawable (paint->pixmap, tmp_gc, tmp_paint->pixmap,
993 old_rect.x - new_rect.x, old_rect.y - new_rect.y,
994 old_rect.width, old_rect.height);
995 g_object_unref (tmp_gc);
996 g_object_unref (tmp_paint->pixmap);
998 paint->x_offset = new_rect.x;
999 paint->y_offset = new_rect.y;
1001 tmp_list = private->paint_stack;
1004 tmp_paint = tmp_list->data;
1005 gdk_region_subtract (init_region, tmp_paint->region);
1007 tmp_paint->pixmap = paint->pixmap;
1008 tmp_paint->x_offset = paint->x_offset;
1009 tmp_paint->y_offset = paint->y_offset;
1011 tmp_list = tmp_list->next;
1016 paint->x_offset = tmp_paint->x_offset;
1017 paint->y_offset = tmp_paint->y_offset;
1018 paint->pixmap = tmp_paint->pixmap;
1020 tmp_list = private->paint_stack;
1023 tmp_paint = tmp_list->data;
1024 gdk_region_subtract (init_region, tmp_paint->region);
1026 tmp_list = tmp_list->next;
1032 paint->x_offset = clip_box.x;
1033 paint->y_offset = clip_box.y;
1034 paint->pixmap = gdk_pixmap_new (window,
1035 clip_box.width, clip_box.height, -1);
1038 if (!gdk_region_empty (init_region))
1039 gdk_window_paint_init_bg (window, paint, init_region);
1041 gdk_region_destroy (init_region);
1043 private->paint_stack = g_slist_prepend (private->paint_stack, paint);
1044 #endif /* USE_BACKING_STORE */
1048 * gdk_window_end_paint:
1049 * @window: a #GdkWindow
1051 * Indicates that the backing store created by the most recent call to
1052 * gdk_window_begin_paint_region() should be copied onscreen and
1053 * deleted, leaving the next-most-recent backing store or no backing
1054 * store at all as the active paint region. See
1055 * gdk_window_begin_paint_region() for full details. It is an error to
1056 * call this function without a matching
1057 * gdk_window_begin_paint_region() first.
1061 gdk_window_end_paint (GdkWindow *window)
1063 #ifdef USE_BACKING_STORE
1064 GdkWindowObject *private = (GdkWindowObject *)window;
1065 GdkWindowPaint *paint;
1067 GdkRectangle clip_box;
1068 gint x_offset, y_offset;
1070 g_return_if_fail (window != NULL);
1071 g_return_if_fail (GDK_IS_WINDOW (window));
1073 if (GDK_WINDOW_DESTROYED (window))
1076 if (private->paint_stack == NULL)
1078 g_warning (G_STRLOC": no preceding call to gdk_window_begin_paint_region(), see documentation");
1082 paint = private->paint_stack->data;
1083 private->paint_stack = g_slist_delete_link (private->paint_stack,
1084 private->paint_stack);
1086 gdk_region_get_clipbox (paint->region, &clip_box);
1088 tmp_gc = gdk_gc_new (window);
1090 _gdk_windowing_window_get_offsets (window, &x_offset, &y_offset);
1092 gdk_gc_set_clip_region (tmp_gc, paint->region);
1093 gdk_gc_set_clip_origin (tmp_gc, -x_offset, -y_offset);
1095 gdk_draw_drawable (private->impl, tmp_gc, paint->pixmap,
1096 clip_box.x - paint->x_offset,
1097 clip_box.y - paint->y_offset,
1098 clip_box.x - x_offset, clip_box.y - y_offset,
1099 clip_box.width, clip_box.height);
1100 g_object_unref (tmp_gc);
1102 if (private->paint_stack)
1104 GSList *tmp_list = private->paint_stack;
1107 GdkWindowPaint *tmp_paint = tmp_list->data;
1108 gdk_region_subtract (tmp_paint->region, paint->region);
1110 tmp_list = tmp_list->next;
1114 g_object_unref (paint->pixmap);
1116 gdk_region_destroy (paint->region);
1118 #endif /* USE_BACKING_STORE */
1122 gdk_window_free_paint_stack (GdkWindow *window)
1124 GdkWindowObject *private = (GdkWindowObject *)window;
1126 if (private->paint_stack)
1128 GSList *tmp_list = private->paint_stack;
1132 GdkWindowPaint *paint = tmp_list->data;
1134 if (tmp_list == private->paint_stack)
1135 g_object_unref (paint->pixmap);
1137 gdk_region_destroy (paint->region);
1140 tmp_list = tmp_list->next;
1143 g_slist_free (private->paint_stack);
1144 private->paint_stack = NULL;
1149 gdk_window_get_offsets (GdkWindow *window,
1153 GdkWindowObject *private = (GdkWindowObject *)window;
1155 if (private->paint_stack)
1157 GdkWindowPaint *paint = private->paint_stack->data;
1158 *x_offset = paint->x_offset;
1159 *y_offset = paint->y_offset;
1162 _gdk_windowing_window_get_offsets (window, x_offset, y_offset);
1166 * gdk_window_get_internal_paint_info:
1167 * @window: a #GdkWindow
1168 * @real_drawable: location to store the drawable to which drawing should be
1170 * @x_offset: location to store the X offset between coordinates in @window,
1171 * and the underlying window system primitive coordinates for
1173 * @y_offset: location to store the Y offset between coordinates in @window,
1174 * and the underlying window system primitive coordinates for
1177 * If you bypass the GDK layer and use windowing system primitives to
1178 * draw directly onto a #GdkWindow, then you need to deal with two
1179 * details: there may be an offset between GDK coordinates and windowing
1180 * system coordinates, and GDK may have redirected drawing to a offscreen
1181 * pixmap as the result of a gdk_window_begin_paint_region() calls.
1182 * This function allows retrieving the information you need to compensate
1183 * for these effects.
1185 * This function exposes details of the GDK implementation, and is thus
1186 * likely to change in future releases of GDK.
1189 gdk_window_get_internal_paint_info (GdkWindow *window,
1190 GdkDrawable **real_drawable,
1196 GdkWindowObject *private;
1198 g_return_if_fail (GDK_IS_WINDOW (window));
1200 private = (GdkWindowObject *)window;
1204 if (private->paint_stack)
1206 GdkWindowPaint *paint = private->paint_stack->data;
1207 *real_drawable = paint->pixmap;
1210 *real_drawable = window;
1213 gdk_window_get_offsets (window, &x_off, &y_off);
1221 #define OFFSET_GC(gc) \
1222 gint x_offset, y_offset; \
1223 gint old_clip_x = gc->clip_x_origin; \
1224 gint old_clip_y = gc->clip_y_origin; \
1225 gint old_ts_x = gc->ts_x_origin; \
1226 gint old_ts_y = gc->ts_y_origin; \
1227 gdk_window_get_offsets (drawable, &x_offset, &y_offset); \
1228 if (x_offset != 0 || y_offset != 0) \
1230 gdk_gc_set_clip_origin (gc, old_clip_x - x_offset, \
1231 old_clip_y - y_offset); \
1232 gdk_gc_set_ts_origin (gc, old_ts_x - x_offset, \
1233 old_ts_y - y_offset); \
1236 #define RESTORE_GC(gc) \
1237 if (x_offset != 0 || y_offset != 0) \
1239 gdk_gc_set_clip_origin (gc, old_clip_x, old_clip_y); \
1240 gdk_gc_set_ts_origin (gc, old_ts_x, old_ts_y); \
1244 gdk_window_create_gc (GdkDrawable *drawable,
1245 GdkGCValues *values,
1246 GdkGCValuesMask mask)
1248 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
1250 if (GDK_WINDOW_DESTROYED (drawable))
1253 return gdk_gc_new_with_values (((GdkWindowObject *) drawable)->impl,
1258 gdk_window_draw_rectangle (GdkDrawable *drawable,
1266 GdkWindowObject *private = (GdkWindowObject *)drawable;
1269 if (GDK_WINDOW_DESTROYED (drawable))
1272 if (private->paint_stack)
1274 GdkWindowPaint *paint = private->paint_stack->data;
1275 gdk_draw_rectangle (paint->pixmap, gc, filled,
1276 x - x_offset, y - y_offset, width, height);
1279 gdk_draw_rectangle (private->impl, gc, filled,
1280 x - x_offset, y - y_offset, width, height);
1286 gdk_window_draw_arc (GdkDrawable *drawable,
1296 GdkWindowObject *private = (GdkWindowObject *)drawable;
1299 if (GDK_WINDOW_DESTROYED (drawable))
1302 if (private->paint_stack)
1304 GdkWindowPaint *paint = private->paint_stack->data;
1305 gdk_draw_arc (paint->pixmap, gc, filled,
1306 x - x_offset, y - y_offset,
1307 width, height, angle1, angle2);
1310 gdk_draw_arc (private->impl, gc, filled,
1311 x - x_offset, y - y_offset,
1312 width, height, angle1, angle2);
1317 gdk_window_draw_polygon (GdkDrawable *drawable,
1323 GdkWindowObject *private = (GdkWindowObject *)drawable;
1324 GdkPoint *new_points;
1328 if (GDK_WINDOW_DESTROYED (drawable))
1331 if (x_offset != 0 || y_offset != 0)
1335 new_points = g_new (GdkPoint, npoints);
1336 for (i=0; i<npoints; i++)
1338 new_points[i].x = points[i].x - x_offset;
1339 new_points[i].y = points[i].y - y_offset;
1343 new_points = points;
1345 if (private->paint_stack)
1347 GdkWindowPaint *paint = private->paint_stack->data;
1348 gdk_draw_polygon (paint->pixmap, gc, filled, new_points, npoints);
1352 gdk_draw_polygon (private->impl, gc, filled, new_points, npoints);
1354 if (new_points != points)
1355 g_free (new_points);
1361 gdk_window_draw_text (GdkDrawable *drawable,
1369 GdkWindowObject *private = (GdkWindowObject *)drawable;
1372 if (GDK_WINDOW_DESTROYED (drawable))
1375 if (private->paint_stack)
1377 GdkWindowPaint *paint = private->paint_stack->data;
1378 gdk_draw_text (paint->pixmap, font, gc,
1379 x - x_offset, y - y_offset, text, text_length);
1383 gdk_draw_text (private->impl, font, gc,
1384 x - x_offset, y - y_offset, text, text_length);
1390 gdk_window_draw_text_wc (GdkDrawable *drawable,
1395 const GdkWChar *text,
1398 GdkWindowObject *private = (GdkWindowObject *)drawable;
1401 if (GDK_WINDOW_DESTROYED (drawable))
1404 if (private->paint_stack)
1406 GdkWindowPaint *paint = private->paint_stack->data;
1407 gdk_draw_text_wc (paint->pixmap, font, gc,
1408 x - x_offset, y - y_offset, text, text_length);
1411 gdk_draw_text_wc (private->impl, font, gc,
1412 x - x_offset, y - y_offset, text, text_length);
1418 gdk_window_get_composite_drawable (GdkDrawable *window,
1423 gint *composite_x_offset,
1424 gint *composite_y_offset)
1426 GdkWindowObject *private = (GdkWindowObject *)window;
1427 GdkWindowPaint *paint;
1428 GdkRegion *buffered_region;
1431 GdkPixmap *tmp_pixmap;
1433 GdkRegion *rect_region;
1435 gint windowing_x_offset, windowing_y_offset;
1436 gint buffer_x_offset, buffer_y_offset;
1438 if (GDK_WINDOW_DESTROYED (window) || private->paint_stack == NULL)
1440 /* No backing store */
1441 _gdk_windowing_window_get_offsets (window,
1443 composite_y_offset);
1445 return g_object_ref (window);
1448 buffered_region = NULL;
1451 /* All GtkWindowPaint structs have the same pixmap and offsets, just
1452 * get the first one. (should probably be cleaned up so that the
1453 * pixmap is stored in the window)
1455 paint = private->paint_stack->data;
1456 buffer = paint->pixmap;
1457 buffer_x_offset = paint->x_offset;
1458 buffer_y_offset = paint->y_offset;
1460 tmp_list = private->paint_stack;
1461 while (tmp_list != NULL)
1463 paint = tmp_list->data;
1465 if (buffered_region == NULL)
1466 buffered_region = gdk_region_copy (paint->region);
1468 gdk_region_union (buffered_region, paint->region);
1470 tmp_list = g_slist_next (tmp_list);
1473 /* See if the buffered part is overlapping the part we want
1479 rect.height = height;
1481 rect_region = gdk_region_rectangle (&rect);
1483 gdk_region_intersect (buffered_region, rect_region);
1485 gdk_region_destroy (rect_region);
1487 if (gdk_region_empty (buffered_region))
1489 gdk_region_destroy (buffered_region);
1491 _gdk_windowing_window_get_offsets (window,
1493 composite_y_offset);
1495 return g_object_ref (window);
1498 tmp_pixmap = gdk_pixmap_new (window,
1502 tmp_gc = gdk_gc_new (tmp_pixmap);
1504 _gdk_windowing_window_get_offsets (window,
1505 &windowing_x_offset,
1506 &windowing_y_offset);
1508 /* Copy the current window contents */
1509 gdk_draw_drawable (tmp_pixmap,
1512 x - windowing_x_offset,
1513 y - windowing_y_offset,
1517 /* Make buffered_region relative to the tmp_pixmap */
1518 gdk_region_offset (buffered_region,
1522 /* Set the clip mask to avoid drawing over non-buffered areas of
1526 gdk_gc_set_clip_region (tmp_gc, buffered_region);
1527 gdk_region_destroy (buffered_region);
1529 /* Draw backing pixmap onto the tmp_pixmap, offsetting
1532 gdk_draw_drawable (tmp_pixmap,
1535 x - buffer_x_offset,
1536 y - buffer_y_offset,
1540 /* Set these to location of tmp_pixmap within the window */
1541 *composite_x_offset = x;
1542 *composite_y_offset = y;
1544 g_object_unref (tmp_gc);
1550 gdk_window_get_clip_region (GdkDrawable *drawable)
1552 GdkWindowObject *private = (GdkWindowObject *)drawable;
1555 result = gdk_drawable_get_clip_region (private->impl);
1557 if (private->paint_stack)
1559 GdkRegion *paint_region = gdk_region_new ();
1560 GSList *tmp_list = private->paint_stack;
1564 GdkWindowPaint *paint = tmp_list->data;
1566 gdk_region_union (paint_region, paint->region);
1568 tmp_list = tmp_list->next;
1571 gdk_region_intersect (result, paint_region);
1572 gdk_region_destroy (paint_region);
1579 gdk_window_get_visible_region (GdkDrawable *drawable)
1581 GdkWindowObject *private = (GdkWindowObject*) drawable;
1583 return gdk_drawable_get_visible_region (private->impl);
1587 gdk_window_draw_drawable (GdkDrawable *drawable,
1597 GdkWindowObject *private = (GdkWindowObject *)drawable;
1600 if (GDK_WINDOW_DESTROYED (drawable))
1603 /* If we have a backing pixmap draw to that */
1604 if (private->paint_stack)
1606 GdkWindowPaint *paint = private->paint_stack->data;
1607 gdk_draw_drawable (paint->pixmap, gc,
1609 xdest - x_offset, ydest - y_offset, width, height);
1613 gdk_draw_drawable (private->impl, gc,
1615 xdest - x_offset, ydest - y_offset,
1622 gdk_window_draw_points (GdkDrawable *drawable,
1627 GdkWindowObject *private = (GdkWindowObject *)drawable;
1628 GdkPoint *new_points;
1632 if (GDK_WINDOW_DESTROYED (drawable))
1635 if (x_offset != 0 || y_offset != 0)
1639 new_points = g_new (GdkPoint, npoints);
1640 for (i=0; i<npoints; i++)
1642 new_points[i].x = points[i].x - x_offset;
1643 new_points[i].y = points[i].y - y_offset;
1647 new_points = points;
1649 if (private->paint_stack)
1651 GdkWindowPaint *paint = private->paint_stack->data;
1652 gdk_draw_points (paint->pixmap, gc, new_points, npoints);
1655 gdk_draw_points (private->impl, gc, points, npoints);
1657 if (new_points != points)
1658 g_free (new_points);
1664 gdk_window_draw_segments (GdkDrawable *drawable,
1669 GdkWindowObject *private = (GdkWindowObject *)drawable;
1670 GdkSegment *new_segs;
1674 if (GDK_WINDOW_DESTROYED (drawable))
1677 if (x_offset != 0 || y_offset != 0)
1681 new_segs = g_new (GdkSegment, nsegs);
1682 for (i=0; i<nsegs; i++)
1684 new_segs[i].x1 = segs[i].x1 - x_offset;
1685 new_segs[i].y1 = segs[i].y1 - y_offset;
1686 new_segs[i].x2 = segs[i].x2 - x_offset;
1687 new_segs[i].y2 = segs[i].y2 - y_offset;
1693 if (private->paint_stack)
1695 GdkWindowPaint *paint = private->paint_stack->data;
1696 gdk_draw_segments (paint->pixmap, gc, new_segs, nsegs);
1699 gdk_draw_segments (private->impl, gc, new_segs, nsegs);
1701 if (new_segs != segs)
1708 gdk_window_draw_lines (GdkDrawable *drawable,
1713 GdkWindowObject *private = (GdkWindowObject *)drawable;
1714 GdkPoint *new_points;
1718 if (GDK_WINDOW_DESTROYED (drawable))
1721 if (x_offset != 0 || y_offset != 0)
1725 new_points = g_new (GdkPoint, npoints);
1726 for (i=0; i<npoints; i++)
1728 new_points[i].x = points[i].x - x_offset;
1729 new_points[i].y = points[i].y - y_offset;
1733 new_points = points;
1735 if (private->paint_stack)
1737 GdkWindowPaint *paint = private->paint_stack->data;
1738 gdk_draw_lines (paint->pixmap, gc, new_points, npoints);
1741 gdk_draw_lines (private->impl, gc, new_points, npoints);
1743 if (new_points != points)
1744 g_free (new_points);
1750 gdk_window_draw_glyphs (GdkDrawable *drawable,
1755 PangoGlyphString *glyphs)
1757 GdkWindowObject *private = (GdkWindowObject *)drawable;
1761 if (GDK_WINDOW_DESTROYED (drawable))
1764 if (private->paint_stack)
1766 GdkWindowPaint *paint = private->paint_stack->data;
1768 gdk_draw_glyphs (paint->pixmap, gc, font, x - x_offset, y - y_offset, glyphs);
1771 gdk_draw_glyphs (private->impl, gc, font,
1772 x - x_offset, y - y_offset, glyphs);
1777 /* Fixme - this is just like gdk_window_paint_init_bg */
1779 gdk_window_clear_backing_rect (GdkWindow *window,
1785 GdkWindowObject *private = (GdkWindowObject *)window;
1786 GdkWindowPaint *paint = private->paint_stack->data;
1789 if (GDK_WINDOW_DESTROYED (window))
1792 tmp_gc = gdk_window_get_bg_gc (window, paint);
1793 gdk_draw_rectangle (paint->pixmap, tmp_gc, TRUE,
1794 x - paint->x_offset, y - paint->y_offset, width, height);
1795 g_object_unref (tmp_gc);
1800 * @window: a #GdkWindow
1802 * Clears an entire @window to the background color or background pixmap.
1805 gdk_window_clear (GdkWindow *window)
1809 g_return_if_fail (window != NULL);
1810 g_return_if_fail (GDK_IS_WINDOW (window));
1812 gdk_drawable_get_size (GDK_DRAWABLE (window), &width, &height);
1814 gdk_window_clear_area (window, 0, 0,
1819 * gdk_window_clear_area:
1820 * @window: a #GdkWindow
1821 * @x: x coordinate of rectangle to clear
1822 * @y: y coordinate of rectangle to clear
1823 * @width: width of rectangle to clear
1824 * @height: height of rectangle to clear
1826 * Clears an area of @window to the background color or background pixmap.
1830 gdk_window_clear_area (GdkWindow *window,
1836 GdkWindowObject *private = (GdkWindowObject *)window;
1838 g_return_if_fail (window != NULL);
1839 g_return_if_fail (GDK_IS_WINDOW (window));
1841 if (private->paint_stack)
1842 gdk_window_clear_backing_rect (window, x, y, width, height);
1844 _gdk_windowing_window_clear_area (window, x, y, width, height);
1848 * gdk_window_clear_area_e:
1849 * @window: a #GdkWindow
1850 * @x: x coordinate of rectangle to clear
1851 * @y: y coordinate of rectangle to clear
1852 * @width: width of rectangle to clear
1853 * @height: height of rectangle to clear
1855 * Like gdk_window_clear_area(), but also generates an expose event for
1858 * This function has a stupid name because it dates back to the mists
1859 * time, pre-GDK-1.0.
1863 gdk_window_clear_area_e (GdkWindow *window,
1869 GdkWindowObject *private = (GdkWindowObject *)window;
1871 g_return_if_fail (window != NULL);
1872 g_return_if_fail (GDK_IS_WINDOW (window));
1874 if (private->paint_stack)
1875 gdk_window_clear_backing_rect (window, x, y, width, height);
1877 _gdk_windowing_window_clear_area_e (window, x, y, width, height);
1881 gdk_window_draw_image (GdkDrawable *drawable,
1891 GdkWindowObject *private = (GdkWindowObject *)drawable;
1895 if (GDK_WINDOW_DESTROYED (drawable))
1898 if (private->paint_stack)
1900 GdkWindowPaint *paint = private->paint_stack->data;
1901 gdk_draw_image (paint->pixmap, gc, image, xsrc, ysrc,
1902 xdest - x_offset, ydest - y_offset,
1907 gdk_draw_image (private->impl, gc, image, xsrc, ysrc,
1908 xdest - x_offset, ydest - y_offset,
1915 gdk_window_draw_pixbuf (GdkDrawable *drawable,
1924 GdkRgbDither dither,
1928 GdkWindowObject *private = (GdkWindowObject *)drawable;
1930 if (GDK_WINDOW_DESTROYED (drawable))
1937 if (private->paint_stack)
1939 GdkWindowPaint *paint = private->paint_stack->data;
1940 gdk_draw_pixbuf (paint->pixmap, gc, pixbuf, src_x, src_y,
1941 dest_x - x_offset, dest_y - y_offset,
1943 dither, x_dither - x_offset, y_dither - y_offset);
1946 gdk_draw_pixbuf (private->impl, gc, pixbuf, src_x, src_y,
1947 dest_x - x_offset, dest_y - y_offset,
1949 dither, x_dither, y_dither);
1955 gint x_offset, y_offset;
1956 gdk_window_get_offsets (drawable, &x_offset, &y_offset);
1958 if (private->paint_stack)
1960 GdkWindowPaint *paint = private->paint_stack->data;
1961 gdk_draw_pixbuf (paint->pixmap, gc, pixbuf, src_x, src_y,
1962 dest_x - x_offset, dest_y - y_offset,
1964 dither, x_dither - x_offset, y_dither - y_offset);
1967 gdk_draw_pixbuf (private->impl, gc, pixbuf, src_x, src_y,
1968 dest_x - x_offset, dest_y - y_offset,
1970 dither, x_dither, y_dither);
1975 gdk_window_real_get_size (GdkDrawable *drawable,
1979 g_return_if_fail (GDK_IS_WINDOW (drawable));
1981 gdk_drawable_get_size (GDK_WINDOW_OBJECT (drawable)->impl,
1986 gdk_window_real_get_visual (GdkDrawable *drawable)
1988 GdkColormap *colormap;
1990 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
1992 colormap = gdk_drawable_get_colormap (drawable);
1993 return colormap ? gdk_colormap_get_visual (colormap) : NULL;
1997 gdk_window_real_get_depth (GdkDrawable *drawable)
1999 g_return_val_if_fail (GDK_IS_WINDOW (drawable), 0);
2001 return ((GdkWindowObject *)GDK_WINDOW (drawable))->depth;
2005 gdk_window_real_get_screen (GdkDrawable *drawable)
2007 return gdk_drawable_get_screen (GDK_WINDOW_OBJECT (drawable)->impl);
2011 gdk_window_real_set_colormap (GdkDrawable *drawable,
2014 g_return_if_fail (GDK_IS_WINDOW (drawable));
2016 if (GDK_WINDOW_DESTROYED (drawable))
2019 gdk_drawable_set_colormap (((GdkWindowObject*)drawable)->impl, cmap);
2023 gdk_window_real_get_colormap (GdkDrawable *drawable)
2025 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
2027 if (GDK_WINDOW_DESTROYED (drawable))
2030 return gdk_drawable_get_colormap (((GdkWindowObject*)drawable)->impl);
2034 gdk_window_copy_to_image (GdkDrawable *drawable,
2043 gint x_offset, y_offset;
2045 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
2047 if (GDK_WINDOW_DESTROYED (drawable))
2050 /* If we're here, a composite image was not necessary, so
2051 * we can ignore the paint stack.
2054 _gdk_windowing_window_get_offsets (drawable, &x_offset, &y_offset);
2056 return _gdk_drawable_copy_to_image (((GdkWindowObject*)drawable)->impl,
2064 /* Code for dirty-region queueing
2067 static GSList *update_windows = NULL;
2068 static guint update_idle = 0;
2069 static gboolean debug_updates = FALSE;
2072 gdk_window_process_updates_internal (GdkWindow *window)
2074 GdkWindowObject *private = (GdkWindowObject *)window;
2075 gboolean save_region = FALSE;
2077 /* If an update got queued during update processing, we can get a
2078 * window in the update queue that has an empty update_area.
2081 if (private->update_area)
2083 GdkRegion *update_area = private->update_area;
2084 private->update_area = NULL;
2086 if (_gdk_event_func && gdk_window_is_viewable (window) &&
2087 (private->event_mask & GDK_EXPOSURE_MASK))
2090 GdkRectangle window_rect;
2091 GdkRegion *expose_region;
2092 GdkRegion *window_region;
2097 /* Make sure we see the red invalid area before redrawing. */
2098 gdk_display_sync (gdk_drawable_get_display (window));
2102 gdk_drawable_get_size (GDK_DRAWABLE (private), &width, &height);
2106 window_rect.width = width;
2107 window_rect.height = height;
2109 save_region = _gdk_windowing_window_queue_antiexpose (window, update_area);
2111 event.expose.type = GDK_EXPOSE;
2112 event.expose.window = g_object_ref (window);
2113 event.expose.count = 0;
2116 expose_region = gdk_region_copy (update_area);
2118 expose_region = update_area;
2119 window_region = gdk_region_rectangle (&window_rect);
2120 gdk_region_intersect (expose_region,
2122 gdk_region_destroy (window_region);
2124 event.expose.region = expose_region;
2125 gdk_region_get_clipbox (expose_region, &event.expose.area);
2127 if (!gdk_region_empty (expose_region))
2129 (*_gdk_event_func) (&event, _gdk_event_data);
2132 if (expose_region != update_area)
2133 gdk_region_destroy (expose_region);
2134 g_object_unref (window);
2137 gdk_region_destroy (update_area);
2142 * gdk_window_process_all_updates:
2144 * Calls gdk_window_process_updates() for all windows (see #GdkWindow)
2145 * in the application.
2149 gdk_window_process_all_updates (void)
2151 GSList *old_update_windows = update_windows;
2152 GSList *tmp_list = update_windows;
2155 g_source_remove (update_idle);
2157 update_windows = NULL;
2160 g_slist_foreach (old_update_windows, (GFunc)g_object_ref, NULL);
2164 gdk_window_process_updates_internal (tmp_list->data);
2165 g_object_unref (tmp_list->data);
2166 tmp_list = tmp_list->next;
2169 g_slist_free (old_update_windows);
2175 gdk_window_update_idle (gpointer data)
2177 GDK_THREADS_ENTER ();
2178 gdk_window_process_all_updates ();
2179 GDK_THREADS_LEAVE ();
2185 * gdk_window_process_updates:
2186 * @window: a #GdkWindow
2187 * @update_children: whether to also process updates for child windows
2189 * Sends one or more expose events to @window. The areas in each
2190 * expose event will cover the entire update area for the window (see
2191 * gdk_window_invalidate_region() for details). Normally GDK calls
2192 * gdk_window_process_all_updates() on your behalf, so there's no
2193 * need to call this function unless you want to force expose events
2194 * to be delivered immediately and synchronously (vs. the usual
2195 * case, where GDK delivers them in an idle handler). Occasionally
2196 * this is useful to produce nicer scrolling behavior, for example.
2200 gdk_window_process_updates (GdkWindow *window,
2201 gboolean update_children)
2203 GdkWindowObject *private = (GdkWindowObject *)window;
2205 g_return_if_fail (window != NULL);
2206 g_return_if_fail (GDK_IS_WINDOW (window));
2208 if (private->update_area)
2210 gdk_window_process_updates_internal (window);
2211 update_windows = g_slist_remove (update_windows, window);
2214 if (update_children)
2216 GList *tmp_list = private->children;
2219 gdk_window_process_updates (tmp_list->data, TRUE);
2220 tmp_list = tmp_list->next;
2226 * gdk_window_invalidate_rect:
2227 * @window: a #GdkWindow
2228 * @rect: rectangle to invalidate
2229 * @invalidate_children: whether to also invalidate child windows
2231 * A convenience wrapper around gdk_window_invalidate_region() which
2232 * invalidates a rectangular region. See
2233 * gdk_window_invalidate_region() for details.
2237 gdk_window_invalidate_rect (GdkWindow *window,
2239 gboolean invalidate_children)
2241 GdkRectangle window_rect;
2243 GdkWindowObject *private = (GdkWindowObject *)window;
2245 g_return_if_fail (window != NULL);
2246 g_return_if_fail (GDK_IS_WINDOW (window));
2248 if (GDK_WINDOW_DESTROYED (window))
2251 if (private->input_only || !GDK_WINDOW_IS_MAPPED (window))
2258 gdk_drawable_get_size (GDK_DRAWABLE (window),
2260 &window_rect.height);
2261 rect = &window_rect;
2264 region = gdk_region_rectangle (rect);
2265 gdk_window_invalidate_region (window, region, invalidate_children);
2266 gdk_region_destroy (region);
2270 draw_ugly_color (GdkWindow *window,
2273 /* Draw ugly color all over the newly-invalid region */
2274 GdkColor ugly_color = { 0, 50000, 10000, 10000 };
2276 GdkRectangle clipbox;
2278 ugly_gc = gdk_gc_new (window);
2279 gdk_gc_set_rgb_fg_color (ugly_gc, &ugly_color);
2280 gdk_gc_set_clip_region (ugly_gc, region);
2282 gdk_region_get_clipbox (region, &clipbox);
2284 gdk_draw_rectangle (window,
2287 clipbox.x, clipbox.y,
2288 clipbox.width, clipbox.height);
2290 g_object_unref (ugly_gc);
2294 * gdk_window_invalidate_maybe_recurse:
2295 * @window: a #GdkWindow
2296 * @region: a #GdkRegion
2297 * @child_func: function to use to decide if to recurse to a child,
2298 * %NULL means never recurse.
2299 * @user_data: data passed to @child_func
2301 * Adds @region to the update area for @window. The update area is the
2302 * region that needs to be redrawn, or "dirty region." The call
2303 * gdk_window_process_updates() sends one or more expose events to the
2304 * window, which together cover the entire update area. An
2305 * application would normally redraw the contents of @window in
2306 * response to those expose events.
2308 * GDK will call gdk_window_process_all_updates() on your behalf
2309 * whenever your program returns to the main loop and becomes idle, so
2310 * normally there's no need to do that manually, you just need to
2311 * invalidate regions that you know should be redrawn.
2313 * The @child_func parameter controls whether the region of
2314 * each child window that intersects @region will also be invalidated.
2315 * Only children for which @child_func returns TRUE will have the area
2319 gdk_window_invalidate_maybe_recurse (GdkWindow *window,
2321 gboolean (*child_func) (GdkWindow *, gpointer),
2324 GdkWindowObject *private = (GdkWindowObject *)window;
2325 GdkRegion *visible_region;
2327 g_return_if_fail (window != NULL);
2328 g_return_if_fail (GDK_IS_WINDOW (window));
2330 if (GDK_WINDOW_DESTROYED (window))
2333 if (private->input_only || !GDK_WINDOW_IS_MAPPED (window))
2336 visible_region = gdk_drawable_get_visible_region (window);
2337 gdk_region_intersect (visible_region, region);
2339 if (!gdk_region_empty (visible_region))
2342 draw_ugly_color (window, region);
2344 if (private->update_area)
2346 gdk_region_union (private->update_area, visible_region);
2350 update_windows = g_slist_prepend (update_windows, window);
2351 private->update_area = gdk_region_copy (visible_region);
2353 if (!private->update_freeze_count && !update_idle)
2354 update_idle = g_idle_add_full (GDK_PRIORITY_REDRAW,
2355 gdk_window_update_idle, NULL, NULL);
2362 tmp_list = private->children;
2365 GdkWindowObject *child = tmp_list->data;
2366 tmp_list = tmp_list->next;
2368 if (!child->input_only && (*child_func) ((GdkWindow *)child, user_data))
2370 GdkRegion *child_region;
2373 gdk_window_get_position ((GdkWindow *)child, &x, &y);
2375 /* This copy could be saved with a little more complexity */
2376 child_region = gdk_region_copy (visible_region);
2377 gdk_region_offset (child_region, -x, -y);
2379 gdk_window_invalidate_maybe_recurse ((GdkWindow *)child, child_region, child_func, user_data);
2381 gdk_region_destroy (child_region);
2387 gdk_region_destroy (visible_region);
2391 true_predicate (GdkWindow *window,
2398 * gdk_window_invalidate_region:
2399 * @window: a #GdkWindow
2400 * @region: a #GdkRegion
2401 * @invalidate_children: %TRUE to also invalidate child windows
2403 * Adds @region to the update area for @window. The update area is the
2404 * region that needs to be redrawn, or "dirty region." The call
2405 * gdk_window_process_updates() sends one or more expose events to the
2406 * window, which together cover the entire update area. An
2407 * application would normally redraw the contents of @window in
2408 * response to those expose events.
2410 * GDK will call gdk_window_process_all_updates() on your behalf
2411 * whenever your program returns to the main loop and becomes idle, so
2412 * normally there's no need to do that manually, you just need to
2413 * invalidate regions that you know should be redrawn.
2415 * The @invalidate_children parameter controls whether the region of
2416 * each child window that intersects @region will also be invalidated.
2417 * If %FALSE, then the update area for child windows will remain
2418 * unaffected. See gdk_window_invalidate_maybe_recurse if you need
2419 * fine grained control over which children are invalidated.
2422 gdk_window_invalidate_region (GdkWindow *window,
2424 gboolean invalidate_children)
2426 gdk_window_invalidate_maybe_recurse (window, region,
2427 invalidate_children ?
2428 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
2433 * gdk_window_get_update_area:
2434 * @window: a #GdkWindow
2436 * Transfers ownership of the update area from @window to the caller
2437 * of the function. That is, after calling this function, @window will
2438 * no longer have an invalid/dirty region; the update area is removed
2439 * from @window and handed to you. If a window has no update area,
2440 * gdk_window_get_update_area() returns %NULL. You are responsible for
2441 * calling gdk_region_destroy() on the returned region if it's non-%NULL.
2443 * Return value: the update area for @window
2446 gdk_window_get_update_area (GdkWindow *window)
2448 GdkWindowObject *private = (GdkWindowObject *)window;
2449 GdkRegion *tmp_region;
2451 g_return_val_if_fail (window != NULL, NULL);
2452 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2454 if (private->update_area)
2456 tmp_region = private->update_area;
2457 private->update_area = NULL;
2459 update_windows = g_slist_remove (update_windows, window);
2468 * _gdk_window_clear_update_area:
2469 * @window: a #GdkWindow.
2471 * Internal function to clear the update area for a window. This
2472 * is called when the window is hidden or destroyed.
2475 _gdk_window_clear_update_area (GdkWindow *window)
2477 GdkWindowObject *private = (GdkWindowObject *)window;
2479 g_return_if_fail (window != NULL);
2480 g_return_if_fail (GDK_IS_WINDOW (window));
2482 if (private->update_area)
2484 update_windows = g_slist_remove (update_windows, window);
2486 gdk_region_destroy (private->update_area);
2487 private->update_area = NULL;
2492 * gdk_window_freeze_updates:
2493 * @window: a #GdkWindow
2495 * Temporarily freezes a window such that it won't receive expose
2496 * events. The window will begin receiving expose events again when
2497 * gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
2498 * has been called more than once, gdk_window_thaw_updates() must be called
2499 * an equal number of times to begin processing exposes.
2502 gdk_window_freeze_updates (GdkWindow *window)
2504 GdkWindowObject *private = (GdkWindowObject *)window;
2506 g_return_if_fail (window != NULL);
2507 g_return_if_fail (GDK_IS_WINDOW (window));
2509 private->update_freeze_count++;
2513 * gdk_window_thaw_updates:
2514 * @window: a #GdkWindow
2516 * Thaws a window frozen with gdk_window_freeze_updates().
2519 gdk_window_thaw_updates (GdkWindow *window)
2521 GdkWindowObject *private = (GdkWindowObject *)window;
2523 g_return_if_fail (window != NULL);
2524 g_return_if_fail (GDK_IS_WINDOW (window));
2525 g_return_if_fail (private->update_freeze_count > 0);
2527 private->update_freeze_count--;
2528 if (!private->update_freeze_count && private->update_area && !update_idle)
2529 update_idle = g_idle_add_full (GDK_PRIORITY_REDRAW,
2530 gdk_window_update_idle, NULL, NULL);
2534 * gdk_window_set_debug_updates:
2535 * @setting: %TRUE to turn on update debugging
2537 * With update debugging enabled, calls to
2538 * gdk_window_invalidate_region() clear the invalidated region of the
2539 * screen to a noticeable color, and GDK pauses for a short time
2540 * before sending exposes to windows during
2541 * gdk_window_process_updates(). The net effect is that you can see
2542 * the invalid region for each window and watch redraws as they
2543 * occur. This allows you to diagnose inefficiencies in your application.
2545 * In essence, because the GDK rendering model prevents all flicker,
2546 * if you are redrawing the same region 400 times you may never
2547 * notice, aside from noticing a speed problem. Enabling update
2548 * debugging causes GTK to flicker slowly and noticeably, so you can
2549 * see exactly what's being redrawn when, in what order.
2551 * The --gtk-debug=updates command line option passed to GTK+ programs
2552 * enables this debug option at application startup time. That's
2553 * usually more useful than calling gdk_window_set_debug_updates()
2554 * yourself, though you might want to use this function to enable
2555 * updates sometime after application startup time.
2559 gdk_window_set_debug_updates (gboolean setting)
2561 debug_updates = setting;
2565 * gdk_window_constrain_size:
2566 * @geometry: a #GdkGeometry structure
2567 * @flags: a mask indicating what portions of @geometry are set
2568 * @width: desired width of window
2569 * @height: desired height of the window
2570 * @new_width: location to store resulting width
2571 * @new_height: location to store resulting height
2573 * Constrains a desired width and height according to a
2574 * set of geometry hints (such as minimum and maximum size).
2577 gdk_window_constrain_size (GdkGeometry *geometry,
2584 /* This routine is partially borrowed from fvwm.
2586 * Copyright 1993, Robert Nation
2587 * You may use this code for any purpose, as long as the original
2588 * copyright remains in the source code and all documentation
2590 * which in turn borrows parts of the algorithm from uwm
2593 gint min_height = 0;
2594 gint base_width = 0;
2595 gint base_height = 0;
2598 gint max_width = G_MAXINT;
2599 gint max_height = G_MAXINT;
2601 #define FLOOR(value, base) ( ((gint) ((value) / (base))) * (base) )
2603 if ((flags & GDK_HINT_BASE_SIZE) && (flags & GDK_HINT_MIN_SIZE))
2605 base_width = geometry->base_width;
2606 base_height = geometry->base_height;
2607 min_width = geometry->min_width;
2608 min_height = geometry->min_height;
2610 else if (flags & GDK_HINT_BASE_SIZE)
2612 base_width = geometry->base_width;
2613 base_height = geometry->base_height;
2614 min_width = geometry->base_width;
2615 min_height = geometry->base_height;
2617 else if (flags & GDK_HINT_MIN_SIZE)
2619 base_width = geometry->min_width;
2620 base_height = geometry->min_height;
2621 min_width = geometry->min_width;
2622 min_height = geometry->min_height;
2625 if (flags & GDK_HINT_MAX_SIZE)
2627 max_width = geometry->max_width ;
2628 max_height = geometry->max_height;
2631 if (flags & GDK_HINT_RESIZE_INC)
2633 xinc = MAX (xinc, geometry->width_inc);
2634 yinc = MAX (yinc, geometry->height_inc);
2637 /* clamp width and height to min and max values
2639 width = CLAMP (width, min_width, max_width);
2640 height = CLAMP (height, min_height, max_height);
2642 /* shrink to base + N * inc
2644 width = base_width + FLOOR (width - base_width, xinc);
2645 height = base_height + FLOOR (height - base_height, yinc);
2647 /* constrain aspect ratio, according to:
2650 * min_aspect <= -------- <= max_aspect
2654 if (flags & GDK_HINT_ASPECT &&
2655 geometry->min_aspect > 0 &&
2656 geometry->max_aspect > 0)
2660 if (geometry->min_aspect * height > width)
2662 delta = FLOOR (height - width * geometry->min_aspect, yinc);
2663 if (height - delta >= min_height)
2667 delta = FLOOR (height * geometry->min_aspect - width, xinc);
2668 if (width + delta <= max_width)
2673 if (geometry->max_aspect * height < width)
2675 delta = FLOOR (width - height * geometry->max_aspect, xinc);
2676 if (width - delta >= min_width)
2680 delta = FLOOR (width / geometry->max_aspect - height, yinc);
2681 if (height + delta <= max_height)
2690 *new_height = height;
2694 * gdk_window_get_pointer:
2695 * @window: a #GdkWindow
2696 * @x: return location for X coordinate of pointer
2697 * @y: return location for Y coordinate of pointer
2698 * @mask: return location for modifier mask
2700 * Obtains the current pointer position and modifier state.
2701 * The position is given in coordinates relative to @window.
2703 * Return value: the window containing the pointer (as with
2704 * gdk_window_at_pointer()), or %NULL if the window containing the
2705 * pointer isn't known to GDK
2708 gdk_window_get_pointer (GdkWindow *window,
2711 GdkModifierType *mask)
2713 GdkDisplay *display;
2715 GdkModifierType tmp_mask;
2718 g_return_val_if_fail (window == NULL || GDK_IS_WINDOW (window), NULL);
2722 display = gdk_drawable_get_display (window);
2726 GdkScreen *screen = gdk_screen_get_default ();
2728 display = gdk_screen_get_display (screen);
2729 window = gdk_screen_get_root_window (screen);
2731 GDK_NOTE (MULTIHEAD,
2732 g_message ("Passing NULL for window to gdk_window_get_pointer()\n"
2733 "is not multihead safe"));
2736 child = display->pointer_hooks->window_get_pointer (display, window, &tmp_x, &tmp_y, &tmp_mask);
2749 * gdk_window_at_pointer:
2750 * @win_x: return location for origin of the window under the pointer
2751 * @win_y: return location for origin of the window under the pointer
2753 * Obtains the window underneath the mouse pointer, returning the
2754 * location of that window in @win_x, @win_y. Returns %NULL if the
2755 * window under the mouse pointer is not known to GDK (if the window
2756 * belongs to another application and a #GdkWindow hasn't been created
2757 * for it with gdk_window_foreign_new())
2759 * NOTE: For multihead-aware widgets or applications use
2760 * gdk_display_get_window_at_pointer() instead.
2762 * Return value: window under the mouse pointer
2765 gdk_window_at_pointer (gint *win_x,
2768 return gdk_display_get_window_at_pointer (gdk_display_get_default (), win_x, win_y);
2772 * gdk_get_default_root_window:
2774 * Obtains the root window (parent all other windows are inside)
2775 * for the default display and screen.
2777 * Return value: the default root window
2780 gdk_get_default_root_window (void)
2782 return gdk_screen_get_root_window (gdk_screen_get_default ());
2786 * gdk_window_foreign_new:
2787 * @anid: a native window handle.
2789 * Wraps a native window for the default display in a #GdkWindow.
2790 * This may fail if the window has been destroyed.
2792 * For example in the X backend, a native window handle is an Xlib
2795 * Return value: the newly-created #GdkWindow wrapper for the
2796 * native window or %NULL if the window has been destroyed.
2799 gdk_window_foreign_new (GdkNativeWindow anid)
2801 return gdk_window_foreign_new_for_display (gdk_display_get_default (), anid);