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;
111 #ifdef G_ENABLE_DEBUG
113 #define GDK_NOTE(type,action) G_STMT_START { \
114 if (_gdk_debug_flags & GDK_DEBUG_##type) \
115 { action; }; } G_STMT_END
117 #else /* !G_ENABLE_DEBUG */
119 #define GDK_NOTE(type,action)
121 #endif /* G_ENABLE_DEBUG */
134 typedef struct _GdkArgContext GdkArgContext;
135 typedef struct _GdkArgDesc GdkArgDesc;
137 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
139 struct _GdkArgContext
155 typedef struct _GdkEventPrivate GdkEventPrivate;
159 /* Following flag is set for events on the event queue during
160 * translation and cleared afterwards.
162 GDK_EVENT_PENDING = 1 << 0
165 struct _GdkEventPrivate
170 gpointer windowing_data;
173 /* Tracks information about the pointer grab on this display */
177 GdkWindow *native_window;
179 gulong serial_end; /* exclusive, i.e. not active on serial_end */
180 gboolean owner_events;
186 gboolean implicit_ungrab;
187 gboolean grab_one_pointer_release_event;
188 } GdkPointerGrabInfo;
190 typedef struct _GdkInputWindow GdkInputWindow;
192 /* Private version of GdkWindowObject. The initial part of this strucuture
193 is public for historical reasons. Don't change that part */
194 typedef struct _GdkWindowPaint GdkWindowPaint;
196 struct _GdkWindowObject
198 /* vvvvvvv THIS PART IS PUBLIC. DON'T CHANGE vvvvvvvvvvvvvv */
199 GdkDrawable parent_instance;
201 GdkDrawable *impl; /* window-system-specific delegate object */
203 GdkWindowObject *parent;
210 gint extension_events;
216 GdkPixmap *bg_pixmap;
220 GdkRegion *update_area;
221 guint update_freeze_count;
227 GdkWindowState state;
229 guint guffaw_gravity : 1;
230 guint input_only : 1;
231 guint modal_hint : 1;
232 guint composited : 1;
236 guint accept_focus : 1;
237 guint focus_on_map : 1;
240 GdkEventMask event_mask;
242 guint update_and_descendants_freeze_count;
244 GdkWindowRedirect *redirect;
246 /* ^^^^^^^^^^ THIS PART IS PUBLIC. DON'T CHANGE ^^^^^^^^^^ */
248 /* The GdkWindowObject that has the impl, ref:ed if another window.
249 * This ref is required to keep the wrapper of the impl window alive
250 * for as long as any GdkWindow references the impl. */
251 GdkWindowObject *impl_window;
252 int abs_x, abs_y; /* Absolute offset in impl */
255 GdkRegion *clip_region; /* Clip region (wrt toplevel) in window coords */
256 GdkRegion *clip_region_with_children; /* Clip region in window coords */
258 gint8 toplevel_window_type;
259 guint effective_visibility : 2;
260 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
261 guint native_visibility : 2; /* the native visibility of a impl windows */
263 GdkWindowPaint *implicit_paint;
264 GdkInputWindow *input_window; /* only set for impl windows */
266 GList *outstanding_moves;
269 GdkRegion *input_shape;
271 cairo_surface_t *cairo_surface;
275 extern GdkEventFunc _gdk_event_func; /* Callback for events */
276 extern gpointer _gdk_event_data;
277 extern GDestroyNotify _gdk_event_notify;
279 extern GSList *_gdk_displays;
280 extern gchar *_gdk_display_name;
281 extern gint _gdk_screen_number;
282 extern gchar *_gdk_display_arg_name;
284 void _gdk_events_queue (GdkDisplay *display);
285 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
287 GList* _gdk_event_queue_find_first (GdkDisplay *display);
288 void _gdk_event_queue_remove_link (GdkDisplay *display,
290 GList* _gdk_event_queue_prepend (GdkDisplay *display,
292 GList* _gdk_event_queue_append (GdkDisplay *display,
294 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
295 GdkEvent *after_event,
297 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
298 GdkEvent *after_event,
300 void _gdk_event_button_generate (GdkDisplay *display,
303 void _gdk_windowing_event_data_copy (const GdkEvent *src,
305 void _gdk_windowing_event_data_free (GdkEvent *event);
307 void gdk_synthesize_window_state (GdkWindow *window,
308 GdkWindowState unset_flags,
309 GdkWindowState set_flags);
311 #define GDK_SCRATCH_IMAGE_WIDTH 256
312 #define GDK_SCRATCH_IMAGE_HEIGHT 64
314 GdkImage* _gdk_image_new_for_depth (GdkScreen *screen,
320 GdkImage *_gdk_image_get_scratch (GdkScreen *screen,
327 GdkImage *_gdk_drawable_copy_to_image (GdkDrawable *drawable,
336 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
338 GdkDrawable *_gdk_drawable_get_source_drawable (GdkDrawable *drawable);
339 cairo_surface_t * _gdk_drawable_create_cairo_surface (GdkDrawable *drawable,
344 GdkGC *_gdk_drawable_get_scratch_gc (GdkDrawable *drawable,
345 gboolean graphics_exposures);
346 GdkGC *_gdk_drawable_get_subwindow_scratch_gc (GdkDrawable *drawable);
348 void _gdk_gc_update_context (GdkGC *gc,
350 const GdkColor *override_foreground,
351 GdkBitmap *override_stipple,
353 GdkDrawable *target_drawable);
355 /*************************************
356 * Interfaces used by windowing code *
357 *************************************/
359 GdkPixmap *_gdk_pixmap_new (GdkDrawable *drawable,
363 GdkPixmap *_gdk_pixmap_create_from_data (GdkDrawable *drawable,
370 GdkPixmap *_gdk_bitmap_create_from_data (GdkDrawable *drawable,
375 void _gdk_window_impl_new (GdkWindow *window,
376 GdkWindow *real_parent,
379 GdkEventMask event_mask,
380 GdkWindowAttr *attributes,
381 gint attributes_mask);
382 void _gdk_window_destroy (GdkWindow *window,
383 gboolean foreign_destroy);
384 void _gdk_window_clear_update_area (GdkWindow *window);
385 void _gdk_window_update_size (GdkWindow *window);
387 void _gdk_window_process_updates_recurse (GdkWindow *window,
388 GdkRegion *expose_region);
390 void _gdk_screen_close (GdkScreen *screen);
392 const char *_gdk_get_sm_client_id (void);
394 void _gdk_gc_init (GdkGC *gc,
395 GdkDrawable *drawable,
397 GdkGCValuesMask values_mask);
399 GdkRegion *_gdk_gc_get_clip_region (GdkGC *gc);
400 gboolean _gdk_gc_get_exposures (GdkGC *gc);
401 GdkFill _gdk_gc_get_fill (GdkGC *gc);
402 GdkPixmap *_gdk_gc_get_tile (GdkGC *gc);
403 GdkBitmap *_gdk_gc_get_stipple (GdkGC *gc);
404 guint32 _gdk_gc_get_fg_pixel (GdkGC *gc);
405 guint32 _gdk_gc_get_bg_pixel (GdkGC *gc);
406 void _gdk_gc_add_drawable_clip (GdkGC *gc,
411 void _gdk_gc_remove_drawable_clip (GdkGC *gc);
412 void _gdk_gc_set_clip_region_internal (GdkGC *gc,
414 gboolean reset_origin);
415 GdkSubwindowMode _gdk_gc_get_subwindow (GdkGC *gc);
417 /*****************************************
418 * Interfaces provided by windowing code *
419 *****************************************/
421 /* Font/string functions implemented in module-specific code */
422 gint _gdk_font_strlen (GdkFont *font, const char *str);
423 void _gdk_font_destroy (GdkFont *font);
425 void _gdk_colormap_real_destroy (GdkColormap *colormap);
427 void _gdk_cursor_destroy (GdkCursor *cursor);
429 void _gdk_windowing_init (void);
431 extern const GOptionEntry _gdk_windowing_args[];
432 void _gdk_windowing_set_default_display (GdkDisplay *display);
434 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
437 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
438 void _gdk_windowing_window_get_offsets (GdkWindow *window,
441 GdkRegion *_gdk_windowing_window_get_shape (GdkWindow *window);
442 GdkRegion *_gdk_windowing_window_get_input_shape(GdkWindow *window);
443 GdkRegion *_gdk_windowing_get_shape_for_mask (GdkBitmap *mask);
446 void _gdk_windowing_get_pointer (GdkDisplay *display,
450 GdkModifierType *mask);
451 GdkWindow* _gdk_windowing_window_at_pointer (GdkDisplay *display,
454 GdkModifierType *mask);
455 void _gdk_windowing_got_event (GdkDisplay *display,
460 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
461 GdkRegion *expose_region);
462 void _gdk_windowing_before_process_all_updates (void);
463 void _gdk_windowing_after_process_all_updates (void);
465 /* Return the number of bits-per-pixel for images of the specified depth. */
466 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
470 #define GDK_WINDOW_IS_MAPPED(window) ((((GdkWindowObject*)window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
473 /* Called when gdk_window_destroy() is called on a foreign window
474 * or an ancestor of the foreign window. It should generally reparent
475 * the window out of it's current heirarchy, hide it, and then
476 * send a message to the owner requesting that the window be destroyed.
478 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
480 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
481 const gchar *sm_client_id);
483 void _gdk_windowing_window_set_composited (GdkWindow *window,
484 gboolean composited);
486 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
487 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
488 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
489 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
491 typedef struct _GdkPaintable GdkPaintable;
492 typedef struct _GdkPaintableIface GdkPaintableIface;
494 struct _GdkPaintableIface
496 GTypeInterface g_iface;
498 void (* begin_paint_region) (GdkPaintable *paintable,
500 const GdkRegion *region);
501 void (* end_paint) (GdkPaintable *paintable);
504 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
506 /* Implementation types */
507 GType _gdk_window_impl_get_type (void) G_GNUC_CONST;
508 GType _gdk_pixmap_impl_get_type (void) G_GNUC_CONST;
512 * _gdk_windowing_gc_set_clip_region:
514 * @region: the new clip region
515 * @reset_origin: if TRUE, reset the clip_x/y_origin values to 0
517 * Do any window-system specific processing necessary
518 * for a change in clip region. Since the clip origin
519 * will likely change before the GC is used with the
520 * new clip, frequently this function will only set a flag and
521 * do the real processing later.
523 * When this function is called, _gdk_gc_get_clip_region
524 * will already return the new region.
526 void _gdk_windowing_gc_set_clip_region (GdkGC *gc,
527 const GdkRegion *region,
528 gboolean reset_origin);
531 * _gdk_windowing_gc_copy:
532 * @dst_gc: a #GdkGC from the GDK backend
533 * @src_gc: a #GdkGC from the GDK backend
535 * Copies backend specific state from @src_gc to @dst_gc.
536 * This is called before the generic state is copied, so
537 * the old generic state is still available from @dst_gc
539 void _gdk_windowing_gc_copy (GdkGC *dst_gc,
542 /* Queries the current foreground color of a GdkGC */
543 void _gdk_windowing_gc_get_foreground (GdkGC *gc,
545 /* Queries the current background color of a GdkGC */
546 void _gdk_windowing_gc_get_background (GdkGC *gc,
549 struct GdkAppLaunchContextPrivate
559 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
562 void _gdk_windowing_launch_failed (GAppLaunchContext *context,
563 const char *startup_notify_id);
565 GdkPointerGrabInfo *_gdk_display_get_active_pointer_grab (GdkDisplay *display);
566 void _gdk_display_pointer_grab_update (GdkDisplay *display,
567 gulong current_serial);
568 GdkPointerGrabInfo *_gdk_display_get_last_pointer_grab (GdkDisplay *display);
569 GdkPointerGrabInfo *_gdk_display_add_pointer_grab (GdkDisplay *display,
571 GdkWindow *native_window,
572 gboolean owner_events,
573 GdkEventMask event_mask,
574 unsigned long serial_start,
577 GdkPointerGrabInfo * _gdk_display_has_pointer_grab (GdkDisplay *display,
579 gboolean _gdk_display_end_pointer_grab (GdkDisplay *display,
583 void _gdk_display_set_has_keyboard_grab (GdkDisplay *display,
585 GdkWindow *native_window,
586 gboolean owner_events,
587 unsigned long serial,
589 void _gdk_display_unset_has_keyboard_grab (GdkDisplay *display,
591 void _gdk_display_enable_motion_hints (GdkDisplay *display);
594 void _gdk_window_invalidate_for_expose (GdkWindow *window,
595 const GdkRegion *region);
597 void _gdk_windowing_set_cairo_surface_size (cairo_surface_t *surface,
601 cairo_surface_t * _gdk_windowing_create_cairo_surface (GdkDrawable *drawable,
604 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
606 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
611 void _gdk_window_add_damage (GdkWindow *toplevel,
612 GdkRegion *damaged_region);
614 GdkEvent * _gdk_make_event (GdkWindow *window,
616 GdkEvent *event_in_queue,
617 gboolean before_event);
619 void _gdk_syntesize_crossing_events (GdkDisplay *display,
622 GdkCrossingMode mode,
625 GdkModifierType mask,
627 GdkEvent *event_in_queue,
629 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
633 void _gdk_syntesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
635 GdkRegion *_gdk_window_calculate_full_clip_region (GdkWindow *window,
636 GdkWindow *base_window,
637 gboolean do_children,
639 gint *base_y_offset);
640 gboolean _gdk_window_has_impl (GdkWindow *window);
641 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
642 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
643 GdkEventType event_type,
646 GdkRegion *_gdk_region_new_from_yxbanded_rects (GdkRectangle *rects, int n_rects);
648 /*****************************
649 * offscreen window routines *
650 *****************************/
651 GType gdk_offscreen_window_get_type (void);
652 void _gdk_offscreen_window_new (GdkWindow *window,
655 GdkWindowAttr *attributes,
656 gint attributes_mask);
659 /************************************
660 * Initialization and exit routines *
661 ************************************/
663 void _gdk_image_exit (void);
664 void _gdk_windowing_exit (void);
668 #endif /* __GDK_INTERNALS_H__ */