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