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/gdkwindowimpl.h>
36 #include <gdk/gdkprivate.h>
40 /**********************
41 * General Facilities *
42 **********************/
44 /* Debugging support */
46 typedef struct _GdkColorInfo GdkColorInfo;
47 typedef struct _GdkEventFilter GdkEventFilter;
48 typedef struct _GdkClientFilter GdkClientFilter;
51 GDK_COLOR_WRITEABLE = 1 << 0
56 GdkColorInfoFlags flags;
61 GDK_EVENT_FILTER_REMOVED = 1 << 0
62 } GdkEventFilterFlags;
64 struct _GdkEventFilter {
65 GdkFilterFunc function;
67 GdkEventFilterFlags flags;
71 struct _GdkClientFilter {
73 GdkFilterFunc function;
78 GDK_DEBUG_MISC = 1 << 0,
79 GDK_DEBUG_EVENTS = 1 << 1,
80 GDK_DEBUG_DND = 1 << 2,
81 GDK_DEBUG_XIM = 1 << 3,
82 GDK_DEBUG_NOGRABS = 1 << 4,
83 GDK_DEBUG_COLORMAP = 1 << 5,
84 GDK_DEBUG_INPUT = 1 << 6,
85 GDK_DEBUG_CURSOR = 1 << 7,
86 GDK_DEBUG_MULTIHEAD = 1 << 8,
87 GDK_DEBUG_XINERAMA = 1 << 9,
88 GDK_DEBUG_DRAW = 1 <<10,
89 GDK_DEBUG_EVENTLOOP = 1 <<11
92 extern GList *_gdk_default_filters;
93 extern GdkWindow *_gdk_parent_root;
95 extern guint _gdk_debug_flags;
96 extern gboolean _gdk_native_windows;
100 #define GDK_NOTE(type,action) G_STMT_START { \
101 if (_gdk_debug_flags & GDK_DEBUG_##type) \
102 { action; }; } G_STMT_END
104 #else /* !G_ENABLE_DEBUG */
106 #define GDK_NOTE(type,action)
108 #endif /* G_ENABLE_DEBUG */
121 typedef struct _GdkArgContext GdkArgContext;
122 typedef struct _GdkArgDesc GdkArgDesc;
124 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
126 struct _GdkArgContext
142 typedef struct _GdkEventPrivate GdkEventPrivate;
146 /* Following flag is set for events on the event queue during
147 * translation and cleared afterwards.
149 GDK_EVENT_PENDING = 1 << 0
152 struct _GdkEventPrivate
157 gpointer windowing_data;
159 GdkDevice *source_device;
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 _GdkWindowPaint GdkWindowPaint;
181 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay *display,
183 GdkPointerWindowInfo *device_info,
188 GObject parent_instance;
190 GdkWindowImpl *impl; /* window-system-specific delegate object */
200 gint extension_events;
205 cairo_pattern_t *background;
209 cairo_region_t *update_area;
210 guint update_freeze_count;
216 GdkWindowState state;
218 guint guffaw_gravity : 1;
219 guint input_only : 1;
220 guint modal_hint : 1;
221 guint composited : 1;
225 guint accept_focus : 1;
226 guint focus_on_map : 1;
228 guint support_multidevice : 1;
230 GdkEventMask event_mask;
232 guint update_and_descendants_freeze_count;
234 /* The GdkWindow that has the impl, ref:ed if another window.
235 * This ref is required to keep the wrapper of the impl window alive
236 * for as long as any GdkWindow references the impl. */
237 GdkWindow *impl_window;
238 int abs_x, abs_y; /* Absolute offset in impl */
241 cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
242 cairo_region_t *clip_region_with_children; /* Clip region in window coords */
244 GHashTable *device_cursor;
245 gint8 toplevel_window_type;
246 guint synthesize_crossing_event_queued : 1;
247 guint effective_visibility : 2;
248 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
249 guint native_visibility : 2; /* the native visibility of a impl windows */
250 guint viewable : 1; /* mapped and all parents mapped */
251 guint applied_shape : 1;
253 guint num_offscreen_children;
254 GdkWindowPaint *implicit_paint;
256 GList *outstanding_moves;
258 cairo_region_t *shape;
259 cairo_region_t *input_shape;
261 cairo_surface_t *cairo_surface;
263 GList *devices_inside;
264 GHashTable *device_events;
266 GHashTable *source_event_masks;
267 gulong device_added_handler_id;
268 gulong device_changed_handler_id;
271 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
272 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
274 struct _GdkDisplayClass
276 GObjectClass parent_class;
278 G_CONST_RETURN gchar * (*get_name) (GdkDisplay *display);
279 gint (*get_n_screens) (GdkDisplay *display);
280 GdkScreen * (*get_screen) (GdkDisplay *display,
282 GdkScreen * (*get_default_screen) (GdkDisplay *display);
283 void (*beep) (GdkDisplay *display);
284 void (*sync) (GdkDisplay *display);
285 void (*flush) (GdkDisplay *display);
286 GdkWindow * (*get_default_group) (GdkDisplay *display);
287 gboolean (*supports_selection_notification) (GdkDisplay *display);
288 gboolean (*request_selection_notification) (GdkDisplay *display,
290 gboolean (*supports_clipboard_persistence) (GdkDisplay *display);
291 void (*store_clipboard) (GdkDisplay *display,
292 GdkWindow *clipboard_window,
294 const GdkAtom *targets,
296 gboolean (*supports_shapes) (GdkDisplay *display);
297 gboolean (*supports_input_shapes) (GdkDisplay *display);
298 gboolean (*supports_composite) (GdkDisplay *display);
299 GList * (*list_devices) (GdkDisplay *display);
300 gboolean (*send_client_message) (GdkDisplay *display,
302 GdkNativeWindow winid);
303 void (*add_client_message_filter) (GdkDisplay *display,
304 GdkAtom message_type,
307 GdkAppLaunchContext * (*get_app_launch_context) (GdkDisplay *display);
308 GdkNativeWindow (*get_drag_protocol) (GdkDisplay *display,
309 GdkNativeWindow winid,
310 GdkDragProtocol *protocol,
315 void (*closed) (GdkDisplay *display,
319 struct _GdkKeymapClass
321 GObjectClass parent_class;
323 PangoDirection (* get_direction) (GdkKeymap *keymap);
324 gboolean (* have_bidi_layouts) (GdkKeymap *keymap);
325 gboolean (* get_caps_lock_state) (GdkKeymap *keymap);
326 gboolean (* get_num_lock_state) (GdkKeymap *keymap);
327 gboolean (* get_entries_for_keyval) (GdkKeymap *keymap,
331 gboolean (* get_entries_for_keycode) (GdkKeymap *keymap,
332 guint hardware_keycode,
336 guint (* lookup_key) (GdkKeymap *keymap,
337 const GdkKeymapKey *key);
338 gboolean (* translate_keyboard_state) (GdkKeymap *keymap,
339 guint hardware_keycode,
340 GdkModifierType state,
343 gint *effective_group,
345 GdkModifierType *consumed_modifiers);
346 void (* add_virtual_modifiers) (GdkKeymap *keymap,
347 GdkModifierType *state);
348 gboolean (* map_virtual_modifiers) (GdkKeymap *keymap,
349 GdkModifierType *state);
353 void (*direction_changed) (GdkKeymap *keymap);
354 void (*keys_changed) (GdkKeymap *keymap);
355 void (*state_changed) (GdkKeymap *keymap);
358 struct _GdkScreenClass
360 GObjectClass parent_class;
362 GdkDisplay * (* get_display) (GdkScreen *screen);
363 gint (* get_width) (GdkScreen *screen);
364 gint (* get_height) (GdkScreen *screen);
365 gint (* get_width_mm) (GdkScreen *screen);
366 gint (* get_height_mm) (GdkScreen *screen);
367 gint (* get_number) (GdkScreen *screen);
368 GdkWindow * (* get_root_window) (GdkScreen *screen);
369 gint (* get_n_monitors) (GdkScreen *screen);
370 gint (* get_primary_monitor) (GdkScreen *screen);
371 gint (* get_monitor_width_mm) (GdkScreen *screen,
373 gint (* get_monitor_height_mm) (GdkScreen *screen,
375 gchar * (* get_monitor_plug_name) (GdkScreen *screen,
377 void (* get_monitor_geometry) (GdkScreen *screen,
380 GList * (* list_visuals) (GdkScreen *screen);
381 GdkVisual * (* get_system_visual) (GdkScreen *screen);
382 GdkVisual * (* get_rgba_visual) (GdkScreen *screen);
383 gboolean (* is_composited) (GdkScreen *screen);
384 gchar * (* make_display_name) (GdkScreen *screen);
385 GdkWindow * (* get_active_window) (GdkScreen *screen);
386 GList * (* get_window_stack) (GdkScreen *screen);
387 void (* broadcast_client_message) (GdkScreen *screen,
389 gboolean (* get_setting) (GdkScreen *screen,
392 gint (* visual_get_best_depth) (GdkScreen *screen);
393 GdkVisualType (* visual_get_best_type) (GdkScreen *screen);
394 GdkVisual * (* visual_get_best) (GdkScreen *screen);
395 GdkVisual * (* visual_get_best_with_depth) (GdkScreen *screen,
397 GdkVisual * (* visual_get_best_with_type) (GdkScreen *screen,
398 GdkVisualType visual_type);
399 GdkVisual * (* visual_get_best_with_both) (GdkScreen *screen,
401 GdkVisualType visual_type);
402 void (* query_depths) (GdkScreen *screen,
405 void (* query_visual_types) (GdkScreen *screen,
406 GdkVisualType **visual_types,
411 void (*size_changed) (GdkScreen *screen);
412 void (*composited_changed) (GdkScreen *screen);
413 void (*monitors_changed) (GdkScreen *screen);
416 struct _GdkDragContextClass {
417 GObjectClass parent_class;
419 GdkWindow * (*find_window) (GdkDragContext *context,
420 GdkWindow *drag_window,
424 GdkDragProtocol *protocol);
425 GdkAtom (*get_selection) (GdkDragContext *context);
426 gboolean (*drag_motion) (GdkDragContext *context,
427 GdkWindow *dest_window,
428 GdkDragProtocol protocol,
431 GdkDragAction suggested_action,
432 GdkDragAction possible_actions,
434 void (*drag_status) (GdkDragContext *context,
435 GdkDragAction action,
437 void (*drag_abort) (GdkDragContext *context,
439 void (*drag_drop) (GdkDragContext *context,
441 void (*drop_reply) (GdkDragContext *context,
444 void (*drop_finish) (GdkDragContext *context,
447 gboolean (*drop_status) (GdkDragContext *context);
450 struct _GdkDragContext {
451 GObject parent_instance;
453 GdkDragProtocol protocol;
456 GdkWindow *source_window;
457 GdkWindow *dest_window;
460 GdkDragAction actions;
461 GdkDragAction suggested_action;
462 GdkDragAction action;
471 GObject parent_instance;
475 GdkByteOrder byte_order;
494 struct _GdkVisualClass
496 GObjectClass parent_class;
499 struct _GdkDeviceManager
501 GObject parent_instance;
506 struct _GdkDeviceManagerClass
508 GObjectClass parent_class;
511 void (* device_added) (GdkDeviceManager *device_manager,
513 void (* device_removed) (GdkDeviceManager *device_manager,
515 void (* device_changed) (GdkDeviceManager *device_manager,
519 GList * (* list_devices) (GdkDeviceManager *device_manager,
521 GdkDevice * (* get_client_pointer) (GdkDeviceManager *device_manager);
524 extern GSList *_gdk_displays;
525 extern gchar *_gdk_display_name;
526 extern gint _gdk_screen_number;
527 extern gchar *_gdk_display_arg_name;
528 extern gboolean _gdk_disable_multidevice;
530 void _gdk_events_queue (GdkDisplay *display);
531 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
533 void _gdk_event_filter_unref (GdkWindow *window,
534 GdkEventFilter *filter);
536 void _gdk_event_emit (GdkEvent *event);
537 GList* _gdk_event_queue_find_first (GdkDisplay *display);
538 void _gdk_event_queue_remove_link (GdkDisplay *display,
540 GList* _gdk_event_queue_prepend (GdkDisplay *display,
542 GList* _gdk_event_queue_append (GdkDisplay *display,
544 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
545 GdkEvent *after_event,
547 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
548 GdkEvent *after_event,
550 void _gdk_event_button_generate (GdkDisplay *display,
553 void _gdk_windowing_event_data_copy (const GdkEvent *src,
555 void _gdk_windowing_event_data_free (GdkEvent *event);
557 void gdk_synthesize_window_state (GdkWindow *window,
558 GdkWindowState unset_flags,
559 GdkWindowState set_flags);
561 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
563 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
564 GdkRectangle *extents);
566 /*************************************
567 * Interfaces used by windowing code *
568 *************************************/
571 _gdk_window_ref_cairo_surface (GdkWindow *window);
573 void _gdk_window_impl_new (GdkWindow *window,
574 GdkWindow *real_parent,
576 GdkEventMask event_mask,
577 GdkWindowAttr *attributes,
578 gint attributes_mask);
579 void _gdk_window_destroy (GdkWindow *window,
580 gboolean foreign_destroy);
581 void _gdk_window_clear_update_area (GdkWindow *window);
582 void _gdk_window_update_size (GdkWindow *window);
583 gboolean _gdk_window_update_viewable (GdkWindow *window);
585 void _gdk_window_process_updates_recurse (GdkWindow *window,
586 cairo_region_t *expose_region);
588 void _gdk_screen_close (GdkScreen *screen);
590 const char *_gdk_get_sm_client_id (void);
592 /*****************************************
593 * Interfaces provided by windowing code *
594 *****************************************/
596 /* Font/string functions implemented in module-specific code */
598 void _gdk_cursor_destroy (GdkCursor *cursor);
600 void _gdk_windowing_init (void);
602 extern const GOptionEntry _gdk_windowing_args[];
603 void _gdk_windowing_set_default_display (GdkDisplay *display);
605 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
608 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
609 void _gdk_windowing_window_get_offsets (GdkWindow *window,
614 void _gdk_windowing_get_device_state (GdkDisplay *display,
619 GdkModifierType *mask);
620 GdkWindow* _gdk_windowing_window_at_device_position (GdkDisplay *display,
624 GdkModifierType *mask,
625 gboolean get_toplevel);
626 GdkGrabStatus _gdk_windowing_device_grab (GdkDevice *device,
629 gboolean owner_events,
630 GdkEventMask event_mask,
631 GdkWindow *confine_to,
634 void _gdk_windowing_got_event (GdkDisplay *display,
639 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
640 cairo_region_t *expose_region);
641 void _gdk_windowing_before_process_all_updates (void);
642 void _gdk_windowing_after_process_all_updates (void);
645 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
648 /* Called when gdk_window_destroy() is called on a foreign window
649 * or an ancestor of the foreign window. It should generally reparent
650 * the window out of it's current heirarchy, hide it, and then
651 * send a message to the owner requesting that the window be destroyed.
653 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
655 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
656 const gchar *sm_client_id);
658 void _gdk_windowing_window_set_composited (GdkWindow *window,
659 gboolean composited);
661 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
662 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
663 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
664 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
666 typedef struct _GdkPaintable GdkPaintable;
667 typedef struct _GdkPaintableIface GdkPaintableIface;
669 struct _GdkPaintableIface
671 GTypeInterface g_iface;
673 void (* begin_paint_region) (GdkPaintable *paintable,
675 const cairo_region_t *region);
676 void (* end_paint) (GdkPaintable *paintable);
679 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
681 struct GdkAppLaunchContextPrivate
691 void _gdk_display_device_grab_update (GdkDisplay *display,
693 GdkDevice *source_device,
694 gulong current_serial);
695 GdkDeviceGrabInfo *_gdk_display_get_last_device_grab (GdkDisplay *display,
697 GdkDeviceGrabInfo *_gdk_display_add_device_grab (GdkDisplay *display,
700 GdkWindow *native_window,
701 GdkGrabOwnership grab_ownership,
702 gboolean owner_events,
703 GdkEventMask event_mask,
704 unsigned long serial_start,
707 GdkDeviceGrabInfo * _gdk_display_has_device_grab (GdkDisplay *display,
710 gboolean _gdk_display_end_device_grab (GdkDisplay *display,
715 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
718 void _gdk_display_enable_motion_hints (GdkDisplay *display,
721 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
724 void _gdk_display_pointer_info_foreach (GdkDisplay *display,
725 GdkDisplayPointerInfoForeach func,
728 void _gdk_window_invalidate_for_expose (GdkWindow *window,
729 cairo_region_t *region);
731 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
733 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
738 void _gdk_window_add_damage (GdkWindow *toplevel,
739 cairo_region_t *damaged_region);
741 GdkEvent * _gdk_make_event (GdkWindow *window,
743 GdkEvent *event_in_queue,
744 gboolean before_event);
745 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
748 void _gdk_synthesize_crossing_events (GdkDisplay *display,
752 GdkDevice *source_device,
753 GdkCrossingMode mode,
756 GdkModifierType mask,
758 GdkEvent *event_in_queue,
760 gboolean non_linear);
761 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
766 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
768 cairo_region_t *_gdk_window_calculate_full_clip_region (GdkWindow *window,
769 GdkWindow *base_window,
770 gboolean do_children,
772 gint *base_y_offset);
773 gboolean _gdk_window_has_impl (GdkWindow *window);
774 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
776 /*****************************
777 * offscreen window routines *
778 *****************************/
779 GType gdk_offscreen_window_get_type (void);
780 void _gdk_offscreen_window_new (GdkWindow *window,
781 GdkWindowAttr *attributes,
782 gint attributes_mask);
783 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
788 /************************************
789 * Initialization and exit routines *
790 ************************************/
792 void _gdk_windowing_exit (void);
796 #endif /* __GDK_INTERNALS_H__ */