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 /* Uninstalled header defining types and functions internal to GDK */
29 #ifndef __GDK_INTERNALS_H__
30 #define __GDK_INTERNALS_H__
33 #include <gdk/gdktypes.h>
34 #include <gdk/gdkwindow.h>
35 #include <gdk/gdkprivate.h>
37 #include <gdk/gdkmedialib.h>
42 /**********************
43 * General Facilities *
44 **********************/
46 /* Debugging support */
48 typedef struct _GdkColorInfo GdkColorInfo;
49 typedef struct _GdkEventFilter GdkEventFilter;
50 typedef struct _GdkClientFilter GdkClientFilter;
53 GDK_COLOR_WRITEABLE = 1 << 0
58 GdkColorInfoFlags flags;
62 struct _GdkEventFilter {
63 GdkFilterFunc function;
67 struct _GdkClientFilter {
69 GdkFilterFunc function;
74 GDK_DEBUG_MISC = 1 << 0,
75 GDK_DEBUG_EVENTS = 1 << 1,
76 GDK_DEBUG_DND = 1 << 2,
77 GDK_DEBUG_XIM = 1 << 3,
78 GDK_DEBUG_NOGRABS = 1 << 4,
79 GDK_DEBUG_COLORMAP = 1 << 5,
80 GDK_DEBUG_GC = 1 << 6,
81 GDK_DEBUG_PIXMAP = 1 << 7,
82 GDK_DEBUG_IMAGE = 1 << 8,
83 GDK_DEBUG_INPUT = 1 << 9,
84 GDK_DEBUG_CURSOR = 1 <<10,
85 GDK_DEBUG_MULTIHEAD = 1 <<11,
86 GDK_DEBUG_XINERAMA = 1 <<12,
87 GDK_DEBUG_DRAW = 1 <<13,
88 GDK_DEBUG_EVENTLOOP = 1 <<14
91 extern GList *_gdk_default_filters;
92 extern GdkWindow *_gdk_parent_root;
93 extern gint _gdk_error_code;
94 extern gint _gdk_error_warnings;
96 extern guint _gdk_debug_flags;
97 extern gboolean _gdk_native_windows;
101 #define GDK_NOTE(type,action) G_STMT_START { \
102 if (_gdk_debug_flags & GDK_DEBUG_##type) \
103 { action; }; } G_STMT_END
105 #else /* !G_ENABLE_DEBUG */
107 #define GDK_NOTE(type,action)
109 #endif /* G_ENABLE_DEBUG */
122 typedef struct _GdkArgContext GdkArgContext;
123 typedef struct _GdkArgDesc GdkArgDesc;
125 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
127 struct _GdkArgContext
143 typedef struct _GdkEventPrivate GdkEventPrivate;
147 /* Following flag is set for events on the event queue during
148 * translation and cleared afterwards.
150 GDK_EVENT_PENDING = 1 << 0
153 struct _GdkEventPrivate
158 gpointer windowing_data;
162 /* Tracks information about the pointer grab on this display */
166 GdkWindow *native_window;
168 gulong serial_end; /* exclusive, i.e. not active on serial_end */
169 gboolean owner_events;
173 GdkGrabOwnership ownership;
176 guint implicit_ungrab : 1;
179 typedef struct _GdkInputWindow GdkInputWindow;
181 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay *display,
183 GdkPointerWindowInfo *device_info,
186 /* Private version of GdkWindowObject. The initial part of this strucuture
187 is public for historical reasons. Don't change that part */
188 typedef struct _GdkWindowPaint GdkWindowPaint;
190 #define GDK_WINDOW_OBJECT(object) ((GdkWindowObject *) GDK_WINDOW (object))
192 struct _GdkWindowObject
194 GdkDrawable parent_instance;
196 GdkDrawable *impl; /* window-system-specific delegate object */
198 GdkWindowObject *parent;
205 gint extension_events;
211 GdkPixmap *bg_pixmap;
215 cairo_region_t *update_area;
216 guint update_freeze_count;
222 GdkWindowState state;
224 guint guffaw_gravity : 1;
225 guint input_only : 1;
226 guint modal_hint : 1;
227 guint composited : 1;
231 guint accept_focus : 1;
232 guint focus_on_map : 1;
234 guint support_multidevice : 1;
236 GdkEventMask event_mask;
238 guint update_and_descendants_freeze_count;
240 GdkWindowRedirect *redirect;
242 /* The GdkWindowObject that has the impl, ref:ed if another window.
243 * This ref is required to keep the wrapper of the impl window alive
244 * for as long as any GdkWindow references the impl. */
245 GdkWindowObject *impl_window;
246 int abs_x, abs_y; /* Absolute offset in impl */
249 cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
250 cairo_region_t *clip_region_with_children; /* Clip region in window coords */
252 GHashTable *device_cursor;
253 gint8 toplevel_window_type;
254 guint synthesize_crossing_event_queued : 1;
255 guint effective_visibility : 2;
256 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
257 guint native_visibility : 2; /* the native visibility of a impl windows */
258 guint viewable : 1; /* mapped and all parents mapped */
259 guint applied_shape : 1;
261 guint num_offscreen_children;
262 GdkWindowPaint *implicit_paint;
263 GdkInputWindow *input_window; /* only set for impl windows */
265 GList *outstanding_moves;
267 cairo_region_t *shape;
268 cairo_region_t *input_shape;
270 cairo_surface_t *cairo_surface;
271 guint outstanding_surfaces; /* only set on impl window */
273 GList *devices_inside;
274 GHashTable *device_events;
277 #define GDK_WINDOW_TYPE(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->window_type)
278 #define GDK_WINDOW_DESTROYED(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->destroyed)
280 extern GdkEventFunc _gdk_event_func; /* Callback for events */
281 extern gpointer _gdk_event_data;
282 extern GDestroyNotify _gdk_event_notify;
284 extern GSList *_gdk_displays;
285 extern gchar *_gdk_display_name;
286 extern gint _gdk_screen_number;
287 extern gchar *_gdk_display_arg_name;
288 extern gboolean _gdk_enable_multidevice;
290 void _gdk_events_queue (GdkDisplay *display);
291 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
293 GList* _gdk_event_queue_find_first (GdkDisplay *display);
294 void _gdk_event_queue_remove_link (GdkDisplay *display,
296 GList* _gdk_event_queue_prepend (GdkDisplay *display,
298 GList* _gdk_event_queue_append (GdkDisplay *display,
300 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
301 GdkEvent *after_event,
303 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
304 GdkEvent *after_event,
306 void _gdk_event_button_generate (GdkDisplay *display,
309 void _gdk_windowing_event_data_copy (const GdkEvent *src,
311 void _gdk_windowing_event_data_free (GdkEvent *event);
313 void gdk_synthesize_window_state (GdkWindow *window,
314 GdkWindowState unset_flags,
315 GdkWindowState set_flags);
317 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
320 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
322 GdkDrawable *_gdk_drawable_get_source_drawable (GdkDrawable *drawable);
323 cairo_surface_t * _gdk_drawable_create_cairo_surface (GdkDrawable *drawable,
328 GdkGC *_gdk_drawable_get_subwindow_scratch_gc (GdkDrawable *drawable);
330 void _gdk_gc_update_context (GdkGC *gc,
332 const GdkColor *override_foreground,
333 GdkBitmap *override_stipple,
335 GdkDrawable *target_drawable);
337 /*************************************
338 * Interfaces used by windowing code *
339 *************************************/
341 GdkPixmap *_gdk_pixmap_new (GdkDrawable *drawable,
345 GdkPixmap *_gdk_pixmap_create_from_data (GdkDrawable *drawable,
352 GdkPixmap *_gdk_bitmap_create_from_data (GdkDrawable *drawable,
357 void _gdk_window_impl_new (GdkWindow *window,
358 GdkWindow *real_parent,
361 GdkEventMask event_mask,
362 GdkWindowAttr *attributes,
363 gint attributes_mask);
364 void _gdk_window_destroy (GdkWindow *window,
365 gboolean foreign_destroy);
366 void _gdk_window_clear_update_area (GdkWindow *window);
367 void _gdk_window_update_size (GdkWindow *window);
368 gboolean _gdk_window_update_viewable (GdkWindow *window);
370 void _gdk_window_process_updates_recurse (GdkWindow *window,
371 cairo_region_t *expose_region);
373 void _gdk_screen_close (GdkScreen *screen);
375 const char *_gdk_get_sm_client_id (void);
377 void _gdk_gc_init (GdkGC *gc,
378 GdkDrawable *drawable,
380 GdkGCValuesMask values_mask);
382 cairo_region_t *_gdk_gc_get_clip_region (GdkGC *gc);
383 GdkBitmap *_gdk_gc_get_clip_mask (GdkGC *gc);
384 gboolean _gdk_gc_get_exposures (GdkGC *gc);
385 GdkFill _gdk_gc_get_fill (GdkGC *gc);
386 GdkPixmap *_gdk_gc_get_tile (GdkGC *gc);
387 GdkBitmap *_gdk_gc_get_stipple (GdkGC *gc);
388 guint32 _gdk_gc_get_fg_pixel (GdkGC *gc);
389 guint32 _gdk_gc_get_bg_pixel (GdkGC *gc);
390 void _gdk_gc_add_drawable_clip (GdkGC *gc,
392 cairo_region_t *region,
395 void _gdk_gc_remove_drawable_clip (GdkGC *gc);
396 void _gdk_gc_set_clip_region_internal (GdkGC *gc,
397 cairo_region_t *region,
398 gboolean reset_origin);
399 GdkSubwindowMode _gdk_gc_get_subwindow (GdkGC *gc);
401 GdkDrawable *_gdk_drawable_begin_direct_draw (GdkDrawable *drawable,
406 void _gdk_drawable_end_direct_draw (gpointer priv_data);
409 /*****************************************
410 * Interfaces provided by windowing code *
411 *****************************************/
413 /* Font/string functions implemented in module-specific code */
415 void _gdk_colormap_real_destroy (GdkColormap *colormap);
417 void _gdk_cursor_destroy (GdkCursor *cursor);
419 void _gdk_windowing_init (void);
421 extern const GOptionEntry _gdk_windowing_args[];
422 void _gdk_windowing_set_default_display (GdkDisplay *display);
424 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
427 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
428 void _gdk_windowing_window_get_offsets (GdkWindow *window,
431 cairo_region_t *_gdk_windowing_window_get_shape (GdkWindow *window);
432 cairo_region_t *_gdk_windowing_window_get_input_shape(GdkWindow *window);
433 cairo_region_t *_gdk_windowing_get_shape_for_mask (GdkBitmap *mask);
434 void _gdk_windowing_window_beep (GdkWindow *window);
437 void _gdk_windowing_get_device_state (GdkDisplay *display,
442 GdkModifierType *mask);
443 GdkWindow* _gdk_windowing_window_at_device_position (GdkDisplay *display,
447 GdkModifierType *mask,
448 gboolean get_toplevel);
449 GdkGrabStatus _gdk_windowing_device_grab (GdkDevice *device,
452 gboolean owner_events,
453 GdkEventMask event_mask,
454 GdkWindow *confine_to,
457 void _gdk_windowing_got_event (GdkDisplay *display,
462 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
463 cairo_region_t *expose_region);
464 void _gdk_windowing_before_process_all_updates (void);
465 void _gdk_windowing_after_process_all_updates (void);
467 /* Return the number of bits-per-pixel for images of the specified depth. */
468 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
472 #define GDK_WINDOW_IS_MAPPED(window) ((((GdkWindowObject*)window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
475 /* Called when gdk_window_destroy() is called on a foreign window
476 * or an ancestor of the foreign window. It should generally reparent
477 * the window out of it's current heirarchy, hide it, and then
478 * send a message to the owner requesting that the window be destroyed.
480 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
482 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
483 const gchar *sm_client_id);
485 void _gdk_windowing_window_set_composited (GdkWindow *window,
486 gboolean composited);
488 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
489 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
490 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
491 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
493 typedef struct _GdkPaintable GdkPaintable;
494 typedef struct _GdkPaintableIface GdkPaintableIface;
496 struct _GdkPaintableIface
498 GTypeInterface g_iface;
500 void (* begin_paint_region) (GdkPaintable *paintable,
502 const cairo_region_t *region);
503 void (* end_paint) (GdkPaintable *paintable);
506 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
508 /* Implementation types */
509 GType _gdk_window_impl_get_type (void) G_GNUC_CONST;
510 GType _gdk_pixmap_impl_get_type (void) G_GNUC_CONST;
514 * _gdk_windowing_gc_set_clip_region:
516 * @region: the new clip region
517 * @reset_origin: if TRUE, reset the clip_x/y_origin values to 0
519 * Do any window-system specific processing necessary
520 * for a change in clip region. Since the clip origin
521 * will likely change before the GC is used with the
522 * new clip, frequently this function will only set a flag and
523 * do the real processing later.
525 * When this function is called, _gdk_gc_get_clip_region
526 * will already return the new region.
528 void _gdk_windowing_gc_set_clip_region (GdkGC *gc,
529 const cairo_region_t *region,
530 gboolean reset_origin);
533 * _gdk_windowing_gc_copy:
534 * @dst_gc: a #GdkGC from the GDK backend
535 * @src_gc: a #GdkGC from the GDK backend
537 * Copies backend specific state from @src_gc to @dst_gc.
538 * This is called before the generic state is copied, so
539 * the old generic state is still available from @dst_gc
541 void _gdk_windowing_gc_copy (GdkGC *dst_gc,
544 /* Queries the current foreground color of a GdkGC */
545 void _gdk_windowing_gc_get_foreground (GdkGC *gc,
547 /* Queries the current background color of a GdkGC */
548 void _gdk_windowing_gc_get_background (GdkGC *gc,
551 struct GdkAppLaunchContextPrivate
561 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
564 void _gdk_windowing_launch_failed (GAppLaunchContext *context,
565 const char *startup_notify_id);
567 void _gdk_display_device_grab_update (GdkDisplay *display,
569 gulong current_serial);
570 GdkDeviceGrabInfo *_gdk_display_get_last_device_grab (GdkDisplay *display,
572 GdkDeviceGrabInfo *_gdk_display_add_device_grab (GdkDisplay *display,
575 GdkWindow *native_window,
576 GdkGrabOwnership grab_ownership,
577 gboolean owner_events,
578 GdkEventMask event_mask,
579 unsigned long serial_start,
582 GdkDeviceGrabInfo * _gdk_display_has_device_grab (GdkDisplay *display,
585 gboolean _gdk_display_end_device_grab (GdkDisplay *display,
590 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
593 void _gdk_display_enable_motion_hints (GdkDisplay *display,
596 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
599 void _gdk_display_pointer_info_foreach (GdkDisplay *display,
600 GdkDisplayPointerInfoForeach func,
603 void _gdk_window_invalidate_for_expose (GdkWindow *window,
604 cairo_region_t *region);
606 void _gdk_windowing_set_cairo_surface_size (cairo_surface_t *surface,
610 cairo_surface_t * _gdk_windowing_create_cairo_surface (GdkDrawable *drawable,
613 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
615 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
620 void _gdk_window_add_damage (GdkWindow *toplevel,
621 cairo_region_t *damaged_region);
623 GdkEvent * _gdk_make_event (GdkWindow *window,
625 GdkEvent *event_in_queue,
626 gboolean before_event);
627 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
630 void _gdk_synthesize_crossing_events (GdkDisplay *display,
634 GdkCrossingMode mode,
637 GdkModifierType mask,
639 GdkEvent *event_in_queue,
641 gboolean non_linear);
642 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
647 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
649 cairo_region_t *_gdk_window_calculate_full_clip_region (GdkWindow *window,
650 GdkWindow *base_window,
651 gboolean do_children,
653 gint *base_y_offset);
654 gboolean _gdk_window_has_impl (GdkWindow *window);
655 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
656 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
657 GdkEventType event_type,
661 /*****************************
662 * offscreen window routines *
663 *****************************/
664 GType gdk_offscreen_window_get_type (void);
665 void _gdk_offscreen_window_new (GdkWindow *window,
668 GdkWindowAttr *attributes,
669 gint attributes_mask);
672 /************************************
673 * Initialization and exit routines *
674 ************************************/
676 void _gdk_windowing_exit (void);
680 #endif /* __GDK_INTERNALS_H__ */