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/gdkwindowimpl.h>
34 #include <gdk/gdkprivate.h>
38 /**********************
39 * General Facilities *
40 **********************/
42 /* Debugging support */
44 typedef struct _GdkColorInfo GdkColorInfo;
45 typedef struct _GdkEventFilter GdkEventFilter;
46 typedef struct _GdkClientFilter GdkClientFilter;
49 GDK_COLOR_WRITEABLE = 1 << 0
54 GdkColorInfoFlags flags;
59 GDK_EVENT_FILTER_REMOVED = 1 << 0
60 } GdkEventFilterFlags;
62 struct _GdkEventFilter {
63 GdkFilterFunc function;
65 GdkEventFilterFlags flags;
69 struct _GdkClientFilter {
71 GdkFilterFunc function;
76 GDK_DEBUG_MISC = 1 << 0,
77 GDK_DEBUG_EVENTS = 1 << 1,
78 GDK_DEBUG_DND = 1 << 2,
79 GDK_DEBUG_XIM = 1 << 3,
80 GDK_DEBUG_NOGRABS = 1 << 4,
81 GDK_DEBUG_COLORMAP = 1 << 5,
82 GDK_DEBUG_INPUT = 1 << 6,
83 GDK_DEBUG_CURSOR = 1 << 7,
84 GDK_DEBUG_MULTIHEAD = 1 << 8,
85 GDK_DEBUG_XINERAMA = 1 << 9,
86 GDK_DEBUG_DRAW = 1 <<10,
87 GDK_DEBUG_EVENTLOOP = 1 <<11
90 extern GList *_gdk_default_filters;
91 extern GdkWindow *_gdk_parent_root;
93 extern guint _gdk_debug_flags;
94 extern gboolean _gdk_native_windows;
98 #define GDK_NOTE(type,action) G_STMT_START { \
99 if (_gdk_debug_flags & GDK_DEBUG_##type) \
100 { action; }; } G_STMT_END
102 #else /* !G_ENABLE_DEBUG */
104 #define GDK_NOTE(type,action)
106 #endif /* G_ENABLE_DEBUG */
119 typedef struct _GdkArgContext GdkArgContext;
120 typedef struct _GdkArgDesc GdkArgDesc;
122 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
124 struct _GdkArgContext
140 typedef struct _GdkEventPrivate GdkEventPrivate;
144 /* Following flag is set for events on the event queue during
145 * translation and cleared afterwards.
147 GDK_EVENT_PENDING = 1 << 0
150 struct _GdkEventPrivate
155 gpointer windowing_data;
157 GdkDevice *source_device;
160 /* Tracks information about the pointer grab on this display */
164 GdkWindow *native_window;
166 gulong serial_end; /* exclusive, i.e. not active on serial_end */
167 gboolean owner_events;
171 GdkGrabOwnership ownership;
174 guint implicit_ungrab : 1;
177 typedef struct _GdkWindowPaint GdkWindowPaint;
179 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay *display,
181 GdkPointerWindowInfo *device_info,
186 GObject parent_instance;
188 GdkWindowImpl *impl; /* window-system-specific delegate object */
198 gint extension_events;
203 cairo_pattern_t *background;
207 cairo_region_t *update_area;
208 guint update_freeze_count;
214 GdkWindowState state;
216 guint guffaw_gravity : 1;
217 guint input_only : 1;
218 guint modal_hint : 1;
219 guint composited : 1;
223 guint accept_focus : 1;
224 guint focus_on_map : 1;
226 guint support_multidevice : 1;
228 GdkEventMask event_mask;
230 guint update_and_descendants_freeze_count;
232 /* The GdkWindow that has the impl, ref:ed if another window.
233 * This ref is required to keep the wrapper of the impl window alive
234 * for as long as any GdkWindow references the impl. */
235 GdkWindow *impl_window;
236 int abs_x, abs_y; /* Absolute offset in impl */
239 cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
240 cairo_region_t *clip_region_with_children; /* Clip region in window coords */
242 GHashTable *device_cursor;
243 gint8 toplevel_window_type;
244 guint synthesize_crossing_event_queued : 1;
245 guint effective_visibility : 2;
246 guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
247 guint native_visibility : 2; /* the native visibility of a impl windows */
248 guint viewable : 1; /* mapped and all parents mapped */
249 guint applied_shape : 1;
251 guint num_offscreen_children;
252 GdkWindowPaint *implicit_paint;
254 GList *outstanding_moves;
256 cairo_region_t *shape;
257 cairo_region_t *input_shape;
259 cairo_surface_t *cairo_surface;
261 GList *devices_inside;
262 GHashTable *device_events;
264 GHashTable *source_event_masks;
265 gulong device_added_handler_id;
266 gulong device_changed_handler_id;
269 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
270 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
272 struct _GdkDisplayManager
274 GObject parent_instance;
277 struct _GdkDisplayManagerClass
279 GObjectClass parent_class;
281 GSList * (*list_displays) (GdkDisplayManager *manager);
282 GdkDisplay * (*get_default_display) (GdkDisplayManager *manager);
283 void (*set_default_display) (GdkDisplayManager *manager,
284 GdkDisplay *display);
285 GdkDisplay * (*open_display) (GdkDisplayManager *manager,
289 void (*display_opened) (GdkDisplayManager *manager,
290 GdkDisplay *display);
293 struct _GdkDisplayClass
295 GObjectClass parent_class;
297 G_CONST_RETURN gchar * (*get_name) (GdkDisplay *display);
298 gint (*get_n_screens) (GdkDisplay *display);
299 GdkScreen * (*get_screen) (GdkDisplay *display,
301 GdkScreen * (*get_default_screen) (GdkDisplay *display);
302 void (*beep) (GdkDisplay *display);
303 void (*sync) (GdkDisplay *display);
304 void (*flush) (GdkDisplay *display);
305 gboolean (*has_pending) (GdkDisplay *display);
306 void (*queue_events) (GdkDisplay *display);
307 GdkWindow * (*get_default_group) (GdkDisplay *display);
308 gboolean (*supports_selection_notification) (GdkDisplay *display);
309 gboolean (*request_selection_notification) (GdkDisplay *display,
311 gboolean (*supports_clipboard_persistence) (GdkDisplay *display);
312 void (*store_clipboard) (GdkDisplay *display,
313 GdkWindow *clipboard_window,
315 const GdkAtom *targets,
317 gboolean (*supports_shapes) (GdkDisplay *display);
318 gboolean (*supports_input_shapes) (GdkDisplay *display);
319 gboolean (*supports_composite) (GdkDisplay *display);
320 GList * (*list_devices) (GdkDisplay *display);
321 gboolean (*send_client_message) (GdkDisplay *display,
323 GdkNativeWindow winid);
324 void (*add_client_message_filter) (GdkDisplay *display,
325 GdkAtom message_type,
328 GdkAppLaunchContext * (*get_app_launch_context) (GdkDisplay *display);
329 GdkNativeWindow (*get_drag_protocol) (GdkDisplay *display,
330 GdkNativeWindow winid,
331 GdkDragProtocol *protocol,
336 void (*closed) (GdkDisplay *display,
341 struct _GdkKeymapClass
343 GObjectClass parent_class;
345 PangoDirection (* get_direction) (GdkKeymap *keymap);
346 gboolean (* have_bidi_layouts) (GdkKeymap *keymap);
347 gboolean (* get_caps_lock_state) (GdkKeymap *keymap);
348 gboolean (* get_num_lock_state) (GdkKeymap *keymap);
349 gboolean (* get_entries_for_keyval) (GdkKeymap *keymap,
353 gboolean (* get_entries_for_keycode) (GdkKeymap *keymap,
354 guint hardware_keycode,
358 guint (* lookup_key) (GdkKeymap *keymap,
359 const GdkKeymapKey *key);
360 gboolean (* translate_keyboard_state) (GdkKeymap *keymap,
361 guint hardware_keycode,
362 GdkModifierType state,
365 gint *effective_group,
367 GdkModifierType *consumed_modifiers);
368 void (* add_virtual_modifiers) (GdkKeymap *keymap,
369 GdkModifierType *state);
370 gboolean (* map_virtual_modifiers) (GdkKeymap *keymap,
371 GdkModifierType *state);
375 void (*direction_changed) (GdkKeymap *keymap);
376 void (*keys_changed) (GdkKeymap *keymap);
377 void (*state_changed) (GdkKeymap *keymap);
382 GObject parent_instance;
386 cairo_font_options_t *font_options;
387 double resolution; /* pixels/points scale factor for fonts */
390 struct _GdkScreenClass
392 GObjectClass parent_class;
394 GdkDisplay * (* get_display) (GdkScreen *screen);
395 gint (* get_width) (GdkScreen *screen);
396 gint (* get_height) (GdkScreen *screen);
397 gint (* get_width_mm) (GdkScreen *screen);
398 gint (* get_height_mm) (GdkScreen *screen);
399 gint (* get_number) (GdkScreen *screen);
400 GdkWindow * (* get_root_window) (GdkScreen *screen);
401 gint (* get_n_monitors) (GdkScreen *screen);
402 gint (* get_primary_monitor) (GdkScreen *screen);
403 gint (* get_monitor_width_mm) (GdkScreen *screen,
405 gint (* get_monitor_height_mm) (GdkScreen *screen,
407 gchar * (* get_monitor_plug_name) (GdkScreen *screen,
409 void (* get_monitor_geometry) (GdkScreen *screen,
412 GList * (* list_visuals) (GdkScreen *screen);
413 GdkVisual * (* get_system_visual) (GdkScreen *screen);
414 GdkVisual * (* get_rgba_visual) (GdkScreen *screen);
415 gboolean (* is_composited) (GdkScreen *screen);
416 gchar * (* make_display_name) (GdkScreen *screen);
417 GdkWindow * (* get_active_window) (GdkScreen *screen);
418 GList * (* get_window_stack) (GdkScreen *screen);
419 void (* broadcast_client_message) (GdkScreen *screen,
421 gboolean (* get_setting) (GdkScreen *screen,
424 gint (* visual_get_best_depth) (GdkScreen *screen);
425 GdkVisualType (* visual_get_best_type) (GdkScreen *screen);
426 GdkVisual * (* visual_get_best) (GdkScreen *screen);
427 GdkVisual * (* visual_get_best_with_depth) (GdkScreen *screen,
429 GdkVisual * (* visual_get_best_with_type) (GdkScreen *screen,
430 GdkVisualType visual_type);
431 GdkVisual * (* visual_get_best_with_both) (GdkScreen *screen,
433 GdkVisualType visual_type);
434 void (* query_depths) (GdkScreen *screen,
437 void (* query_visual_types) (GdkScreen *screen,
438 GdkVisualType **visual_types,
443 void (*size_changed) (GdkScreen *screen);
444 void (*composited_changed) (GdkScreen *screen);
445 void (*monitors_changed) (GdkScreen *screen);
448 struct _GdkDragContextClass {
449 GObjectClass parent_class;
451 GdkWindow * (*find_window) (GdkDragContext *context,
452 GdkWindow *drag_window,
456 GdkDragProtocol *protocol);
457 GdkAtom (*get_selection) (GdkDragContext *context);
458 gboolean (*drag_motion) (GdkDragContext *context,
459 GdkWindow *dest_window,
460 GdkDragProtocol protocol,
463 GdkDragAction suggested_action,
464 GdkDragAction possible_actions,
466 void (*drag_status) (GdkDragContext *context,
467 GdkDragAction action,
469 void (*drag_abort) (GdkDragContext *context,
471 void (*drag_drop) (GdkDragContext *context,
473 void (*drop_reply) (GdkDragContext *context,
476 void (*drop_finish) (GdkDragContext *context,
479 gboolean (*drop_status) (GdkDragContext *context);
482 struct _GdkDragContext {
483 GObject parent_instance;
485 GdkDragProtocol protocol;
488 GdkWindow *source_window;
489 GdkWindow *dest_window;
492 GdkDragAction actions;
493 GdkDragAction suggested_action;
494 GdkDragAction action;
503 GObject parent_instance;
507 GdkByteOrder byte_order;
526 struct _GdkVisualClass
528 GObjectClass parent_class;
531 struct _GdkDeviceManager
533 GObject parent_instance;
538 struct _GdkDeviceManagerClass
540 GObjectClass parent_class;
543 void (* device_added) (GdkDeviceManager *device_manager,
545 void (* device_removed) (GdkDeviceManager *device_manager,
547 void (* device_changed) (GdkDeviceManager *device_manager,
551 GList * (* list_devices) (GdkDeviceManager *device_manager,
553 GdkDevice * (* get_client_pointer) (GdkDeviceManager *device_manager);
556 extern gchar *_gdk_display_name;
557 extern gint _gdk_screen_number;
558 extern gchar *_gdk_display_arg_name;
559 extern gboolean _gdk_disable_multidevice;
561 void _gdk_events_queue (GdkDisplay *display);
562 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
564 void _gdk_event_filter_unref (GdkWindow *window,
565 GdkEventFilter *filter);
567 void _gdk_event_emit (GdkEvent *event);
568 GList* _gdk_event_queue_find_first (GdkDisplay *display);
569 void _gdk_event_queue_remove_link (GdkDisplay *display,
571 GList* _gdk_event_queue_prepend (GdkDisplay *display,
573 GList* _gdk_event_queue_append (GdkDisplay *display,
575 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
576 GdkEvent *after_event,
578 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
579 GdkEvent *after_event,
581 void _gdk_event_button_generate (GdkDisplay *display,
584 void _gdk_windowing_event_data_copy (const GdkEvent *src,
586 void _gdk_windowing_event_data_free (GdkEvent *event);
588 void gdk_synthesize_window_state (GdkWindow *window,
589 GdkWindowState unset_flags,
590 GdkWindowState set_flags);
592 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
594 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
595 GdkRectangle *extents);
597 /*************************************
598 * Interfaces used by windowing code *
599 *************************************/
602 _gdk_window_ref_cairo_surface (GdkWindow *window);
604 void _gdk_window_impl_new (GdkWindow *window,
605 GdkWindow *real_parent,
607 GdkEventMask event_mask,
608 GdkWindowAttr *attributes,
609 gint attributes_mask);
610 void _gdk_window_destroy (GdkWindow *window,
611 gboolean foreign_destroy);
612 void _gdk_window_clear_update_area (GdkWindow *window);
613 void _gdk_window_update_size (GdkWindow *window);
614 gboolean _gdk_window_update_viewable (GdkWindow *window);
616 void _gdk_window_process_updates_recurse (GdkWindow *window,
617 cairo_region_t *expose_region);
619 void _gdk_screen_close (GdkScreen *screen);
621 const char *_gdk_get_sm_client_id (void);
623 /*****************************************
624 * Interfaces provided by windowing code *
625 *****************************************/
627 /* Font/string functions implemented in module-specific code */
629 void _gdk_cursor_destroy (GdkCursor *cursor);
631 void _gdk_windowing_init (void);
633 extern const GOptionEntry _gdk_windowing_args[];
634 void _gdk_windowing_set_default_display (GdkDisplay *display);
636 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
639 gulong _gdk_windowing_window_get_next_serial (GdkDisplay *display);
640 void _gdk_windowing_window_get_offsets (GdkWindow *window,
645 void _gdk_windowing_get_device_state (GdkDisplay *display,
650 GdkModifierType *mask);
651 GdkWindow* _gdk_windowing_window_at_device_position (GdkDisplay *display,
655 GdkModifierType *mask,
656 gboolean get_toplevel);
657 void _gdk_windowing_got_event (GdkDisplay *display,
662 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
663 cairo_region_t *expose_region);
664 void _gdk_windowing_before_process_all_updates (void);
665 void _gdk_windowing_after_process_all_updates (void);
668 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
671 /* Called when gdk_window_destroy() is called on a foreign window
672 * or an ancestor of the foreign window. It should generally reparent
673 * the window out of it's current heirarchy, hide it, and then
674 * send a message to the owner requesting that the window be destroyed.
676 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
678 void _gdk_windowing_display_set_sm_client_id (GdkDisplay *display,
679 const gchar *sm_client_id);
681 void _gdk_windowing_window_set_composited (GdkWindow *window,
682 gboolean composited);
684 #define GDK_TYPE_PAINTABLE (_gdk_paintable_get_type ())
685 #define GDK_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
686 #define GDK_IS_PAINTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
687 #define GDK_PAINTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
689 typedef struct _GdkPaintable GdkPaintable;
690 typedef struct _GdkPaintableIface GdkPaintableIface;
692 struct _GdkPaintableIface
694 GTypeInterface g_iface;
696 void (* begin_paint_region) (GdkPaintable *paintable,
698 const cairo_region_t *region);
699 void (* end_paint) (GdkPaintable *paintable);
702 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
704 struct GdkAppLaunchContextPrivate
714 void _gdk_display_device_grab_update (GdkDisplay *display,
716 GdkDevice *source_device,
717 gulong current_serial);
718 GdkDeviceGrabInfo *_gdk_display_get_last_device_grab (GdkDisplay *display,
720 GdkDeviceGrabInfo *_gdk_display_add_device_grab (GdkDisplay *display,
723 GdkWindow *native_window,
724 GdkGrabOwnership grab_ownership,
725 gboolean owner_events,
726 GdkEventMask event_mask,
727 unsigned long serial_start,
730 GdkDeviceGrabInfo * _gdk_display_has_device_grab (GdkDisplay *display,
733 gboolean _gdk_display_end_device_grab (GdkDisplay *display,
738 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
741 void _gdk_display_enable_motion_hints (GdkDisplay *display,
744 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
747 void _gdk_display_pointer_info_foreach (GdkDisplay *display,
748 GdkDisplayPointerInfoForeach func,
751 void _gdk_window_invalidate_for_expose (GdkWindow *window,
752 cairo_region_t *region);
754 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
756 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
761 void _gdk_window_add_damage (GdkWindow *toplevel,
762 cairo_region_t *damaged_region);
764 GdkEvent * _gdk_make_event (GdkWindow *window,
766 GdkEvent *event_in_queue,
767 gboolean before_event);
768 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
771 void _gdk_synthesize_crossing_events (GdkDisplay *display,
775 GdkDevice *source_device,
776 GdkCrossingMode mode,
779 GdkModifierType mask,
781 GdkEvent *event_in_queue,
783 gboolean non_linear);
784 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
789 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
791 cairo_region_t *_gdk_window_calculate_full_clip_region (GdkWindow *window,
792 GdkWindow *base_window,
793 gboolean do_children,
795 gint *base_y_offset);
796 gboolean _gdk_window_has_impl (GdkWindow *window);
797 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
799 /*****************************
800 * offscreen window routines *
801 *****************************/
802 GType gdk_offscreen_window_get_type (void);
803 void _gdk_offscreen_window_new (GdkWindow *window,
804 GdkWindowAttr *attributes,
805 gint attributes_mask);
806 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
811 /************************************
812 * Initialization and exit routines *
813 ************************************/
815 void _gdk_windowing_exit (void);
819 #endif /* __GDK_INTERNALS_H__ */