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_GDKRGB = 1 << 6,
81 GDK_DEBUG_GC = 1 << 7,
82 GDK_DEBUG_PIXMAP = 1 << 8,
83 GDK_DEBUG_IMAGE = 1 << 9,
84 GDK_DEBUG_INPUT = 1 <<10,
85 GDK_DEBUG_CURSOR = 1 <<11,
86 GDK_DEBUG_MULTIHEAD = 1 <<12,
87 GDK_DEBUG_XINERAMA = 1 <<13,
88 GDK_DEBUG_DRAW = 1 <<14,
89 GDK_DEBUG_EVENTLOOP = 1 <<15
92 #ifndef GDK_DISABLE_DEPRECATED
94 typedef struct _GdkFontPrivate GdkFontPrivate;
96 struct _GdkFontPrivate
102 #endif /* GDK_DISABLE_DEPRECATED */
104 extern GList *_gdk_default_filters;
105 extern GdkWindow *_gdk_parent_root;
106 extern gint _gdk_error_code;
107 extern gint _gdk_error_warnings;
109 extern guint _gdk_debug_flags;
110 extern gboolean _gdk_native_windows;
112 #ifdef G_ENABLE_DEBUG
114 #define GDK_NOTE(type,action) G_STMT_START { \
115 if (_gdk_debug_flags & GDK_DEBUG_##type) \
116 { action; }; } G_STMT_END
118 #else /* !G_ENABLE_DEBUG */
120 #define GDK_NOTE(type,action)
122 #endif /* G_ENABLE_DEBUG */
135 typedef struct _GdkArgContext GdkArgContext;
136 typedef struct _GdkArgDesc GdkArgDesc;
138 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
140 struct _GdkArgContext
156 typedef struct _GdkEventPrivate GdkEventPrivate;
160 /* Following flag is set for events on the event queue during
161 * translation and cleared afterwards.
163 GDK_EVENT_PENDING = 1 << 0
166 struct _GdkEventPrivate
171 gpointer windowing_data;
175 /* Tracks information about the pointer grab on this display */
179 GdkWindow *native_window;
181 gulong serial_end; /* exclusive, i.e. not active on serial_end */
182 gboolean owner_events;
186 GdkGrabOwnership ownership;
189 guint implicit_ungrab : 1;
192 typedef struct _GdkInputWindow GdkInputWindow;
194 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay *display,
196 GdkPointerWindowInfo *device_info,
199 /* Private version of GdkWindowObject. The initial part of this strucuture
200 is public for historical reasons. Don't change that part */
201 typedef struct _GdkWindowPaint GdkWindowPaint;
203 struct _GdkWindowObject
205 /* vvvvvvv THIS PART IS PUBLIC. DON'T CHANGE vvvvvvvvvvvvvv */
206 GdkDrawable parent_instance;
208 GdkDrawable *impl; /* window-system-specific delegate object */
210 GdkWindowObject *parent;
217 gint extension_events;
223 GdkPixmap *bg_pixmap;
227 GdkRegion *update_area;
228 guint update_freeze_count;
234 GdkWindowState state;
236 guint guffaw_gravity : 1;
237 guint input_only : 1;
238 guint modal_hint : 1;
239 guint composited : 1;
243 guint accept_focus : 1;
244 guint focus_on_map : 1;
246 guint support_multidevice : 1;
248 GdkEventMask event_mask;
250 guint update_and_descendants_freeze_count;
252 GdkWindowRedirect *redirect;
254 /* ^^^^^^^^^^ THIS PART IS PUBLIC. DON'T CHANGE ^^^^^^^^^^ */
256 /* The GdkWindowObject that has the impl, ref:ed if another window.
257 * This ref is required to keep the wrapper of the impl window alive
258 * for as long as any GdkWindow references the impl. */
259 GdkWindowObject *impl_window;
260 int abs_x, abs_y; /* Absolute offset in impl */
263 GdkRegion *clip_region; /* Clip region (wrt toplevel) in window coords */
264 GdkRegion *clip_region_with_children; /* Clip region in window coords */
266 GHashTable *device_cursor;
267 gint8 toplevel_window_type;
268 guint synthesize_crossing_event_queued : 1;
269 guint effective_visibility : 2;
270 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
271 guint native_visibility : 2; /* the native visibility of a impl windows */
272 guint viewable : 1; /* mapped and all parents mapped */
273 guint applied_shape : 1;
275 guint num_offscreen_children;
276 GdkWindowPaint *implicit_paint;
277 GdkInputWindow *input_window; /* only set for impl windows */
279 GList *outstanding_moves;
282 GdkRegion *input_shape;
284 cairo_surface_t *cairo_surface;
285 guint outstanding_surfaces; /* only set on impl window */
287 GList *devices_inside;
288 GHashTable *device_events;
291 #define GDK_WINDOW_TYPE(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->window_type)
292 #define GDK_WINDOW_DESTROYED(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->destroyed)
294 extern GdkEventFunc _gdk_event_func; /* Callback for events */
295 extern gpointer _gdk_event_data;
296 extern GDestroyNotify _gdk_event_notify;
298 extern GSList *_gdk_displays;
299 extern gchar *_gdk_display_name;
300 extern gint _gdk_screen_number;
301 extern gchar *_gdk_display_arg_name;
302 extern gboolean _gdk_enable_multidevice;
304 void _gdk_events_queue (GdkDisplay *display);
305 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
307 GList* _gdk_event_queue_find_first (GdkDisplay *display);
308 void _gdk_event_queue_remove_link (GdkDisplay *display,
310 GList* _gdk_event_queue_prepend (GdkDisplay *display,
312 GList* _gdk_event_queue_append (GdkDisplay *display,
314 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
315 GdkEvent *after_event,
317 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
318 GdkEvent *after_event,
320 void _gdk_event_button_generate (GdkDisplay *display,
323 void _gdk_windowing_event_data_copy (const GdkEvent *src,
325 void _gdk_windowing_event_data_free (GdkEvent *event);
327 void gdk_synthesize_window_state (GdkWindow *window,
328 GdkWindowState unset_flags,
329 GdkWindowState set_flags);
331 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
334 #define GDK_SCRATCH_IMAGE_WIDTH 256
335 #define GDK_SCRATCH_IMAGE_HEIGHT 64
337 GdkImage* _gdk_image_new_for_depth (GdkScreen *screen,
343 GdkImage *_gdk_image_get_scratch (GdkScreen *screen,
350 GdkImage *_gdk_drawable_copy_to_image (GdkDrawable *drawable,
359 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
361 GdkDrawable *_gdk_drawable_get_source_drawable (GdkDrawable *drawable);
362 cairo_surface_t * _gdk_drawable_create_cairo_surface (GdkDrawable *drawable,
367 GdkGC *_gdk_drawable_get_scratch_gc (GdkDrawable *drawable,
368 gboolean graphics_exposures);
369 GdkGC *_gdk_drawable_get_subwindow_scratch_gc (GdkDrawable *drawable);
371 void _gdk_gc_update_context (GdkGC *gc,
373 const GdkColor *override_foreground,
374 GdkBitmap *override_stipple,
376 GdkDrawable *target_drawable);
378 /*************************************
379 * Interfaces used by windowing code *
380 *************************************/
382 GdkPixmap *_gdk_pixmap_new (GdkDrawable *drawable,
386 GdkPixmap *_gdk_pixmap_create_from_data (GdkDrawable *drawable,
393 GdkPixmap *_gdk_bitmap_create_from_data (GdkDrawable *drawable,
398 void _gdk_window_impl_new (GdkWindow *window,
399 GdkWindow *real_parent,
402 GdkEventMask event_mask,
403 GdkWindowAttr *attributes,
404 gint attributes_mask);
405 void _gdk_window_destroy (GdkWindow *window,
406 gboolean foreign_destroy);
407 void _gdk_window_clear_update_area (GdkWindow *window);
408 void _gdk_window_update_size (GdkWindow *window);
409 gboolean _gdk_window_update_viewable (GdkWindow *window);
411 void _gdk_window_process_updates_recurse (GdkWindow *window,
412 GdkRegion *expose_region);
414 void _gdk_screen_close (GdkScreen *screen);
416 const char *_gdk_get_sm_client_id (void);
418 void _gdk_gc_init (GdkGC *gc,
419 GdkDrawable *drawable,
421 GdkGCValuesMask values_mask);
423 GdkRegion *_gdk_gc_get_clip_region (GdkGC *gc);
424 GdkBitmap *_gdk_gc_get_clip_mask (GdkGC *gc);
425 gboolean _gdk_gc_get_exposures (GdkGC *gc);
426 GdkFill _gdk_gc_get_fill (GdkGC *gc);
427 GdkPixmap *_gdk_gc_get_tile (GdkGC *gc);
428 GdkBitmap *_gdk_gc_get_stipple (GdkGC *gc);
429 guint32 _gdk_gc_get_fg_pixel (GdkGC *gc);
430 guint32 _gdk_gc_get_bg_pixel (GdkGC *gc);
431 void _gdk_gc_add_drawable_clip (GdkGC *gc,
436 void _gdk_gc_remove_drawable_clip (GdkGC *gc);
437 void _gdk_gc_set_clip_region_internal (GdkGC *gc,
439 gboolean reset_origin);
440 GdkSubwindowMode _gdk_gc_get_subwindow (GdkGC *gc);
442 GdkDrawable *_gdk_drawable_begin_direct_draw (GdkDrawable *drawable,
447 void _gdk_drawable_end_direct_draw (gpointer priv_data);
450 /*****************************************
451 * Interfaces provided by windowing code *
452 *****************************************/
454 /* Font/string functions implemented in module-specific code */
455 gint _gdk_font_strlen (GdkFont *font, const char *str);
456 void _gdk_font_destroy (GdkFont *font);
458 void _gdk_colormap_real_destroy (GdkColormap *colormap);
460 void _gdk_cursor_destroy (GdkCursor *cursor);
462 void _gdk_windowing_init (void);
464 extern const GOptionEntry _gdk_windowing_args[];
465 void _gdk_windowing_set_default_display (GdkDisplay *display);
467 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
470 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
471 void _gdk_windowing_window_get_offsets (GdkWindow *window,
474 GdkRegion *_gdk_windowing_window_get_shape (GdkWindow *window);
475 GdkRegion *_gdk_windowing_window_get_input_shape(GdkWindow *window);
476 GdkRegion *_gdk_windowing_get_shape_for_mask (GdkBitmap *mask);
477 void _gdk_windowing_window_beep (GdkWindow *window);
480 void _gdk_windowing_get_device_state (GdkDisplay *display,
485 GdkModifierType *mask);
486 GdkWindow* _gdk_windowing_window_at_device_position (GdkDisplay *display,
490 GdkModifierType *mask,
491 gboolean get_toplevel);
492 GdkGrabStatus _gdk_windowing_device_grab (GdkDevice *device,
495 gboolean owner_events,
496 GdkEventMask event_mask,
497 GdkWindow *confine_to,
500 void _gdk_windowing_got_event (GdkDisplay *display,
505 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
506 GdkRegion *expose_region);
507 void _gdk_windowing_before_process_all_updates (void);
508 void _gdk_windowing_after_process_all_updates (void);
510 /* Return the number of bits-per-pixel for images of the specified depth. */
511 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
515 #define GDK_WINDOW_IS_MAPPED(window) ((((GdkWindowObject*)window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
518 /* Called when gdk_window_destroy() is called on a foreign window
519 * or an ancestor of the foreign window. It should generally reparent
520 * the window out of it's current heirarchy, hide it, and then
521 * send a message to the owner requesting that the window be destroyed.
523 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
525 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
526 const gchar *sm_client_id);
528 void _gdk_windowing_window_set_composited (GdkWindow *window,
529 gboolean composited);
531 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
532 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
533 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
534 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
536 typedef struct _GdkPaintable GdkPaintable;
537 typedef struct _GdkPaintableIface GdkPaintableIface;
539 struct _GdkPaintableIface
541 GTypeInterface g_iface;
543 void (* begin_paint_region) (GdkPaintable *paintable,
545 const GdkRegion *region);
546 void (* end_paint) (GdkPaintable *paintable);
549 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
551 /* Implementation types */
552 GType _gdk_window_impl_get_type (void) G_GNUC_CONST;
553 GType _gdk_pixmap_impl_get_type (void) G_GNUC_CONST;
557 * _gdk_windowing_gc_set_clip_region:
559 * @region: the new clip region
560 * @reset_origin: if TRUE, reset the clip_x/y_origin values to 0
562 * Do any window-system specific processing necessary
563 * for a change in clip region. Since the clip origin
564 * will likely change before the GC is used with the
565 * new clip, frequently this function will only set a flag and
566 * do the real processing later.
568 * When this function is called, _gdk_gc_get_clip_region
569 * will already return the new region.
571 void _gdk_windowing_gc_set_clip_region (GdkGC *gc,
572 const GdkRegion *region,
573 gboolean reset_origin);
576 * _gdk_windowing_gc_copy:
577 * @dst_gc: a #GdkGC from the GDK backend
578 * @src_gc: a #GdkGC from the GDK backend
580 * Copies backend specific state from @src_gc to @dst_gc.
581 * This is called before the generic state is copied, so
582 * the old generic state is still available from @dst_gc
584 void _gdk_windowing_gc_copy (GdkGC *dst_gc,
587 /* Queries the current foreground color of a GdkGC */
588 void _gdk_windowing_gc_get_foreground (GdkGC *gc,
590 /* Queries the current background color of a GdkGC */
591 void _gdk_windowing_gc_get_background (GdkGC *gc,
594 struct GdkAppLaunchContextPrivate
604 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
607 void _gdk_windowing_launch_failed (GAppLaunchContext *context,
608 const char *startup_notify_id);
610 void _gdk_display_device_grab_update (GdkDisplay *display,
612 gulong current_serial);
613 GdkDeviceGrabInfo *_gdk_display_get_last_device_grab (GdkDisplay *display,
615 GdkDeviceGrabInfo *_gdk_display_add_device_grab (GdkDisplay *display,
618 GdkWindow *native_window,
619 GdkGrabOwnership grab_ownership,
620 gboolean owner_events,
621 GdkEventMask event_mask,
622 unsigned long serial_start,
625 GdkDeviceGrabInfo * _gdk_display_has_device_grab (GdkDisplay *display,
628 gboolean _gdk_display_end_device_grab (GdkDisplay *display,
633 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
636 void _gdk_display_enable_motion_hints (GdkDisplay *display,
639 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
642 void _gdk_display_pointer_info_foreach (GdkDisplay *display,
643 GdkDisplayPointerInfoForeach func,
646 void _gdk_window_invalidate_for_expose (GdkWindow *window,
649 void _gdk_windowing_set_cairo_surface_size (cairo_surface_t *surface,
653 cairo_surface_t * _gdk_windowing_create_cairo_surface (GdkDrawable *drawable,
656 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
658 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
663 void _gdk_window_add_damage (GdkWindow *toplevel,
664 GdkRegion *damaged_region);
666 GdkEvent * _gdk_make_event (GdkWindow *window,
668 GdkEvent *event_in_queue,
669 gboolean before_event);
670 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
673 void _gdk_synthesize_crossing_events (GdkDisplay *display,
677 GdkCrossingMode mode,
680 GdkModifierType mask,
682 GdkEvent *event_in_queue,
684 gboolean non_linear);
685 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
690 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
692 GdkRegion *_gdk_window_calculate_full_clip_region (GdkWindow *window,
693 GdkWindow *base_window,
694 gboolean do_children,
696 gint *base_y_offset);
697 gboolean _gdk_window_has_impl (GdkWindow *window);
698 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
699 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
700 GdkEventType event_type,
703 GdkRegion *_gdk_region_new_from_yxbanded_rects (GdkRectangle *rects, int n_rects);
705 /*****************************
706 * offscreen window routines *
707 *****************************/
708 GType gdk_offscreen_window_get_type (void);
709 void _gdk_offscreen_window_new (GdkWindow *window,
712 GdkWindowAttr *attributes,
713 gint attributes_mask);
716 /************************************
717 * Initialization and exit routines *
718 ************************************/
720 void _gdk_image_exit (void);
721 void _gdk_windowing_exit (void);
725 #endif /* __GDK_INTERNALS_H__ */