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