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