]> Pileus Git - ~andy/gtk/blob - gdk/gdkdisplayprivate.h
gdk: Allow display subclasses to override the type used for windows
[~andy/gtk] / gdk / gdkdisplayprivate.h
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 2010 Red Hat, Inc.
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 #ifndef __GDK_DISPLAY_PRIVATE_H__
21 #define __GDK_DISPLAY_PRIVATE_H__
22
23 #include "gdkdisplay.h"
24 #include "gdkwindow.h"
25 #include "gdkcursor.h"
26
27 G_BEGIN_DECLS
28
29 typedef struct _GdkDisplayClass GdkDisplayClass;
30
31 /* Tracks information about the keyboard grab on this display */
32 typedef struct
33 {
34   GdkWindow *window;
35   GdkWindow *native_window;
36   gulong serial;
37   gboolean owner_events;
38   guint32 time;
39 } GdkKeyboardGrabInfo;
40
41 /* Tracks information about the pointer grab on this display */
42 typedef struct
43 {
44   GdkWindow *window;
45   GdkWindow *native_window;
46   gulong serial_start;
47   gulong serial_end; /* exclusive, i.e. not active on serial_end */
48   gboolean owner_events;
49   guint event_mask;
50   gboolean implicit;
51   guint32 time;
52   GdkGrabOwnership ownership;
53
54   guint activated : 1;
55   guint implicit_ungrab : 1;
56 } GdkDeviceGrabInfo;
57
58 /* Tracks information about which window and position the pointer last was in.
59  * This is useful when we need to synthesize events later.
60  * Note that we track toplevel_under_pointer using enter/leave events,
61  * so in the case of a grab, either with owner_events==FALSE or with the
62  * pointer in no clients window the x/y coordinates may actually be outside
63  * the window.
64  */
65 typedef struct
66 {
67   GdkWindow *toplevel_under_pointer; /* toplevel window containing the pointer, */
68                                      /* tracked via native events */
69   GdkWindow *window_under_pointer;   /* window that last got a normal enter event */
70   gdouble toplevel_x, toplevel_y;
71   guint32 state;
72   guint32 button;
73 } GdkPointerWindowInfo;
74
75 typedef struct
76 {
77   guint32 button_click_time[2]; /* last 2 button click times */
78   GdkWindow *button_window[2];  /* last 2 windows to receive button presses */
79   gint button_number[2];        /* last 2 buttons to be pressed */
80   gint button_x[2];             /* last 2 button click positions */
81   gint button_y[2];
82 } GdkMultipleClickInfo;
83
84 struct _GdkDisplay
85 {
86   GObject parent_instance;
87
88   GList *queued_events;
89   GList *queued_tail;
90
91   /* Information for determining if the latest button click
92    * is part of a double-click or triple-click
93    */
94   GHashTable *multiple_click_info;
95   guint double_click_time;  /* Maximum time between clicks in msecs */
96   GdkDevice *core_pointer;  /* Core pointer device */
97
98   const GdkDisplayDeviceHooks *device_hooks; /* Hooks for querying pointer */
99
100   guint closed             : 1;  /* Whether this display has been closed */
101   guint ignore_core_events : 1;  /* Don't send core motion and button event */
102
103   guint double_click_distance;   /* Maximum distance between clicks in pixels */
104
105   GHashTable *device_grabs;
106   GHashTable *motion_hint_info;
107
108   GHashTable *pointers_info;  /* GdkPointerWindowInfo for each device */
109   guint32 last_event_time;    /* Last reported event time from server */
110
111   GdkDeviceManager *device_manager;
112 };
113
114 struct _GdkDisplayClass
115 {
116   GObjectClass parent_class;
117
118   GType window_type;          /* type for native windows for this display, set in class_init */
119
120   G_CONST_RETURN gchar *     (*get_name)           (GdkDisplay *display);
121   gint                       (*get_n_screens)      (GdkDisplay *display);
122   GdkScreen *                (*get_screen)         (GdkDisplay *display,
123                                                     gint        screen_num);
124   GdkScreen *                (*get_default_screen) (GdkDisplay *display);
125   void                       (*beep)               (GdkDisplay *display);
126   void                       (*sync)               (GdkDisplay *display);
127   void                       (*flush)              (GdkDisplay *display);
128   gboolean                   (*has_pending)        (GdkDisplay *display);
129   void                       (*queue_events)       (GdkDisplay *display);
130   GdkWindow *                (*get_default_group)  (GdkDisplay *display);
131   gboolean                   (*supports_selection_notification) (GdkDisplay *display);
132   gboolean                   (*request_selection_notification)  (GdkDisplay *display,
133                                                                  GdkAtom     selection);
134   gboolean                   (*supports_shapes)       (GdkDisplay *display);
135   gboolean                   (*supports_input_shapes) (GdkDisplay *display);
136   gboolean                   (*supports_composite)    (GdkDisplay *display);
137   gboolean                   (*supports_cursor_alpha) (GdkDisplay *display);
138   gboolean                   (*supports_cursor_color) (GdkDisplay *display);
139
140   gboolean                   (*supports_clipboard_persistence)  (GdkDisplay *display);
141   void                       (*store_clipboard)    (GdkDisplay    *display,
142                                                     GdkWindow     *clipboard_window,
143                                                     guint32        time_,
144                                                     const GdkAtom *targets,
145                                                     gint           n_targets);
146
147   void                       (*get_default_cursor_size) (GdkDisplay *display,
148                                                          guint      *width,
149                                                          guint      *height);
150   void                       (*get_maximal_cursor_size) (GdkDisplay *display,
151                                                          guint      *width,
152                                                          guint      *height);
153   GdkCursor *                (*get_cursor_for_type)     (GdkDisplay    *display,
154                                                          GdkCursorType  type);
155   GdkCursor *                (*get_cursor_for_name)     (GdkDisplay    *display,
156                                                          const gchar   *name);
157   GdkCursor *                (*get_cursor_for_pixbuf)   (GdkDisplay    *display,
158                                                          GdkPixbuf     *pixbuf,
159                                                          gint           x,
160                                                          gint           y);
161
162   GList *                    (*list_devices)       (GdkDisplay *display);
163   gboolean                   (*send_client_message) (GdkDisplay     *display,
164                                                      GdkEvent       *event,
165                                                      GdkNativeWindow winid);
166   void                       (*add_client_message_filter) (GdkDisplay   *display,
167                                                            GdkAtom       message_type,
168                                                            GdkFilterFunc func,
169                                                            gpointer      data);
170   GdkAppLaunchContext *      (*get_app_launch_context) (GdkDisplay *display);
171   GdkNativeWindow            (*get_drag_protocol)      (GdkDisplay      *display,
172                                                         GdkNativeWindow  winid,
173                                                         GdkDragProtocol *protocol,
174                                                         guint           *version);
175
176   void                       (*before_process_all_updates) (GdkDisplay *display);
177   void                       (*after_process_all_updates)  (GdkDisplay *display);
178
179   gulong                     (*get_next_serial) (GdkDisplay *display);
180
181   void                       (*notify_startup_complete) (GdkDisplay  *display,
182                                                          const gchar *startup_id);
183   void                       (*event_data_copy) (GdkDisplay     *display,
184                                                  const GdkEvent *event,
185                                                  GdkEvent       *new_event);
186   void                       (*event_data_free) (GdkDisplay     *display,
187                                                  GdkEvent       *event);
188   void                       (*create_window_impl) (GdkDisplay    *display,
189                                                     GdkWindow     *window,
190                                                     GdkWindow     *real_parent,
191                                                     GdkScreen     *screen,
192                                                     GdkEventMask   event_mask,
193                                                     GdkWindowAttr *attributes,
194                                                     gint           attributes_mask);
195
196   GdkKeymap *                (*get_keymap)         (GdkDisplay    *display);
197   void                       (*push_error_trap)    (GdkDisplay    *display);
198   gint                       (*pop_error_trap)     (GdkDisplay    *display,
199                                                     gboolean       ignore);
200
201   GdkWindow *                (*get_selection_owner) (GdkDisplay   *display,
202                                                      GdkAtom       selection);
203   gboolean                   (*set_selection_owner) (GdkDisplay   *display,
204                                                      GdkWindow    *owner,
205                                                      GdkAtom       selection,
206                                                      guint32       time,
207                                                      gboolean      send_event);
208   void                       (*send_selection_notify) (GdkDisplay *dispay,
209                                                        GdkNativeWindow  requestor,
210                                                        GdkAtom          selection,
211                                                        GdkAtom          target,
212                                                        GdkAtom          property,
213                                                        guint32          time);
214   gint                       (*get_selection_property) (GdkDisplay  *display,
215                                                         GdkWindow   *requestor,
216                                                         guchar     **data,
217                                                         GdkAtom     *type,
218                                                         gint        *format);
219   void                       (*convert_selection)      (GdkDisplay  *display,
220                                                         GdkWindow   *requestor,
221                                                         GdkAtom      selection,
222                                                         GdkAtom      target,
223                                                         guint32      time);
224
225   gint                   (*text_property_to_utf8_list) (GdkDisplay     *display,
226                                                         GdkAtom         encoding,
227                                                         gint            format,
228                                                         const guchar   *text,
229                                                         gint            length,
230                                                         gchar        ***list);
231   gchar *                (*utf8_to_string_target)      (GdkDisplay     *display,
232                                                         const gchar    *text);
233
234   /* Signals */
235   void (*closed) (GdkDisplay *display,
236                   gboolean    is_error);
237 };
238
239
240 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay           *display,
241                                                GdkDevice            *device,
242                                                GdkPointerWindowInfo *device_info,
243                                                gpointer              user_data);
244
245 void                _gdk_display_device_grab_update   (GdkDisplay *display,
246                                                        GdkDevice  *device,
247                                                        GdkDevice  *source_device,
248                                                        gulong      current_serial);
249 GdkDeviceGrabInfo * _gdk_display_get_last_device_grab (GdkDisplay *display,
250                                                        GdkDevice  *device);
251 GdkDeviceGrabInfo * _gdk_display_add_device_grab      (GdkDisplay       *display,
252                                                        GdkDevice        *device,
253                                                        GdkWindow        *window,
254                                                        GdkWindow        *native_window,
255                                                        GdkGrabOwnership  grab_ownership,
256                                                        gboolean          owner_events,
257                                                        GdkEventMask      event_mask,
258                                                        gulong            serial_start,
259                                                        guint32           time,
260                                                        gboolean          implicit);
261 GdkDeviceGrabInfo * _gdk_display_has_device_grab      (GdkDisplay       *display,
262                                                        GdkDevice        *device,
263                                                        gulong            serial);
264 gboolean            _gdk_display_end_device_grab      (GdkDisplay       *display,
265                                                        GdkDevice        *device,
266                                                        gulong            serial,
267                                                        GdkWindow        *if_child,
268                                                        gboolean          implicit);
269 gboolean            _gdk_display_check_grab_ownership (GdkDisplay       *display,
270                                                        GdkDevice        *device,
271                                                        gulong            serial);
272 void                _gdk_display_enable_motion_hints  (GdkDisplay       *display,
273                                                        GdkDevice        *device);
274 GdkPointerWindowInfo * _gdk_display_get_pointer_info  (GdkDisplay       *display,
275                                                        GdkDevice        *device);
276 void                _gdk_display_pointer_info_foreach (GdkDisplay       *display,
277                                                        GdkDisplayPointerInfoForeach func,
278                                                        gpointer          user_data);
279 gulong              _gdk_display_get_next_serial      (GdkDisplay       *display);
280 void                _gdk_display_event_data_copy      (GdkDisplay       *display,
281                                                        const GdkEvent   *event,
282                                                        GdkEvent         *new_event);
283 void                _gdk_display_event_data_free      (GdkDisplay       *display,
284                                                        GdkEvent         *event);
285 void                _gdk_display_create_window_impl   (GdkDisplay       *display,
286                                                        GdkWindow        *window,
287                                                        GdkWindow        *real_parent,
288                                                        GdkScreen        *screen,
289                                                        GdkEventMask      event_mask,
290                                                        GdkWindowAttr    *attributes,
291                                                        gint              attributes_mask);
292 GdkWindow *         _gdk_display_create_window        (GdkDisplay       *display);
293
294 G_END_DECLS
295
296 #endif  /* __GDK_DISPLAY_PRIVATE_H__ */