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