1 /* GDK - The GIMP Drawing Kit
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.
26 #include "gdkdisplay.h"
28 #include "gdkevents.h"
29 #include "gdkwindowimpl.h"
30 #include "gdkinternals.h"
31 #include "gdkmarshalers.h"
32 #include "gdkscreen.h"
40 * @Short_description: Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
43 * #GdkDisplay objects purpose are two fold:
46 * To grab/ungrab keyboard focus and mouse pointer
49 * To manage and provide information about the #GdkScreen(s)
50 * available for this #GdkDisplay
54 * #GdkDisplay objects are the GDK representation of the X Display which can be
55 * described as <emphasis>a workstation consisting of a keyboard a pointing
56 * device (such as a mouse) and one or more screens</emphasis>.
57 * It is used to open and keep track of various #GdkScreen objects currently
58 * instanciated by the application. It is also used to grab and release the keyboard
59 * and the mouse pointer.
69 static void gdk_display_dispose (GObject *object);
70 static void gdk_display_finalize (GObject *object);
72 static void multihead_get_device_state (GdkDisplay *display,
77 GdkModifierType *mask);
78 static GdkWindow * multihead_window_get_device_position (GdkDisplay *display,
83 GdkModifierType *mask);
84 static GdkWindow * multihead_window_at_device_position (GdkDisplay *display,
89 static void multihead_default_get_pointer (GdkDisplay *display,
93 GdkModifierType *mask);
94 static GdkWindow * multihead_default_window_get_pointer (GdkDisplay *display,
98 GdkModifierType *mask);
99 static GdkWindow * multihead_default_window_at_pointer (GdkDisplay *display,
104 static void singlehead_get_pointer (GdkDisplay *display,
108 GdkModifierType *mask);
109 static GdkWindow* singlehead_window_get_pointer (GdkDisplay *display,
113 GdkModifierType *mask);
114 static GdkWindow* singlehead_window_at_pointer (GdkDisplay *display,
118 static GdkWindow* singlehead_default_window_get_pointer (GdkWindow *window,
121 GdkModifierType *mask);
122 static GdkWindow* singlehead_default_window_at_pointer (GdkScreen *screen,
125 static GdkWindow *gdk_window_real_window_get_device_position (GdkDisplay *display,
130 GdkModifierType *mask);
131 static GdkWindow *gdk_display_real_get_window_at_device_position (GdkDisplay *display,
136 static guint signals[LAST_SIGNAL] = { 0 };
138 static char *gdk_sm_client_id;
140 static const GdkDisplayDeviceHooks default_device_hooks = {
141 _gdk_windowing_get_device_state,
142 gdk_window_real_window_get_device_position,
143 gdk_display_real_get_window_at_device_position
146 static const GdkDisplayDeviceHooks multihead_pointer_hooks = {
147 multihead_get_device_state,
148 multihead_window_get_device_position,
149 multihead_window_at_device_position
152 static const GdkDisplayPointerHooks multihead_default_pointer_hooks = {
153 multihead_default_get_pointer,
154 multihead_default_window_get_pointer,
155 multihead_default_window_at_pointer
158 static const GdkDisplayPointerHooks singlehead_pointer_hooks = {
159 singlehead_get_pointer,
160 singlehead_window_get_pointer,
161 singlehead_window_at_pointer
164 static const GdkPointerHooks singlehead_default_pointer_hooks = {
165 singlehead_default_window_get_pointer,
166 singlehead_default_window_at_pointer
169 static const GdkPointerHooks *singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
170 static const GdkDisplayPointerHooks *multihead_current_pointer_hooks = &multihead_default_pointer_hooks;
172 G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
175 gdk_display_class_init (GdkDisplayClass *class)
177 GObjectClass *object_class = G_OBJECT_CLASS (class);
179 object_class->finalize = gdk_display_finalize;
180 object_class->dispose = gdk_display_dispose;
183 * GdkDisplay::opened:
184 * @display: the object on which the signal is emitted
186 * The ::opened signal is emitted when the connection to the windowing
187 * system for @display is opened.
190 g_signal_new (g_intern_static_string ("opened"),
191 G_OBJECT_CLASS_TYPE (object_class),
194 g_cclosure_marshal_VOID__VOID,
198 * GdkDisplay::closed:
199 * @display: the object on which the signal is emitted
200 * @is_error: %TRUE if the display was closed due to an error
202 * The ::closed signal is emitted when the connection to the windowing
203 * system for @display is closed.
208 g_signal_new (g_intern_static_string ("closed"),
209 G_OBJECT_CLASS_TYPE (object_class),
211 G_STRUCT_OFFSET (GdkDisplayClass, closed),
213 _gdk_marshal_VOID__BOOLEAN,
220 free_pointer_info (GdkPointerWindowInfo *info)
222 g_object_unref (info->toplevel_under_pointer);
223 g_slice_free (GdkPointerWindowInfo, info);
227 free_device_grab (GdkDeviceGrabInfo *info)
229 g_object_unref (info->window);
230 g_object_unref (info->native_window);
235 free_device_grabs_foreach (gpointer key,
241 g_list_foreach (list, (GFunc) free_device_grab, NULL);
248 device_removed_cb (GdkDeviceManager *device_manager,
252 g_hash_table_remove (display->multiple_click_info, device);
253 g_hash_table_remove (display->device_grabs, device);
254 g_hash_table_remove (display->pointers_info, device);
256 /* FIXME: change core pointer and remove from device list */
260 gdk_display_opened (GdkDisplay *display)
262 GdkDeviceManager *device_manager;
264 device_manager = gdk_display_get_device_manager (display);
266 g_signal_connect (device_manager, "device-removed",
267 G_CALLBACK (device_removed_cb), display);
271 gdk_display_init (GdkDisplay *display)
273 _gdk_displays = g_slist_prepend (_gdk_displays, display);
275 display->double_click_time = 250;
276 display->double_click_distance = 5;
278 display->device_hooks = &default_device_hooks;
280 display->device_grabs = g_hash_table_new (NULL, NULL);
281 display->motion_hint_info = g_hash_table_new_full (NULL, NULL, NULL,
282 (GDestroyNotify) g_free);
284 display->pointers_info = g_hash_table_new_full (NULL, NULL, NULL,
285 (GDestroyNotify) free_pointer_info);
287 display->multiple_click_info = g_hash_table_new_full (NULL, NULL, NULL,
288 (GDestroyNotify) g_free);
290 g_signal_connect (display, "opened",
291 G_CALLBACK (gdk_display_opened), NULL);
295 gdk_display_dispose (GObject *object)
297 GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
298 GdkDeviceManager *device_manager;
300 device_manager = gdk_display_get_device_manager (GDK_DISPLAY_OBJECT (object));
302 g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
303 g_list_free (display->queued_events);
304 display->queued_events = NULL;
305 display->queued_tail = NULL;
307 _gdk_displays = g_slist_remove (_gdk_displays, object);
309 if (gdk_display_get_default () == display)
312 gdk_display_manager_set_default_display (gdk_display_manager_get(),
313 _gdk_displays->data);
315 gdk_display_manager_set_default_display (gdk_display_manager_get(),
321 /* this is to make it drop devices which may require using the X
322 * display and therefore can't be cleaned up in finalize.
323 * It will also disconnect device_removed_cb
325 g_object_run_dispose (G_OBJECT (display->device_manager));
328 G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
332 gdk_display_finalize (GObject *object)
334 GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
336 g_hash_table_foreach_remove (display->device_grabs,
337 free_device_grabs_foreach,
339 g_hash_table_destroy (display->device_grabs);
341 g_hash_table_destroy (display->pointers_info);
342 g_hash_table_destroy (display->multiple_click_info);
344 if (display->device_manager)
345 g_object_unref (display->device_manager);
347 G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
352 * @display: a #GdkDisplay
354 * Closes the connection to the windowing system for the given display,
355 * and cleans up associated resources.
360 gdk_display_close (GdkDisplay *display)
362 g_return_if_fail (GDK_IS_DISPLAY (display));
364 if (!display->closed)
366 display->closed = TRUE;
368 g_signal_emit (display, signals[CLOSED], 0, FALSE);
369 g_object_run_dispose (G_OBJECT (display));
371 g_object_unref (display);
376 * gdk_display_is_closed:
377 * @display: a #GdkDisplay
379 * Finds out if the display has been closed.
381 * Returns: %TRUE if the display is closed.
386 gdk_display_is_closed (GdkDisplay *display)
388 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
390 return display->closed;
394 * gdk_display_get_event:
395 * @display: a #GdkDisplay
397 * Gets the next #GdkEvent to be processed for @display, fetching events from the
398 * windowing system if necessary.
400 * Return value: the next #GdkEvent to be processed, or %NULL if no events
401 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
406 gdk_display_get_event (GdkDisplay *display)
408 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
410 _gdk_events_queue (display);
411 return _gdk_event_unqueue (display);
415 * gdk_display_peek_event:
416 * @display: a #GdkDisplay
418 * Gets a copy of the first #GdkEvent in the @display's event queue, without
419 * removing the event from the queue. (Note that this function will
420 * not get more events from the windowing system. It only checks the events
421 * that have already been moved to the GDK event queue.)
423 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL
424 * if no events are in the queue. The returned #GdkEvent should be freed with
430 gdk_display_peek_event (GdkDisplay *display)
434 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
436 tmp_list = _gdk_event_queue_find_first (display);
439 return gdk_event_copy (tmp_list->data);
445 * gdk_display_put_event:
446 * @display: a #GdkDisplay
447 * @event: a #GdkEvent.
449 * Appends a copy of the given event onto the front of the event
450 * queue for @display.
455 gdk_display_put_event (GdkDisplay *display,
456 const GdkEvent *event)
458 g_return_if_fail (GDK_IS_DISPLAY (display));
459 g_return_if_fail (event != NULL);
461 _gdk_event_queue_append (display, gdk_event_copy (event));
462 /* If the main loop is blocking in a different thread, wake it up */
463 g_main_context_wakeup (NULL);
467 * gdk_display_pointer_ungrab:
468 * @display: a #GdkDisplay.
469 * @time_: a timestap (e.g. %GDK_CURRENT_TIME).
471 * Release any pointer grab.
475 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
479 gdk_display_pointer_ungrab (GdkDisplay *display,
482 GdkDeviceManager *device_manager;
483 GList *devices, *dev;
486 g_return_if_fail (GDK_IS_DISPLAY (display));
488 device_manager = gdk_display_get_device_manager (display);
489 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
491 /* FIXME: Should this be generic to all backends? */
492 /* FIXME: What happens with extended devices? */
493 for (dev = devices; dev; dev = dev->next)
497 if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
500 gdk_device_ungrab (device, time_);
503 g_list_free (devices);
507 * gdk_pointer_ungrab:
508 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
509 * timestamp is available.
511 * Ungrabs the pointer on the default display, if it is grabbed by this
514 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
518 gdk_pointer_ungrab (guint32 time)
520 gdk_display_pointer_ungrab (gdk_display_get_default (), time);
524 * gdk_pointer_is_grabbed:
526 * Returns %TRUE if the pointer on the default display is currently
527 * grabbed by this application.
529 * Note that this does not take the inmplicit pointer grab on button
530 * presses into account.
532 * Return value: %TRUE if the pointer is currently grabbed by this application.
534 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
537 gdk_pointer_is_grabbed (void)
539 return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
543 * gdk_display_keyboard_ungrab:
544 * @display: a #GdkDisplay.
545 * @time_: a timestap (e.g #GDK_CURRENT_TIME).
547 * Release any keyboard grab
551 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
555 gdk_display_keyboard_ungrab (GdkDisplay *display,
558 GdkDeviceManager *device_manager;
559 GList *devices, *dev;
562 g_return_if_fail (GDK_IS_DISPLAY (display));
564 device_manager = gdk_display_get_device_manager (display);
565 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
567 /* FIXME: Should this be generic to all backends? */
568 /* FIXME: What happens with extended devices? */
569 for (dev = devices; dev; dev = dev->next)
573 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
576 gdk_device_ungrab (device, time);
579 g_list_free (devices);
583 * gdk_keyboard_ungrab:
584 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
585 * timestamp is available.
587 * Ungrabs the keyboard on the default display, if it is grabbed by this
590 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
594 gdk_keyboard_ungrab (guint32 time)
596 gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
602 * Emits a short beep on the default display.
607 gdk_display_beep (gdk_display_get_default ());
611 * gdk_event_send_client_message:
612 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
613 * @winid: the window to send the X ClientMessage event to.
615 * Sends an X ClientMessage event to a given window (which must be
616 * on the default #GdkDisplay.)
617 * This could be used for communicating between different applications,
618 * though the amount of data is limited to 20 bytes.
620 * Return value: non-zero on success.
623 gdk_event_send_client_message (GdkEvent *event,
624 GdkNativeWindow winid)
626 g_return_val_if_fail (event != NULL, FALSE);
628 return gdk_event_send_client_message_for_display (gdk_display_get_default (),
633 * gdk_event_send_clientmessage_toall:
634 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
636 * Sends an X ClientMessage event to all toplevel windows on the default
639 * Toplevel windows are determined by checking for the WM_STATE property, as
640 * described in the Inter-Client Communication Conventions Manual (ICCCM).
641 * If no windows are found with the WM_STATE property set, the message is sent
642 * to all children of the root window.
645 gdk_event_send_clientmessage_toall (GdkEvent *event)
647 g_return_if_fail (event != NULL);
649 gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
653 * gdk_set_sm_client_id:
654 * @sm_client_id: the client id assigned by the session manager when the
655 * connection was opened, or %NULL to remove the property.
657 * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
658 * the window manager can save the application's state using the X11R6 ICCCM
659 * session management protocol.
661 * See the X Session Management Library documentation for more information on
662 * session management and the Inter-Client Communication Conventions Manual
663 * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property.
664 * (Both documents are part of the X Window System distribution.)
667 gdk_set_sm_client_id (const gchar* sm_client_id)
669 GSList *displays, *tmp_list;
671 g_free (gdk_sm_client_id);
672 gdk_sm_client_id = g_strdup (sm_client_id);
674 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
675 for (tmp_list = displays; tmp_list; tmp_list = tmp_list->next)
676 _gdk_windowing_display_set_sm_client_id (tmp_list->data, sm_client_id);
678 g_slist_free (displays);
682 * _gdk_get_sm_client_id:
684 * Gets the client ID set with gdk_set_sm_client_id(), if any.
686 * Return value: Session ID, or %NULL if gdk_set_sm_client_id()
687 * has never been called.
690 _gdk_get_sm_client_id (void)
692 return gdk_sm_client_id;
696 _gdk_display_enable_motion_hints (GdkDisplay *display,
699 gulong *device_serial, serial;
701 device_serial = g_hash_table_lookup (display->motion_hint_info, device);
705 device_serial = g_new0 (gulong, 1);
706 *device_serial = G_MAXULONG;
707 g_hash_table_insert (display->motion_hint_info, device, device_serial);
710 if (*device_serial != 0)
712 serial = _gdk_windowing_window_get_next_serial (display);
713 /* We might not actually generate the next request, so
714 make sure this triggers always, this may cause it to
715 trigger slightly too early, but this is just a hint
719 if (serial < *device_serial)
720 *device_serial = serial;
725 * gdk_display_get_device_state:
726 * @display: a #GdkDisplay.
727 * @device: pointer device to query status about.
728 * @screen: (out) (transfer none) (allow-none): location to store the #GdkScreen
729 * the @device is on, or %NULL.
730 * @x: (out) (allow-none): location to store root window X coordinate of @device, or %NULL.
731 * @y: (out) (allow-none): location to store root window Y coordinate of @device, or %NULL.
732 * @mask: (out) (allow-none): location to store current modifier mask for @device, or %NULL.
734 * Gets the current location and state of @device for a given display.
739 gdk_display_get_device_state (GdkDisplay *display,
744 GdkModifierType *mask)
746 GdkScreen *tmp_screen;
748 GdkModifierType tmp_mask;
750 g_return_if_fail (GDK_IS_DISPLAY (display));
751 g_return_if_fail (GDK_IS_DEVICE (device));
752 g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
754 display->device_hooks->get_device_state (display, device, &tmp_screen, &tmp_x, &tmp_y, &tmp_mask);
757 *screen = tmp_screen;
767 * gdk_display_get_window_at_device_position:
768 * @display: a #GdkDisplay.
769 * @device: pointer #GdkDevice to query info to.
770 * @win_x: (out) (allow-none): return location for the X coordinate of the device location,
771 * relative to the window origin, or %NULL.
772 * @win_y: (out) (allow-none): return location for the Y coordinate of the device location,
773 * relative to the window origin, or %NULL.
775 * Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns
776 * %NULL if the window tree under @device is not known to GDK (for example, belongs to another application).
778 * Returns: (transfer none): the #GdkWindow under the device position, or %NULL.
783 gdk_display_get_window_at_device_position (GdkDisplay *display,
791 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
792 g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
793 g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
795 window = display->device_hooks->window_at_device_position (display, device, &tmp_x, &tmp_y);
806 * gdk_display_set_device_hooks:
807 * @display: a #GdkDisplay.
808 * @new_hooks: (allow-none): a table of pointers to functions for getting quantities related
809 * to all devices position, or %NULL to restore the default table.
811 * This function allows for hooking into the operation of getting the current location of any
812 * #GdkDevice on a particular #GdkDisplay. This is only useful for such low-level tools as
813 * an event recorder. Applications should never have any reason to use this facility.
815 * Returns: (transfer none): The previous device hook table.
819 GdkDisplayDeviceHooks *
820 gdk_display_set_device_hooks (GdkDisplay *display,
821 const GdkDisplayDeviceHooks *new_hooks)
823 const GdkDisplayDeviceHooks *result;
825 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
826 result = display->device_hooks;
829 display->device_hooks = new_hooks;
831 display->device_hooks = &default_device_hooks;
833 return (GdkDisplayDeviceHooks *) result;
837 * gdk_display_get_pointer:
838 * @display: a #GdkDisplay
839 * @screen: (allow-none): location to store the screen that the
840 * cursor is on, or %NULL.
841 * @x: (out) (allow-none): location to store root window X coordinate of pointer, or %NULL.
842 * @y: (out) (allow-none): location to store root window Y coordinate of pointer, or %NULL.
843 * @mask: (out) (allow-none): location to store current modifier mask, or %NULL
845 * Gets the current location of the pointer and the current modifier
846 * mask for a given display.
850 * Deprecated: 3.0: Use gdk_display_get_device_state() instead.
853 gdk_display_get_pointer (GdkDisplay *display,
857 GdkModifierType *mask)
859 g_return_if_fail (GDK_IS_DISPLAY (display));
861 gdk_display_get_device_state (display, display->core_pointer, screen, x, y, mask);
865 gdk_display_real_get_window_at_device_position (GdkDisplay *display,
873 window = _gdk_windowing_window_at_device_position (display, device, &x, &y, NULL, FALSE);
875 /* This might need corrections, as the native window returned
876 may contain client side children */
881 window = _gdk_window_find_descendant_at (window,
884 x = floor (xx + 0.5);
885 y = floor (yy + 0.5);
895 gdk_window_real_window_get_device_position (GdkDisplay *display,
900 GdkModifierType *mask)
903 GdkModifierType tmp_mask;
904 gboolean normal_child;
906 normal_child = GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_device_state (window,
910 /* We got the coords on the impl, convert to the window */
911 tmpx -= window->abs_x;
912 tmpy -= window->abs_y;
922 return _gdk_window_find_child_at (window, tmpx, tmpy);
927 * gdk_display_get_window_at_pointer:
928 * @display: a #GdkDisplay
929 * @win_x: (out) (allow-none): return location for x coordinate of the pointer location relative
930 * to the window origin, or %NULL
931 * @win_y: (out) (allow-none): return location for y coordinate of the pointer location relative
932 & to the window origin, or %NULL
934 * Obtains the window underneath the mouse pointer, returning the location
935 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL
936 * if the window under the mouse pointer is not known to GDK (for example,
937 * belongs to another application).
939 * Returns: (transfer none): the window under the mouse pointer, or %NULL
943 * Deprecated: 3.0: Use gdk_display_get_window_at_device_position() instead.
946 gdk_display_get_window_at_pointer (GdkDisplay *display,
950 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
952 return gdk_display_get_window_at_device_position (display, display->core_pointer, win_x, win_y);
956 multihead_get_device_state (GdkDisplay *display,
961 GdkModifierType *mask)
963 multihead_current_pointer_hooks->get_pointer (display, screen, x, y, mask);
967 multihead_window_get_device_position (GdkDisplay *display,
972 GdkModifierType *mask)
974 return multihead_current_pointer_hooks->window_get_pointer (display, window, x, y, mask);
978 multihead_window_at_device_position (GdkDisplay *display,
983 return multihead_current_pointer_hooks->window_at_pointer (display, win_x, win_y);
987 multihead_default_get_pointer (GdkDisplay *display,
991 GdkModifierType *mask)
993 return _gdk_windowing_get_device_state (display,
994 display->core_pointer,
999 multihead_default_window_get_pointer (GdkDisplay *display,
1003 GdkModifierType *mask)
1005 return gdk_window_real_window_get_device_position (display,
1006 display->core_pointer,
1007 window, x, y, mask);
1011 multihead_default_window_at_pointer (GdkDisplay *display,
1015 return gdk_display_real_get_window_at_device_position (display,
1016 display->core_pointer,
1021 * gdk_display_set_pointer_hooks:
1022 * @display: a #GdkDisplay
1023 * @new_hooks: (allow-none): a table of pointers to functions for getting
1024 * quantities related to the current pointer position,
1025 * or %NULL to restore the default table.
1027 * This function allows for hooking into the operation
1028 * of getting the current location of the pointer on a particular
1029 * display. This is only useful for such low-level tools as an
1030 * event recorder. Applications should never have any
1031 * reason to use this facility.
1033 * Return value: (transfer none): the previous pointer hook table
1037 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1039 GdkDisplayPointerHooks *
1040 gdk_display_set_pointer_hooks (GdkDisplay *display,
1041 const GdkDisplayPointerHooks *new_hooks)
1043 const GdkDisplayPointerHooks *result = multihead_current_pointer_hooks;
1045 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
1048 multihead_current_pointer_hooks = new_hooks;
1050 multihead_current_pointer_hooks = &multihead_default_pointer_hooks;
1052 gdk_display_set_device_hooks (display, &multihead_pointer_hooks);
1054 return (GdkDisplayPointerHooks *)result;
1058 singlehead_get_pointer (GdkDisplay *display,
1062 GdkModifierType *mask)
1064 GdkScreen *default_screen = gdk_display_get_default_screen (display);
1065 GdkWindow *root_window = gdk_screen_get_root_window (default_screen);
1067 *screen = default_screen;
1069 singlehead_current_pointer_hooks->get_pointer (root_window, x, y, mask);
1073 singlehead_window_get_pointer (GdkDisplay *display,
1077 GdkModifierType *mask)
1079 return singlehead_current_pointer_hooks->get_pointer (window, x, y, mask);
1083 singlehead_window_at_pointer (GdkDisplay *display,
1087 GdkScreen *default_screen = gdk_display_get_default_screen (display);
1089 return singlehead_current_pointer_hooks->window_at_pointer (default_screen,
1094 singlehead_default_window_get_pointer (GdkWindow *window,
1097 GdkModifierType *mask)
1099 GdkDisplay *display;
1101 display = gdk_window_get_display (window);
1103 return gdk_window_real_window_get_device_position (display,
1104 display->core_pointer,
1105 window, x, y, mask);
1109 singlehead_default_window_at_pointer (GdkScreen *screen,
1113 GdkDisplay *display;
1115 display = gdk_screen_get_display (screen);
1117 return gdk_display_real_get_window_at_device_position (display,
1118 display->core_pointer,
1123 * gdk_set_pointer_hooks:
1124 * @new_hooks: (allow-none): a table of pointers to functions for getting
1125 * quantities related to the current pointer position,
1126 * or %NULL to restore the default table.
1128 * This function allows for hooking into the operation
1129 * of getting the current location of the pointer. This
1130 * is only useful for such low-level tools as an
1131 * event recorder. Applications should never have any
1132 * reason to use this facility.
1134 * This function is not multihead safe. For multihead operation,
1135 * see gdk_display_set_pointer_hooks().
1137 * Return value: the previous pointer hook table
1139 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1142 gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
1144 const GdkPointerHooks *result = singlehead_current_pointer_hooks;
1147 singlehead_current_pointer_hooks = new_hooks;
1149 singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
1151 gdk_display_set_pointer_hooks (gdk_display_get_default (),
1152 &singlehead_pointer_hooks);
1154 return (GdkPointerHooks *)result;
1158 generate_grab_broken_event (GdkWindow *window,
1161 GdkWindow *grab_window)
1163 g_return_if_fail (window != NULL);
1165 if (!GDK_WINDOW_DESTROYED (window))
1169 event = gdk_event_new (GDK_GRAB_BROKEN);
1170 event->grab_broken.window = g_object_ref (window);
1171 event->grab_broken.send_event = FALSE;
1172 event->grab_broken.implicit = implicit;
1173 event->grab_broken.grab_window = grab_window;
1174 gdk_event_set_device (event, device);
1175 event->grab_broken.keyboard = (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD) ? TRUE : FALSE;
1177 gdk_event_put (event);
1178 gdk_event_free (event);
1183 _gdk_display_get_last_device_grab (GdkDisplay *display,
1188 l = g_hash_table_lookup (display->device_grabs, device);
1192 l = g_list_last (l);
1200 _gdk_display_add_device_grab (GdkDisplay *display,
1203 GdkWindow *native_window,
1204 GdkGrabOwnership grab_ownership,
1205 gboolean owner_events,
1206 GdkEventMask event_mask,
1207 unsigned long serial_start,
1211 GdkDeviceGrabInfo *info, *other_info;
1214 info = g_new0 (GdkDeviceGrabInfo, 1);
1216 info->window = g_object_ref (window);
1217 info->native_window = g_object_ref (native_window);
1218 info->serial_start = serial_start;
1219 info->serial_end = G_MAXULONG;
1220 info->owner_events = owner_events;
1221 info->event_mask = event_mask;
1223 info->implicit = implicit;
1224 info->ownership = grab_ownership;
1226 grabs = g_hash_table_lookup (display->device_grabs, device);
1228 /* Find the first grab that has a larger start time (if any) and insert
1229 * before that. I.E we insert after already existing grabs with same
1231 for (l = grabs; l != NULL; l = l->next)
1233 other_info = l->data;
1235 if (info->serial_start < other_info->serial_start)
1239 grabs = g_list_insert_before (grabs, l, info);
1241 /* Make sure the new grab end before next grab */
1244 other_info = l->data;
1245 info->serial_end = other_info->serial_start;
1248 /* Find any previous grab and update its end time */
1249 l = g_list_find (grabs, info);
1253 other_info = l->data;
1254 other_info->serial_end = serial_start;
1257 g_hash_table_insert (display->device_grabs, device, grabs);
1262 /* _gdk_synthesize_crossing_events only works inside one toplevel.
1263 This function splits things into two calls if needed, converting the
1264 coordinates to the right toplevel */
1266 synthesize_crossing_events (GdkDisplay *display,
1268 GdkDevice *source_device,
1269 GdkWindow *src_window,
1270 GdkWindow *dest_window,
1271 GdkCrossingMode crossing_mode,
1275 GdkWindow *src_toplevel, *dest_toplevel;
1276 GdkModifierType state;
1279 /* We use the native crossing events if all native */
1280 if (_gdk_native_windows)
1284 src_toplevel = gdk_window_get_toplevel (src_window);
1286 src_toplevel = NULL;
1288 dest_toplevel = gdk_window_get_toplevel (dest_window);
1290 dest_toplevel = NULL;
1292 if (src_toplevel == NULL && dest_toplevel == NULL)
1295 if (src_toplevel == NULL ||
1296 src_toplevel == dest_toplevel)
1298 /* Same toplevels */
1299 gdk_window_get_pointer (dest_toplevel,
1301 _gdk_synthesize_crossing_events (display,
1304 device, source_device,
1311 else if (dest_toplevel == NULL)
1313 gdk_window_get_pointer (src_toplevel,
1315 _gdk_synthesize_crossing_events (display,
1318 device, source_device,
1327 /* Different toplevels */
1328 gdk_window_get_pointer (src_toplevel,
1330 _gdk_synthesize_crossing_events (display,
1333 device, source_device,
1339 gdk_window_get_pointer (dest_toplevel,
1341 _gdk_synthesize_crossing_events (display,
1344 device, source_device,
1354 get_current_toplevel (GdkDisplay *display,
1358 GdkModifierType *state_out)
1360 GdkWindow *pointer_window;
1362 GdkModifierType state;
1364 pointer_window = _gdk_windowing_window_at_device_position (display, device, &x, &y, &state, TRUE);
1366 if (pointer_window != NULL &&
1367 (GDK_WINDOW_DESTROYED (pointer_window) ||
1368 GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_ROOT ||
1369 GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_FOREIGN))
1370 pointer_window = NULL;
1375 return pointer_window;
1379 switch_to_pointer_grab (GdkDisplay *display,
1381 GdkDevice *source_device,
1382 GdkDeviceGrabInfo *grab,
1383 GdkDeviceGrabInfo *last_grab,
1387 GdkWindow *src_window, *pointer_window, *new_toplevel;
1388 GdkPointerWindowInfo *info;
1390 GdkModifierType state;
1393 /* Temporarily unset pointer to make sure we send the crossing events below */
1394 old_grabs = g_hash_table_lookup (display->device_grabs, device);
1395 g_hash_table_steal (display->device_grabs, device);
1396 info = _gdk_display_get_pointer_info (display, device);
1400 /* New grab is in effect */
1402 /* We need to generate crossing events for the grab.
1403 * However, there are never any crossing events for implicit grabs
1404 * TODO: ... Actually, this could happen if the pointer window
1405 * doesn't have button mask so a parent gets the event...
1407 if (!grab->implicit)
1409 /* We send GRAB crossing events from the window under the pointer to the
1410 grab window. Except if there is an old grab then we start from that */
1412 src_window = last_grab->window;
1414 src_window = info->window_under_pointer;
1416 if (src_window != grab->window)
1417 synthesize_crossing_events (display, device, source_device,
1418 src_window, grab->window,
1419 GDK_CROSSING_GRAB, time, serial);
1421 /* !owner_event Grabbing a window that we're not inside, current status is
1422 now NULL (i.e. outside grabbed window) */
1423 if (!grab->owner_events && info->window_under_pointer != grab->window)
1424 _gdk_display_set_window_under_pointer (display, device, NULL);
1427 grab->activated = TRUE;
1432 new_toplevel = NULL;
1434 if (grab == NULL /* ungrab */ ||
1435 (!last_grab->owner_events && grab->owner_events) /* switched to owner_events */ )
1437 /* We force check what window we're in, and update the toplevel_under_pointer info,
1438 * as that won't get told of this change with toplevel enter events.
1440 if (info->toplevel_under_pointer)
1441 g_object_unref (info->toplevel_under_pointer);
1442 info->toplevel_under_pointer = NULL;
1444 new_toplevel = get_current_toplevel (display, device, &x, &y, &state);
1447 /* w is now toplevel and x,y in toplevel coords */
1448 info->toplevel_under_pointer = g_object_ref (new_toplevel);
1449 info->toplevel_x = x;
1450 info->toplevel_y = y;
1451 info->state = state;
1455 if (grab == NULL) /* Ungrabbed, send events */
1457 pointer_window = NULL;
1460 /* Find (possibly virtual) child window */
1462 _gdk_window_find_descendant_at (new_toplevel,
1467 if (pointer_window != last_grab->window)
1468 synthesize_crossing_events (display, device, source_device,
1469 last_grab->window, pointer_window,
1470 GDK_CROSSING_UNGRAB, time, serial);
1472 /* We're now ungrabbed, update the window_under_pointer */
1473 _gdk_display_set_window_under_pointer (display, device, pointer_window);
1477 g_hash_table_insert (display->device_grabs, device, old_grabs);
1481 _gdk_display_device_grab_update (GdkDisplay *display,
1483 GdkDevice *source_device,
1484 gulong current_serial)
1486 GdkDeviceGrabInfo *current_grab, *next_grab;
1490 time = display->last_event_time;
1491 grabs = g_hash_table_lookup (display->device_grabs, device);
1493 while (grabs != NULL)
1495 current_grab = grabs->data;
1497 if (current_grab->serial_start > current_serial)
1498 return; /* Hasn't started yet */
1500 if (current_grab->serial_end > current_serial)
1502 /* This one hasn't ended yet.
1503 its the currently active one or scheduled to be active */
1505 if (!current_grab->activated)
1507 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1508 switch_to_pointer_grab (display, device, source_device, current_grab, NULL, time, current_serial);
1517 /* This is the next active grab */
1518 next_grab = grabs->next->data;
1520 if (next_grab->serial_start > current_serial)
1521 next_grab = NULL; /* Actually its not yet active */
1524 if ((next_grab == NULL && current_grab->implicit_ungrab) ||
1525 (next_grab != NULL && current_grab->window != next_grab->window))
1526 generate_grab_broken_event (GDK_WINDOW (current_grab->window),
1528 current_grab->implicit,
1529 next_grab? next_grab->window : NULL);
1531 /* Remove old grab */
1532 grabs = g_list_delete_link (grabs, grabs);
1533 g_hash_table_insert (display->device_grabs, device, grabs);
1535 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1536 switch_to_pointer_grab (display, device, source_device,
1537 next_grab, current_grab,
1538 time, current_serial);
1540 free_device_grab (current_grab);
1545 grab_list_find (GList *grabs,
1548 GdkDeviceGrabInfo *grab;
1554 if (serial >= grab->serial_start && serial < grab->serial_end)
1557 grabs = grabs->next;
1564 find_device_grab (GdkDisplay *display,
1570 l = g_hash_table_lookup (display->device_grabs, device);
1571 return grab_list_find (l, serial);
1575 _gdk_display_has_device_grab (GdkDisplay *display,
1581 l = find_device_grab (display, device, serial);
1588 /* Returns true if last grab was ended
1589 * If if_child is non-NULL, end the grab only if the grabbed
1590 * window is the same as if_child or a descendant of it */
1592 _gdk_display_end_device_grab (GdkDisplay *display,
1595 GdkWindow *if_child,
1598 GdkDeviceGrabInfo *grab;
1601 l = find_device_grab (display, device, serial);
1608 (if_child == NULL ||
1609 _gdk_window_event_parent_of (if_child, grab->window)))
1611 grab->serial_end = serial;
1612 grab->implicit_ungrab = implicit;
1613 return l->next == NULL;
1619 /* Returns TRUE if device events are not blocked by any grab */
1621 _gdk_display_check_grab_ownership (GdkDisplay *display,
1625 GHashTableIter iter;
1626 gpointer key, value;
1627 GdkGrabOwnership higher_ownership, device_ownership;
1628 gboolean device_is_keyboard;
1630 g_hash_table_iter_init (&iter, display->device_grabs);
1631 higher_ownership = device_ownership = GDK_OWNERSHIP_NONE;
1632 device_is_keyboard = (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD);
1634 while (g_hash_table_iter_next (&iter, &key, &value))
1636 GdkDeviceGrabInfo *grab;
1642 grabs = grab_list_find (grabs, serial);
1647 /* Discard device if it's not of the same type */
1648 if ((device_is_keyboard && gdk_device_get_source (dev) != GDK_SOURCE_KEYBOARD) ||
1649 (!device_is_keyboard && gdk_device_get_source (dev) == GDK_SOURCE_KEYBOARD))
1655 device_ownership = grab->ownership;
1658 if (grab->ownership > higher_ownership)
1659 higher_ownership = grab->ownership;
1663 if (higher_ownership > device_ownership)
1665 /* There's a higher priority ownership
1666 * going on for other device(s)
1674 GdkPointerWindowInfo *
1675 _gdk_display_get_pointer_info (GdkDisplay *display,
1678 GdkPointerWindowInfo *info;
1680 if (G_UNLIKELY (!device))
1683 info = g_hash_table_lookup (display->pointers_info, device);
1685 if (G_UNLIKELY (!info))
1687 info = g_slice_new0 (GdkPointerWindowInfo);
1688 g_hash_table_insert (display->pointers_info, device, info);
1695 _gdk_display_pointer_info_foreach (GdkDisplay *display,
1696 GdkDisplayPointerInfoForeach func,
1699 GHashTableIter iter;
1700 gpointer key, value;
1702 g_hash_table_iter_init (&iter, display->pointers_info);
1704 while (g_hash_table_iter_next (&iter, &key, &value))
1706 GdkPointerWindowInfo *info = value;
1707 GdkDevice *device = key;
1709 (func) (display, device, info, user_data);
1714 * gdk_device_grab_info_libgtk_only:
1715 * @display: the display for which to get the grab information
1716 * @device: device to get the grab information from
1717 * @grab_window: (out) (transfer none): location to store current grab window
1718 * @owner_events: (out): location to store boolean indicating whether
1719 * the @owner_events flag to gdk_keyboard_grab() or
1720 * gdk_pointer_grab() was %TRUE.
1722 * Determines information about the current keyboard grab.
1723 * This is not public API and must not be used by applications.
1725 * Return value: %TRUE if this application currently has the
1729 gdk_device_grab_info_libgtk_only (GdkDisplay *display,
1731 GdkWindow **grab_window,
1732 gboolean *owner_events)
1734 GdkDeviceGrabInfo *info;
1736 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
1737 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
1739 info = _gdk_display_get_last_device_grab (display, device);
1744 *grab_window = info->window;
1746 *owner_events = info->owner_events;
1755 * gdk_display_pointer_is_grabbed:
1756 * @display: a #GdkDisplay
1758 * Test if the pointer is grabbed.
1760 * Returns: %TRUE if an active X pointer grab is in effect
1764 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
1767 gdk_display_pointer_is_grabbed (GdkDisplay *display)
1769 GdkDeviceManager *device_manager;
1770 GList *devices, *dev;
1773 g_return_val_if_fail (GDK_IS_DISPLAY (display), TRUE);
1775 device_manager = gdk_display_get_device_manager (display);
1776 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1778 for (dev = devices; dev; dev = dev->next)
1782 if (gdk_device_get_source (device) == GDK_SOURCE_MOUSE &&
1783 gdk_display_device_is_grabbed (display, device))
1791 * gdk_display_device_is_grabbed:
1792 * @display: a #GdkDisplay
1793 * @device: a #GdkDevice
1795 * Returns %TRUE if there is an ongoing grab on @device for @display.
1797 * Returns: %TRUE if there is a grab in effect for @device.
1800 gdk_display_device_is_grabbed (GdkDisplay *display,
1803 GdkDeviceGrabInfo *info;
1805 g_return_val_if_fail (GDK_IS_DISPLAY (display), TRUE);
1806 g_return_val_if_fail (GDK_IS_DEVICE (device), TRUE);
1808 /* What we're interested in is the steady state (ie last grab),
1809 because we're interested e.g. if we grabbed so that we
1810 can ungrab, even if our grab is not active just yet. */
1811 info = _gdk_display_get_last_device_grab (display, device);
1813 return (info && !info->implicit);
1817 * gdk_display_get_device_manager:
1818 * @display: a #GdkDisplay.
1820 * Returns the #GdkDeviceManager associated to @display.
1822 * Returns: (transfer none): A #GdkDeviceManager, or %NULL. This memory is
1823 * owned by GDK and must not be freed or unreferenced.
1828 gdk_display_get_device_manager (GdkDisplay *display)
1830 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
1832 return display->device_manager;