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_PIXMAP = 1 << 6,
81 GDK_DEBUG_INPUT = 1 << 7,
82 GDK_DEBUG_CURSOR = 1 << 8,
83 GDK_DEBUG_MULTIHEAD = 1 << 9,
84 GDK_DEBUG_XINERAMA = 1 <<10,
85 GDK_DEBUG_DRAW = 1 <<11,
86 GDK_DEBUG_EVENTLOOP = 1 <<12
89 extern GList *_gdk_default_filters;
90 extern GdkWindow *_gdk_parent_root;
92 extern guint _gdk_debug_flags;
93 extern gboolean _gdk_native_windows;
97 #define GDK_NOTE(type,action) G_STMT_START { \
98 if (_gdk_debug_flags & GDK_DEBUG_##type) \
99 { action; }; } G_STMT_END
101 #else /* !G_ENABLE_DEBUG */
103 #define GDK_NOTE(type,action)
105 #endif /* G_ENABLE_DEBUG */
118 typedef struct _GdkArgContext GdkArgContext;
119 typedef struct _GdkArgDesc GdkArgDesc;
121 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
123 struct _GdkArgContext
139 typedef struct _GdkEventPrivate GdkEventPrivate;
143 /* Following flag is set for events on the event queue during
144 * translation and cleared afterwards.
146 GDK_EVENT_PENDING = 1 << 0
149 struct _GdkEventPrivate
154 gpointer windowing_data;
158 /* Tracks information about the pointer grab on this display */
162 GdkWindow *native_window;
164 gulong serial_end; /* exclusive, i.e. not active on serial_end */
165 gboolean owner_events;
169 GdkGrabOwnership ownership;
172 guint implicit_ungrab : 1;
175 typedef struct _GdkInputWindow GdkInputWindow;
177 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay *display,
179 GdkPointerWindowInfo *device_info,
182 /* Private version of GdkWindowObject. The initial part of this strucuture
183 is public for historical reasons. Don't change that part */
184 typedef struct _GdkWindowPaint GdkWindowPaint;
186 #define GDK_WINDOW_OBJECT(object) ((GdkWindowObject *) GDK_WINDOW (object))
188 struct _GdkWindowObject
190 GdkDrawable parent_instance;
192 GdkDrawable *impl; /* window-system-specific delegate object */
194 GdkWindowObject *parent;
201 gint extension_events;
207 GdkPixmap *bg_pixmap;
208 cairo_pattern_t *background;
212 cairo_region_t *update_area;
213 guint update_freeze_count;
219 GdkWindowState state;
221 guint guffaw_gravity : 1;
222 guint input_only : 1;
223 guint modal_hint : 1;
224 guint composited : 1;
228 guint accept_focus : 1;
229 guint focus_on_map : 1;
231 guint support_multidevice : 1;
233 GdkEventMask event_mask;
235 guint update_and_descendants_freeze_count;
237 GdkWindowRedirect *redirect;
239 /* The GdkWindowObject that has the impl, ref:ed if another window.
240 * This ref is required to keep the wrapper of the impl window alive
241 * for as long as any GdkWindow references the impl. */
242 GdkWindowObject *impl_window;
243 int abs_x, abs_y; /* Absolute offset in impl */
246 cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
247 cairo_region_t *clip_region_with_children; /* Clip region in window coords */
249 GHashTable *device_cursor;
250 gint8 toplevel_window_type;
251 guint synthesize_crossing_event_queued : 1;
252 guint effective_visibility : 2;
253 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
254 guint native_visibility : 2; /* the native visibility of a impl windows */
255 guint viewable : 1; /* mapped and all parents mapped */
256 guint applied_shape : 1;
258 guint num_offscreen_children;
259 GdkWindowPaint *implicit_paint;
260 GdkInputWindow *input_window; /* only set for impl windows */
262 GList *outstanding_moves;
264 cairo_region_t *shape;
265 cairo_region_t *input_shape;
267 cairo_surface_t *cairo_surface;
268 guint outstanding_surfaces; /* only set on impl window */
270 GList *devices_inside;
271 GHashTable *device_events;
274 #define GDK_WINDOW_TYPE(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->window_type)
275 #define GDK_WINDOW_DESTROYED(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->destroyed)
277 extern GdkEventFunc _gdk_event_func; /* Callback for events */
278 extern gpointer _gdk_event_data;
279 extern GDestroyNotify _gdk_event_notify;
281 extern GSList *_gdk_displays;
282 extern gchar *_gdk_display_name;
283 extern gint _gdk_screen_number;
284 extern gchar *_gdk_display_arg_name;
285 extern gboolean _gdk_enable_multidevice;
287 void _gdk_events_queue (GdkDisplay *display);
288 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
290 GList* _gdk_event_queue_find_first (GdkDisplay *display);
291 void _gdk_event_queue_remove_link (GdkDisplay *display,
293 GList* _gdk_event_queue_prepend (GdkDisplay *display,
295 GList* _gdk_event_queue_append (GdkDisplay *display,
297 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
298 GdkEvent *after_event,
300 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
301 GdkEvent *after_event,
303 void _gdk_event_button_generate (GdkDisplay *display,
306 void _gdk_windowing_event_data_copy (const GdkEvent *src,
308 void _gdk_windowing_event_data_free (GdkEvent *event);
310 void gdk_synthesize_window_state (GdkWindow *window,
311 GdkWindowState unset_flags,
312 GdkWindowState set_flags);
314 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
316 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
317 GdkRectangle *extents);
319 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
321 GdkDrawable *_gdk_drawable_get_source_drawable (GdkDrawable *drawable);
322 cairo_surface_t * _gdk_drawable_create_cairo_surface (GdkDrawable *drawable,
326 /*************************************
327 * Interfaces used by windowing code *
328 *************************************/
330 GdkPixmap *_gdk_pixmap_new (GdkDrawable *drawable,
335 void _gdk_window_impl_new (GdkWindow *window,
336 GdkWindow *real_parent,
339 GdkEventMask event_mask,
340 GdkWindowAttr *attributes,
341 gint attributes_mask);
342 void _gdk_window_destroy (GdkWindow *window,
343 gboolean foreign_destroy);
344 void _gdk_window_clear_update_area (GdkWindow *window);
345 void _gdk_window_update_size (GdkWindow *window);
346 gboolean _gdk_window_update_viewable (GdkWindow *window);
348 void _gdk_window_process_updates_recurse (GdkWindow *window,
349 cairo_region_t *expose_region);
351 void _gdk_screen_close (GdkScreen *screen);
353 const char *_gdk_get_sm_client_id (void);
355 /*****************************************
356 * Interfaces provided by windowing code *
357 *****************************************/
359 /* Font/string functions implemented in module-specific code */
361 void _gdk_colormap_real_destroy (GdkColormap *colormap);
363 void _gdk_cursor_destroy (GdkCursor *cursor);
365 void _gdk_windowing_init (void);
367 extern const GOptionEntry _gdk_windowing_args[];
368 void _gdk_windowing_set_default_display (GdkDisplay *display);
370 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
373 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
374 void _gdk_windowing_window_get_offsets (GdkWindow *window,
377 cairo_region_t *_gdk_windowing_window_get_shape (GdkWindow *window);
378 cairo_region_t *_gdk_windowing_window_get_input_shape(GdkWindow *window);
379 void _gdk_windowing_window_beep (GdkWindow *window);
382 void _gdk_windowing_get_device_state (GdkDisplay *display,
387 GdkModifierType *mask);
388 GdkWindow* _gdk_windowing_window_at_device_position (GdkDisplay *display,
392 GdkModifierType *mask,
393 gboolean get_toplevel);
394 GdkGrabStatus _gdk_windowing_device_grab (GdkDevice *device,
397 gboolean owner_events,
398 GdkEventMask event_mask,
399 GdkWindow *confine_to,
402 void _gdk_windowing_got_event (GdkDisplay *display,
407 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
408 cairo_region_t *expose_region);
409 void _gdk_windowing_before_process_all_updates (void);
410 void _gdk_windowing_after_process_all_updates (void);
412 /* Return the number of bits-per-pixel for images of the specified depth. */
413 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
417 #define GDK_WINDOW_IS_MAPPED(window) ((((GdkWindowObject*)window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
420 /* Called when gdk_window_destroy() is called on a foreign window
421 * or an ancestor of the foreign window. It should generally reparent
422 * the window out of it's current heirarchy, hide it, and then
423 * send a message to the owner requesting that the window be destroyed.
425 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
427 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
428 const gchar *sm_client_id);
430 void _gdk_windowing_window_set_composited (GdkWindow *window,
431 gboolean composited);
433 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
434 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
435 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
436 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
438 typedef struct _GdkPaintable GdkPaintable;
439 typedef struct _GdkPaintableIface GdkPaintableIface;
441 struct _GdkPaintableIface
443 GTypeInterface g_iface;
445 void (* begin_paint_region) (GdkPaintable *paintable,
447 const cairo_region_t *region);
448 void (* end_paint) (GdkPaintable *paintable);
451 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
453 /* Implementation types */
454 GType _gdk_window_impl_get_type (void) G_GNUC_CONST;
455 GType _gdk_pixmap_impl_get_type (void) G_GNUC_CONST;
457 struct GdkAppLaunchContextPrivate
467 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
470 void _gdk_windowing_launch_failed (GAppLaunchContext *context,
471 const char *startup_notify_id);
473 void _gdk_display_device_grab_update (GdkDisplay *display,
475 gulong current_serial);
476 GdkDeviceGrabInfo *_gdk_display_get_last_device_grab (GdkDisplay *display,
478 GdkDeviceGrabInfo *_gdk_display_add_device_grab (GdkDisplay *display,
481 GdkWindow *native_window,
482 GdkGrabOwnership grab_ownership,
483 gboolean owner_events,
484 GdkEventMask event_mask,
485 unsigned long serial_start,
488 GdkDeviceGrabInfo * _gdk_display_has_device_grab (GdkDisplay *display,
491 gboolean _gdk_display_end_device_grab (GdkDisplay *display,
496 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
499 void _gdk_display_enable_motion_hints (GdkDisplay *display,
502 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
505 void _gdk_display_pointer_info_foreach (GdkDisplay *display,
506 GdkDisplayPointerInfoForeach func,
509 void _gdk_window_invalidate_for_expose (GdkWindow *window,
510 cairo_region_t *region);
512 gboolean _gdk_windowing_set_cairo_surface_size (cairo_surface_t *surface,
516 cairo_surface_t * _gdk_windowing_create_cairo_surface (GdkDrawable *drawable,
519 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
521 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
526 void _gdk_window_add_damage (GdkWindow *toplevel,
527 cairo_region_t *damaged_region);
529 GdkEvent * _gdk_make_event (GdkWindow *window,
531 GdkEvent *event_in_queue,
532 gboolean before_event);
533 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
536 void _gdk_synthesize_crossing_events (GdkDisplay *display,
540 GdkCrossingMode mode,
543 GdkModifierType mask,
545 GdkEvent *event_in_queue,
547 gboolean non_linear);
548 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
553 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
555 cairo_region_t *_gdk_window_calculate_full_clip_region (GdkWindow *window,
556 GdkWindow *base_window,
557 gboolean do_children,
559 gint *base_y_offset);
560 gboolean _gdk_window_has_impl (GdkWindow *window);
561 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
562 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
563 GdkEventType event_type,
567 /*****************************
568 * offscreen window routines *
569 *****************************/
570 GType gdk_offscreen_window_get_type (void);
571 void _gdk_offscreen_window_new (GdkWindow *window,
574 GdkWindowAttr *attributes,
575 gint attributes_mask);
578 /************************************
579 * Initialization and exit routines *
580 ************************************/
582 void _gdk_windowing_exit (void);
586 #endif /* __GDK_INTERNALS_H__ */