4 * Copyright 2001 Sun Microsystems Inc.
6 * Erwann Chenede <erwann.chenede@sun.com>
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.
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.
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.
24 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
25 #error "Only <gdk/gdk.h> can be included directly."
28 #ifndef __GDK_DISPLAY_H__
29 #define __GDK_DISPLAY_H__
31 #include <gdk/gdktypes.h>
32 #include <gdk/gdkevents.h>
33 #include <gdk/gdkdevicemanager.h>
37 typedef struct _GdkDisplayClass GdkDisplayClass;
38 typedef struct _GdkDisplayPointerHooks GdkDisplayPointerHooks;
39 typedef struct _GdkDisplayDeviceHooks GdkDisplayDeviceHooks;
41 #define GDK_TYPE_DISPLAY (gdk_display_get_type ())
42 #define GDK_DISPLAY_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_DISPLAY, GdkDisplay))
43 #define GDK_DISPLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_DISPLAY, GdkDisplayClass))
44 #define GDK_IS_DISPLAY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_DISPLAY))
45 #define GDK_IS_DISPLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_DISPLAY))
46 #define GDK_DISPLAY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_DISPLAY, GdkDisplayClass))
48 /* Tracks information about the keyboard grab on this display */
52 GdkWindow *native_window;
54 gboolean owner_events;
56 } GdkKeyboardGrabInfo;
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
67 GdkWindow *toplevel_under_pointer; /* The toplevel window with mouse inside, tracked via native events */
68 GdkWindow *window_under_pointer; /* The window that last got sent a normal enter event */
69 gdouble toplevel_x, toplevel_y;
72 } GdkPointerWindowInfo;
76 guint32 button_click_time[2]; /* The last 2 button click times. */
77 GdkWindow *button_window[2]; /* The last 2 windows to receive button presses. */
78 gint button_number[2]; /* The last 2 buttons to be pressed. */
79 gint button_x[2]; /* The last 2 button click positions. */
81 } GdkMultipleClickInfo;
85 GObject parent_instance;
88 GList *GSEAL (queued_events);
89 GList *GSEAL (queued_tail);
91 /* Information for determining if the latest button click
92 * is part of a double-click or triple-click
94 GHashTable *GSEAL (multiple_click_info);
96 guint GSEAL (double_click_time); /* Maximum time between clicks in msecs */
97 GdkDevice *GSEAL (core_pointer); /* Core pointer device */
99 const GdkDisplayDeviceHooks *GSEAL (device_hooks); /* Current hooks for querying pointer */
101 guint GSEAL (closed) : 1; /* Whether this display has been closed */
102 guint GSEAL (ignore_core_events) : 1; /* Don't send core motion and button event */
104 guint GSEAL (double_click_distance); /* Maximum distance between clicks in pixels */
106 GHashTable *GSEAL (device_grabs);
107 GHashTable *GSEAL (motion_hint_info);
109 /* Hashtable containing a GdkPointerWindowInfo for each device */
110 GHashTable *GSEAL (pointers_info);
112 /* Last reported event time from server */
113 guint32 GSEAL (last_event_time);
115 /* Device manager associated to the display */
116 GdkDeviceManager *GSEAL (device_manager);
120 * GdkDisplayPointerHooks:
121 * @get_pointer: Obtains the current pointer position and modifier state.
122 * The position is given in coordinates relative to the screen containing
123 * the pointer, which is returned in @screen.
124 * @window_get_pointer: Obtains the window underneath the mouse pointer.
125 * Current pointer position and modifier state are returned in @x, @y and
126 * @mask. The position is given in coordinates relative to @window.
127 * @window_at_pointer: Obtains the window underneath the mouse pointer,
128 * returning the location of that window in @win_x, @win_y. Returns %NULL
129 * if the window under the mouse pointer is not known to GDK (for example,
130 * belongs to another application).
132 * A table of pointers to functions for getting quantities related to
133 * the current pointer position. Each #GdkDisplay has a table of this type,
134 * which can be set using gdk_display_set_pointer_hooks().
136 * This is only useful for such low-level tools as an event recorder.
137 * Applications should never have any reason to use this facility
141 struct _GdkDisplayPointerHooks
143 void (*get_pointer) (GdkDisplay *display,
147 GdkModifierType *mask);
148 GdkWindow* (*window_get_pointer) (GdkDisplay *display,
152 GdkModifierType *mask);
153 GdkWindow* (*window_at_pointer) (GdkDisplay *display,
159 * GdkDisplayDeviceHooks:
160 * @get_device_state: Obtains the current position and modifier state for
161 * @device. The position is given in coordinates relative to the window
162 * containing the pointer, which is returned in @window.
163 * @window_get_device_position: Obtains the window underneath the device
164 * position. Current device position and modifier state are returned in
165 * @x, @y and @mask. The position is given in coordinates relative to
167 * @window_at_device_position: Obtains the window underneath the device
168 * position, returning the location of that window in @win_x, @win_y.
169 * Returns %NULL if the window under the mouse pointer is not known to
170 * GDK (for example, belongs to another application).
172 * A table of pointers to functions for getting quantities related to
173 * the current device position. Each #GdkDisplay has a table of this type,
174 * which can be set using gdk_display_set_device_hooks().
176 struct _GdkDisplayDeviceHooks
178 void (* get_device_state) (GdkDisplay *display,
183 GdkModifierType *mask);
184 GdkWindow * (* window_get_device_position) (GdkDisplay *display,
189 GdkModifierType *mask);
190 GdkWindow * (* window_at_device_position) (GdkDisplay *display,
196 GType gdk_display_get_type (void) G_GNUC_CONST;
197 GdkDisplay *gdk_display_open (const gchar *display_name);
199 G_CONST_RETURN gchar * gdk_display_get_name (GdkDisplay *display);
201 gint gdk_display_get_n_screens (GdkDisplay *display);
202 GdkScreen * gdk_display_get_screen (GdkDisplay *display,
204 GdkScreen * gdk_display_get_default_screen (GdkDisplay *display);
206 #ifndef GDK_MULTIDEVICE_SAFE
207 void gdk_display_pointer_ungrab (GdkDisplay *display,
209 void gdk_display_keyboard_ungrab (GdkDisplay *display,
211 gboolean gdk_display_pointer_is_grabbed (GdkDisplay *display);
212 #endif /* GDK_MULTIDEVICE_SAFE */
214 gboolean gdk_display_device_is_grabbed (GdkDisplay *display,
216 void gdk_display_beep (GdkDisplay *display);
217 void gdk_display_sync (GdkDisplay *display);
218 void gdk_display_flush (GdkDisplay *display);
220 void gdk_display_close (GdkDisplay *display);
221 gboolean gdk_display_is_closed (GdkDisplay *display);
223 #ifndef GDK_DISABLE_DEPRECATED
224 GList * gdk_display_list_devices (GdkDisplay *display);
225 #endif /* GDK_DISABLE_DEPRECATED */
227 GdkEvent* gdk_display_get_event (GdkDisplay *display);
228 GdkEvent* gdk_display_peek_event (GdkDisplay *display);
229 void gdk_display_put_event (GdkDisplay *display,
230 const GdkEvent *event);
231 gboolean gdk_display_has_pending (GdkDisplay *display);
233 void gdk_display_add_client_message_filter (GdkDisplay *display,
234 GdkAtom message_type,
238 void gdk_display_set_double_click_time (GdkDisplay *display,
240 void gdk_display_set_double_click_distance (GdkDisplay *display,
243 GdkDisplay *gdk_display_get_default (void);
245 #ifndef GDK_MULTIDEVICE_SAFE
247 void gdk_display_get_pointer (GdkDisplay *display,
251 GdkModifierType *mask);
252 GdkWindow * gdk_display_get_window_at_pointer (GdkDisplay *display,
255 void gdk_display_warp_pointer (GdkDisplay *display,
259 #endif /* GDK_MULTIDEVICE_SAFE */
261 void gdk_display_get_device_state (GdkDisplay *display,
266 GdkModifierType *mask);
267 GdkWindow * gdk_display_get_window_at_device_position (GdkDisplay *display,
271 void gdk_display_warp_device (GdkDisplay *display,
277 #ifndef GDK_MULTIDEVICE_SAFE
278 GdkDisplayPointerHooks *gdk_display_set_pointer_hooks (GdkDisplay *display,
279 const GdkDisplayPointerHooks *new_hooks);
280 #endif /* GDK_MULTIDEVICE_SAFE */
282 GdkDisplayDeviceHooks *gdk_display_set_device_hooks (GdkDisplay *display,
283 const GdkDisplayDeviceHooks *new_hooks);
285 GdkDisplay *gdk_display_open_default_libgtk_only (void);
287 gboolean gdk_display_supports_cursor_alpha (GdkDisplay *display);
288 gboolean gdk_display_supports_cursor_color (GdkDisplay *display);
289 guint gdk_display_get_default_cursor_size (GdkDisplay *display);
290 void gdk_display_get_maximal_cursor_size (GdkDisplay *display,
294 GdkWindow *gdk_display_get_default_group (GdkDisplay *display);
296 gboolean gdk_display_supports_selection_notification (GdkDisplay *display);
297 gboolean gdk_display_request_selection_notification (GdkDisplay *display,
300 gboolean gdk_display_supports_clipboard_persistence (GdkDisplay *display);
301 void gdk_display_store_clipboard (GdkDisplay *display,
302 GdkWindow *clipboard_window,
304 const GdkAtom *targets,
307 gboolean gdk_display_supports_shapes (GdkDisplay *display);
308 gboolean gdk_display_supports_input_shapes (GdkDisplay *display);
309 gboolean gdk_display_supports_composite (GdkDisplay *display);
311 GdkDeviceManager * gdk_display_get_device_manager (GdkDisplay *display);
313 GdkAppLaunchContext *gdk_display_get_app_launch_context (GdkDisplay *display);
318 #endif /* __GDK_DISPLAY_H__ */