Pileus Git - ~andy/gtk/blob - gdk/gdkdisplay.h

   1 /*
   2  * gdkdisplay.h
   3  *
   4  * Copyright 2001 Sun Microsystems Inc.
   5  *
   6  * Erwann Chenede <erwann.chenede@sun.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
  25 #error "Only <gdk/gdk.h> can be included directly."
  26 #endif
  27
  28 #ifndef __GDK_DISPLAY_H__
  29 #define __GDK_DISPLAY_H__
  30
  31 #include <gdk/gdktypes.h>
  32 #include <gdk/gdkevents.h>
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _GdkDisplayClass GdkDisplayClass;
  37 typedef struct _GdkDisplayPointerHooks GdkDisplayPointerHooks;
  38
  39 #define GDK_TYPE_DISPLAY              (gdk_display_get_type ())
  40 #define GDK_DISPLAY_OBJECT(object)    (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_DISPLAY, GdkDisplay))
  41 #define GDK_DISPLAY_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_DISPLAY, GdkDisplayClass))
  42 #define GDK_IS_DISPLAY(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_DISPLAY))
  43 #define GDK_IS_DISPLAY_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_DISPLAY))
  44 #define GDK_DISPLAY_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_DISPLAY, GdkDisplayClass))
  45
  46 /* Tracks information about the keyboard grab on this display */
  47 typedef struct
  48 {
  49   GdkWindow *window;
  50   GdkWindow *native_window;
  51   gulong serial;
  52   gboolean owner_events;
  53   guint32 time;
  54 } GdkKeyboardGrabInfo;
  55
  56 /* Tracks information about which window and position the pointer last was in.
  57  * This is useful when we need to synthesize events later.
  58  * Note that we track toplevel_under_pointer using enter/leave events,
  59  * so in the case of a grab, either with owner_events==FALSE or with the
  60  * pointer in no clients window the x/y coordinates may actually be outside
  61  * the window.
  62  */
  63 typedef struct
  64 {
  65   GdkWindow *toplevel_under_pointer; /* The toplevel window with mouse inside, tracked via native events */
  66   GdkWindow *window_under_pointer; /* The window that last got sent a normal enter event */
  67   gdouble toplevel_x, toplevel_y;
  68   guint32 state;
  69   guint32 button;
  70   gulong motion_hint_serial; /* 0 == didn't deliver hinted motion event */
  71 } GdkPointerWindowInfo;
  72
  73 struct _GdkDisplay
  74 {
  75   GObject parent_instance;
  76
  77   /*< private >*/
  78   GList *queued_events;
  79   GList *queued_tail;
  80
  81   /* Information for determining if the latest button click
  82    * is part of a double-click or triple-click
  83    */
  84   guint32 button_click_time[2]; /* The last 2 button click times. */
  85   GdkWindow *button_window[2];  /* The last 2 windows to receive button presses. */
  86   gint button_number[2];        /* The last 2 buttons to be pressed. */
  87
  88   guint double_click_time;      /* Maximum time between clicks in msecs */
  89   GdkDevice *core_pointer;      /* Core pointer device */
  90
  91   const GdkDisplayPointerHooks *pointer_hooks; /* Current hooks for querying pointer */
  92
  93   guint closed : 1;             /* Whether this display has been closed */
  94
  95   guint double_click_distance;  /* Maximum distance between clicks in pixels */
  96   gint button_x[2];             /* The last 2 button click positions. */
  97   gint button_y[2];
  98
  99   GList *pointer_grabs;
 100   GdkKeyboardGrabInfo keyboard_grab;
 101   GdkPointerWindowInfo pointer_info;
 102
 103   /* Last reported event time from server */
 104   guint32 last_event_time;
 105 };
 106
 107 struct _GdkDisplayClass
 108 {
 109   GObjectClass parent_class;
 110
 111   G_CONST_RETURN gchar *     (*get_display_name)   (GdkDisplay *display);
 112   gint                       (*get_n_screens)      (GdkDisplay *display);
 113   GdkScreen *                (*get_screen)         (GdkDisplay *display,
 114                                                     gint        screen_num);
 115   GdkScreen *                (*get_default_screen) (GdkDisplay *display);
 116
 117
 118   /* Signals */
 119   void (*closed) (GdkDisplay *display,
 120                   gboolean    is_error);
 121 };
 122
 123 struct _GdkDisplayPointerHooks
 124 {
 125   void (*get_pointer)              (GdkDisplay      *display,
 126                                     GdkScreen      **screen,
 127                                     gint            *x,
 128                                     gint            *y,
 129                                     GdkModifierType *mask);
 130   GdkWindow* (*window_get_pointer) (GdkDisplay      *display,
 131                                     GdkWindow       *window,
 132                                     gint            *x,
 133                                     gint            *y,
 134                                     GdkModifierType *mask);
 135   GdkWindow* (*window_at_pointer)  (GdkDisplay      *display,
 136                                     gint            *win_x,
 137                                     gint            *win_y);
 138 };
 139
 140 GType       gdk_display_get_type (void) G_GNUC_CONST;
 141 GdkDisplay *gdk_display_open                (const gchar *display_name);
 142
 143 G_CONST_RETURN gchar * gdk_display_get_name (GdkDisplay *display);
 144
 145 gint        gdk_display_get_n_screens      (GdkDisplay  *display);
 146 GdkScreen * gdk_display_get_screen         (GdkDisplay  *display,
 147                                             gint         screen_num);
 148 GdkScreen * gdk_display_get_default_screen (GdkDisplay  *display);
 149 void        gdk_display_pointer_ungrab     (GdkDisplay  *display,
 150                                             guint32      time_);
 151 void        gdk_display_keyboard_ungrab    (GdkDisplay  *display,
 152                                             guint32      time_);
 153 gboolean    gdk_display_pointer_is_grabbed (GdkDisplay  *display);
 154 void        gdk_display_beep               (GdkDisplay  *display);
 155 void        gdk_display_sync               (GdkDisplay  *display);
 156 void        gdk_display_flush              (GdkDisplay  *display);
 157
 158 void        gdk_display_close              (GdkDisplay  *display);
 159
 160 GList *     gdk_display_list_devices       (GdkDisplay  *display);
 161
 162 GdkEvent* gdk_display_get_event  (GdkDisplay     *display);
 163 GdkEvent* gdk_display_peek_event (GdkDisplay     *display);
 164 void      gdk_display_put_event  (GdkDisplay     *display,
 165                                   const GdkEvent *event);
 166
 167 void gdk_display_add_client_message_filter (GdkDisplay   *display,
 168                                             GdkAtom       message_type,
 169                                             GdkFilterFunc func,
 170                                             gpointer      data);
 171
 172 void gdk_display_set_double_click_time     (GdkDisplay   *display,
 173                                             guint         msec);
 174 void gdk_display_set_double_click_distance (GdkDisplay   *display,
 175                                             guint         distance);
 176
 177 GdkDisplay *gdk_display_get_default (void);
 178
 179 GdkDevice  *gdk_display_get_core_pointer (GdkDisplay *display);
 180
 181 void             gdk_display_get_pointer           (GdkDisplay             *display,
 182                                                     GdkScreen             **screen,
 183                                                     gint                   *x,
 184                                                     gint                   *y,
 185                                                     GdkModifierType        *mask);
 186 GdkWindow *      gdk_display_get_window_at_pointer (GdkDisplay             *display,
 187                                                     gint                   *win_x,
 188                                                     gint                   *win_y);
 189 void             gdk_display_warp_pointer          (GdkDisplay             *display,
 190                                                     GdkScreen              *screen,
 191                                                     gint                   x,
 192                                                     gint                   y);
 193
 194 GdkDisplayPointerHooks *gdk_display_set_pointer_hooks (GdkDisplay                   *display,
 195                                                        const GdkDisplayPointerHooks *new_hooks);
 196
 197 GdkDisplay *gdk_display_open_default_libgtk_only (void);
 198
 199 gboolean gdk_display_supports_cursor_alpha     (GdkDisplay    *display);
 200 gboolean gdk_display_supports_cursor_color     (GdkDisplay    *display);
 201 guint    gdk_display_get_default_cursor_size   (GdkDisplay    *display);
 202 void     gdk_display_get_maximal_cursor_size   (GdkDisplay    *display,
 203                                                 guint         *width,
 204                                                 guint         *height);
 205
 206 GdkWindow *gdk_display_get_default_group       (GdkDisplay *display);
 207
 208 gboolean gdk_display_supports_selection_notification (GdkDisplay *display);
 209 gboolean gdk_display_request_selection_notification  (GdkDisplay *display,
 210                                                       GdkAtom     selection);
 211
 212 gboolean gdk_display_supports_clipboard_persistence (GdkDisplay    *display);
 213 void     gdk_display_store_clipboard                (GdkDisplay    *display,
 214                                                      GdkWindow     *clipboard_window,
 215                                                      guint32        time_,
 216                                                      const GdkAtom *targets,
 217                                                      gint           n_targets);
 218
 219 gboolean gdk_display_supports_shapes           (GdkDisplay    *display);
 220 gboolean gdk_display_supports_input_shapes     (GdkDisplay    *display);
 221 gboolean gdk_display_supports_composite        (GdkDisplay    *display);
 222
 223 G_END_DECLS
 224
 225 #endif  /* __GDK_DISPLAY_H__ */