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
 204   GdkWindowState state;
 205
 206   guint guffaw_gravity : 1;
 207   guint input_only : 1;
 208   guint modal_hint : 1;
 209   guint composited : 1;
 210   guint has_alpha_background : 1;
 211
 212   guint destroyed : 2;
 213
 214   guint accept_focus : 1;
 215   guint focus_on_map : 1;
 216   guint shaped : 1;
 217   guint support_multidevice : 1;
 218   guint synthesize_crossing_event_queued : 1;
 219   guint effective_visibility : 2;
 220   guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
 221   guint native_visibility : 2; /* the native visibility of a impl windows */
 222   guint viewable : 1; /* mapped and all parents mapped */
 223   guint applied_shape : 1;
 224   GdkFullscreenMode fullscreen_mode;
 225
 226   /* The GdkWindow that has the impl, ref:ed if another window.
 227    * This ref is required to keep the wrapper of the impl window alive
 228    * for as long as any GdkWindow references the impl. */
 229   GdkWindow *impl_window;
 230
 231   guint update_and_descendants_freeze_count;
 232
 233   gint abs_x, abs_y; /* Absolute offset in impl */
 234   gint width, height;
 235
 236   /* The clip region is the part of the window, in window coordinates
 237      that is fully or partially (i.e. semi transparently) visible in
 238      the window hierarchy from the toplevel and down */
 239   cairo_region_t *clip_region;
 240   /* This is the clip region, with additionally all the opaque
 241      child windows removed */
 242   cairo_region_t *clip_region_with_children;
 243   /* The layered region is the subset of clip_region that
 244      is covered by non-opaque sibling or ancestor sibling window. */
 245   cairo_region_t *layered_region;
 246
 247   GdkCursor *cursor;
 248   GHashTable *device_cursor;
 249
 250   GdkWindowPaint *implicit_paint;
 251
 252   GList *outstanding_moves;
 253
 254   cairo_region_t *shape;
 255   cairo_region_t *input_shape;
 256
 257   cairo_surface_t *cairo_surface;
 258
 259   GList *devices_inside;
 260   GHashTable *device_events;
 261
 262   GHashTable *source_event_masks;
 263   gulong device_added_handler_id;
 264   gulong device_changed_handler_id;
 265
 266   guint num_offscreen_children;
 267 };
 268
 269 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
 270 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
 271
 272 extern gchar     *_gdk_display_name;
 273 extern gint       _gdk_screen_number;
 274 extern gchar     *_gdk_display_arg_name;
 275 extern gboolean   _gdk_disable_multidevice;
 276
 277 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 278
 279 void _gdk_event_filter_unref        (GdkWindow      *window,
 280                                      GdkEventFilter *filter);
 281
 282 void     _gdk_event_set_pointer_emulated (GdkEvent *event,
 283                                           gboolean  emulated);
 284 gboolean _gdk_event_get_pointer_emulated (GdkEvent *event);
 285
 286 void   _gdk_event_emit               (GdkEvent   *event);
 287 GList* _gdk_event_queue_find_first   (GdkDisplay *display);
 288 void   _gdk_event_queue_remove_link  (GdkDisplay *display,
 289                                       GList      *node);
 290 GList* _gdk_event_queue_prepend      (GdkDisplay *display,
 291                                       GdkEvent   *event);
 292 GList* _gdk_event_queue_append       (GdkDisplay *display,
 293                                       GdkEvent   *event);
 294 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
 295                                       GdkEvent   *after_event,
 296                                       GdkEvent   *event);
 297 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
 298                                       GdkEvent   *after_event,
 299                                       GdkEvent   *event);
 300 void   _gdk_event_button_generate    (GdkDisplay *display,
 301                                       GdkEvent   *event);
 302
 303 void _gdk_windowing_event_data_copy (const GdkEvent *src,
 304                                      GdkEvent       *dst);
 305 void _gdk_windowing_event_data_free (GdkEvent       *event);
 306
 307 void gdk_synthesize_window_state (GdkWindow     *window,
 308                                   GdkWindowState unset_flags,
 309                                   GdkWindowState set_flags);
 310
 311 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 312                                      GdkRectangle *extents);
 313
 314 /*************************************
 315  * Interfaces used by windowing code *
 316  *************************************/
 317
 318 cairo_surface_t *
 319            _gdk_window_ref_cairo_surface (GdkWindow *window);
 320
 321 void       _gdk_window_destroy           (GdkWindow      *window,
 322                                           gboolean        foreign_destroy);
 323 void       _gdk_window_clear_update_area (GdkWindow      *window);
 324 void       _gdk_window_update_size       (GdkWindow      *window);
 325 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 326
 327 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 328                                                 cairo_region_t *expose_region);
 329
 330 void       _gdk_screen_close             (GdkScreen      *screen);
 331
 332 /*****************************************
 333  * Interfaces provided by windowing code *
 334  *****************************************/
 335
 336 /* Font/string functions implemented in module-specific code */
 337
 338 void _gdk_cursor_destroy (GdkCursor *cursor);
 339
 340 extern const GOptionEntry _gdk_windowing_args[];
 341 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 342                                                 gint         screen_number);
 343
 344 void _gdk_windowing_got_event                (GdkDisplay       *display,
 345                                               GList            *event_link,
 346                                               GdkEvent         *event,
 347                                               gulong            serial);
 348
 349 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 350
 351 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 352 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 353 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 354 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 355
 356 typedef struct _GdkPaintable        GdkPaintable;
 357 typedef struct _GdkPaintableIface   GdkPaintableIface;
 358
 359 struct _GdkPaintableIface
 360 {
 361   GTypeInterface g_iface;
 362
 363   void (* begin_paint_region)       (GdkPaintable    *paintable,
 364                                      GdkWindow       *window,
 365                                      const cairo_region_t *region);
 366   void (* end_paint)                (GdkPaintable    *paintable);
 367 };
 368
 369 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 370
 371 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 372                                         cairo_region_t       *region);
 373
 374 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 375                                        int x, int y);
 376 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 377                                             double x, double y,
 378                                             double *found_x,
 379                                             double *found_y);
 380
 381 void _gdk_window_add_damage (GdkWindow *toplevel,
 382                              cairo_region_t *damaged_region);
 383
 384 GdkEvent * _gdk_make_event (GdkWindow    *window,
 385                             GdkEventType  type,
 386                             GdkEvent     *event_in_queue,
 387                             gboolean      before_event);
 388 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 389                                       GdkWindow *child);
 390
 391 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 392                                       GdkWindow                  *src,
 393                                       GdkWindow                  *dest,
 394                                       GdkDevice                  *device,
 395                                       GdkDevice                  *source_device,
 396                                       GdkCrossingMode             mode,
 397                                       gint                        toplevel_x,
 398                                       gint                        toplevel_y,
 399                                       GdkModifierType             mask,
 400                                       guint32                     time_,
 401                                       GdkEvent                   *event_in_queue,
 402                                       gulong                      serial,
 403                                       gboolean                    non_linear);
 404 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 405                                             GdkDevice  *device,
 406                                             GdkWindow  *window);
 407
 408
 409 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 410
 411 gboolean    _gdk_window_has_impl (GdkWindow *window);
 412 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 413
 414 /*****************************
 415  * offscreen window routines *
 416  *****************************/
 417 GType gdk_offscreen_window_get_type (void);
 418 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 419                                                       GdkWindowAttr *attributes,
 420                                                       gint           attributes_mask);
 421 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 422                                                         gint       width,
 423                                                         gint       height);
 424
 425
 426 G_END_DECLS
 427
 428 #endif /* __GDK_INTERNALS_H__ */