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