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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 /* Uninstalled header defining types and functions internal to GDK */
  28
  29 #ifndef __GDK_INTERNALS_H__
  30 #define __GDK_INTERNALS_H__
  31
  32 #include <gio/gio.h>
  33 #include <gdk/gdktypes.h>
  34 #include <gdk/gdkwindow.h>
  35 #include <gdk/gdkprivate.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /**********************
  40  * General Facilities *
  41  **********************/
  42
  43 /* Debugging support */
  44
  45 typedef struct _GdkColorInfo           GdkColorInfo;
  46 typedef struct _GdkEventFilter         GdkEventFilter;
  47 typedef struct _GdkClientFilter        GdkClientFilter;
  48
  49 typedef enum {
  50   GDK_COLOR_WRITEABLE = 1 << 0
  51 } GdkColorInfoFlags;
  52
  53 struct _GdkColorInfo
  54 {
  55   GdkColorInfoFlags flags;
  56   guint ref_count;
  57 };
  58
  59 typedef enum {
  60   GDK_EVENT_FILTER_REMOVED = 1 << 0
  61 } GdkEventFilterFlags;
  62
  63 struct _GdkEventFilter {
  64   GdkFilterFunc function;
  65   gpointer data;
  66   GdkEventFilterFlags flags;
  67   guint ref_count;
  68 };
  69
  70 struct _GdkClientFilter {
  71   GdkAtom       type;
  72   GdkFilterFunc function;
  73   gpointer      data;
  74 };
  75
  76 typedef enum {
  77   GDK_DEBUG_MISC          = 1 << 0,
  78   GDK_DEBUG_EVENTS        = 1 << 1,
  79   GDK_DEBUG_DND           = 1 << 2,
  80   GDK_DEBUG_XIM           = 1 << 3,
  81   GDK_DEBUG_NOGRABS       = 1 << 4,
  82   GDK_DEBUG_COLORMAP      = 1 << 5,
  83   GDK_DEBUG_INPUT         = 1 << 6,
  84   GDK_DEBUG_CURSOR        = 1 << 7,
  85   GDK_DEBUG_MULTIHEAD     = 1 << 8,
  86   GDK_DEBUG_XINERAMA      = 1 << 9,
  87   GDK_DEBUG_DRAW          = 1 <<10,
  88   GDK_DEBUG_EVENTLOOP     = 1 <<11
  89 } GdkDebugFlag;
  90
  91 extern GList            *_gdk_default_filters;
  92 extern GdkWindow        *_gdk_parent_root;
  93
  94 extern guint _gdk_debug_flags;
  95 extern gboolean _gdk_native_windows;
  96
  97 #ifdef G_ENABLE_DEBUG
  98
  99 #define GDK_NOTE(type,action)                G_STMT_START { \
 100     if (_gdk_debug_flags & GDK_DEBUG_##type)                \
 101        { action; };                          } G_STMT_END
 102
 103 #else /* !G_ENABLE_DEBUG */
 104
 105 #define GDK_NOTE(type,action)
 106
 107 #endif /* G_ENABLE_DEBUG */
 108
 109 /* Arg parsing */
 110
 111 typedef enum
 112 {
 113   GDK_ARG_STRING,
 114   GDK_ARG_INT,
 115   GDK_ARG_BOOL,
 116   GDK_ARG_NOBOOL,
 117   GDK_ARG_CALLBACK
 118 } GdkArgType;
 119
 120 typedef struct _GdkArgContext GdkArgContext;
 121 typedef struct _GdkArgDesc GdkArgDesc;
 122
 123 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
 124
 125 struct _GdkArgContext
 126 {
 127   GPtrArray *tables;
 128   gpointer cb_data;
 129 };
 130
 131 struct _GdkArgDesc
 132 {
 133   const char *name;
 134   GdkArgType type;
 135   gpointer location;
 136   GdkArgFunc callback;
 137 };
 138
 139 /* Event handling */
 140
 141 typedef struct _GdkEventPrivate GdkEventPrivate;
 142
 143 typedef enum
 144 {
 145   /* Following flag is set for events on the event queue during
 146    * translation and cleared afterwards.
 147    */
 148   GDK_EVENT_PENDING = 1 << 0
 149 } GdkEventFlags;
 150
 151 struct _GdkEventPrivate
 152 {
 153   GdkEvent   event;
 154   guint      flags;
 155   GdkScreen *screen;
 156   gpointer   windowing_data;
 157   GdkDevice *device;
 158 };
 159
 160 /* Tracks information about the pointer grab on this display */
 161 typedef struct
 162 {
 163   GdkWindow *window;
 164   GdkWindow *native_window;
 165   gulong serial_start;
 166   gulong serial_end; /* exclusive, i.e. not active on serial_end */
 167   gboolean owner_events;
 168   guint event_mask;
 169   gboolean implicit;
 170   guint32 time;
 171   GdkGrabOwnership ownership;
 172
 173   guint activated : 1;
 174   guint implicit_ungrab : 1;
 175 } GdkDeviceGrabInfo;
 176
 177 typedef struct _GdkInputWindow GdkInputWindow;
 178
 179 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay           *display,
 180                                                GdkDevice            *device,
 181                                                GdkPointerWindowInfo *device_info,
 182                                                gpointer              user_data);
 183
 184 /* Private version of GdkWindowObject. The initial part of this strucuture
 185    is public for historical reasons. Don't change that part */
 186 typedef struct _GdkWindowPaint             GdkWindowPaint;
 187
 188 #define GDK_WINDOW_OBJECT(object)    ((GdkWindowObject *) GDK_WINDOW (object))
 189
 190 struct _GdkWindowObject
 191 {
 192   GdkDrawable parent_instance;
 193
 194   GdkDrawable *impl; /* window-system-specific delegate object */
 195
 196   GdkWindowObject *parent;
 197   GdkVisual *visual;
 198
 199   gpointer user_data;
 200
 201   gint x;
 202   gint y;
 203
 204   gint extension_events;
 205
 206   GList *filters;
 207   GList *children;
 208
 209   cairo_pattern_t *background;
 210
 211   GSList *paint_stack;
 212
 213   cairo_region_t *update_area;
 214   guint update_freeze_count;
 215
 216   guint8 window_type;
 217   guint8 depth;
 218   guint8 resize_count;
 219
 220   GdkWindowState state;
 221
 222   guint guffaw_gravity : 1;
 223   guint input_only : 1;
 224   guint modal_hint : 1;
 225   guint composited : 1;
 226
 227   guint destroyed : 2;
 228
 229   guint accept_focus : 1;
 230   guint focus_on_map : 1;
 231   guint shaped : 1;
 232   guint support_multidevice : 1;
 233
 234   GdkEventMask event_mask;
 235
 236   guint update_and_descendants_freeze_count;
 237
 238   /* The GdkWindowObject that has the impl, ref:ed if another window.
 239    * This ref is required to keep the wrapper of the impl window alive
 240    * for as long as any GdkWindow references the impl. */
 241   GdkWindowObject *impl_window;
 242   int abs_x, abs_y; /* Absolute offset in impl */
 243   gint width, height;
 244   guint32 clip_tag;
 245   cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
 246   cairo_region_t *clip_region_with_children; /* Clip region in window coords */
 247   GdkCursor *cursor;
 248   GHashTable *device_cursor;
 249   gint8 toplevel_window_type;
 250   guint synthesize_crossing_event_queued : 1;
 251   guint effective_visibility : 2;
 252   guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
 253   guint native_visibility : 2; /* the native visibility of a impl windows */
 254   guint viewable : 1; /* mapped and all parents mapped */
 255   guint applied_shape : 1;
 256
 257   guint num_offscreen_children;
 258   GdkWindowPaint *implicit_paint;
 259   GdkInputWindow *input_window; /* only set for impl windows */
 260
 261   GList *outstanding_moves;
 262
 263   cairo_region_t *shape;
 264   cairo_region_t *input_shape;
 265
 266   cairo_surface_t *cairo_surface;
 267
 268   GList *devices_inside;
 269   GHashTable *device_events;
 270 };
 271
 272 #define GDK_WINDOW_TYPE(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->window_type)
 273 #define GDK_WINDOW_DESTROYED(d) (((GdkWindowObject*)(GDK_WINDOW (d)))->destroyed)
 274
 275 extern GdkEventFunc   _gdk_event_func;    /* Callback for events */
 276 extern gpointer       _gdk_event_data;
 277 extern GDestroyNotify _gdk_event_notify;
 278
 279 extern GSList    *_gdk_displays;
 280 extern gchar     *_gdk_display_name;
 281 extern gint       _gdk_screen_number;
 282 extern gchar     *_gdk_display_arg_name;
 283 extern gboolean   _gdk_enable_multidevice;
 284
 285 void      _gdk_events_queue  (GdkDisplay *display);
 286 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 287
 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 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
 313
 314 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 315                                      GdkRectangle *extents);
 316
 317 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
 318
 319 cairo_surface_t * _gdk_drawable_create_cairo_surface (GdkDrawable *drawable,
 320                                                       int width,
 321                                                       int height);
 322
 323 /*************************************
 324  * Interfaces used by windowing code *
 325  *************************************/
 326
 327 cairo_surface_t *
 328            _gdk_window_ref_cairo_surface (GdkWindow *window);
 329
 330 void       _gdk_window_impl_new          (GdkWindow      *window,
 331                                           GdkWindow      *real_parent,
 332                                           GdkScreen      *screen,
 333                                           GdkEventMask    event_mask,
 334                                           GdkWindowAttr  *attributes,
 335                                           gint            attributes_mask);
 336 void       _gdk_window_destroy           (GdkWindow      *window,
 337                                           gboolean        foreign_destroy);
 338 void       _gdk_window_clear_update_area (GdkWindow      *window);
 339 void       _gdk_window_update_size       (GdkWindow      *window);
 340 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 341
 342 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 343                                                 cairo_region_t *expose_region);
 344
 345 void       _gdk_screen_close             (GdkScreen      *screen);
 346
 347 const char *_gdk_get_sm_client_id (void);
 348
 349 /*****************************************
 350  * Interfaces provided by windowing code *
 351  *****************************************/
 352
 353 /* Font/string functions implemented in module-specific code */
 354
 355 void _gdk_cursor_destroy (GdkCursor *cursor);
 356
 357 void     _gdk_windowing_init                    (void);
 358
 359 extern const GOptionEntry _gdk_windowing_args[];
 360 void     _gdk_windowing_set_default_display     (GdkDisplay *display);
 361
 362 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 363                                                 gint         screen_number);
 364
 365 gulong   _gdk_windowing_window_get_next_serial  (GdkDisplay *display);
 366 void     _gdk_windowing_window_get_offsets      (GdkWindow  *window,
 367                                                  gint       *x_offset,
 368                                                  gint       *y_offset);
 369 cairo_region_t *_gdk_windowing_window_get_shape      (GdkWindow  *window);
 370 cairo_region_t *_gdk_windowing_window_get_input_shape(GdkWindow  *window);
 371 void     _gdk_windowing_window_beep             (GdkWindow *window);
 372
 373
 374 void       _gdk_windowing_get_device_state   (GdkDisplay       *display,
 375                                               GdkDevice        *device,
 376                                               GdkScreen       **screen,
 377                                               gint             *x,
 378                                               gint             *y,
 379                                               GdkModifierType  *mask);
 380 GdkWindow* _gdk_windowing_window_at_device_position  (GdkDisplay       *display,
 381                                                       GdkDevice        *device,
 382                                                       gint             *win_x,
 383                                                       gint             *win_y,
 384                                                       GdkModifierType  *mask,
 385                                                       gboolean          get_toplevel);
 386 GdkGrabStatus _gdk_windowing_device_grab     (GdkDevice        *device,
 387                                               GdkWindow        *window,
 388                                               GdkWindow        *native,
 389                                               gboolean          owner_events,
 390                                               GdkEventMask      event_mask,
 391                                               GdkWindow        *confine_to,
 392                                               GdkCursor        *cursor,
 393                                               guint32           time);
 394 void _gdk_windowing_got_event                (GdkDisplay       *display,
 395                                               GList            *event_link,
 396                                               GdkEvent         *event,
 397                                               gulong            serial);
 398
 399 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
 400                                                     cairo_region_t *expose_region);
 401 void _gdk_windowing_before_process_all_updates     (void);
 402 void _gdk_windowing_after_process_all_updates      (void);
 403
 404 /* Return the number of bits-per-pixel for images of the specified depth. */
 405 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
 406                                         gint        depth);
 407
 408
 409 #define GDK_WINDOW_IS_MAPPED(window) ((((GdkWindowObject*)window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 410
 411
 412 /* Called when gdk_window_destroy() is called on a foreign window
 413  * or an ancestor of the foreign window. It should generally reparent
 414  * the window out of it's current heirarchy, hide it, and then
 415  * send a message to the owner requesting that the window be destroyed.
 416  */
 417 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
 418
 419 void _gdk_windowing_display_set_sm_client_id (GdkDisplay  *display,
 420                                               const gchar *sm_client_id);
 421
 422 void _gdk_windowing_window_set_composited (GdkWindow *window,
 423                                            gboolean composited);
 424
 425 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 426 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 427 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 428 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 429
 430 typedef struct _GdkPaintable        GdkPaintable;
 431 typedef struct _GdkPaintableIface   GdkPaintableIface;
 432
 433 struct _GdkPaintableIface
 434 {
 435   GTypeInterface g_iface;
 436
 437   void (* begin_paint_region)       (GdkPaintable    *paintable,
 438                                      GdkWindow       *window,
 439                                      const cairo_region_t *region);
 440   void (* end_paint)                (GdkPaintable    *paintable);
 441 };
 442
 443 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 444
 445 /* Implementation types */
 446 GType _gdk_window_impl_get_type (void) G_GNUC_CONST;
 447
 448 struct GdkAppLaunchContextPrivate
 449 {
 450   GdkDisplay *display;
 451   GdkScreen *screen;
 452   gint workspace;
 453   guint32 timestamp;
 454   GIcon *icon;
 455   char *icon_name;
 456 };
 457
 458 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
 459                                             GAppInfo          *info,
 460                                             GList             *files);
 461 void  _gdk_windowing_launch_failed         (GAppLaunchContext *context,
 462                                             const char        *startup_notify_id);
 463
 464 void _gdk_display_device_grab_update                     (GdkDisplay *display,
 465                                                           GdkDevice  *device,
 466                                                           gulong      current_serial);
 467 GdkDeviceGrabInfo  *_gdk_display_get_last_device_grab  (GdkDisplay *display,
 468                                                         GdkDevice  *device);
 469 GdkDeviceGrabInfo  *_gdk_display_add_device_grab   (GdkDisplay       *display,
 470                                                     GdkDevice        *device,
 471                                                     GdkWindow        *window,
 472                                                     GdkWindow        *native_window,
 473                                                     GdkGrabOwnership  grab_ownership,
 474                                                     gboolean          owner_events,
 475                                                     GdkEventMask      event_mask,
 476                                                     unsigned long     serial_start,
 477                                                     guint32           time,
 478                                                     gboolean          implicit);
 479 GdkDeviceGrabInfo  * _gdk_display_has_device_grab  (GdkDisplay *display,
 480                                                     GdkDevice  *device,
 481                                                     gulong      serial);
 482 gboolean _gdk_display_end_device_grab  (GdkDisplay *display,
 483                                         GdkDevice  *device,
 484                                         gulong      serial,
 485                                         GdkWindow  *if_child,
 486                                         gboolean    implicit);
 487 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
 488                                             GdkDevice  *device,
 489                                             gulong      serial);
 490 void _gdk_display_enable_motion_hints     (GdkDisplay *display,
 491                                            GdkDevice  *device);
 492
 493 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
 494                                                       GdkDevice  *device);
 495
 496 void _gdk_display_pointer_info_foreach (GdkDisplay                   *display,
 497                                         GdkDisplayPointerInfoForeach  func,
 498                                         gpointer                      user_data);
 499
 500 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 501                                         cairo_region_t       *region);
 502
 503 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 504                                        int x, int y);
 505 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 506                                             double x, double y,
 507                                             double *found_x,
 508                                             double *found_y);
 509
 510 void _gdk_window_add_damage (GdkWindow *toplevel,
 511                              cairo_region_t *damaged_region);
 512
 513 GdkEvent * _gdk_make_event (GdkWindow    *window,
 514                             GdkEventType  type,
 515                             GdkEvent     *event_in_queue,
 516                             gboolean      before_event);
 517 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 518                                       GdkWindow *child);
 519
 520 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 521                                       GdkWindow                  *src,
 522                                       GdkWindow                  *dest,
 523                                       GdkDevice                  *device,
 524                                       GdkCrossingMode             mode,
 525                                       gint                        toplevel_x,
 526                                       gint                        toplevel_y,
 527                                       GdkModifierType             mask,
 528                                       guint32                     time_,
 529                                       GdkEvent                   *event_in_queue,
 530                                       gulong                      serial,
 531                                       gboolean                    non_linear);
 532 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 533                                             GdkDevice  *device,
 534                                             GdkWindow  *window);
 535
 536
 537 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 538
 539 cairo_region_t *_gdk_window_calculate_full_clip_region    (GdkWindow     *window,
 540                                                       GdkWindow     *base_window,
 541                                                       gboolean       do_children,
 542                                                       gint          *base_x_offset,
 543                                                       gint          *base_y_offset);
 544 gboolean    _gdk_window_has_impl (GdkWindow *window);
 545 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 546 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
 547                                                    GdkEventType event_type,
 548                                                    int x, int y,
 549                                                    gulong serial);
 550
 551 /*****************************
 552  * offscreen window routines *
 553  *****************************/
 554 GType gdk_offscreen_window_get_type (void);
 555 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 556                                                       GdkWindowAttr *attributes,
 557                                                       gint           attributes_mask);
 558 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 559                                                         gint       width,
 560                                                         gint       height);
 561
 562
 563 /************************************
 564  * Initialization and exit routines *
 565  ************************************/
 566
 567 void _gdk_windowing_exit (void);
 568
 569 G_END_DECLS
 570
 571 #endif /* __GDK_INTERNALS_H__ */