Pileus Git - ~andy/gtk/blob - gdk/gdkinternals.h

   1 /* GDK - The GIMP Drawing Kit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 /* Uninstalled header defining types and functions internal to GDK */
  26
  27 #ifndef __GDK_INTERNALS_H__
  28 #define __GDK_INTERNALS_H__
  29
  30 #include <gio/gio.h>
  31 #include "gdkwindowimpl.h"
  32 #include "gdkdisplay.h"
  33 #include "gdkprivate.h"
  34
  35 G_BEGIN_DECLS
  36
  37 /**********************
  38  * General Facilities *
  39  **********************/
  40
  41 /* Debugging support */
  42
  43 typedef struct _GdkColorInfo           GdkColorInfo;
  44 typedef struct _GdkEventFilter         GdkEventFilter;
  45 typedef struct _GdkClientFilter        GdkClientFilter;
  46
  47 typedef enum {
  48   GDK_COLOR_WRITEABLE = 1 << 0
  49 } GdkColorInfoFlags;
  50
  51 struct _GdkColorInfo
  52 {
  53   GdkColorInfoFlags flags;
  54   guint ref_count;
  55 };
  56
  57 typedef enum {
  58   GDK_EVENT_FILTER_REMOVED = 1 << 0
  59 } GdkEventFilterFlags;
  60
  61 struct _GdkEventFilter {
  62   GdkFilterFunc function;
  63   gpointer data;
  64   GdkEventFilterFlags flags;
  65   guint ref_count;
  66 };
  67
  68 struct _GdkClientFilter {
  69   GdkAtom       type;
  70   GdkFilterFunc function;
  71   gpointer      data;
  72 };
  73
  74 typedef enum {
  75   GDK_DEBUG_MISC          = 1 <<  0,
  76   GDK_DEBUG_EVENTS        = 1 <<  1,
  77   GDK_DEBUG_DND           = 1 <<  2,
  78   GDK_DEBUG_XIM           = 1 <<  3,
  79   GDK_DEBUG_NOGRABS       = 1 <<  4,
  80   GDK_DEBUG_INPUT         = 1 <<  5,
  81   GDK_DEBUG_CURSOR        = 1 <<  6,
  82   GDK_DEBUG_MULTIHEAD     = 1 <<  7,
  83   GDK_DEBUG_XINERAMA      = 1 <<  8,
  84   GDK_DEBUG_DRAW          = 1 <<  9,
  85   GDK_DEBUG_EVENTLOOP     = 1 << 10
  86 } GdkDebugFlag;
  87
  88 typedef enum {
  89   GDK_RENDERING_MODE_SIMILAR = 0,
  90   GDK_RENDERING_MODE_IMAGE,
  91   GDK_RENDERING_MODE_RECORDING
  92 } GdkRenderingMode;
  93
  94 extern GList            *_gdk_default_filters;
  95 extern GdkWindow        *_gdk_parent_root;
  96
  97 extern guint _gdk_debug_flags;
  98 extern GdkRenderingMode    _gdk_rendering_mode;
  99
 100 #ifdef G_ENABLE_DEBUG
 101
 102 #define GDK_NOTE(type,action)                G_STMT_START { \
 103     if (_gdk_debug_flags & GDK_DEBUG_##type)                \
 104        { action; };                          } G_STMT_END
 105
 106 #else /* !G_ENABLE_DEBUG */
 107
 108 #define GDK_NOTE(type,action)
 109
 110 #endif /* G_ENABLE_DEBUG */
 111
 112 /* Arg parsing */
 113
 114 typedef enum
 115 {
 116   GDK_ARG_STRING,
 117   GDK_ARG_INT,
 118   GDK_ARG_BOOL,
 119   GDK_ARG_NOBOOL,
 120   GDK_ARG_CALLBACK
 121 } GdkArgType;
 122
 123 typedef struct _GdkArgContext GdkArgContext;
 124 typedef struct _GdkArgDesc GdkArgDesc;
 125
 126 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
 127
 128 struct _GdkArgContext
 129 {
 130   GPtrArray *tables;
 131   gpointer cb_data;
 132 };
 133
 134 struct _GdkArgDesc
 135 {
 136   const char *name;
 137   GdkArgType type;
 138   gpointer location;
 139   GdkArgFunc callback;
 140 };
 141
 142 /* Event handling */
 143
 144 typedef struct _GdkEventPrivate GdkEventPrivate;
 145
 146 typedef enum
 147 {
 148   /* Following flag is set for events on the event queue during
 149    * translation and cleared afterwards.
 150    */
 151   GDK_EVENT_PENDING = 1 << 0,
 152
 153   /* The following flag is set for:
 154    * 1) touch events emulating pointer events
 155    * 2) pointer events being emulated by a touch sequence.
 156    */
 157   GDK_EVENT_POINTER_EMULATED = 1 << 1
 158 } GdkEventFlags;
 159
 160 struct _GdkEventPrivate
 161 {
 162   GdkEvent   event;
 163   guint      flags;
 164   GdkScreen *screen;
 165   gpointer   windowing_data;
 166   GdkDevice *device;
 167   GdkDevice *source_device;
 168 };
 169
 170 typedef struct _GdkWindowPaint GdkWindowPaint;
 171
 172 struct _GdkWindow
 173 {
 174   GObject parent_instance;
 175
 176   GdkWindowImpl *impl; /* window-system-specific delegate object */
 177
 178   GdkWindow *parent;
 179   GdkVisual *visual;
 180
 181   gpointer user_data;
 182
 183   gint x;
 184   gint y;
 185
 186   GdkEventMask event_mask;
 187
 188   GList *filters;
 189   GList *children;
 190
 191   cairo_pattern_t *background;
 192
 193   GSList *paint_stack;
 194
 195   cairo_region_t *update_area;
 196   guint update_freeze_count;
 197
 198   guint8 window_type;
 199   guint8 depth;
 200   guint8 resize_count;
 201
 202   gint8 toplevel_window_type;
 203   guint8 alpha;
 204
 205   GdkWindowState state;
 206
 207   guint guffaw_gravity : 1;
 208   guint input_only : 1;
 209   guint modal_hint : 1;
 210   guint composited : 1;
 211   guint has_alpha_background : 1;
 212
 213   guint destroyed : 2;
 214
 215   guint accept_focus : 1;
 216   guint focus_on_map : 1;
 217   guint shaped : 1;
 218   guint support_multidevice : 1;
 219   guint synthesize_crossing_event_queued : 1;
 220   guint effective_visibility : 2;
 221   guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
 222   guint native_visibility : 2; /* the native visibility of a impl windows */
 223   guint viewable : 1; /* mapped and all parents mapped */
 224   guint applied_shape : 1;
 225   GdkFullscreenMode fullscreen_mode;
 226
 227   /* The GdkWindow that has the impl, ref:ed if another window.
 228    * This ref is required to keep the wrapper of the impl window alive
 229    * for as long as any GdkWindow references the impl. */
 230   GdkWindow *impl_window;
 231
 232   guint update_and_descendants_freeze_count;
 233
 234   gint abs_x, abs_y; /* Absolute offset in impl */
 235   gint width, height;
 236
 237   /* The clip region is the part of the window, in window coordinates
 238      that is fully or partially (i.e. semi transparently) visible in
 239      the window hierarchy from the toplevel and down */
 240   cairo_region_t *clip_region;
 241   /* This is the clip region, with additionally all the opaque
 242      child windows removed */
 243   cairo_region_t *clip_region_with_children;
 244   /* The layered region is the subset of clip_region that
 245      is covered by non-opaque sibling or ancestor sibling window. */
 246   cairo_region_t *layered_region;
 247
 248   GdkCursor *cursor;
 249   GHashTable *device_cursor;
 250
 251   GSList *implicit_paint;
 252
 253   GList *outstanding_moves;
 254
 255   cairo_region_t *shape;
 256   cairo_region_t *input_shape;
 257
 258   cairo_surface_t *cairo_surface;
 259
 260   GList *devices_inside;
 261   GHashTable *device_events;
 262
 263   GHashTable *source_event_masks;
 264   gulong device_added_handler_id;
 265   gulong device_changed_handler_id;
 266
 267   guint num_offscreen_children;
 268 };
 269
 270 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
 271 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
 272
 273 extern gchar     *_gdk_display_name;
 274 extern gint       _gdk_screen_number;
 275 extern gchar     *_gdk_display_arg_name;
 276 extern gboolean   _gdk_disable_multidevice;
 277
 278 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 279
 280 void _gdk_event_filter_unref        (GdkWindow      *window,
 281                                      GdkEventFilter *filter);
 282
 283 void     _gdk_event_set_pointer_emulated (GdkEvent *event,
 284                                           gboolean  emulated);
 285 gboolean _gdk_event_get_pointer_emulated (GdkEvent *event);
 286
 287 void   _gdk_event_emit               (GdkEvent   *event);
 288 GList* _gdk_event_queue_find_first   (GdkDisplay *display);
 289 void   _gdk_event_queue_remove_link  (GdkDisplay *display,
 290                                       GList      *node);
 291 GList* _gdk_event_queue_prepend      (GdkDisplay *display,
 292                                       GdkEvent   *event);
 293 GList* _gdk_event_queue_append       (GdkDisplay *display,
 294                                       GdkEvent   *event);
 295 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
 296                                       GdkEvent   *after_event,
 297                                       GdkEvent   *event);
 298 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
 299                                       GdkEvent   *after_event,
 300                                       GdkEvent   *event);
 301 void   _gdk_event_button_generate    (GdkDisplay *display,
 302                                       GdkEvent   *event);
 303
 304 void _gdk_windowing_event_data_copy (const GdkEvent *src,
 305                                      GdkEvent       *dst);
 306 void _gdk_windowing_event_data_free (GdkEvent       *event);
 307
 308 void gdk_synthesize_window_state (GdkWindow     *window,
 309                                   GdkWindowState unset_flags,
 310                                   GdkWindowState set_flags);
 311
 312 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 313                                      GdkRectangle *extents);
 314
 315 /*************************************
 316  * Interfaces used by windowing code *
 317  *************************************/
 318
 319 cairo_surface_t *
 320            _gdk_window_ref_cairo_surface (GdkWindow *window);
 321
 322 void       _gdk_window_destroy           (GdkWindow      *window,
 323                                           gboolean        foreign_destroy);
 324 void       _gdk_window_clear_update_area (GdkWindow      *window);
 325 void       _gdk_window_update_size       (GdkWindow      *window);
 326 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 327
 328 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 329                                                 cairo_region_t *expose_region);
 330
 331 void       _gdk_screen_close             (GdkScreen      *screen);
 332
 333 /*****************************************
 334  * Interfaces provided by windowing code *
 335  *****************************************/
 336
 337 /* Font/string functions implemented in module-specific code */
 338
 339 void _gdk_cursor_destroy (GdkCursor *cursor);
 340
 341 extern const GOptionEntry _gdk_windowing_args[];
 342 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 343                                                 gint         screen_number);
 344
 345 void _gdk_windowing_got_event                (GdkDisplay       *display,
 346                                               GList            *event_link,
 347                                               GdkEvent         *event,
 348                                               gulong            serial);
 349
 350 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 351
 352 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 353 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 354 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 355 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 356
 357 typedef struct _GdkPaintable        GdkPaintable;
 358 typedef struct _GdkPaintableIface   GdkPaintableIface;
 359
 360 struct _GdkPaintableIface
 361 {
 362   GTypeInterface g_iface;
 363
 364   void (* begin_paint_region)       (GdkPaintable    *paintable,
 365                                      GdkWindow       *window,
 366                                      const cairo_region_t *region);
 367   void (* end_paint)                (GdkPaintable    *paintable);
 368 };
 369
 370 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 371
 372 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 373                                         cairo_region_t       *region);
 374
 375 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 376                                        int x, int y);
 377 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 378                                             double x, double y,
 379                                             double *found_x,
 380                                             double *found_y);
 381
 382 void _gdk_window_add_damage (GdkWindow *toplevel,
 383                              cairo_region_t *damaged_region);
 384
 385 GdkEvent * _gdk_make_event (GdkWindow    *window,
 386                             GdkEventType  type,
 387                             GdkEvent     *event_in_queue,
 388                             gboolean      before_event);
 389 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 390                                       GdkWindow *child);
 391
 392 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 393                                       GdkWindow                  *src,
 394                                       GdkWindow                  *dest,
 395                                       GdkDevice                  *device,
 396                                       GdkDevice                  *source_device,
 397                                       GdkCrossingMode             mode,
 398                                       gint                        toplevel_x,
 399                                       gint                        toplevel_y,
 400                                       GdkModifierType             mask,
 401                                       guint32                     time_,
 402                                       GdkEvent                   *event_in_queue,
 403                                       gulong                      serial,
 404                                       gboolean                    non_linear);
 405 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 406                                             GdkDevice  *device,
 407                                             GdkWindow  *window);
 408
 409
 410 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 411
 412 gboolean    _gdk_window_has_impl (GdkWindow *window);
 413 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 414
 415 /*****************************
 416  * offscreen window routines *
 417  *****************************/
 418 GType gdk_offscreen_window_get_type (void);
 419 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 420                                                       GdkWindowAttr *attributes,
 421                                                       gint           attributes_mask);
 422 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 423                                                         gint       width,
 424                                                         gint       height);
 425
 426
 427 G_END_DECLS
 428
 429 #endif /* __GDK_INTERNALS_H__ */