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   GdkFrameClock *frame_clock; /* NULL to use from parent or default */
 270 };
 271
 272 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
 273 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
 274
 275 extern gchar     *_gdk_display_name;
 276 extern gint       _gdk_screen_number;
 277 extern gchar     *_gdk_display_arg_name;
 278 extern gboolean   _gdk_disable_multidevice;
 279
 280 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 281
 282 void _gdk_event_filter_unref        (GdkWindow      *window,
 283                                      GdkEventFilter *filter);
 284
 285 void     _gdk_event_set_pointer_emulated (GdkEvent *event,
 286                                           gboolean  emulated);
 287 gboolean _gdk_event_get_pointer_emulated (GdkEvent *event);
 288
 289 void   _gdk_event_emit               (GdkEvent   *event);
 290 GList* _gdk_event_queue_find_first   (GdkDisplay *display);
 291 void   _gdk_event_queue_remove_link  (GdkDisplay *display,
 292                                       GList      *node);
 293 GList* _gdk_event_queue_prepend      (GdkDisplay *display,
 294                                       GdkEvent   *event);
 295 GList* _gdk_event_queue_append       (GdkDisplay *display,
 296                                       GdkEvent   *event);
 297 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
 298                                       GdkEvent   *after_event,
 299                                       GdkEvent   *event);
 300 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
 301                                       GdkEvent   *after_event,
 302                                       GdkEvent   *event);
 303 void   _gdk_event_button_generate    (GdkDisplay *display,
 304                                       GdkEvent   *event);
 305
 306 void _gdk_windowing_event_data_copy (const GdkEvent *src,
 307                                      GdkEvent       *dst);
 308 void _gdk_windowing_event_data_free (GdkEvent       *event);
 309
 310 void gdk_synthesize_window_state (GdkWindow     *window,
 311                                   GdkWindowState unset_flags,
 312                                   GdkWindowState set_flags);
 313
 314 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 315                                      GdkRectangle *extents);
 316
 317 /*************************************
 318  * Interfaces used by windowing code *
 319  *************************************/
 320
 321 cairo_surface_t *
 322            _gdk_window_ref_cairo_surface (GdkWindow *window);
 323
 324 void       _gdk_window_destroy           (GdkWindow      *window,
 325                                           gboolean        foreign_destroy);
 326 void       _gdk_window_clear_update_area (GdkWindow      *window);
 327 void       _gdk_window_update_size       (GdkWindow      *window);
 328 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 329
 330 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 331                                                 cairo_region_t *expose_region);
 332
 333 void       _gdk_screen_close             (GdkScreen      *screen);
 334
 335 /*****************************************
 336  * Interfaces provided by windowing code *
 337  *****************************************/
 338
 339 /* Font/string functions implemented in module-specific code */
 340
 341 void _gdk_cursor_destroy (GdkCursor *cursor);
 342
 343 extern const GOptionEntry _gdk_windowing_args[];
 344 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 345                                                 gint         screen_number);
 346
 347 void _gdk_windowing_got_event                (GdkDisplay       *display,
 348                                               GList            *event_link,
 349                                               GdkEvent         *event,
 350                                               gulong            serial);
 351
 352 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 353
 354 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 355 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 356 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 357 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 358
 359 typedef struct _GdkPaintable        GdkPaintable;
 360 typedef struct _GdkPaintableIface   GdkPaintableIface;
 361
 362 struct _GdkPaintableIface
 363 {
 364   GTypeInterface g_iface;
 365
 366   void (* begin_paint_region)       (GdkPaintable    *paintable,
 367                                      GdkWindow       *window,
 368                                      const cairo_region_t *region);
 369   void (* end_paint)                (GdkPaintable    *paintable);
 370 };
 371
 372 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 373
 374 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 375                                         cairo_region_t       *region);
 376
 377 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 378                                        int x, int y);
 379 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 380                                             double x, double y,
 381                                             double *found_x,
 382                                             double *found_y);
 383
 384 void _gdk_window_add_damage (GdkWindow *toplevel,
 385                              cairo_region_t *damaged_region);
 386
 387 GdkEvent * _gdk_make_event (GdkWindow    *window,
 388                             GdkEventType  type,
 389                             GdkEvent     *event_in_queue,
 390                             gboolean      before_event);
 391 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 392                                       GdkWindow *child);
 393
 394 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 395                                       GdkWindow                  *src,
 396                                       GdkWindow                  *dest,
 397                                       GdkDevice                  *device,
 398                                       GdkDevice                  *source_device,
 399                                       GdkCrossingMode             mode,
 400                                       gint                        toplevel_x,
 401                                       gint                        toplevel_y,
 402                                       GdkModifierType             mask,
 403                                       guint32                     time_,
 404                                       GdkEvent                   *event_in_queue,
 405                                       gulong                      serial,
 406                                       gboolean                    non_linear);
 407 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 408                                             GdkDevice  *device,
 409                                             GdkWindow  *window);
 410
 411
 412 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 413
 414 gboolean    _gdk_window_has_impl (GdkWindow *window);
 415 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 416
 417 /*****************************
 418  * offscreen window routines *
 419  *****************************/
 420 GType gdk_offscreen_window_get_type (void);
 421 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 422                                                       GdkWindowAttr *attributes,
 423                                                       gint           attributes_mask);
 424 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 425                                                         gint       width,
 426                                                         gint       height);
 427
 428
 429 G_END_DECLS
 430
 431 #endif /* __GDK_INTERNALS_H__ */