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"
27 #include "gdkdisplayprivate.h"
29 #include "gdkdeviceprivate.h"
30 #include "gdkevents.h"
31 #include "gdkwindowimpl.h"
32 #include "gdkinternals.h"
33 #include "gdkmarshalers.h"
34 #include "gdkscreen.h"
41 * @Short_description: Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
44 * #GdkDisplay objects purpose are two fold:
47 * To grab/ungrab keyboard focus and mouse pointer
50 * To manage and provide information about the #GdkScreen(s)
51 * available for this #GdkDisplay
55 * #GdkDisplay objects are the GDK representation of the X Display which can be
56 * described as <emphasis>a workstation consisting of a keyboard a pointing
57 * device (such as a mouse) and one or more screens</emphasis>.
58 * It is used to open and keep track of various #GdkScreen objects currently
59 * instanciated by the application. It is also used to grab and release the keyboard
60 * and the mouse pointer.
70 static void gdk_display_dispose (GObject *object);
71 static void gdk_display_finalize (GObject *object);
74 static GdkAppLaunchContext *gdk_display_real_get_app_launch_context (GdkDisplay *display);
76 static guint signals[LAST_SIGNAL] = { 0 };
78 G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
81 gdk_display_class_init (GdkDisplayClass *class)
83 GObjectClass *object_class = G_OBJECT_CLASS (class);
85 object_class->finalize = gdk_display_finalize;
86 object_class->dispose = gdk_display_dispose;
88 class->get_app_launch_context = gdk_display_real_get_app_launch_context;
89 class->window_type = GDK_TYPE_WINDOW;
93 * @display: the object on which the signal is emitted
95 * The ::opened signal is emitted when the connection to the windowing
96 * system for @display is opened.
99 g_signal_new (g_intern_static_string ("opened"),
100 G_OBJECT_CLASS_TYPE (object_class),
103 g_cclosure_marshal_VOID__VOID,
107 * GdkDisplay::closed:
108 * @display: the object on which the signal is emitted
109 * @is_error: %TRUE if the display was closed due to an error
111 * The ::closed signal is emitted when the connection to the windowing
112 * system for @display is closed.
117 g_signal_new (g_intern_static_string ("closed"),
118 G_OBJECT_CLASS_TYPE (object_class),
120 G_STRUCT_OFFSET (GdkDisplayClass, closed),
122 _gdk_marshal_VOID__BOOLEAN,
129 free_pointer_info (GdkPointerWindowInfo *info)
131 g_object_unref (info->toplevel_under_pointer);
132 g_slice_free (GdkPointerWindowInfo, info);
136 free_device_grab (GdkDeviceGrabInfo *info)
138 g_object_unref (info->window);
139 g_object_unref (info->native_window);
144 free_device_grabs_foreach (gpointer key,
150 g_list_foreach (list, (GFunc) free_device_grab, NULL);
157 device_removed_cb (GdkDeviceManager *device_manager,
161 g_hash_table_remove (display->multiple_click_info, device);
162 g_hash_table_remove (display->device_grabs, device);
163 g_hash_table_remove (display->pointers_info, device);
165 /* FIXME: change core pointer and remove from device list */
169 gdk_display_opened (GdkDisplay *display)
171 GdkDeviceManager *device_manager;
173 device_manager = gdk_display_get_device_manager (display);
175 g_signal_connect (device_manager, "device-removed",
176 G_CALLBACK (device_removed_cb), display);
180 gdk_display_init (GdkDisplay *display)
182 display->double_click_time = 250;
183 display->double_click_distance = 5;
185 display->device_grabs = g_hash_table_new (NULL, NULL);
186 display->motion_hint_info = g_hash_table_new_full (NULL, NULL, NULL,
187 (GDestroyNotify) g_free);
189 display->pointers_info = g_hash_table_new_full (NULL, NULL, NULL,
190 (GDestroyNotify) free_pointer_info);
192 display->multiple_click_info = g_hash_table_new_full (NULL, NULL, NULL,
193 (GDestroyNotify) g_free);
195 g_signal_connect (display, "opened",
196 G_CALLBACK (gdk_display_opened), NULL);
200 gdk_display_dispose (GObject *object)
202 GdkDisplay *display = GDK_DISPLAY (object);
203 GdkDeviceManager *device_manager;
205 device_manager = gdk_display_get_device_manager (GDK_DISPLAY (object));
207 g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
208 g_list_free (display->queued_events);
209 display->queued_events = NULL;
210 display->queued_tail = NULL;
214 /* this is to make it drop devices which may require using the X
215 * display and therefore can't be cleaned up in finalize.
216 * It will also disconnect device_removed_cb
218 g_object_run_dispose (G_OBJECT (display->device_manager));
221 G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
225 gdk_display_finalize (GObject *object)
227 GdkDisplay *display = GDK_DISPLAY (object);
229 g_hash_table_foreach_remove (display->device_grabs,
230 free_device_grabs_foreach,
232 g_hash_table_destroy (display->device_grabs);
234 g_hash_table_destroy (display->pointers_info);
235 g_hash_table_destroy (display->multiple_click_info);
237 if (display->device_manager)
238 g_object_unref (display->device_manager);
240 G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
245 * @display: a #GdkDisplay
247 * Closes the connection to the windowing system for the given display,
248 * and cleans up associated resources.
253 gdk_display_close (GdkDisplay *display)
255 g_return_if_fail (GDK_IS_DISPLAY (display));
257 if (!display->closed)
259 display->closed = TRUE;
261 g_signal_emit (display, signals[CLOSED], 0, FALSE);
262 g_object_run_dispose (G_OBJECT (display));
264 g_object_unref (display);
269 * gdk_display_is_closed:
270 * @display: a #GdkDisplay
272 * Finds out if the display has been closed.
274 * Returns: %TRUE if the display is closed.
279 gdk_display_is_closed (GdkDisplay *display)
281 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
283 return display->closed;
287 * gdk_display_get_event:
288 * @display: a #GdkDisplay
290 * Gets the next #GdkEvent to be processed for @display, fetching events from the
291 * windowing system if necessary.
293 * Return value: the next #GdkEvent to be processed, or %NULL if no events
294 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
299 gdk_display_get_event (GdkDisplay *display)
301 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
303 GDK_DISPLAY_GET_CLASS (display)->queue_events (display);
304 return _gdk_event_unqueue (display);
308 * gdk_display_peek_event:
309 * @display: a #GdkDisplay
311 * Gets a copy of the first #GdkEvent in the @display's event queue, without
312 * removing the event from the queue. (Note that this function will
313 * not get more events from the windowing system. It only checks the events
314 * that have already been moved to the GDK event queue.)
316 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL
317 * if no events are in the queue. The returned #GdkEvent should be freed with
323 gdk_display_peek_event (GdkDisplay *display)
327 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
329 tmp_list = _gdk_event_queue_find_first (display);
332 return gdk_event_copy (tmp_list->data);
338 * gdk_display_put_event:
339 * @display: a #GdkDisplay
340 * @event: a #GdkEvent.
342 * Appends a copy of the given event onto the front of the event
343 * queue for @display.
348 gdk_display_put_event (GdkDisplay *display,
349 const GdkEvent *event)
351 g_return_if_fail (GDK_IS_DISPLAY (display));
352 g_return_if_fail (event != NULL);
354 _gdk_event_queue_append (display, gdk_event_copy (event));
355 /* If the main loop is blocking in a different thread, wake it up */
356 g_main_context_wakeup (NULL);
360 * gdk_display_pointer_ungrab:
361 * @display: a #GdkDisplay.
362 * @time_: a timestap (e.g. %GDK_CURRENT_TIME).
364 * Release any pointer grab.
368 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
372 gdk_display_pointer_ungrab (GdkDisplay *display,
375 GdkDeviceManager *device_manager;
376 GList *devices, *dev;
379 g_return_if_fail (GDK_IS_DISPLAY (display));
381 device_manager = gdk_display_get_device_manager (display);
382 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
384 /* FIXME: Should this be generic to all backends? */
385 /* FIXME: What happens with extended devices? */
386 for (dev = devices; dev; dev = dev->next)
390 if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
393 gdk_device_ungrab (device, time_);
396 g_list_free (devices);
400 * gdk_pointer_ungrab:
401 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
402 * timestamp is available.
404 * Ungrabs the pointer on the default display, if it is grabbed by this
407 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
411 gdk_pointer_ungrab (guint32 time)
413 gdk_display_pointer_ungrab (gdk_display_get_default (), time);
417 * gdk_pointer_is_grabbed:
419 * Returns %TRUE if the pointer on the default display is currently
420 * grabbed by this application.
422 * Note that this does not take the inmplicit pointer grab on button
423 * presses into account.
425 * Return value: %TRUE if the pointer is currently grabbed by this application.
427 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
430 gdk_pointer_is_grabbed (void)
432 return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
436 * gdk_display_keyboard_ungrab:
437 * @display: a #GdkDisplay.
438 * @time_: a timestap (e.g #GDK_CURRENT_TIME).
440 * Release any keyboard grab
444 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
448 gdk_display_keyboard_ungrab (GdkDisplay *display,
451 GdkDeviceManager *device_manager;
452 GList *devices, *dev;
455 g_return_if_fail (GDK_IS_DISPLAY (display));
457 device_manager = gdk_display_get_device_manager (display);
458 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
460 /* FIXME: Should this be generic to all backends? */
461 /* FIXME: What happens with extended devices? */
462 for (dev = devices; dev; dev = dev->next)
466 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
469 gdk_device_ungrab (device, time);
472 g_list_free (devices);
476 * gdk_keyboard_ungrab:
477 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
478 * timestamp is available.
480 * Ungrabs the keyboard on the default display, if it is grabbed by this
483 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
487 gdk_keyboard_ungrab (guint32 time)
489 gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
495 * Emits a short beep on the default display.
500 gdk_display_beep (gdk_display_get_default ());
506 * Flushes the output buffers of all display connections and waits
507 * until all requests have been processed.
508 * This is rarely needed by applications.
515 list = gdk_display_manager_list_displays (gdk_display_manager_get ());
516 for (l = list; l; l = l->next)
518 GdkDisplay *display = l->data;
520 GDK_DISPLAY_GET_CLASS (display)->sync (display);
527 * gdk_event_send_client_message:
528 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
529 * @winid: the window to send the X ClientMessage event to.
531 * Sends an X ClientMessage event to a given window (which must be
532 * on the default #GdkDisplay.)
533 * This could be used for communicating between different applications,
534 * though the amount of data is limited to 20 bytes.
536 * Return value: non-zero on success.
539 gdk_event_send_client_message (GdkEvent *event,
540 GdkNativeWindow winid)
542 g_return_val_if_fail (event != NULL, FALSE);
544 return gdk_event_send_client_message_for_display (gdk_display_get_default (),
549 * gdk_event_send_clientmessage_toall:
550 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
552 * Sends an X ClientMessage event to all toplevel windows on the default
555 * Toplevel windows are determined by checking for the WM_STATE property, as
556 * described in the Inter-Client Communication Conventions Manual (ICCCM).
557 * If no windows are found with the WM_STATE property set, the message is sent
558 * to all children of the root window.
561 gdk_event_send_clientmessage_toall (GdkEvent *event)
563 g_return_if_fail (event != NULL);
565 gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
569 _gdk_display_enable_motion_hints (GdkDisplay *display,
572 gulong *device_serial, serial;
574 device_serial = g_hash_table_lookup (display->motion_hint_info, device);
578 device_serial = g_new0 (gulong, 1);
579 *device_serial = G_MAXULONG;
580 g_hash_table_insert (display->motion_hint_info, device, device_serial);
583 if (*device_serial != 0)
585 serial = _gdk_display_get_next_serial (display);
586 /* We might not actually generate the next request, so
587 make sure this triggers always, this may cause it to
588 trigger slightly too early, but this is just a hint
592 if (serial < *device_serial)
593 *device_serial = serial;
598 * gdk_display_get_pointer:
599 * @display: a #GdkDisplay
600 * @screen: (allow-none): location to store the screen that the
601 * cursor is on, or %NULL.
602 * @x: (out) (allow-none): location to store root window X coordinate of pointer, or %NULL.
603 * @y: (out) (allow-none): location to store root window Y coordinate of pointer, or %NULL.
604 * @mask: (out) (allow-none): location to store current modifier mask, or %NULL
606 * Gets the current location of the pointer and the current modifier
607 * mask for a given display.
611 * Deprecated: 3.0: Use gdk_device_get_position() instead.
614 gdk_display_get_pointer (GdkDisplay *display,
618 GdkModifierType *mask)
620 GdkScreen *default_screen;
623 GdkModifierType tmp_mask;
625 g_return_if_fail (GDK_IS_DISPLAY (display));
627 if (gdk_display_is_closed (display))
630 default_screen = gdk_display_get_default_screen (display);
632 /* We call _gdk_device_query_state() here manually instead of
633 * gdk_device_get_position() because we care about the modifier mask */
635 _gdk_device_query_state (display->core_pointer,
636 gdk_screen_get_root_window (default_screen),
643 *screen = gdk_window_get_screen (root);
653 * gdk_display_get_window_at_pointer:
654 * @display: a #GdkDisplay
655 * @win_x: (out) (allow-none): return location for x coordinate of the pointer location relative
656 * to the window origin, or %NULL
657 * @win_y: (out) (allow-none): return location for y coordinate of the pointer location relative
658 & to the window origin, or %NULL
660 * Obtains the window underneath the mouse pointer, returning the location
661 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL
662 * if the window under the mouse pointer is not known to GDK (for example,
663 * belongs to another application).
665 * Returns: (transfer none): the window under the mouse pointer, or %NULL
669 * Deprecated: 3.0: Use gdk_device_get_window_at_position() instead.
672 gdk_display_get_window_at_pointer (GdkDisplay *display,
676 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
678 return gdk_device_get_window_at_position (display->core_pointer, win_x, win_y);
682 generate_grab_broken_event (GdkWindow *window,
685 GdkWindow *grab_window)
687 g_return_if_fail (window != NULL);
689 if (!GDK_WINDOW_DESTROYED (window))
693 event = gdk_event_new (GDK_GRAB_BROKEN);
694 event->grab_broken.window = g_object_ref (window);
695 event->grab_broken.send_event = FALSE;
696 event->grab_broken.implicit = implicit;
697 event->grab_broken.grab_window = grab_window;
698 gdk_event_set_device (event, device);
699 event->grab_broken.keyboard = (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD) ? TRUE : FALSE;
701 gdk_event_put (event);
702 gdk_event_free (event);
707 _gdk_display_get_last_device_grab (GdkDisplay *display,
712 l = g_hash_table_lookup (display->device_grabs, device);
724 _gdk_display_add_device_grab (GdkDisplay *display,
727 GdkWindow *native_window,
728 GdkGrabOwnership grab_ownership,
729 gboolean owner_events,
730 GdkEventMask event_mask,
731 unsigned long serial_start,
735 GdkDeviceGrabInfo *info, *other_info;
738 info = g_new0 (GdkDeviceGrabInfo, 1);
740 info->window = g_object_ref (window);
741 info->native_window = g_object_ref (native_window);
742 info->serial_start = serial_start;
743 info->serial_end = G_MAXULONG;
744 info->owner_events = owner_events;
745 info->event_mask = event_mask;
747 info->implicit = implicit;
748 info->ownership = grab_ownership;
750 grabs = g_hash_table_lookup (display->device_grabs, device);
752 /* Find the first grab that has a larger start time (if any) and insert
753 * before that. I.E we insert after already existing grabs with same
755 for (l = grabs; l != NULL; l = l->next)
757 other_info = l->data;
759 if (info->serial_start < other_info->serial_start)
763 grabs = g_list_insert_before (grabs, l, info);
765 /* Make sure the new grab end before next grab */
768 other_info = l->data;
769 info->serial_end = other_info->serial_start;
772 /* Find any previous grab and update its end time */
773 l = g_list_find (grabs, info);
777 other_info = l->data;
778 other_info->serial_end = serial_start;
781 g_hash_table_insert (display->device_grabs, device, grabs);
786 /* _gdk_synthesize_crossing_events only works inside one toplevel.
787 This function splits things into two calls if needed, converting the
788 coordinates to the right toplevel */
790 synthesize_crossing_events (GdkDisplay *display,
792 GdkDevice *source_device,
793 GdkWindow *src_window,
794 GdkWindow *dest_window,
795 GdkCrossingMode crossing_mode,
799 GdkWindow *src_toplevel, *dest_toplevel;
800 GdkModifierType state;
803 /* We use the native crossing events if all native */
804 if (_gdk_native_windows)
808 src_toplevel = gdk_window_get_toplevel (src_window);
812 dest_toplevel = gdk_window_get_toplevel (dest_window);
814 dest_toplevel = NULL;
816 if (src_toplevel == NULL && dest_toplevel == NULL)
819 if (src_toplevel == NULL ||
820 src_toplevel == dest_toplevel)
823 gdk_window_get_pointer (dest_toplevel,
825 _gdk_synthesize_crossing_events (display,
828 device, source_device,
835 else if (dest_toplevel == NULL)
837 gdk_window_get_pointer (src_toplevel,
839 _gdk_synthesize_crossing_events (display,
842 device, source_device,
851 /* Different toplevels */
852 gdk_window_get_pointer (src_toplevel,
854 _gdk_synthesize_crossing_events (display,
857 device, source_device,
863 gdk_window_get_pointer (dest_toplevel,
865 _gdk_synthesize_crossing_events (display,
868 device, source_device,
878 get_current_toplevel (GdkDisplay *display,
882 GdkModifierType *state_out)
884 GdkWindow *pointer_window;
886 GdkModifierType state;
888 pointer_window = _gdk_device_window_at_position (device, &x, &y, &state, TRUE);
890 if (pointer_window != NULL &&
891 (GDK_WINDOW_DESTROYED (pointer_window) ||
892 GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_ROOT ||
893 GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_FOREIGN))
894 pointer_window = NULL;
900 return pointer_window;
904 switch_to_pointer_grab (GdkDisplay *display,
906 GdkDevice *source_device,
907 GdkDeviceGrabInfo *grab,
908 GdkDeviceGrabInfo *last_grab,
912 GdkWindow *src_window, *pointer_window, *new_toplevel;
913 GdkPointerWindowInfo *info;
915 GdkModifierType state;
918 /* Temporarily unset pointer to make sure we send the crossing events below */
919 old_grabs = g_hash_table_lookup (display->device_grabs, device);
920 g_hash_table_steal (display->device_grabs, device);
921 info = _gdk_display_get_pointer_info (display, device);
925 /* New grab is in effect */
927 /* We need to generate crossing events for the grab.
928 * However, there are never any crossing events for implicit grabs
929 * TODO: ... Actually, this could happen if the pointer window
930 * doesn't have button mask so a parent gets the event...
934 /* We send GRAB crossing events from the window under the pointer to the
935 grab window. Except if there is an old grab then we start from that */
937 src_window = last_grab->window;
939 src_window = info->window_under_pointer;
941 if (src_window != grab->window)
942 synthesize_crossing_events (display, device, source_device,
943 src_window, grab->window,
944 GDK_CROSSING_GRAB, time, serial);
946 /* !owner_event Grabbing a window that we're not inside, current status is
947 now NULL (i.e. outside grabbed window) */
948 if (!grab->owner_events && info->window_under_pointer != grab->window)
949 _gdk_display_set_window_under_pointer (display, device, NULL);
952 grab->activated = TRUE;
959 if (grab == NULL /* ungrab */ ||
960 (!last_grab->owner_events && grab->owner_events) /* switched to owner_events */ )
962 /* We force check what window we're in, and update the toplevel_under_pointer info,
963 * as that won't get told of this change with toplevel enter events.
965 if (info->toplevel_under_pointer)
966 g_object_unref (info->toplevel_under_pointer);
967 info->toplevel_under_pointer = NULL;
969 new_toplevel = get_current_toplevel (display, device, &x, &y, &state);
972 /* w is now toplevel and x,y in toplevel coords */
973 info->toplevel_under_pointer = g_object_ref (new_toplevel);
974 info->toplevel_x = x;
975 info->toplevel_y = y;
980 if (grab == NULL) /* Ungrabbed, send events */
982 pointer_window = NULL;
985 /* Find (possibly virtual) child window */
987 _gdk_window_find_descendant_at (new_toplevel,
992 if (pointer_window != last_grab->window)
993 synthesize_crossing_events (display, device, source_device,
994 last_grab->window, pointer_window,
995 GDK_CROSSING_UNGRAB, time, serial);
997 /* We're now ungrabbed, update the window_under_pointer */
998 _gdk_display_set_window_under_pointer (display, device, pointer_window);
1002 g_hash_table_insert (display->device_grabs, device, old_grabs);
1006 _gdk_display_device_grab_update (GdkDisplay *display,
1008 GdkDevice *source_device,
1009 gulong current_serial)
1011 GdkDeviceGrabInfo *current_grab, *next_grab;
1015 time = display->last_event_time;
1016 grabs = g_hash_table_lookup (display->device_grabs, device);
1018 while (grabs != NULL)
1020 current_grab = grabs->data;
1022 if (current_grab->serial_start > current_serial)
1023 return; /* Hasn't started yet */
1025 if (current_grab->serial_end > current_serial)
1027 /* This one hasn't ended yet.
1028 its the currently active one or scheduled to be active */
1030 if (!current_grab->activated)
1032 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1033 switch_to_pointer_grab (display, device, source_device, current_grab, NULL, time, current_serial);
1042 /* This is the next active grab */
1043 next_grab = grabs->next->data;
1045 if (next_grab->serial_start > current_serial)
1046 next_grab = NULL; /* Actually its not yet active */
1049 if ((next_grab == NULL && current_grab->implicit_ungrab) ||
1050 (next_grab != NULL && current_grab->window != next_grab->window))
1051 generate_grab_broken_event (GDK_WINDOW (current_grab->window),
1053 current_grab->implicit,
1054 next_grab? next_grab->window : NULL);
1056 /* Remove old grab */
1057 grabs = g_list_delete_link (grabs, grabs);
1058 g_hash_table_insert (display->device_grabs, device, grabs);
1060 if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
1061 switch_to_pointer_grab (display, device, source_device,
1062 next_grab, current_grab,
1063 time, current_serial);
1065 free_device_grab (current_grab);
1070 grab_list_find (GList *grabs,
1073 GdkDeviceGrabInfo *grab;
1079 if (serial >= grab->serial_start && serial < grab->serial_end)
1082 grabs = grabs->next;
1089 find_device_grab (GdkDisplay *display,
1095 l = g_hash_table_lookup (display->device_grabs, device);
1096 return grab_list_find (l, serial);
1100 _gdk_display_has_device_grab (GdkDisplay *display,
1106 l = find_device_grab (display, device, serial);
1113 /* Returns true if last grab was ended
1114 * If if_child is non-NULL, end the grab only if the grabbed
1115 * window is the same as if_child or a descendant of it */
1117 _gdk_display_end_device_grab (GdkDisplay *display,
1120 GdkWindow *if_child,
1123 GdkDeviceGrabInfo *grab;
1126 l = find_device_grab (display, device, serial);
1133 (if_child == NULL ||
1134 _gdk_window_event_parent_of (if_child, grab->window)))
1136 grab->serial_end = serial;
1137 grab->implicit_ungrab = implicit;
1138 return l->next == NULL;
1144 /* Returns TRUE if device events are not blocked by any grab */
1146 _gdk_display_check_grab_ownership (GdkDisplay *display,
1150 GHashTableIter iter;
1151 gpointer key, value;
1152 GdkGrabOwnership higher_ownership, device_ownership;
1153 gboolean device_is_keyboard;
1155 g_hash_table_iter_init (&iter, display->device_grabs);
1156 higher_ownership = device_ownership = GDK_OWNERSHIP_NONE;
1157 device_is_keyboard = (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD);
1159 while (g_hash_table_iter_next (&iter, &key, &value))
1161 GdkDeviceGrabInfo *grab;
1167 grabs = grab_list_find (grabs, serial);
1172 /* Discard device if it's not of the same type */
1173 if ((device_is_keyboard && gdk_device_get_source (dev) != GDK_SOURCE_KEYBOARD) ||
1174 (!device_is_keyboard && gdk_device_get_source (dev) == GDK_SOURCE_KEYBOARD))
1180 device_ownership = grab->ownership;
1183 if (grab->ownership > higher_ownership)
1184 higher_ownership = grab->ownership;
1188 if (higher_ownership > device_ownership)
1190 /* There's a higher priority ownership
1191 * going on for other device(s)
1199 GdkPointerWindowInfo *
1200 _gdk_display_get_pointer_info (GdkDisplay *display,
1203 GdkPointerWindowInfo *info;
1205 if (G_UNLIKELY (!device))
1208 info = g_hash_table_lookup (display->pointers_info, device);
1210 if (G_UNLIKELY (!info))
1212 info = g_slice_new0 (GdkPointerWindowInfo);
1213 g_hash_table_insert (display->pointers_info, device, info);
1220 _gdk_display_pointer_info_foreach (GdkDisplay *display,
1221 GdkDisplayPointerInfoForeach func,
1224 GHashTableIter iter;
1225 gpointer key, value;
1227 g_hash_table_iter_init (&iter, display->pointers_info);
1229 while (g_hash_table_iter_next (&iter, &key, &value))
1231 GdkPointerWindowInfo *info = value;
1232 GdkDevice *device = key;
1234 (func) (display, device, info, user_data);
1239 * gdk_device_grab_info_libgtk_only:
1240 * @display: the display for which to get the grab information
1241 * @device: device to get the grab information from
1242 * @grab_window: (out) (transfer none): location to store current grab window
1243 * @owner_events: (out): location to store boolean indicating whether
1244 * the @owner_events flag to gdk_keyboard_grab() or
1245 * gdk_pointer_grab() was %TRUE.
1247 * Determines information about the current keyboard grab.
1248 * This is not public API and must not be used by applications.
1250 * Return value: %TRUE if this application currently has the
1254 gdk_device_grab_info_libgtk_only (GdkDisplay *display,
1256 GdkWindow **grab_window,
1257 gboolean *owner_events)
1259 GdkDeviceGrabInfo *info;
1261 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
1262 g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
1264 info = _gdk_display_get_last_device_grab (display, device);
1269 *grab_window = info->window;
1271 *owner_events = info->owner_events;
1280 * gdk_display_pointer_is_grabbed:
1281 * @display: a #GdkDisplay
1283 * Test if the pointer is grabbed.
1285 * Returns: %TRUE if an active X pointer grab is in effect
1289 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
1292 gdk_display_pointer_is_grabbed (GdkDisplay *display)
1294 GdkDeviceManager *device_manager;
1295 GList *devices, *dev;
1298 g_return_val_if_fail (GDK_IS_DISPLAY (display), TRUE);
1300 device_manager = gdk_display_get_device_manager (display);
1301 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1303 for (dev = devices; dev; dev = dev->next)
1307 if (gdk_device_get_source (device) == GDK_SOURCE_MOUSE &&
1308 gdk_display_device_is_grabbed (display, device))
1316 * gdk_display_device_is_grabbed:
1317 * @display: a #GdkDisplay
1318 * @device: a #GdkDevice
1320 * Returns %TRUE if there is an ongoing grab on @device for @display.
1322 * Returns: %TRUE if there is a grab in effect for @device.
1325 gdk_display_device_is_grabbed (GdkDisplay *display,
1328 GdkDeviceGrabInfo *info;
1330 g_return_val_if_fail (GDK_IS_DISPLAY (display), TRUE);
1331 g_return_val_if_fail (GDK_IS_DEVICE (device), TRUE);
1333 /* What we're interested in is the steady state (ie last grab),
1334 because we're interested e.g. if we grabbed so that we
1335 can ungrab, even if our grab is not active just yet. */
1336 info = _gdk_display_get_last_device_grab (display, device);
1338 return (info && !info->implicit);
1342 * gdk_display_get_device_manager:
1343 * @display: a #GdkDisplay.
1345 * Returns the #GdkDeviceManager associated to @display.
1347 * Returns: (transfer none): A #GdkDeviceManager, or %NULL. This memory is
1348 * owned by GDK and must not be freed or unreferenced.
1353 gdk_display_get_device_manager (GdkDisplay *display)
1355 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
1357 return display->device_manager;
1361 * gdk_display_get_name:
1362 * @display: a #GdkDisplay
1364 * Gets the name of the display.
1366 * Returns: a string representing the display name. This string is owned
1367 * by GDK and should not be modified or freed.
1371 G_CONST_RETURN gchar *
1372 gdk_display_get_name (GdkDisplay *display)
1374 return GDK_DISPLAY_GET_CLASS(display)->get_name (display);
1378 gdk_get_display (void)
1380 return g_strdup (gdk_display_get_name (gdk_display_get_default ()));
1384 * gdk_display_get_n_screens:
1385 * @display: a #GdkDisplay
1387 * Gets the number of screen managed by the @display.
1389 * Returns: number of screens.
1394 gdk_display_get_n_screens (GdkDisplay *display)
1396 return GDK_DISPLAY_GET_CLASS(display)->get_n_screens (display);
1400 * gdk_display_get_screen:
1401 * @display: a #GdkDisplay
1402 * @screen_num: the screen number
1404 * Returns a screen object for one of the screens of the display.
1406 * Returns: (transfer none): the #GdkScreen object
1411 gdk_display_get_screen (GdkDisplay *display,
1414 return GDK_DISPLAY_GET_CLASS(display)->get_screen (display, screen_num);
1418 * gdk_display_get_default_screen:
1419 * @display: a #GdkDisplay
1421 * Get the default #GdkScreen for @display.
1423 * Returns: (transfer none): the default #GdkScreen object for @display
1428 gdk_display_get_default_screen (GdkDisplay *display)
1430 return GDK_DISPLAY_GET_CLASS(display)->get_default_screen (display);
1435 * @display: a #GdkDisplay
1437 * Emits a short beep on @display
1442 gdk_display_beep (GdkDisplay *display)
1444 GDK_DISPLAY_GET_CLASS(display)->beep (display);
1449 * @display: a #GdkDisplay
1451 * Flushes any requests queued for the windowing system and waits until all
1452 * requests have been handled. This is often used for making sure that the
1453 * display is synchronized with the current state of the program. Calling
1454 * gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors
1455 * generated from earlier requests are handled before the error trap is
1458 * This is most useful for X11. On windowing systems where requests are
1459 * handled synchronously, this function will do nothing.
1464 gdk_display_sync (GdkDisplay *display)
1466 GDK_DISPLAY_GET_CLASS(display)->sync (display);
1470 * gdk_display_flush:
1471 * @display: a #GdkDisplay
1473 * Flushes any requests queued for the windowing system; this happens automatically
1474 * when the main loop blocks waiting for new events, but if your application
1475 * is drawing without returning control to the main loop, you may need
1476 * to call this function explicitely. A common case where this function
1477 * needs to be called is when an application is executing drawing commands
1478 * from a thread other than the thread where the main loop is running.
1480 * This is most useful for X11. On windowing systems where requests are
1481 * handled synchronously, this function will do nothing.
1486 gdk_display_flush (GdkDisplay *display)
1488 GDK_DISPLAY_GET_CLASS(display)->flush (display);
1492 * gdk_display_get_default_group:
1493 * @display: a #GdkDisplay
1495 * Returns the default group leader window for all toplevel windows
1496 * on @display. This window is implicitly created by GDK.
1497 * See gdk_window_set_group().
1499 * Return value: (transfer none): The default group leader window
1505 gdk_display_get_default_group (GdkDisplay *display)
1507 return GDK_DISPLAY_GET_CLASS(display)->get_default_group (display);
1511 * gdk_display_supports_selection_notification:
1512 * @display: a #GdkDisplay
1514 * Returns whether #GdkEventOwnerChange events will be
1515 * sent when the owner of a selection changes.
1517 * Return value: whether #GdkEventOwnerChange events will
1523 gdk_display_supports_selection_notification (GdkDisplay *display)
1525 return GDK_DISPLAY_GET_CLASS(display)->supports_selection_notification (display);
1529 * gdk_display_request_selection_notification:
1530 * @display: a #GdkDisplay
1531 * @selection: the #GdkAtom naming the selection for which
1532 * ownership change notification is requested
1534 * Request #GdkEventOwnerChange events for ownership changes
1535 * of the selection named by the given atom.
1537 * Return value: whether #GdkEventOwnerChange events will
1543 gdk_display_request_selection_notification (GdkDisplay *display,
1547 return GDK_DISPLAY_GET_CLASS(display)->request_selection_notification (display, selection);
1551 * gdk_display_supports_clipboard_persistence
1552 * @display: a #GdkDisplay
1554 * Returns whether the speicifed display supports clipboard
1555 * persistance; i.e. if it's possible to store the clipboard data after an
1556 * application has quit. On X11 this checks if a clipboard daemon is
1559 * Returns: %TRUE if the display supports clipboard persistance.
1564 gdk_display_supports_clipboard_persistence (GdkDisplay *display)
1566 return GDK_DISPLAY_GET_CLASS(display)->supports_clipboard_persistence (display);
1570 * gdk_display_store_clipboard
1571 * @display: a #GdkDisplay
1572 * @clipboard_window: a #GdkWindow belonging to the clipboard owner
1573 * @time_: a timestamp
1574 * @targets: an array of targets that should be saved, or %NULL
1575 * if all available targets should be saved.
1576 * @n_targets: length of the @targets array
1578 * Issues a request to the clipboard manager to store the
1579 * clipboard data. On X11, this is a special program that works
1580 * according to the freedesktop clipboard specification, available at
1581 * <ulink url="http://www.freedesktop.org/Standards/clipboard-manager-spec">
1582 * http://www.freedesktop.org/Standards/clipboard-manager-spec</ulink>.
1587 gdk_display_store_clipboard (GdkDisplay *display,
1588 GdkWindow *clipboard_window,
1590 const GdkAtom *targets,
1593 GDK_DISPLAY_GET_CLASS(display)->store_clipboard (display, clipboard_window, time_, targets, n_targets);
1597 * gdk_display_supports_shapes:
1598 * @display: a #GdkDisplay
1600 * Returns %TRUE if gdk_window_shape_combine_mask() can
1601 * be used to create shaped windows on @display.
1603 * Returns: %TRUE if shaped windows are supported
1608 gdk_display_supports_shapes (GdkDisplay *display)
1610 return GDK_DISPLAY_GET_CLASS(display)->supports_shapes (display);
1614 * gdk_display_supports_input_shapes:
1615 * @display: a #GdkDisplay
1617 * Returns %TRUE if gdk_window_input_shape_combine_mask() can
1618 * be used to modify the input shape of windows on @display.
1620 * Returns: %TRUE if windows with modified input shape are supported
1625 gdk_display_supports_input_shapes (GdkDisplay *display)
1627 return GDK_DISPLAY_GET_CLASS(display)->supports_input_shapes (display);
1631 * gdk_display_supports_composite:
1632 * @display: a #GdkDisplay
1634 * Returns %TRUE if gdk_window_set_composited() can be used
1635 * to redirect drawing on the window using compositing.
1637 * Currently this only works on X11 with XComposite and
1638 * XDamage extensions available.
1640 * Returns: %TRUE if windows may be composited.
1645 gdk_display_supports_composite (GdkDisplay *display)
1647 return GDK_DISPLAY_GET_CLASS(display)->supports_composite (display);
1651 * gdk_display_list_devices:
1652 * @display: a #GdkDisplay
1654 * Returns the list of available input devices attached to @display.
1655 * The list is statically allocated and should not be freed.
1657 * Return value: (transfer none) (element-type GdkDevice):
1658 * a list of #GdkDevice
1662 * Deprecated: 3.0: Use gdk_device_manager_list_devices() instead.
1665 gdk_display_list_devices (GdkDisplay *display)
1667 return GDK_DISPLAY_GET_CLASS(display)->list_devices (display);
1671 * gdk_event_send_client_message_for_display:
1672 * @display: the #GdkDisplay for the window where the message is to be sent.
1673 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
1674 * @winid: the window to send the client message to.
1676 * On X11, sends an X ClientMessage event to a given window. On
1677 * Windows, sends a message registered with the name
1678 * GDK_WIN32_CLIENT_MESSAGE.
1680 * This could be used for communicating between different
1681 * applications, though the amount of data is limited to 20 bytes on
1682 * X11, and to just four bytes on Windows.
1684 * Returns: non-zero on success.
1689 gdk_event_send_client_message_for_display (GdkDisplay *display,
1691 GdkNativeWindow winid)
1693 return GDK_DISPLAY_GET_CLASS(display)->send_client_message (display, event, winid);
1697 * gdk_display_add_client_message_filter:
1698 * @display: a #GdkDisplay for which this message filter applies
1699 * @message_type: the type of ClientMessage events to receive.
1700 * This will be checked against the @message_type field
1701 * of the XClientMessage event struct.
1702 * @func: the function to call to process the event.
1703 * @data: user data to pass to @func.
1705 * Adds a filter to be called when X ClientMessage events are received.
1706 * See gdk_window_add_filter() if you are interested in filtering other
1712 gdk_display_add_client_message_filter (GdkDisplay *display,
1713 GdkAtom message_type,
1717 GDK_DISPLAY_GET_CLASS(display)->add_client_message_filter (display, message_type, func, data);
1721 * gdk_add_client_message_filter:
1722 * @message_type: the type of ClientMessage events to receive. This will be
1723 * checked against the <structfield>message_type</structfield> field of the
1724 * XClientMessage event struct.
1725 * @func: the function to call to process the event.
1726 * @data: user data to pass to @func.
1728 * Adds a filter to the default display to be called when X ClientMessage events
1729 * are received. See gdk_display_add_client_message_filter().
1732 gdk_add_client_message_filter (GdkAtom message_type,
1736 gdk_display_add_client_message_filter (gdk_display_get_default (),
1737 message_type, func, data);
1740 static GdkAppLaunchContext *
1741 gdk_display_real_get_app_launch_context (GdkDisplay *display)
1743 GdkAppLaunchContext *ctx;
1745 ctx = g_object_new (GDK_TYPE_APP_LAUNCH_CONTEXT,
1753 * gdk_display_get_app_launch_context:
1754 * @display: a #GdkDisplay
1756 * Returns a #GdkAppLaunchContext suitable for launching
1757 * applications on the given display.
1759 * Returns: a new #GdkAppLaunchContext for @display.
1760 * Free with g_object_unref() when done
1764 GdkAppLaunchContext *
1765 gdk_display_get_app_launch_context (GdkDisplay *display)
1767 return GDK_DISPLAY_GET_CLASS(display)->get_app_launch_context (display);
1771 * gdk_drag_get_protocol_for_display:
1772 * @display: the #GdkDisplay where the destination window resides
1773 * @xid: the windowing system id of the destination window.
1774 * @protocol: location where the supported DND protocol is returned.
1776 * Finds out the DND protocol supported by a window.
1778 * Return value: the windowing system id of the window where the drop
1779 * should happen. This may be @xid or the id of a proxy window,
1780 * or zero if @xid does not support Drag and Drop.
1785 gdk_drag_get_protocol_for_display (GdkDisplay *display,
1786 GdkNativeWindow xid,
1787 GdkDragProtocol *protocol)
1789 return GDK_DISPLAY_GET_CLASS (display)->get_drag_protocol (display, xid, protocol, NULL);
1794 * @display_name: the name of the display to open
1798 * Return value: (transfer none): a #GdkDisplay, or %NULL
1799 * if the display could not be opened
1804 gdk_display_open (const gchar *display_name)
1806 return gdk_display_manager_open_display (gdk_display_manager_get (), display_name);
1810 * gdk_display_has_pending:
1811 * @display: a #GdkDisplay
1813 * Returns whether the display has events that are waiting
1816 * Returns: %TRUE if there are events ready to be processed.
1821 gdk_display_has_pending (GdkDisplay *display)
1823 return GDK_DISPLAY_GET_CLASS (display)->has_pending (display);
1827 * gdk_display_supports_cursor_alpha:
1828 * @display: a #GdkDisplay
1830 * Returns %TRUE if cursors can use an 8bit alpha channel
1831 * on @display. Otherwise, cursors are restricted to bilevel
1832 * alpha (i.e. a mask).
1834 * Returns: whether cursors can have alpha channels.
1839 gdk_display_supports_cursor_alpha (GdkDisplay *display)
1841 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
1843 return GDK_DISPLAY_GET_CLASS (display)->supports_cursor_alpha (display);
1847 * gdk_display_supports_cursor_color:
1848 * @display: a #GdkDisplay
1850 * Returns %TRUE if multicolored cursors are supported
1851 * on @display. Otherwise, cursors have only a forground
1852 * and a background color.
1854 * Returns: whether cursors can have multiple colors.
1859 gdk_display_supports_cursor_color (GdkDisplay *display)
1861 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
1863 return GDK_DISPLAY_GET_CLASS (display)->supports_cursor_color (display);
1867 * gdk_display_get_default_cursor_size:
1868 * @display: a #GdkDisplay
1870 * Returns the default size to use for cursors on @display.
1872 * Returns: the default cursor size.
1877 gdk_display_get_default_cursor_size (GdkDisplay *display)
1879 guint width, height;
1881 g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);
1883 GDK_DISPLAY_GET_CLASS (display)->get_default_cursor_size (display,
1887 return MIN (width, height);
1891 * gdk_display_get_maximal_cursor_size:
1892 * @display: a #GdkDisplay
1893 * @width: (out): the return location for the maximal cursor width
1894 * @height: (out): the return location for the maximal cursor height
1896 * Gets the maximal size to use for cursors on @display.
1901 gdk_display_get_maximal_cursor_size (GdkDisplay *display,
1905 g_return_if_fail (GDK_IS_DISPLAY (display));
1907 GDK_DISPLAY_GET_CLASS (display)->get_maximal_cursor_size (display,
1913 * gdk_display_warp_pointer:
1914 * @display: a #GdkDisplay
1915 * @screen: the screen of @display to warp the pointer to
1916 * @x: the x coordinate of the destination
1917 * @y: the y coordinate of the destination
1919 * Warps the pointer of @display to the point @x,@y on
1920 * the screen @screen, unless the pointer is confined
1921 * to a window by a grab, in which case it will be moved
1922 * as far as allowed by the grab. Warping the pointer
1923 * creates events as if the user had moved the mouse
1924 * instantaneously to the destination.
1926 * Note that the pointer should normally be under the
1927 * control of the user. This function was added to cover
1928 * some rare use cases like keyboard navigation support
1929 * for the color picker in the #GtkColorSelectionDialog.
1933 * Deprecated: 3.0: Use gdk_device_warp() instead.
1936 gdk_display_warp_pointer (GdkDisplay *display,
1941 gdk_device_warp (display->core_pointer,
1947 _gdk_display_get_next_serial (GdkDisplay *display)
1949 return GDK_DISPLAY_GET_CLASS (display)->get_next_serial (display);
1954 * gdk_notify_startup_complete:
1956 * Indicates to the GUI environment that the application has finished
1957 * loading. If the applications opens windows, this function is
1958 * normally called after opening the application's initial set of
1961 * GTK+ will call this function automatically after opening the first
1962 * #GtkWindow unless gtk_window_set_auto_startup_notification() is called
1963 * to disable that feature.
1968 gdk_notify_startup_complete (void)
1970 gdk_notify_startup_complete_with_id (NULL);
1974 * gdk_notify_startup_complete_with_id:
1975 * @startup_id: a startup-notification identifier, for which
1976 * notification process should be completed
1978 * Indicates to the GUI environment that the application has
1979 * finished loading, using a given identifier.
1981 * GTK+ will call this function automatically for #GtkWindow
1982 * with custom startup-notification identifier unless
1983 * gtk_window_set_auto_startup_notification() is called to
1984 * disable that feature.
1989 gdk_notify_startup_complete_with_id (const gchar* startup_id)
1991 GdkDisplay *display;
1993 display = gdk_display_get_default ();
1995 gdk_display_notify_startup_complete (display, startup_id);
1999 * gdk_display_notify_startup_complete:
2000 * @display: a #GdkDisplay
2001 * @startup_id: a startup-notification identifier, for which
2002 * notification process should be completed
2004 * Indicates to the GUI environment that the application has
2005 * finished loading, using a given identifier.
2007 * GTK+ will call this function automatically for #GtkWindow
2008 * with custom startup-notification identifier unless
2009 * gtk_window_set_auto_startup_notification() is called to
2010 * disable that feature.
2015 gdk_display_notify_startup_complete (GdkDisplay *display,
2016 const gchar *startup_id)
2018 GDK_DISPLAY_GET_CLASS (display)->notify_startup_complete (display, startup_id);
2022 _gdk_display_event_data_copy (GdkDisplay *display,
2023 const GdkEvent *event,
2024 GdkEvent *new_event)
2026 GDK_DISPLAY_GET_CLASS (display)->event_data_copy (display, event, new_event);
2030 _gdk_display_event_data_free (GdkDisplay *display,
2033 GDK_DISPLAY_GET_CLASS (display)->event_data_free (display, event);
2037 _gdk_display_create_window_impl (GdkDisplay *display,
2039 GdkWindow *real_parent,
2041 GdkEventMask event_mask,
2042 GdkWindowAttr *attributes,
2043 gint attributes_mask)
2045 GDK_DISPLAY_GET_CLASS (display)->create_window_impl (display,
2055 _gdk_display_create_window (GdkDisplay *display)
2057 return g_object_new (GDK_DISPLAY_GET_CLASS (display)->window_type, NULL);
2061 * gdk_keymap_get_for_display:
2062 * @display: the #GdkDisplay.
2064 * Returns the #GdkKeymap attached to @display.
2066 * Return value: (transfer none): the #GdkKeymap attached to @display.
2071 gdk_keymap_get_for_display (GdkDisplay *display)
2073 return GDK_DISPLAY_GET_CLASS (display)->get_keymap (display);
2076 typedef struct _GdkGlobalErrorTrap GdkGlobalErrorTrap;
2078 struct _GdkGlobalErrorTrap
2083 static GQueue gdk_error_traps = G_QUEUE_INIT;
2086 * gdk_error_trap_push:
2088 * This function allows X errors to be trapped instead of the normal
2089 * behavior of exiting the application. It should only be used if it
2090 * is not possible to avoid the X error in any other way. Errors are
2091 * ignored on all #GdkDisplay currently known to the
2092 * #GdkDisplayManager. If you don't care which error happens and just
2093 * want to ignore everything, pop with gdk_error_trap_pop_ignored().
2094 * If you need the error code, use gdk_error_trap_pop() which may have
2095 * to block and wait for the error to arrive from the X server.
2097 * This API exists on all platforms but only does anything on X.
2099 * You can use gdk_x11_display_error_trap_push() to ignore errors
2100 * on only a single display.
2103 * <title>Trapping an X error</title>
2105 * gdk_error_trap_push (<!-- -->);
2107 * // ... Call the X function which may cause an error here ...
2110 * if (gdk_error_trap_pop (<!-- -->))
2112 * // ... Handle the error here ...
2118 gdk_error_trap_push (void)
2120 GdkDisplayManager *manager;
2121 GdkDisplayClass *class;
2122 GdkGlobalErrorTrap *trap;
2125 manager = gdk_display_manager_get ();
2126 class = GDK_DISPLAY_GET_CLASS (gdk_display_manager_get_default_display (manager));
2128 if (class->push_error_trap == NULL)
2131 trap = g_slice_new (GdkGlobalErrorTrap);
2132 trap->displays = gdk_display_manager_list_displays (manager);
2134 g_slist_foreach (trap->displays, (GFunc) g_object_ref, NULL);
2135 for (l = trap->displays; l != NULL; l = l->next)
2137 class->push_error_trap (l->data);
2140 g_queue_push_head (&gdk_error_traps, trap);
2144 gdk_error_trap_pop_internal (gboolean need_code)
2146 GdkDisplayManager *manager;
2147 GdkDisplayClass *class;
2148 GdkGlobalErrorTrap *trap;
2152 manager = gdk_display_manager_get ();
2153 class = GDK_DISPLAY_GET_CLASS (gdk_display_manager_get_default_display (manager));
2155 if (class->pop_error_trap == NULL)
2158 trap = g_queue_pop_head (&gdk_error_traps);
2160 g_return_val_if_fail (trap != NULL, 0);
2163 for (l = trap->displays; l != NULL; l = l->next)
2167 code = class->pop_error_trap (l->data, !need_code);
2169 /* we use the error on the last display listed, why not. */
2174 g_slist_free_full (trap->displays, g_object_unref);
2175 g_slice_free (GdkGlobalErrorTrap, trap);
2181 * gdk_error_trap_pop_ignored:
2183 * Removes an error trap pushed with gdk_error_trap_push(), but
2184 * without bothering to wait and see whether an error occurred. If an
2185 * error arrives later asynchronously that was triggered while the
2186 * trap was pushed, that error will be ignored.
2191 gdk_error_trap_pop_ignored (void)
2193 gdk_error_trap_pop_internal (FALSE);
2197 * gdk_error_trap_pop:
2199 * Removes an error trap pushed with gdk_error_trap_push().
2200 * May block until an error has been definitively received
2201 * or not received from the X server. gdk_error_trap_pop_ignored()
2202 * is preferred if you don't need to know whether an error
2203 * occurred, because it never has to block. If you don't
2204 * need the return value of gdk_error_trap_pop(), use
2205 * gdk_error_trap_pop_ignored().
2207 * Prior to GDK 3.0, this function would not automatically
2208 * sync for you, so you had to gdk_flush() if your last
2209 * call to Xlib was not a blocking round trip.
2211 * Return value: X error code or 0 on success
2214 gdk_error_trap_pop (void)
2216 return gdk_error_trap_pop_internal (TRUE);