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 typedef struct _GdkWindowPaint GdkWindowPaint;
 179
 180 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay           *display,
 181                                                GdkDevice            *device,
 182                                                GdkPointerWindowInfo *device_info,
 183                                                gpointer              user_data);
 184
 185 struct _GdkWindow
 186 {
 187   GdkDrawable parent_instance;
 188
 189   GdkDrawable *impl; /* window-system-specific delegate object */
 190
 191   GdkWindow *parent;
 192   GdkVisual *visual;
 193
 194   gpointer user_data;
 195
 196   gint x;
 197   gint y;
 198
 199   gint extension_events;
 200
 201   GList *filters;
 202   GList *children;
 203
 204   cairo_pattern_t *background;
 205
 206   GSList *paint_stack;
 207
 208   cairo_region_t *update_area;
 209   guint update_freeze_count;
 210
 211   guint8 window_type;
 212   guint8 depth;
 213   guint8 resize_count;
 214
 215   GdkWindowState state;
 216
 217   guint guffaw_gravity : 1;
 218   guint input_only : 1;
 219   guint modal_hint : 1;
 220   guint composited : 1;
 221
 222   guint destroyed : 2;
 223
 224   guint accept_focus : 1;
 225   guint focus_on_map : 1;
 226   guint shaped : 1;
 227   guint support_multidevice : 1;
 228
 229   GdkEventMask event_mask;
 230
 231   guint update_and_descendants_freeze_count;
 232
 233   /* The GdkWindow that has the impl, ref:ed if another window.
 234    * This ref is required to keep the wrapper of the impl window alive
 235    * for as long as any GdkWindow references the impl. */
 236   GdkWindow *impl_window;
 237   int abs_x, abs_y; /* Absolute offset in impl */
 238   gint width, height;
 239   guint32 clip_tag;
 240   cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
 241   cairo_region_t *clip_region_with_children; /* Clip region in window coords */
 242   GdkCursor *cursor;
 243   GHashTable *device_cursor;
 244   gint8 toplevel_window_type;
 245   guint synthesize_crossing_event_queued : 1;
 246   guint effective_visibility : 2;
 247   guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
 248   guint native_visibility : 2; /* the native visibility of a impl windows */
 249   guint viewable : 1; /* mapped and all parents mapped */
 250   guint applied_shape : 1;
 251
 252   guint num_offscreen_children;
 253   GdkWindowPaint *implicit_paint;
 254   GdkInputWindow *input_window; /* only set for impl windows */
 255
 256   GList *outstanding_moves;
 257
 258   cairo_region_t *shape;
 259   cairo_region_t *input_shape;
 260
 261   cairo_surface_t *cairo_surface;
 262
 263   GList *devices_inside;
 264   GHashTable *device_events;
 265 };
 266
 267 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
 268 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
 269
 270 extern GdkEventFunc   _gdk_event_func;    /* Callback for events */
 271 extern gpointer       _gdk_event_data;
 272 extern GDestroyNotify _gdk_event_notify;
 273
 274 extern GSList    *_gdk_displays;
 275 extern gchar     *_gdk_display_name;
 276 extern gint       _gdk_screen_number;
 277 extern gchar     *_gdk_display_arg_name;
 278 extern gboolean   _gdk_enable_multidevice;
 279
 280 void      _gdk_events_queue  (GdkDisplay *display);
 281 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 282
 283 GList* _gdk_event_queue_find_first   (GdkDisplay *display);
 284 void   _gdk_event_queue_remove_link  (GdkDisplay *display,
 285                                       GList      *node);
 286 GList* _gdk_event_queue_prepend      (GdkDisplay *display,
 287                                       GdkEvent   *event);
 288 GList* _gdk_event_queue_append       (GdkDisplay *display,
 289                                       GdkEvent   *event);
 290 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
 291                                       GdkEvent   *after_event,
 292                                       GdkEvent   *event);
 293 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
 294                                       GdkEvent   *after_event,
 295                                       GdkEvent   *event);
 296 void   _gdk_event_button_generate    (GdkDisplay *display,
 297                                       GdkEvent   *event);
 298
 299 void _gdk_windowing_event_data_copy (const GdkEvent *src,
 300                                      GdkEvent       *dst);
 301 void _gdk_windowing_event_data_free (GdkEvent       *event);
 302
 303 void gdk_synthesize_window_state (GdkWindow     *window,
 304                                   GdkWindowState unset_flags,
 305                                   GdkWindowState set_flags);
 306
 307 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
 308
 309 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 310                                      GdkRectangle *extents);
 311
 312 cairo_surface_t *_gdk_drawable_ref_cairo_surface (GdkDrawable *drawable);
 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_impl_new          (GdkWindow      *window,
 322                                           GdkWindow      *real_parent,
 323                                           GdkScreen      *screen,
 324                                           GdkEventMask    event_mask,
 325                                           GdkWindowAttr  *attributes,
 326                                           gint            attributes_mask);
 327 void       _gdk_window_destroy           (GdkWindow      *window,
 328                                           gboolean        foreign_destroy);
 329 void       _gdk_window_clear_update_area (GdkWindow      *window);
 330 void       _gdk_window_update_size       (GdkWindow      *window);
 331 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 332
 333 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 334                                                 cairo_region_t *expose_region);
 335
 336 void       _gdk_screen_close             (GdkScreen      *screen);
 337
 338 const char *_gdk_get_sm_client_id (void);
 339
 340 /*****************************************
 341  * Interfaces provided by windowing code *
 342  *****************************************/
 343
 344 /* Font/string functions implemented in module-specific code */
 345
 346 void _gdk_cursor_destroy (GdkCursor *cursor);
 347
 348 void     _gdk_windowing_init                    (void);
 349
 350 extern const GOptionEntry _gdk_windowing_args[];
 351 void     _gdk_windowing_set_default_display     (GdkDisplay *display);
 352
 353 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 354                                                 gint         screen_number);
 355
 356 gulong   _gdk_windowing_window_get_next_serial  (GdkDisplay *display);
 357 void     _gdk_windowing_window_get_offsets      (GdkWindow  *window,
 358                                                  gint       *x_offset,
 359                                                  gint       *y_offset);
 360 cairo_region_t *_gdk_windowing_window_get_shape      (GdkWindow  *window);
 361 cairo_region_t *_gdk_windowing_window_get_input_shape(GdkWindow  *window);
 362 void     _gdk_windowing_window_beep             (GdkWindow *window);
 363
 364
 365 void       _gdk_windowing_get_device_state   (GdkDisplay       *display,
 366                                               GdkDevice        *device,
 367                                               GdkScreen       **screen,
 368                                               gint             *x,
 369                                               gint             *y,
 370                                               GdkModifierType  *mask);
 371 GdkWindow* _gdk_windowing_window_at_device_position  (GdkDisplay       *display,
 372                                                       GdkDevice        *device,
 373                                                       gint             *win_x,
 374                                                       gint             *win_y,
 375                                                       GdkModifierType  *mask,
 376                                                       gboolean          get_toplevel);
 377 GdkGrabStatus _gdk_windowing_device_grab     (GdkDevice        *device,
 378                                               GdkWindow        *window,
 379                                               GdkWindow        *native,
 380                                               gboolean          owner_events,
 381                                               GdkEventMask      event_mask,
 382                                               GdkWindow        *confine_to,
 383                                               GdkCursor        *cursor,
 384                                               guint32           time);
 385 void _gdk_windowing_got_event                (GdkDisplay       *display,
 386                                               GList            *event_link,
 387                                               GdkEvent         *event,
 388                                               gulong            serial);
 389
 390 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
 391                                                     cairo_region_t *expose_region);
 392 void _gdk_windowing_before_process_all_updates     (void);
 393 void _gdk_windowing_after_process_all_updates      (void);
 394
 395 /* Return the number of bits-per-pixel for images of the specified depth. */
 396 gint _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
 397                                         gint        depth);
 398
 399
 400 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 401
 402
 403 /* Called when gdk_window_destroy() is called on a foreign window
 404  * or an ancestor of the foreign window. It should generally reparent
 405  * the window out of it's current heirarchy, hide it, and then
 406  * send a message to the owner requesting that the window be destroyed.
 407  */
 408 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
 409
 410 void _gdk_windowing_display_set_sm_client_id (GdkDisplay  *display,
 411                                               const gchar *sm_client_id);
 412
 413 void _gdk_windowing_window_set_composited (GdkWindow *window,
 414                                            gboolean composited);
 415
 416 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 417 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 418 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 419 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 420
 421 typedef struct _GdkPaintable        GdkPaintable;
 422 typedef struct _GdkPaintableIface   GdkPaintableIface;
 423
 424 struct _GdkPaintableIface
 425 {
 426   GTypeInterface g_iface;
 427
 428   void (* begin_paint_region)       (GdkPaintable    *paintable,
 429                                      GdkWindow       *window,
 430                                      const cairo_region_t *region);
 431   void (* end_paint)                (GdkPaintable    *paintable);
 432 };
 433
 434 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 435
 436 struct GdkAppLaunchContextPrivate
 437 {
 438   GdkDisplay *display;
 439   GdkScreen *screen;
 440   gint workspace;
 441   guint32 timestamp;
 442   GIcon *icon;
 443   char *icon_name;
 444 };
 445
 446 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
 447                                             GAppInfo          *info,
 448                                             GList             *files);
 449 void  _gdk_windowing_launch_failed         (GAppLaunchContext *context,
 450                                             const char        *startup_notify_id);
 451
 452 void _gdk_display_device_grab_update                     (GdkDisplay *display,
 453                                                           GdkDevice  *device,
 454                                                           gulong      current_serial);
 455 GdkDeviceGrabInfo  *_gdk_display_get_last_device_grab  (GdkDisplay *display,
 456                                                         GdkDevice  *device);
 457 GdkDeviceGrabInfo  *_gdk_display_add_device_grab   (GdkDisplay       *display,
 458                                                     GdkDevice        *device,
 459                                                     GdkWindow        *window,
 460                                                     GdkWindow        *native_window,
 461                                                     GdkGrabOwnership  grab_ownership,
 462                                                     gboolean          owner_events,
 463                                                     GdkEventMask      event_mask,
 464                                                     unsigned long     serial_start,
 465                                                     guint32           time,
 466                                                     gboolean          implicit);
 467 GdkDeviceGrabInfo  * _gdk_display_has_device_grab  (GdkDisplay *display,
 468                                                     GdkDevice  *device,
 469                                                     gulong      serial);
 470 gboolean _gdk_display_end_device_grab  (GdkDisplay *display,
 471                                         GdkDevice  *device,
 472                                         gulong      serial,
 473                                         GdkWindow  *if_child,
 474                                         gboolean    implicit);
 475 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
 476                                             GdkDevice  *device,
 477                                             gulong      serial);
 478 void _gdk_display_enable_motion_hints     (GdkDisplay *display,
 479                                            GdkDevice  *device);
 480
 481 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
 482                                                       GdkDevice  *device);
 483
 484 void _gdk_display_pointer_info_foreach (GdkDisplay                   *display,
 485                                         GdkDisplayPointerInfoForeach  func,
 486                                         gpointer                      user_data);
 487
 488 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 489                                         cairo_region_t       *region);
 490
 491 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 492                                        int x, int y);
 493 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 494                                             double x, double y,
 495                                             double *found_x,
 496                                             double *found_y);
 497
 498 void _gdk_window_add_damage (GdkWindow *toplevel,
 499                              cairo_region_t *damaged_region);
 500
 501 GdkEvent * _gdk_make_event (GdkWindow    *window,
 502                             GdkEventType  type,
 503                             GdkEvent     *event_in_queue,
 504                             gboolean      before_event);
 505 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 506                                       GdkWindow *child);
 507
 508 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 509                                       GdkWindow                  *src,
 510                                       GdkWindow                  *dest,
 511                                       GdkDevice                  *device,
 512                                       GdkCrossingMode             mode,
 513                                       gint                        toplevel_x,
 514                                       gint                        toplevel_y,
 515                                       GdkModifierType             mask,
 516                                       guint32                     time_,
 517                                       GdkEvent                   *event_in_queue,
 518                                       gulong                      serial,
 519                                       gboolean                    non_linear);
 520 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 521                                             GdkDevice  *device,
 522                                             GdkWindow  *window);
 523
 524
 525 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 526
 527 cairo_region_t *_gdk_window_calculate_full_clip_region    (GdkWindow     *window,
 528                                                       GdkWindow     *base_window,
 529                                                       gboolean       do_children,
 530                                                       gint          *base_x_offset,
 531                                                       gint          *base_y_offset);
 532 gboolean    _gdk_window_has_impl (GdkWindow *window);
 533 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 534 GdkWindow *_gdk_window_get_input_window_for_event (GdkWindow *native_window,
 535                                                    GdkEventType event_type,
 536                                                    int x, int y,
 537                                                    gulong serial);
 538
 539 /*****************************
 540  * offscreen window routines *
 541  *****************************/
 542 GType gdk_offscreen_window_get_type (void);
 543 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 544                                                       GdkWindowAttr *attributes,
 545                                                       gint           attributes_mask);
 546 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 547                                                         gint       width,
 548                                                         gint       height);
 549
 550
 551 /************************************
 552  * Initialization and exit routines *
 553  ************************************/
 554
 555 void _gdk_windowing_exit (void);
 556
 557 G_END_DECLS
 558
 559 #endif /* __GDK_INTERNALS_H__ */