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 const GdkPointerHooks default_pointer_hooks = {
48 _gdk_windowing_window_get_pointer,
49 _gdk_windowing_window_at_pointer
52 const GdkPointerHooks *_gdk_current_pointer_hooks = &default_pointer_hooks;
54 static GdkGC *gdk_window_create_gc (GdkDrawable *drawable,
56 GdkGCValuesMask mask);
57 static void gdk_window_draw_rectangle (GdkDrawable *drawable,
64 static void gdk_window_draw_arc (GdkDrawable *drawable,
73 static void gdk_window_draw_polygon (GdkDrawable *drawable,
78 static void gdk_window_draw_text (GdkDrawable *drawable,
85 static void gdk_window_draw_text_wc (GdkDrawable *drawable,
92 static void gdk_window_draw_drawable (GdkDrawable *drawable,
101 static void gdk_window_draw_points (GdkDrawable *drawable,
105 static void gdk_window_draw_segments (GdkDrawable *drawable,
109 static void gdk_window_draw_lines (GdkDrawable *drawable,
113 static void gdk_window_draw_glyphs (GdkDrawable *drawable,
118 PangoGlyphString *glyphs);
120 static void gdk_window_draw_image (GdkDrawable *drawable,
130 static void gdk_window_draw_pixbuf (GdkDrawable *drawable,
143 static GdkImage* gdk_window_copy_to_image (GdkDrawable *drawable,
152 static void gdk_window_real_get_size (GdkDrawable *drawable,
156 static GdkVisual* gdk_window_real_get_visual (GdkDrawable *drawable);
157 static gint gdk_window_real_get_depth (GdkDrawable *drawable);
158 static GdkScreen* gdk_window_real_get_screen (GdkDrawable *drawable);
159 static void gdk_window_real_set_colormap (GdkDrawable *drawable,
161 static GdkColormap* gdk_window_real_get_colormap (GdkDrawable *drawable);
163 static GdkDrawable* gdk_window_get_composite_drawable (GdkDrawable *drawable,
168 gint *composite_x_offset,
169 gint *composite_y_offset);
170 static GdkRegion* gdk_window_get_clip_region (GdkDrawable *drawable);
171 static GdkRegion* gdk_window_get_visible_region (GdkDrawable *drawable);
173 static void gdk_window_free_paint_stack (GdkWindow *window);
175 static void gdk_window_init (GdkWindowObject *window);
176 static void gdk_window_class_init (GdkWindowObjectClass *klass);
177 static void gdk_window_finalize (GObject *object);
179 static gpointer parent_class = NULL;
182 gdk_window_object_get_type (void)
184 static GType object_type = 0;
188 static const GTypeInfo object_info =
190 sizeof (GdkWindowObjectClass),
191 (GBaseInitFunc) NULL,
192 (GBaseFinalizeFunc) NULL,
193 (GClassInitFunc) gdk_window_class_init,
194 NULL, /* class_finalize */
195 NULL, /* class_data */
196 sizeof (GdkWindowObject),
198 (GInstanceInitFunc) gdk_window_init,
201 object_type = g_type_register_static (GDK_TYPE_DRAWABLE,
210 gdk_window_init (GdkWindowObject *window)
212 /* 0-initialization is good for all other fields. */
214 window->window_type = GDK_WINDOW_CHILD;
216 window->state = GDK_WINDOW_STATE_WITHDRAWN;
218 window->impl = g_object_new (_gdk_window_impl_get_type (), NULL);
222 gdk_window_class_init (GdkWindowObjectClass *klass)
224 GObjectClass *object_class = G_OBJECT_CLASS (klass);
225 GdkDrawableClass *drawable_class = GDK_DRAWABLE_CLASS (klass);
227 parent_class = g_type_class_peek_parent (klass);
229 object_class->finalize = gdk_window_finalize;
231 drawable_class->create_gc = gdk_window_create_gc;
232 drawable_class->draw_rectangle = gdk_window_draw_rectangle;
233 drawable_class->draw_arc = gdk_window_draw_arc;
234 drawable_class->draw_polygon = gdk_window_draw_polygon;
235 drawable_class->draw_text = gdk_window_draw_text;
236 drawable_class->draw_text_wc = gdk_window_draw_text_wc;
237 drawable_class->draw_drawable = gdk_window_draw_drawable;
238 drawable_class->draw_points = gdk_window_draw_points;
239 drawable_class->draw_segments = gdk_window_draw_segments;
240 drawable_class->draw_lines = gdk_window_draw_lines;
241 drawable_class->draw_glyphs = gdk_window_draw_glyphs;
242 drawable_class->draw_image = gdk_window_draw_image;
243 drawable_class->_draw_pixbuf = gdk_window_draw_pixbuf;
244 drawable_class->get_depth = gdk_window_real_get_depth;
245 drawable_class->get_screen = gdk_window_real_get_screen;
246 drawable_class->get_size = gdk_window_real_get_size;
247 drawable_class->set_colormap = gdk_window_real_set_colormap;
248 drawable_class->get_colormap = gdk_window_real_get_colormap;
249 drawable_class->get_visual = gdk_window_real_get_visual;
250 drawable_class->_copy_to_image = gdk_window_copy_to_image;
251 drawable_class->get_clip_region = gdk_window_get_clip_region;
252 drawable_class->get_visible_region = gdk_window_get_visible_region;
253 drawable_class->get_composite_drawable = gdk_window_get_composite_drawable;
257 gdk_window_finalize (GObject *object)
259 GdkWindow *window = GDK_WINDOW (object);
260 GdkWindowObject *obj = (GdkWindowObject *) object;
262 if (!GDK_WINDOW_DESTROYED (window))
264 if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
266 g_warning ("losing last reference to undestroyed window\n");
267 _gdk_window_destroy (window, FALSE);
270 /* We use TRUE here, to keep us from actually calling
271 * XDestroyWindow() on the window
273 _gdk_window_destroy (window, TRUE);
276 g_object_unref (G_OBJECT (obj->impl));
279 G_OBJECT_CLASS (parent_class)->finalize (object);
283 * _gdk_window_destroy_hierarchy:
284 * @window: a #GdkWindow
285 * @recursing: If TRUE, then this is being called because a parent
286 * was destroyed. This generally means that the call to the
287 * windowing system to destroy the window can be omitted, since
288 * it will be destroyed as a result of the parent being destroyed.
289 * Unless @foreign_destroy.
290 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
291 * external agency. The window has already been destroyed and no
292 * windowing system calls should be made. (This may never happen
293 * for some windowing systems.)
295 * Internal function to destroy a window. Like gdk_window_destroy(),
296 * but does not drop the reference count created by gdk_window_new().
299 _gdk_window_destroy_hierarchy (GdkWindow *window,
301 gboolean foreign_destroy)
303 GdkWindowObject *private;
304 GdkWindowObject *temp_private;
305 GdkWindow *temp_window;
309 g_return_if_fail (window != NULL);
311 private = (GdkWindowObject*) window;
313 switch (GDK_WINDOW_TYPE (window))
315 case GDK_WINDOW_TOPLEVEL:
316 case GDK_WINDOW_CHILD:
317 case GDK_WINDOW_DIALOG:
318 case GDK_WINDOW_TEMP:
319 case GDK_WINDOW_FOREIGN:
320 if (!GDK_WINDOW_DESTROYED (window))
322 private->state |= GDK_WINDOW_STATE_WITHDRAWN;
326 GdkWindowObject *parent_private = (GdkWindowObject *)private->parent;
327 if (parent_private->children)
328 parent_private->children = g_list_remove (parent_private->children, window);
331 _gdk_window_clear_update_area (window);
332 gdk_window_free_paint_stack (window);
334 if (private->bg_pixmap &&
335 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
336 private->bg_pixmap != GDK_NO_BG)
338 gdk_pixmap_unref (private->bg_pixmap);
339 private->bg_pixmap = NULL;
342 if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_FOREIGN)
343 g_assert (private->children == NULL);
346 children = tmp = private->children;
347 private->children = NULL;
351 temp_window = tmp->data;
354 temp_private = (GdkWindowObject*) temp_window;
356 _gdk_window_destroy_hierarchy (temp_window,
357 TRUE, foreign_destroy);
360 g_list_free (children);
363 _gdk_windowing_window_destroy (window, recursing, foreign_destroy);
364 private->destroyed = TRUE;
366 if (private->filters)
368 tmp = private->filters;
376 g_list_free (private->filters);
377 private->filters = NULL;
380 gdk_drawable_set_colormap (GDK_DRAWABLE (window), NULL);
384 case GDK_WINDOW_ROOT:
385 g_error ("attempted to destroy root window");
391 * _gdk_window_destroy:
392 * @window: a #GdkWindow
393 * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
394 * external agency. The window has already been destroyed and no
395 * windowing system calls should be made. (This may never happen
396 * for some windowing systems.)
398 * Internal function to destroy a window. Like gdk_window_destroy(),
399 * but does not drop the reference count created by gdk_window_new().
402 _gdk_window_destroy (GdkWindow *window,
403 gboolean foreign_destroy)
405 _gdk_window_destroy_hierarchy (window, FALSE, foreign_destroy);
409 * gdk_window_destroy:
410 * @window: a #GdkWindow
412 * Destroys @window (destroys the server-side resource associated with
413 * @window). Memory allocated for @window may not be freed until all
414 * references to @window are dropped. All children of @window are also
417 * There's normally no need to use this function, window are automatically
418 * destroyed when their reference count reaches 0.
422 gdk_window_destroy (GdkWindow *window)
424 _gdk_window_destroy_hierarchy (window, FALSE, FALSE);
425 gdk_drawable_unref (window);
429 * gdk_window_set_user_data:
430 * @window: a #GdkWindow
431 * @user_data: user data
433 * For most purposes this function is deprecated in favor of
434 * g_object_set_data(). However, for historical reasons GTK+ stores
435 * the #GtkWidget that owns a #GdkWindow as user data on the
436 * #GdkWindow. So, custom widget implementations should use
437 * this function for that. If GTK+ receives an event for a #GdkWindow,
438 * and the user data for the window is non-%NULL, GTK+ will assume the
439 * user data is a #GtkWidget, and forward the event to that widget.
443 gdk_window_set_user_data (GdkWindow *window,
446 g_return_if_fail (window != NULL);
448 ((GdkWindowObject*)window)->user_data = user_data;
452 * gdk_window_get_user_data:
453 * @window: a #GdkWindow
454 * @data: return location for user data
456 * Retrieves the user data for @window, which is normally the widget
457 * that @window belongs to. See gdk_window_set_user_data().
461 gdk_window_get_user_data (GdkWindow *window,
464 g_return_if_fail (window != NULL);
466 *data = ((GdkWindowObject*)window)->user_data;
470 * gdk_window_get_window_type:
471 * @window: a #GdkWindow
473 * Gets the type of the window. See #GdkWindowType.
475 * Return value: type of window
478 gdk_window_get_window_type (GdkWindow *window)
480 g_return_val_if_fail (GDK_IS_WINDOW (window), (GdkWindowType) -1);
482 return GDK_WINDOW_TYPE (window);
486 * gdk_window_get_position:
487 * @window: a #GdkWindow
488 * @x: X coordinate of window
489 * @y: Y coordinate of window
491 * Obtains the position of the window as reported in the
492 * most-recently-processed #GdkEventConfigure. Contrast with
493 * gdk_window_get_geometry() which queries the X server for the
494 * current window position, regardless of which events have been
495 * received or processed.
497 * The position coordinates are relative to the window's parent window.
501 gdk_window_get_position (GdkWindow *window,
505 GdkWindowObject *obj;
507 g_return_if_fail (GDK_IS_WINDOW (window));
509 obj = (GdkWindowObject*) window;
518 * gdk_window_get_parent:
519 * @window: a #GdkWindow
521 * Obtains the parent of @window, as known to GDK. Does not query the
522 * X server; thus this returns the parent as passed to gdk_window_new(),
523 * not the actual parent. This should never matter unless you're using
524 * Xlib calls mixed with GDK calls on the X11 platform. It may also
525 * matter for toplevel windows, because the window manager may choose
528 * Return value: parent of @window
531 gdk_window_get_parent (GdkWindow *window)
533 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
535 return (GdkWindow*) ((GdkWindowObject*) window)->parent;
539 * gdk_window_get_toplevel:
540 * @window: a #GdkWindow
542 * Gets the toplevel window that's an ancestor of @window.
544 * Return value: the toplevel window containing @window
547 gdk_window_get_toplevel (GdkWindow *window)
549 GdkWindowObject *obj;
551 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
553 obj = (GdkWindowObject *)window;
554 while (GDK_WINDOW_TYPE (obj) == GDK_WINDOW_CHILD)
555 obj = (GdkWindowObject *)obj->parent;
557 return GDK_WINDOW (obj);
561 * gdk_window_get_children:
562 * @window: a #GdkWindow
564 * Gets the list of children of @window known to GDK.
565 * This function only returns children created via GDK,
566 * so for example it's useless when used with the root window;
567 * it only returns windows an application created itself.
569 * The returned list must be freed, but the elements in the
572 * Return value: list of child windows inside @window
575 gdk_window_get_children (GdkWindow *window)
577 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
579 if (GDK_WINDOW_DESTROYED (window))
582 return g_list_copy (GDK_WINDOW_OBJECT (window)->children);
586 * gdk_window_peek_children:
587 * @window: a #GdkWindow
589 * Like gdk_window_get_children(), but does not copy the list of
590 * children, so the list does not need to be freed.
592 * Return value: a reference to the list of child windows in @window
595 gdk_window_peek_children (GdkWindow *window)
597 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
599 if (GDK_WINDOW_DESTROYED (window))
602 return GDK_WINDOW_OBJECT (window)->children;
606 * gdk_window_add_filter:
607 * @window: a #GdkWindow
608 * @function: filter callback
609 * @data: data to pass to filter callback
611 * Adds an event filter to @window, allowing you to intercept events
612 * before they reach GDK. This is a low-level operation and makes it
613 * easy to break GDK and/or GTK+, so you have to know what you're
614 * doing. Pass %NULL for @window to get all events for all windows,
615 * instead of events for a specific window.
619 gdk_window_add_filter (GdkWindow *window,
620 GdkFilterFunc function,
623 GdkWindowObject *private;
625 GdkEventFilter *filter;
627 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
629 private = (GdkWindowObject*) window;
630 if (private && GDK_WINDOW_DESTROYED (window))
634 tmp_list = private->filters;
636 tmp_list = _gdk_default_filters;
640 filter = (GdkEventFilter *)tmp_list->data;
641 if ((filter->function == function) && (filter->data == data))
643 tmp_list = tmp_list->next;
646 filter = g_new (GdkEventFilter, 1);
647 filter->function = function;
651 private->filters = g_list_append (private->filters, filter);
653 _gdk_default_filters = g_list_append (_gdk_default_filters, filter);
657 * gdk_window_remove_filter:
658 * @window: a #GdkWindow
659 * @function: previously-added filter function
660 * @data: user data for previously-added filter function
662 * Remove a filter previously added with gdk_window_add_filter().
666 gdk_window_remove_filter (GdkWindow *window,
667 GdkFilterFunc function,
670 GdkWindowObject *private;
671 GList *tmp_list, *node;
672 GdkEventFilter *filter;
674 g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
676 private = (GdkWindowObject*) window;
679 tmp_list = private->filters;
681 tmp_list = _gdk_default_filters;
685 filter = (GdkEventFilter *)tmp_list->data;
687 tmp_list = tmp_list->next;
689 if ((filter->function == function) && (filter->data == data))
692 private->filters = g_list_remove_link (private->filters, node);
694 _gdk_default_filters = g_list_remove_link (_gdk_default_filters, node);
695 g_list_free_1 (node);
704 * gdk_screen_get_toplevel_windows:
705 * @screen : The #GdkScreen where the toplevels are located.
707 * Obtains a list of all toplevel windows known to GDK on the screen @screen.
708 * A toplevel window is a child of the root window (see
709 * gdk_get_default_root_window()).
711 * The returned list should be freed with g_list_free(), but
712 * its elements need not be freed.
714 * Return value: list of toplevel windows, free with g_list_free()
717 gdk_screen_get_toplevel_windows (GdkScreen *screen)
719 GdkWindow * root_window;
720 GList *new_list = NULL;
723 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
725 root_window = gdk_screen_get_root_window (screen);
727 tmp_list = ((GdkWindowObject *)root_window)->children;
730 if (GDK_WINDOW_TYPE (tmp_list->data) != GDK_WINDOW_FOREIGN)
731 new_list = g_list_prepend (new_list, tmp_list->data);
732 tmp_list = tmp_list->next;
739 * gdk_window_get_toplevels:
741 * Obtains a list of all toplevel windows known to GDK on the default
742 * screen (see gdk_window_get_toplevels_for_screen()).
743 * A toplevel window is a child of the root window (see
744 * gdk_get_default_root_window()).
746 * The returned list should be freed with g_list_free(), but
747 * its elements need not be freed.
749 * Return value: list of toplevel windows, free with g_list_free()
752 gdk_window_get_toplevels (void)
754 return gdk_screen_get_toplevel_windows (gdk_get_default_screen ());
758 * gdk_window_is_visible:
759 * @window: a #GdkWindow
761 * Checks whether the window has been mapped (with gdk_window_show() or
762 * gdk_window_show_unraised()).
764 * Return value: %TRUE if the window is mapped
767 gdk_window_is_visible (GdkWindow *window)
769 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
771 return GDK_WINDOW_IS_MAPPED (window);
775 * gdk_window_is_viewable:
776 * @window: a #GdkWindow
778 * Check if the window and all ancestors of the window are
779 * mapped. (This is not necessarily "viewable" in the X sense, since
780 * we only check as far as we have GDK window parents, not to the root
783 * Return value: %TRUE if the window is viewable
786 gdk_window_is_viewable (GdkWindow *window)
788 GdkWindowObject *private = (GdkWindowObject *)window;
789 GdkScreen *screen = gdk_drawable_get_screen (window);
790 GdkWindow *root_window = gdk_screen_get_root_window (screen);
792 g_return_val_if_fail (window != NULL, FALSE);
793 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
796 (private != (GdkWindowObject *)root_window) &&
797 (GDK_WINDOW_TYPE (private) != GDK_WINDOW_FOREIGN))
799 if (!GDK_WINDOW_IS_MAPPED (window))
802 private = (GdkWindowObject *)private->parent;
809 * gdk_window_get_state:
810 * @window: a #GdkWindow
812 * Gets the bitwise OR of the currently active window state flags,
813 * from the #GdkWindowState enumeration.
815 * Return value: window state bitfield
818 gdk_window_get_state (GdkWindow *window)
820 GdkWindowObject *private = (GdkWindowObject *)window;
822 g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
824 return private->state;
828 * gdk_window_begin_paint_rect:
829 * @window: a #GdkWindow
830 * @rectangle: rectangle you intend to draw to
832 * A convenience wrapper around gdk_window_begin_paint_region() which
833 * creates a rectangular region for you. See
834 * gdk_window_begin_paint_region() for details.
838 gdk_window_begin_paint_rect (GdkWindow *window,
839 GdkRectangle *rectangle)
843 g_return_if_fail (window != NULL);
844 g_return_if_fail (GDK_IS_WINDOW (window));
846 region = gdk_region_rectangle (rectangle);
847 gdk_window_begin_paint_region (window, region);
848 gdk_region_destroy (region);
852 gdk_window_get_bg_gc (GdkWindow *window, GdkWindowPaint *paint)
854 GdkWindowObject *private = (GdkWindowObject *)window;
857 GdkGCValues gc_values;
859 if (private->bg_pixmap == GDK_PARENT_RELATIVE_BG && private->parent)
861 GdkWindowPaint tmp_paint = *paint;
862 tmp_paint.x_offset += private->x;
863 tmp_paint.y_offset += private->y;
865 return gdk_window_get_bg_gc (GDK_WINDOW (private->parent), &tmp_paint);
867 else if (private->bg_pixmap &&
868 private->bg_pixmap != GDK_PARENT_RELATIVE_BG &&
869 private->bg_pixmap != GDK_NO_BG)
871 gc_values.fill = GDK_TILED;
872 gc_values.tile = private->bg_pixmap;
873 gc_values.ts_x_origin = - paint->x_offset;
874 gc_values.ts_y_origin = - paint->y_offset;
876 gc_mask = (GDK_GC_FILL | GDK_GC_TILE |
877 GDK_GC_TS_X_ORIGIN | GDK_GC_TS_Y_ORIGIN);
881 gc_values.foreground = private->bg_color;
882 gc_mask = GDK_GC_FOREGROUND;
885 return gdk_gc_new_with_values (paint->pixmap, &gc_values, gc_mask);
889 gdk_window_paint_init_bg (GdkWindow *window,
890 GdkWindowPaint *paint,
891 GdkRegion *init_region)
895 tmp_gc = gdk_window_get_bg_gc (window, paint);
897 gdk_region_offset (init_region,
900 gdk_gc_set_clip_region (tmp_gc, init_region);
902 gdk_draw_rectangle (paint->pixmap, tmp_gc, TRUE, 0, 0, -1, -1);
903 gdk_gc_unref (tmp_gc);
906 #ifdef GDK_WINDOWING_X11
907 #include "x11/gdkx.h"
911 * gdk_window_begin_paint_region:
912 * @window: a #GdkWindow
913 * @region: region you intend to draw to
915 * Indicates that you are beginning the process of redrawing @region.
916 * A backing store (offscreen buffer) large enough to contain @region
917 * will be created. The backing store will be initialized with the
918 * background color or background pixmap for @window. Then, all
919 * drawing operations performed on @window will be diverted to the
920 * backing store. When you call gdk_window_end_paint(), the backing
921 * store will be copied to @window, making it visible onscreen. Only
922 * the part of @window contained in @region will be modified; that is,
923 * drawing operations are clipped to @region.
925 * The net result of all this is to remove flicker, because the user
926 * sees the finished product appear all at once when you call
927 * gdk_window_end_paint(). If you draw to @window directly without
928 * calling gdk_window_begin_paint_region(), the user may see flicker
929 * as individual drawing operations are performed in sequence. The
930 * clipping and background-initializing features of
931 * gdk_window_begin_paint_region() are conveniences for the
932 * programmer, so you can avoid doing that work yourself.
934 * When using GTK+, the widget system automatically places calls to
935 * gdk_window_begin_paint_region() and gdk_window_end_paint() around
936 * emissions of the expose_event signal. That is, if you're writing an
937 * expose event handler, you can assume that the exposed area in
938 * #GdkEventExpose has already been cleared to the window background,
939 * is already set as the clip region, and already has a backing store.
940 * Therefore in most cases, application code need not call
941 * gdk_window_begin_paint_region(). (You can disable the automatic
942 * calls around expose events on a widget-by-widget basis by calling
943 * gtk_widget_set_double_buffered().)
945 * If you call this function multiple times before calling the
946 * matching gdk_window_end_paint(), the backing stores are pushed onto
947 * a stack. gdk_window_end_paint() copies the topmost backing store
948 * onscreen, subtracts the topmost region from all other regions in
949 * the stack, and pops the stack. All drawing operations affect only
950 * the topmost backing store in the stack. One matching call to
951 * gdk_window_end_paint() is required for each call to
952 * gdk_window_begin_paint_region().
956 gdk_window_begin_paint_region (GdkWindow *window,
959 #ifdef USE_BACKING_STORE
960 GdkWindowObject *private = (GdkWindowObject *)window;
961 GdkRectangle clip_box;
962 GdkWindowPaint *paint;
963 GdkRegion *init_region;
966 g_return_if_fail (window != NULL);
967 g_return_if_fail (GDK_IS_WINDOW (window));
969 if (GDK_WINDOW_DESTROYED (window))
972 paint = g_new (GdkWindowPaint, 1);
974 paint->region = gdk_region_copy (region);
976 init_region = gdk_region_copy (region);
977 gdk_region_get_clipbox (paint->region, &clip_box);
979 if (private->paint_stack)
981 gint old_width, old_height;
982 GdkWindowPaint *tmp_paint = private->paint_stack->data;
983 GdkRectangle old_rect, new_rect;
986 gdk_drawable_get_size (tmp_paint->pixmap, &old_width, &old_height);
987 old_rect.x = tmp_paint->x_offset;
988 old_rect.y = tmp_paint->y_offset;
989 old_rect.width = old_width;
990 old_rect.height = old_height;
992 gdk_rectangle_union (&clip_box, &old_rect, &new_rect);
994 if (new_rect.width > old_rect.width || new_rect.height > old_rect.height)
996 paint->pixmap = gdk_pixmap_new (window,
997 new_rect.width, new_rect.height, -1);
998 tmp_gc = gdk_gc_new (paint->pixmap);
999 gdk_draw_drawable (paint->pixmap, tmp_gc, tmp_paint->pixmap,
1001 old_rect.x - new_rect.x, old_rect.y - new_rect.y,
1002 old_rect.width, old_rect.height);
1003 gdk_gc_unref (tmp_gc);
1004 gdk_drawable_unref (tmp_paint->pixmap);
1006 paint->x_offset = new_rect.x;
1007 paint->y_offset = new_rect.y;
1009 tmp_list = private->paint_stack;
1012 tmp_paint = tmp_list->data;
1013 gdk_region_subtract (init_region, tmp_paint->region);
1015 tmp_paint->pixmap = paint->pixmap;
1016 tmp_paint->x_offset = paint->x_offset;
1017 tmp_paint->y_offset = paint->y_offset;
1019 tmp_list = tmp_list->next;
1024 paint->x_offset = tmp_paint->x_offset;
1025 paint->y_offset = tmp_paint->y_offset;
1026 paint->pixmap = tmp_paint->pixmap;
1028 tmp_list = private->paint_stack;
1031 tmp_paint = tmp_list->data;
1032 gdk_region_subtract (init_region, tmp_paint->region);
1034 tmp_list = tmp_list->next;
1040 paint->x_offset = clip_box.x;
1041 paint->y_offset = clip_box.y;
1042 paint->pixmap = gdk_pixmap_new (window,
1043 clip_box.width, clip_box.height, -1);
1046 if (!gdk_region_empty (init_region))
1047 gdk_window_paint_init_bg (window, paint, init_region);
1049 gdk_region_destroy (init_region);
1051 private->paint_stack = g_slist_prepend (private->paint_stack, paint);
1052 #endif /* USE_BACKING_STORE */
1056 * gdk_window_end_paint:
1057 * @window: a #GdkWindow
1059 * Indicates that the backing store created by the most recent call to
1060 * gdk_window_begin_paint_region() should be copied onscreen and
1061 * deleted, leaving the next-most-recent backing store or no backing
1062 * store at all as the active paint region. See
1063 * gdk_window_begin_paint_region() for full details. It is an error to
1064 * call this function without a matching
1065 * gdk_window_begin_paint_region() first.
1069 gdk_window_end_paint (GdkWindow *window)
1071 #ifdef USE_BACKING_STORE
1072 GdkWindowObject *private = (GdkWindowObject *)window;
1073 GdkWindowPaint *paint;
1075 GdkRectangle clip_box;
1076 gint x_offset, y_offset;
1078 g_return_if_fail (window != NULL);
1079 g_return_if_fail (GDK_IS_WINDOW (window));
1081 if (GDK_WINDOW_DESTROYED (window))
1084 if (private->paint_stack == NULL)
1086 g_warning (G_STRLOC": no preceding call to gdk_window_begin_paint_region(), see documentation");
1090 paint = private->paint_stack->data;
1091 private->paint_stack = g_slist_delete_link (private->paint_stack,
1092 private->paint_stack);
1094 gdk_region_get_clipbox (paint->region, &clip_box);
1096 tmp_gc = gdk_gc_new (window);
1098 _gdk_windowing_window_get_offsets (window, &x_offset, &y_offset);
1100 gdk_gc_set_clip_region (tmp_gc, paint->region);
1101 gdk_gc_set_clip_origin (tmp_gc, -x_offset, -y_offset);
1103 gdk_draw_drawable (private->impl, tmp_gc, paint->pixmap,
1104 clip_box.x - paint->x_offset,
1105 clip_box.y - paint->y_offset,
1106 clip_box.x - x_offset, clip_box.y - y_offset,
1107 clip_box.width, clip_box.height);
1108 gdk_gc_unref (tmp_gc);
1110 if (private->paint_stack)
1112 GSList *tmp_list = private->paint_stack;
1115 GdkWindowPaint *tmp_paint = tmp_list->data;
1116 gdk_region_subtract (tmp_paint->region, paint->region);
1118 tmp_list = tmp_list->next;
1122 gdk_drawable_unref (paint->pixmap);
1124 gdk_region_destroy (paint->region);
1126 #endif /* USE_BACKING_STORE */
1130 gdk_window_free_paint_stack (GdkWindow *window)
1132 GdkWindowObject *private = (GdkWindowObject *)window;
1134 if (private->paint_stack)
1136 GSList *tmp_list = private->paint_stack;
1140 GdkWindowPaint *paint = tmp_list->data;
1142 if (tmp_list == private->paint_stack)
1143 gdk_drawable_unref (paint->pixmap);
1145 gdk_region_destroy (paint->region);
1148 tmp_list = tmp_list->next;
1151 g_slist_free (private->paint_stack);
1152 private->paint_stack = NULL;
1157 gdk_window_get_offsets (GdkWindow *window,
1161 GdkWindowObject *private = (GdkWindowObject *)window;
1163 if (private->paint_stack)
1165 GdkWindowPaint *paint = private->paint_stack->data;
1166 *x_offset = paint->x_offset;
1167 *y_offset = paint->y_offset;
1170 _gdk_windowing_window_get_offsets (window, x_offset, y_offset);
1174 * gdk_window_get_internal_paint_info:
1175 * @window: a #GdkWindow
1176 * @real_drawable: location to store the drawable to which drawing should be
1178 * @x_offset: location to store the X offset between coordinates in @window,
1179 * and the underlying window system primitive coordinates for
1181 * @y_offset: location to store the Y offset between coordinates in @window,
1182 * and the underlying window system primitive coordinates for
1185 * If you bypass the GDK layer and use windowing system primitives to
1186 * draw directly onto a #GdkWindow, then you need to deal with two
1187 * details: there may be an offset between GDK coordinates and windowing
1188 * system coordinates, and GDK may have redirected drawing to a offscreen
1189 * pixmap as the result of a gdk_window_begin_paint_region() calls.
1190 * This function allows retrieving the information you need to compensate
1191 * for these effects.
1193 * This function exposes details of the GDK implementation, and is thus
1194 * likely to change in future releases of GDK.
1197 gdk_window_get_internal_paint_info (GdkWindow *window,
1198 GdkDrawable **real_drawable,
1204 GdkWindowObject *private;
1206 g_return_if_fail (GDK_IS_WINDOW (window));
1208 private = (GdkWindowObject *)window;
1212 if (private->paint_stack)
1214 GdkWindowPaint *paint = private->paint_stack->data;
1215 *real_drawable = paint->pixmap;
1218 *real_drawable = window;
1221 gdk_window_get_offsets (window, &x_off, &y_off);
1229 #define OFFSET_GC(gc) \
1230 gint x_offset, y_offset; \
1231 gint old_clip_x = gc->clip_x_origin; \
1232 gint old_clip_y = gc->clip_y_origin; \
1233 gint old_ts_x = gc->ts_x_origin; \
1234 gint old_ts_y = gc->ts_y_origin; \
1235 gdk_window_get_offsets (drawable, &x_offset, &y_offset); \
1236 if (x_offset != 0 || y_offset != 0) \
1238 gdk_gc_set_clip_origin (gc, old_clip_x - x_offset, \
1239 old_clip_y - y_offset); \
1240 gdk_gc_set_ts_origin (gc, old_ts_x - x_offset, \
1241 old_ts_y - y_offset); \
1244 #define RESTORE_GC(gc) \
1245 if (x_offset != 0 || y_offset != 0) \
1247 gdk_gc_set_clip_origin (gc, old_clip_x, old_clip_y); \
1248 gdk_gc_set_ts_origin (gc, old_ts_x, old_ts_y); \
1252 gdk_window_create_gc (GdkDrawable *drawable,
1253 GdkGCValues *values,
1254 GdkGCValuesMask mask)
1256 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
1258 if (GDK_WINDOW_DESTROYED (drawable))
1261 return gdk_gc_new_with_values (((GdkWindowObject *) drawable)->impl,
1266 gdk_window_draw_rectangle (GdkDrawable *drawable,
1274 GdkWindowObject *private = (GdkWindowObject *)drawable;
1277 if (GDK_WINDOW_DESTROYED (drawable))
1280 if (private->paint_stack)
1282 GdkWindowPaint *paint = private->paint_stack->data;
1283 gdk_draw_rectangle (paint->pixmap, gc, filled,
1284 x - x_offset, y - y_offset, width, height);
1287 gdk_draw_rectangle (private->impl, gc, filled,
1288 x - x_offset, y - y_offset, width, height);
1294 gdk_window_draw_arc (GdkDrawable *drawable,
1304 GdkWindowObject *private = (GdkWindowObject *)drawable;
1307 if (GDK_WINDOW_DESTROYED (drawable))
1310 if (private->paint_stack)
1312 GdkWindowPaint *paint = private->paint_stack->data;
1313 gdk_draw_arc (paint->pixmap, gc, filled,
1314 x - x_offset, y - y_offset,
1315 width, height, angle1, angle2);
1318 gdk_draw_arc (private->impl, gc, filled,
1319 x - x_offset, y - y_offset,
1320 width, height, angle1, angle2);
1325 gdk_window_draw_polygon (GdkDrawable *drawable,
1331 GdkWindowObject *private = (GdkWindowObject *)drawable;
1332 GdkPoint *new_points;
1336 if (GDK_WINDOW_DESTROYED (drawable))
1339 if (x_offset != 0 || y_offset != 0)
1343 new_points = g_new (GdkPoint, npoints);
1344 for (i=0; i<npoints; i++)
1346 new_points[i].x = points[i].x - x_offset;
1347 new_points[i].y = points[i].y - y_offset;
1351 new_points = points;
1353 if (private->paint_stack)
1355 GdkWindowPaint *paint = private->paint_stack->data;
1356 gdk_draw_polygon (paint->pixmap, gc, filled, new_points, npoints);
1360 gdk_draw_polygon (private->impl, gc, filled, new_points, npoints);
1362 if (new_points != points)
1363 g_free (new_points);
1369 gdk_window_draw_text (GdkDrawable *drawable,
1377 GdkWindowObject *private = (GdkWindowObject *)drawable;
1380 if (GDK_WINDOW_DESTROYED (drawable))
1383 if (private->paint_stack)
1385 GdkWindowPaint *paint = private->paint_stack->data;
1386 gdk_draw_text (paint->pixmap, font, gc,
1387 x - x_offset, y - y_offset, text, text_length);
1391 gdk_draw_text (private->impl, font, gc,
1392 x - x_offset, y - y_offset, text, text_length);
1398 gdk_window_draw_text_wc (GdkDrawable *drawable,
1403 const GdkWChar *text,
1406 GdkWindowObject *private = (GdkWindowObject *)drawable;
1409 if (GDK_WINDOW_DESTROYED (drawable))
1412 if (private->paint_stack)
1414 GdkWindowPaint *paint = private->paint_stack->data;
1415 gdk_draw_text_wc (paint->pixmap, font, gc,
1416 x - x_offset, y - y_offset, text, text_length);
1419 gdk_draw_text_wc (private->impl, font, gc,
1420 x - x_offset, y - y_offset, text, text_length);
1426 gdk_window_get_composite_drawable (GdkDrawable *window,
1431 gint *composite_x_offset,
1432 gint *composite_y_offset)
1434 GdkWindowObject *private = (GdkWindowObject *)window;
1435 GdkWindowPaint *paint;
1436 GdkRegion *buffered_region;
1439 GdkPixmap *tmp_pixmap;
1441 GdkRegion *rect_region;
1443 gint windowing_x_offset, windowing_y_offset;
1444 gint buffer_x_offset, buffer_y_offset;
1446 if (GDK_WINDOW_DESTROYED (window) || private->paint_stack == NULL)
1448 /* No backing store */
1449 _gdk_windowing_window_get_offsets (window,
1451 composite_y_offset);
1453 return GDK_DRAWABLE (g_object_ref (G_OBJECT (window)));
1456 buffered_region = NULL;
1459 /* All GtkWindowPaint structs have the same pixmap and offsets, just
1460 * get the first one. (should probably be cleaned up so that the
1461 * pixmap is stored in the window)
1463 paint = private->paint_stack->data;
1464 buffer = paint->pixmap;
1465 buffer_x_offset = paint->x_offset;
1466 buffer_y_offset = paint->y_offset;
1468 tmp_list = private->paint_stack;
1469 while (tmp_list != NULL)
1471 paint = tmp_list->data;
1473 if (buffered_region == NULL)
1474 buffered_region = gdk_region_copy (paint->region);
1476 gdk_region_union (buffered_region, paint->region);
1478 tmp_list = g_slist_next (tmp_list);
1481 /* See if the buffered part is overlapping the part we want
1487 rect.height = height;
1489 rect_region = gdk_region_rectangle (&rect);
1491 gdk_region_intersect (buffered_region, rect_region);
1493 gdk_region_destroy (rect_region);
1495 if (gdk_region_empty (buffered_region))
1497 gdk_region_destroy (buffered_region);
1499 _gdk_windowing_window_get_offsets (window,
1501 composite_y_offset);
1503 return GDK_DRAWABLE (g_object_ref (G_OBJECT (window)));
1506 tmp_pixmap = gdk_pixmap_new (window,
1510 tmp_gc = gdk_gc_new (tmp_pixmap);
1512 _gdk_windowing_window_get_offsets (window,
1513 &windowing_x_offset,
1514 &windowing_y_offset);
1516 /* Copy the current window contents */
1517 gdk_draw_drawable (tmp_pixmap,
1520 x - windowing_x_offset,
1521 y - windowing_y_offset,
1525 /* Make buffered_region relative to the tmp_pixmap */
1526 gdk_region_offset (buffered_region,
1530 /* Set the clip mask to avoid drawing over non-buffered areas of
1534 gdk_gc_set_clip_region (tmp_gc, buffered_region);
1535 gdk_region_destroy (buffered_region);
1537 /* Draw backing pixmap onto the tmp_pixmap, offsetting
1540 gdk_draw_drawable (tmp_pixmap,
1543 x - buffer_x_offset,
1544 y - buffer_y_offset,
1548 /* Set these to location of tmp_pixmap within the window */
1549 *composite_x_offset = x;
1550 *composite_y_offset = y;
1552 g_object_unref (G_OBJECT (tmp_gc));
1558 gdk_window_get_clip_region (GdkDrawable *drawable)
1560 GdkWindowObject *private = (GdkWindowObject *)drawable;
1563 result = gdk_drawable_get_clip_region (private->impl);
1565 if (private->paint_stack)
1567 GdkRegion *paint_region = gdk_region_new ();
1568 GSList *tmp_list = private->paint_stack;
1572 GdkWindowPaint *paint = tmp_list->data;
1574 gdk_region_union (paint_region, paint->region);
1576 tmp_list = tmp_list->next;
1579 gdk_region_intersect (result, paint_region);
1580 gdk_region_destroy (paint_region);
1587 gdk_window_get_visible_region (GdkDrawable *drawable)
1589 GdkWindowObject *private = (GdkWindowObject*) drawable;
1591 return gdk_drawable_get_visible_region (private->impl);
1595 gdk_window_draw_drawable (GdkDrawable *drawable,
1605 GdkWindowObject *private = (GdkWindowObject *)drawable;
1608 if (GDK_WINDOW_DESTROYED (drawable))
1611 /* If we have a backing pixmap draw to that */
1612 if (private->paint_stack)
1614 GdkWindowPaint *paint = private->paint_stack->data;
1615 gdk_draw_drawable (paint->pixmap, gc,
1617 xdest - x_offset, ydest - y_offset, width, height);
1621 gdk_draw_drawable (private->impl, gc,
1623 xdest - x_offset, ydest - y_offset,
1630 gdk_window_draw_points (GdkDrawable *drawable,
1635 GdkWindowObject *private = (GdkWindowObject *)drawable;
1636 GdkPoint *new_points;
1640 if (GDK_WINDOW_DESTROYED (drawable))
1643 if (x_offset != 0 || y_offset != 0)
1647 new_points = g_new (GdkPoint, npoints);
1648 for (i=0; i<npoints; i++)
1650 new_points[i].x = points[i].x - x_offset;
1651 new_points[i].y = points[i].y - y_offset;
1655 new_points = points;
1657 if (private->paint_stack)
1659 GdkWindowPaint *paint = private->paint_stack->data;
1660 gdk_draw_points (paint->pixmap, gc, new_points, npoints);
1663 gdk_draw_points (private->impl, gc, points, npoints);
1665 if (new_points != points)
1666 g_free (new_points);
1672 gdk_window_draw_segments (GdkDrawable *drawable,
1677 GdkWindowObject *private = (GdkWindowObject *)drawable;
1678 GdkSegment *new_segs;
1682 if (GDK_WINDOW_DESTROYED (drawable))
1685 if (x_offset != 0 || y_offset != 0)
1689 new_segs = g_new (GdkSegment, nsegs);
1690 for (i=0; i<nsegs; i++)
1692 new_segs[i].x1 = segs[i].x1 - x_offset;
1693 new_segs[i].y1 = segs[i].y1 - y_offset;
1694 new_segs[i].x2 = segs[i].x2 - x_offset;
1695 new_segs[i].y2 = segs[i].y2 - y_offset;
1701 if (private->paint_stack)
1703 GdkWindowPaint *paint = private->paint_stack->data;
1704 gdk_draw_segments (paint->pixmap, gc, new_segs, nsegs);
1707 gdk_draw_segments (private->impl, gc, new_segs, nsegs);
1709 if (new_segs != segs)
1716 gdk_window_draw_lines (GdkDrawable *drawable,
1721 GdkWindowObject *private = (GdkWindowObject *)drawable;
1722 GdkPoint *new_points;
1726 if (GDK_WINDOW_DESTROYED (drawable))
1729 if (x_offset != 0 || y_offset != 0)
1733 new_points = g_new (GdkPoint, npoints);
1734 for (i=0; i<npoints; i++)
1736 new_points[i].x = points[i].x - x_offset;
1737 new_points[i].y = points[i].y - y_offset;
1741 new_points = points;
1743 if (private->paint_stack)
1745 GdkWindowPaint *paint = private->paint_stack->data;
1746 gdk_draw_lines (paint->pixmap, gc, new_points, npoints);
1749 gdk_draw_lines (private->impl, gc, new_points, npoints);
1751 if (new_points != points)
1752 g_free (new_points);
1758 gdk_window_draw_glyphs (GdkDrawable *drawable,
1763 PangoGlyphString *glyphs)
1765 GdkWindowObject *private = (GdkWindowObject *)drawable;
1769 if (GDK_WINDOW_DESTROYED (drawable))
1772 if (private->paint_stack)
1774 GdkWindowPaint *paint = private->paint_stack->data;
1776 gdk_draw_glyphs (paint->pixmap, gc, font, x - x_offset, y - y_offset, glyphs);
1779 gdk_draw_glyphs (private->impl, gc, font,
1780 x - x_offset, y - y_offset, glyphs);
1785 /* Fixme - this is just like gdk_window_paint_init_bg */
1787 gdk_window_clear_backing_rect (GdkWindow *window,
1793 GdkWindowObject *private = (GdkWindowObject *)window;
1794 GdkWindowPaint *paint = private->paint_stack->data;
1797 if (GDK_WINDOW_DESTROYED (window))
1800 tmp_gc = gdk_window_get_bg_gc (window, paint);
1801 gdk_draw_rectangle (paint->pixmap, tmp_gc, TRUE,
1802 x - paint->x_offset, y - paint->y_offset, width, height);
1803 gdk_gc_unref (tmp_gc);
1808 * @window: a #GdkWindow
1810 * Clears an entire @window to the background color or background pixmap.
1813 gdk_window_clear (GdkWindow *window)
1817 g_return_if_fail (window != NULL);
1818 g_return_if_fail (GDK_IS_WINDOW (window));
1820 gdk_drawable_get_size (GDK_DRAWABLE (window), &width, &height);
1822 gdk_window_clear_area (window, 0, 0,
1827 * gdk_window_clear_area:
1828 * @window: a #GdkWindow
1829 * @x: x coordinate of rectangle to clear
1830 * @y: y coordinate of rectangle to clear
1831 * @width: width of rectangle to clear
1832 * @height: height of rectangle to clear
1834 * Clears an area of @window to the background color or background pixmap.
1838 gdk_window_clear_area (GdkWindow *window,
1844 GdkWindowObject *private = (GdkWindowObject *)window;
1846 g_return_if_fail (window != NULL);
1847 g_return_if_fail (GDK_IS_WINDOW (window));
1849 if (private->paint_stack)
1850 gdk_window_clear_backing_rect (window, x, y, width, height);
1852 _gdk_windowing_window_clear_area (window, x, y, width, height);
1856 * gdk_window_clear_area_e:
1857 * @window: a #GdkWindow
1858 * @x: x coordinate of rectangle to clear
1859 * @y: y coordinate of rectangle to clear
1860 * @width: width of rectangle to clear
1861 * @height: height of rectangle to clear
1863 * Like gdk_window_clear_area(), but also generates an expose event for
1866 * This function has a stupid name because it dates back to the mists
1867 * time, pre-GDK-1.0.
1871 gdk_window_clear_area_e (GdkWindow *window,
1877 GdkWindowObject *private = (GdkWindowObject *)window;
1879 g_return_if_fail (window != NULL);
1880 g_return_if_fail (GDK_IS_WINDOW (window));
1882 if (private->paint_stack)
1883 gdk_window_clear_backing_rect (window, x, y, width, height);
1885 _gdk_windowing_window_clear_area_e (window, x, y, width, height);
1889 gdk_window_draw_image (GdkDrawable *drawable,
1899 GdkWindowObject *private = (GdkWindowObject *)drawable;
1903 if (GDK_WINDOW_DESTROYED (drawable))
1906 if (private->paint_stack)
1908 GdkWindowPaint *paint = private->paint_stack->data;
1909 gdk_draw_image (paint->pixmap, gc, image, xsrc, ysrc,
1910 xdest - x_offset, ydest - y_offset,
1915 gdk_draw_image (private->impl, gc, image, xsrc, ysrc,
1916 xdest - x_offset, ydest - y_offset,
1923 gdk_window_draw_pixbuf (GdkDrawable *drawable,
1932 GdkRgbDither dither,
1936 GdkWindowObject *private = (GdkWindowObject *)drawable;
1938 if (GDK_WINDOW_DESTROYED (drawable))
1945 if (private->paint_stack)
1947 GdkWindowPaint *paint = private->paint_stack->data;
1948 _gdk_draw_pixbuf (paint->pixmap, gc, pixbuf, src_x, src_y,
1949 dest_x - x_offset, dest_y - y_offset,
1951 dither, x_dither - x_offset, y_dither - y_offset);
1954 _gdk_draw_pixbuf (private->impl, gc, pixbuf, src_x, src_y,
1955 dest_x - x_offset, dest_y - y_offset,
1957 dither, x_dither, y_dither);
1963 gint x_offset, y_offset;
1964 gdk_window_get_offsets (drawable, &x_offset, &y_offset);
1966 if (private->paint_stack)
1968 GdkWindowPaint *paint = private->paint_stack->data;
1969 _gdk_draw_pixbuf (paint->pixmap, gc, pixbuf, src_x, src_y,
1970 dest_x - x_offset, dest_y - y_offset,
1972 dither, x_dither - x_offset, y_dither - y_offset);
1975 _gdk_draw_pixbuf (private->impl, gc, pixbuf, src_x, src_y,
1976 dest_x - x_offset, dest_y - y_offset,
1978 dither, x_dither, y_dither);
1983 gdk_window_real_get_size (GdkDrawable *drawable,
1987 g_return_if_fail (GDK_IS_WINDOW (drawable));
1989 gdk_drawable_get_size (GDK_WINDOW_OBJECT (drawable)->impl,
1994 gdk_window_real_get_visual (GdkDrawable *drawable)
1996 GdkColormap *colormap;
1998 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
2000 colormap = gdk_drawable_get_colormap (drawable);
2001 return colormap ? gdk_colormap_get_visual (colormap) : NULL;
2005 gdk_window_real_get_depth (GdkDrawable *drawable)
2007 g_return_val_if_fail (GDK_IS_WINDOW (drawable), 0);
2009 return ((GdkWindowObject *)GDK_WINDOW (drawable))->depth;
2013 gdk_window_real_get_screen (GdkDrawable *drawable)
2015 return gdk_drawable_get_screen (GDK_WINDOW_OBJECT (drawable)->impl);
2019 gdk_window_real_set_colormap (GdkDrawable *drawable,
2022 g_return_if_fail (GDK_IS_WINDOW (drawable));
2024 if (GDK_WINDOW_DESTROYED (drawable))
2027 gdk_drawable_set_colormap (((GdkWindowObject*)drawable)->impl, cmap);
2031 gdk_window_real_get_colormap (GdkDrawable *drawable)
2033 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
2035 if (GDK_WINDOW_DESTROYED (drawable))
2038 return gdk_drawable_get_colormap (((GdkWindowObject*)drawable)->impl);
2042 gdk_window_copy_to_image (GdkDrawable *drawable,
2051 gint x_offset, y_offset;
2053 g_return_val_if_fail (GDK_IS_WINDOW (drawable), NULL);
2055 if (GDK_WINDOW_DESTROYED (drawable))
2058 /* If we're here, a composite image was not necessary, so
2059 * we can ignore the paint stack.
2062 _gdk_windowing_window_get_offsets (drawable, &x_offset, &y_offset);
2064 return _gdk_drawable_copy_to_image (((GdkWindowObject*)drawable)->impl,
2072 /* Code for dirty-region queueing
2075 static GSList *update_windows = NULL;
2076 static guint update_idle = 0;
2077 static gboolean debug_updates = FALSE;
2080 gdk_window_process_updates_internal (GdkWindow *window)
2082 GdkWindowObject *private = (GdkWindowObject *)window;
2083 gboolean save_region = FALSE;
2085 /* If an update got queued during update processing, we can get a
2086 * window in the update queue that has an empty update_area.
2089 if (private->update_area)
2091 GdkRegion *update_area = private->update_area;
2092 private->update_area = NULL;
2094 if (_gdk_event_func && gdk_window_is_viewable (window) &&
2095 (private->event_mask & GDK_EXPOSURE_MASK))
2098 GdkRectangle window_rect;
2099 GdkRegion *expose_region;
2100 GdkRegion *window_region;
2105 /* Make sure we see the red invalid area before redrawing. */
2106 gdk_display_sync (gdk_drawable_get_display (window));
2110 gdk_drawable_get_size (GDK_DRAWABLE (private), &width, &height);
2114 window_rect.width = width;
2115 window_rect.height = height;
2117 save_region = _gdk_windowing_window_queue_antiexpose (window, update_area);
2119 event.expose.type = GDK_EXPOSE;
2120 event.expose.window = gdk_window_ref (window);
2121 event.expose.count = 0;
2124 expose_region = gdk_region_copy (update_area);
2126 expose_region = update_area;
2127 window_region = gdk_region_rectangle (&window_rect);
2128 gdk_region_intersect (expose_region,
2130 gdk_region_destroy (window_region);
2132 event.expose.region = expose_region;
2133 gdk_region_get_clipbox (expose_region, &event.expose.area);
2135 if (!gdk_region_empty (expose_region))
2137 (*_gdk_event_func) (&event, _gdk_event_data);
2140 if (expose_region != update_area)
2141 gdk_region_destroy (expose_region);
2142 gdk_window_unref (window);
2145 gdk_region_destroy (update_area);
2150 * gdk_window_process_all_updates:
2152 * Calls gdk_window_process_updates() for all windows (see #GdkWindow)
2153 * in the application.
2157 gdk_window_process_all_updates (void)
2159 GSList *old_update_windows = update_windows;
2160 GSList *tmp_list = update_windows;
2163 g_source_remove (update_idle);
2165 update_windows = NULL;
2168 g_slist_foreach (old_update_windows, (GFunc)g_object_ref, NULL);
2172 gdk_window_process_updates_internal (tmp_list->data);
2173 g_object_unref (tmp_list->data);
2174 tmp_list = tmp_list->next;
2177 g_slist_free (old_update_windows);
2183 gdk_window_update_idle (gpointer data)
2185 gdk_window_process_all_updates ();
2191 * gdk_window_process_updates:
2192 * @window: a #GdkWindow
2193 * @update_children: whether to also process updates for child windows
2195 * Sends one or more expose events to @window. The areas in each
2196 * expose event will cover the entire update area for the window (see
2197 * gdk_window_invalidate_region() for details). Normally GDK calls
2198 * gdk_window_process_all_updates() on your behalf, so there's no
2199 * need to call this function unless you want to force expose events
2200 * to be delivered immediately and synchronously (vs. the usual
2201 * case, where GDK delivers them in an idle handler). Occasionally
2202 * this is useful to produce nicer scrolling behavior, for example.
2206 gdk_window_process_updates (GdkWindow *window,
2207 gboolean update_children)
2209 GdkWindowObject *private = (GdkWindowObject *)window;
2211 g_return_if_fail (window != NULL);
2212 g_return_if_fail (GDK_IS_WINDOW (window));
2214 if (private->update_area)
2216 gdk_window_process_updates_internal (window);
2217 update_windows = g_slist_remove (update_windows, window);
2220 if (update_children)
2222 GList *tmp_list = private->children;
2225 gdk_window_process_updates (tmp_list->data, TRUE);
2226 tmp_list = tmp_list->next;
2232 * gdk_window_invalidate_rect:
2233 * @window: a #GdkWindow
2234 * @rect: rectangle to invalidate
2235 * @invalidate_children: whether to also invalidate child windows
2237 * A convenience wrapper around gdk_window_invalidate_region() which
2238 * invalidates a rectangular region. See
2239 * gdk_window_invalidate_region() for details.
2243 gdk_window_invalidate_rect (GdkWindow *window,
2245 gboolean invalidate_children)
2247 GdkRectangle window_rect;
2249 GdkWindowObject *private = (GdkWindowObject *)window;
2251 g_return_if_fail (window != NULL);
2252 g_return_if_fail (GDK_IS_WINDOW (window));
2254 if (GDK_WINDOW_DESTROYED (window))
2257 if (private->input_only || !GDK_WINDOW_IS_MAPPED (window))
2264 gdk_drawable_get_size (GDK_DRAWABLE (window),
2266 &window_rect.height);
2267 rect = &window_rect;
2270 region = gdk_region_rectangle (rect);
2271 gdk_window_invalidate_region (window, region, invalidate_children);
2272 gdk_region_destroy (region);
2276 draw_ugly_color (GdkWindow *window,
2279 /* Draw ugly color all over the newly-invalid region */
2280 GdkColor ugly_color = { 0, 50000, 10000, 10000 };
2282 GdkRectangle clipbox;
2284 ugly_gc = gdk_gc_new (window);
2285 gdk_gc_set_rgb_fg_color (ugly_gc, &ugly_color);
2286 gdk_gc_set_clip_region (ugly_gc, region);
2288 gdk_region_get_clipbox (region, &clipbox);
2290 gdk_draw_rectangle (window,
2293 clipbox.x, clipbox.y,
2294 clipbox.width, clipbox.height);
2296 g_object_unref (G_OBJECT (ugly_gc));
2300 * gdk_window_invalidate_maybe_recurse:
2301 * @window: a #GdkWindow
2302 * @region: a #GdkRegion
2303 * @child_func: function to use to decide if to recurse to a child,
2304 * %NULL means never recurse.
2305 * @user_data: data passed to @child_func
2307 * Adds @region to the update area for @window. The update area is the
2308 * region that needs to be redrawn, or "dirty region." The call
2309 * gdk_window_process_updates() sends one or more expose events to the
2310 * window, which together cover the entire update area. An
2311 * application would normally redraw the contents of @window in
2312 * response to those expose events.
2314 * GDK will call gdk_window_process_all_updates() on your behalf
2315 * whenever your program returns to the main loop and becomes idle, so
2316 * normally there's no need to do that manually, you just need to
2317 * invalidate regions that you know should be redrawn.
2319 * The @child_func parameter controls whether the region of
2320 * each child window that intersects @region will also be invalidated.
2321 * Only children for which @child_func returns TRUE will have the area
2325 gdk_window_invalidate_maybe_recurse (GdkWindow *window,
2327 gboolean (*child_func) (GdkWindow *, gpointer),
2330 GdkWindowObject *private = (GdkWindowObject *)window;
2331 GdkRegion *visible_region;
2333 g_return_if_fail (window != NULL);
2334 g_return_if_fail (GDK_IS_WINDOW (window));
2336 if (GDK_WINDOW_DESTROYED (window))
2339 if (private->input_only || !GDK_WINDOW_IS_MAPPED (window))
2342 visible_region = gdk_drawable_get_visible_region (window);
2343 gdk_region_intersect (visible_region, region);
2345 if (!gdk_region_empty (visible_region))
2348 draw_ugly_color (window, region);
2350 if (private->update_area)
2352 gdk_region_union (private->update_area, visible_region);
2356 update_windows = g_slist_prepend (update_windows, window);
2357 private->update_area = gdk_region_copy (visible_region);
2359 if (!private->update_freeze_count && !update_idle)
2360 update_idle = g_idle_add_full (GDK_PRIORITY_REDRAW,
2361 gdk_window_update_idle, NULL, NULL);
2368 tmp_list = private->children;
2371 GdkWindowObject *child = tmp_list->data;
2372 tmp_list = tmp_list->next;
2374 if (!child->input_only && (*child_func) ((GdkWindow *)child, user_data))
2376 GdkRegion *child_region;
2379 gdk_window_get_position ((GdkWindow *)child, &x, &y);
2381 /* This copy could be saved with a little more complexity */
2382 child_region = gdk_region_copy (visible_region);
2383 gdk_region_offset (child_region, -x, -y);
2385 gdk_window_invalidate_maybe_recurse ((GdkWindow *)child, child_region, child_func, user_data);
2387 gdk_region_destroy (child_region);
2393 gdk_region_destroy (visible_region);
2397 true_predicate (GdkWindow *window,
2404 * gdk_window_invalidate_region:
2405 * @window: a #GdkWindow
2406 * @region: a #GdkRegion
2407 * @invalidate_children: %TRUE to also invalidate child windows
2409 * Adds @region to the update area for @window. The update area is the
2410 * region that needs to be redrawn, or "dirty region." The call
2411 * gdk_window_process_updates() sends one or more expose events to the
2412 * window, which together cover the entire update area. An
2413 * application would normally redraw the contents of @window in
2414 * response to those expose events.
2416 * GDK will call gdk_window_process_all_updates() on your behalf
2417 * whenever your program returns to the main loop and becomes idle, so
2418 * normally there's no need to do that manually, you just need to
2419 * invalidate regions that you know should be redrawn.
2421 * The @invalidate_children parameter controls whether the region of
2422 * each child window that intersects @region will also be invalidated.
2423 * If %FALSE, then the update area for child windows will remain
2424 * unaffected. See gdk_window_invalidate_maybe_recurse if you need
2425 * fine grained control over which children are invalidated.
2428 gdk_window_invalidate_region (GdkWindow *window,
2430 gboolean invalidate_children)
2432 gdk_window_invalidate_maybe_recurse (window, region,
2433 invalidate_children ?
2434 true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
2439 * gdk_window_get_update_area:
2440 * @window: a #GdkWindow
2442 * Transfers ownership of the update area from @window to the caller
2443 * of the function. That is, after calling this function, @window will
2444 * no longer have an invalid/dirty region; the update area is removed
2445 * from @window and handed to you. If a window has no update area,
2446 * gdk_window_get_update_area() returns %NULL. You are responsible for
2447 * calling gdk_region_destroy() on the returned region if it's non-%NULL.
2449 * Return value: the update area for @window
2452 gdk_window_get_update_area (GdkWindow *window)
2454 GdkWindowObject *private = (GdkWindowObject *)window;
2455 GdkRegion *tmp_region;
2457 g_return_val_if_fail (window != NULL, NULL);
2458 g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2460 if (private->update_area)
2462 tmp_region = private->update_area;
2463 private->update_area = NULL;
2465 update_windows = g_slist_remove (update_windows, window);
2474 * _gdk_window_clear_update_area:
2475 * @window: a #GdkWindow.
2477 * Internal function to clear the update area for a window. This
2478 * is called when the window is hidden or destroyed.
2481 _gdk_window_clear_update_area (GdkWindow *window)
2483 GdkWindowObject *private = (GdkWindowObject *)window;
2485 g_return_if_fail (window != NULL);
2486 g_return_if_fail (GDK_IS_WINDOW (window));
2488 if (private->update_area)
2490 update_windows = g_slist_remove (update_windows, window);
2492 gdk_region_destroy (private->update_area);
2493 private->update_area = NULL;
2498 * gdk_window_freeze_updates:
2499 * @window: a #GdkWindow
2501 * Temporarily freezes a window such that it won't receive expose
2502 * events. The window will begin receiving expose events again when
2503 * gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
2504 * has been called more than once, gdk_window_thaw_updates() must be called
2505 * an equal number of times to begin processing exposes.
2508 gdk_window_freeze_updates (GdkWindow *window)
2510 GdkWindowObject *private = (GdkWindowObject *)window;
2512 g_return_if_fail (window != NULL);
2513 g_return_if_fail (GDK_IS_WINDOW (window));
2515 private->update_freeze_count++;
2519 * gdk_window_thaw_updates:
2520 * @window: a #GdkWindow
2522 * Thaws a window frozen with gdk_window_freeze_updates().
2525 gdk_window_thaw_updates (GdkWindow *window)
2527 GdkWindowObject *private = (GdkWindowObject *)window;
2529 g_return_if_fail (window != NULL);
2530 g_return_if_fail (GDK_IS_WINDOW (window));
2531 g_return_if_fail (private->update_freeze_count > 0);
2533 private->update_freeze_count--;
2534 if (!private->update_freeze_count && private->update_area && !update_idle)
2535 update_idle = g_idle_add_full (GDK_PRIORITY_REDRAW,
2536 gdk_window_update_idle, NULL, NULL);
2540 * gdk_window_set_debug_updates:
2541 * @setting: %TRUE to turn on update debugging
2543 * With update debugging enabled, calls to
2544 * gdk_window_invalidate_region() clear the invalidated region of the
2545 * screen to a noticeable color, and GDK pauses for a short time
2546 * before sending exposes to windows during
2547 * gdk_window_process_updates(). The net effect is that you can see
2548 * the invalid region for each window and watch redraws as they
2549 * occur. This allows you to diagnose inefficiencies in your application.
2551 * In essence, because the GDK rendering model prevents all flicker,
2552 * if you are redrawing the same region 400 times you may never
2553 * notice, aside from noticing a speed problem. Enabling update
2554 * debugging causes GTK to flicker slowly and noticeably, so you can
2555 * see exactly what's being redrawn when, in what order.
2557 * The --gtk-debug=updates command line option passed to GTK+ programs
2558 * enables this debug option at application startup time. That's
2559 * usually more useful than calling gdk_window_set_debug_updates()
2560 * yourself, though you might want to use this function to enable
2561 * updates sometime after application startup time.
2565 gdk_window_set_debug_updates (gboolean setting)
2567 debug_updates = setting;
2571 * gdk_window_constrain_size:
2572 * @geometry: a #GdkGeometry structure
2573 * @flags: a mask indicating what portions of @geometry are set
2574 * @width: desired width of window
2575 * @height: desired height of the window
2576 * @new_width: location to store resulting width
2577 * @new_height: location to store resulting height
2579 * Constrains a desired width and height according to a
2580 * set of geometry hints (such as minimum and maximum size).
2583 gdk_window_constrain_size (GdkGeometry *geometry,
2590 /* This routine is partially borrowed from fvwm.
2592 * Copyright 1993, Robert Nation
2593 * You may use this code for any purpose, as long as the original
2594 * copyright remains in the source code and all documentation
2596 * which in turn borrows parts of the algorithm from uwm
2599 gint min_height = 0;
2600 gint base_width = 0;
2601 gint base_height = 0;
2604 gint max_width = G_MAXINT;
2605 gint max_height = G_MAXINT;
2607 #define FLOOR(value, base) ( ((gint) ((value) / (base))) * (base) )
2609 if ((flags & GDK_HINT_BASE_SIZE) && (flags & GDK_HINT_MIN_SIZE))
2611 base_width = geometry->base_width;
2612 base_height = geometry->base_height;
2613 min_width = geometry->min_width;
2614 min_height = geometry->min_height;
2616 else if (flags & GDK_HINT_BASE_SIZE)
2618 base_width = geometry->base_width;
2619 base_height = geometry->base_height;
2620 min_width = geometry->base_width;
2621 min_height = geometry->base_height;
2623 else if (flags & GDK_HINT_MIN_SIZE)
2625 base_width = geometry->min_width;
2626 base_height = geometry->min_height;
2627 min_width = geometry->min_width;
2628 min_height = geometry->min_height;
2631 if (flags & GDK_HINT_MAX_SIZE)
2633 max_width = geometry->max_width ;
2634 max_height = geometry->max_height;
2637 if (flags & GDK_HINT_RESIZE_INC)
2639 xinc = MAX (xinc, geometry->width_inc);
2640 yinc = MAX (yinc, geometry->height_inc);
2643 /* clamp width and height to min and max values
2645 width = CLAMP (width, min_width, max_width);
2646 height = CLAMP (height, min_height, max_height);
2648 /* shrink to base + N * inc
2650 width = base_width + FLOOR (width - base_width, xinc);
2651 height = base_height + FLOOR (height - base_height, yinc);
2653 /* constrain aspect ratio, according to:
2656 * min_aspect <= -------- <= max_aspect
2660 if (flags & GDK_HINT_ASPECT &&
2661 geometry->min_aspect > 0 &&
2662 geometry->max_aspect > 0)
2666 if (geometry->min_aspect * height > width)
2668 delta = FLOOR (height - width * geometry->min_aspect, yinc);
2669 if (height - delta >= min_height)
2673 delta = FLOOR (height * geometry->min_aspect - width, xinc);
2674 if (width + delta <= max_width)
2679 if (geometry->max_aspect * height < width)
2681 delta = FLOOR (width - height * geometry->max_aspect, xinc);
2682 if (width - delta >= min_width)
2686 delta = FLOOR (width / geometry->max_aspect - height, yinc);
2687 if (height + delta <= max_height)
2696 *new_height = height;
2700 * gdk_set_pointer_hooks:
2701 * @new_hooks: a table of pointers to functions for getting
2702 * quantities related to the current pointer position,
2703 * or %NULL to restore the default table.
2705 * This function allows for hooking into the operation
2706 * of getting the current location of the pointer. This
2707 * is only useful for such low-level tools as an
2708 * event recorder. Applications should never have any
2709 * reason to use this facility
2711 * Return value: the previous pointer hook table
2714 gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
2716 const GdkPointerHooks *result = _gdk_current_pointer_hooks;
2719 _gdk_current_pointer_hooks = new_hooks;
2721 _gdk_current_pointer_hooks = &default_pointer_hooks;
2723 return (GdkPointerHooks *)result;
2727 * gdk_window_get_pointer:
2728 * @window: a #GdkWindow
2729 * @x: return location for X coordinate of pointer
2730 * @y: return location for Y coordinate of pointer
2731 * @mask: return location for modifier mask
2733 * Obtains the current pointer position and modifier state.
2734 * The position is given in coordinates relative to @window.
2736 * Return value: the window containing the pointer (as with
2737 * gdk_window_at_pointer()), or %NULL if the window containing the
2738 * pointer isn't known to GDK
2741 gdk_window_get_pointer (GdkWindow *window,
2744 GdkModifierType *mask)
2746 g_return_val_if_fail (window == NULL || GDK_IS_WINDOW (window), NULL);
2748 return _gdk_current_pointer_hooks->get_pointer (window, x, y, mask);
2752 * gdk_window_at_pointer:
2753 * @win_x: return location for origin of the window under the pointer
2754 * @win_y: return location for origin of the window under the pointer
2756 * Obtains the window underneath the mouse pointer, returning the
2757 * location of that window in @win_x, @win_y. Returns %NULL if the
2758 * window under the mouse pointer is not known to GDK (for example,
2759 * belongs to another application).
2761 * NOTE: For multihead-aware widgets or applications use
2762 * gdk_screen_get_window_at_pointer() instead.
2764 * Return value: window under the mouse pointer
2767 gdk_window_at_pointer (gint *win_x,
2770 return gdk_screen_get_window_at_pointer (gdk_get_default_screen (), win_x, win_y);
2774 * gdk_get_default_root_window:
2776 * Obtains the root window (parent all other windows are inside)
2777 * for the default display and screen.
2779 * Return value: the default root window
2782 gdk_get_default_root_window (void)
2784 return gdk_screen_get_root_window (gdk_get_default_screen ());
2788 * gdk_window_foreign_new:
2789 * @anid: a native window handle.
2791 * Wraps a native window for the default display in a #GdkWindow.
2792 * This may fail if the window has been destroyed.
2794 * For example in the X backend, a native window handle is an Xlib
2797 * Return value: the newly-created #GdkWindow wrapper for the
2798 * native window or %NULL if the window has been destroyed.
2801 gdk_window_foreign_new (GdkNativeWindow anid)
2803 return gdk_window_foreign_new_for_display (gdk_get_default_display (), anid);