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.
25 #include "gdk.h" /* gdk_event_send_client_message() */
26 #include "gdkdisplay.h"
27 #include "gdkinternals.h"
28 #include "gdkmarshalers.h"
29 #include "gdkscreen.h"
36 static void gdk_display_class_init (GdkDisplayClass *class);
37 static void gdk_display_init (GdkDisplay *display);
38 static void gdk_display_dispose (GObject *object);
39 static void gdk_display_finalize (GObject *object);
42 void singlehead_get_pointer (GdkDisplay *display,
46 GdkModifierType *mask);
47 GdkWindow* singlehead_window_get_pointer (GdkDisplay *display,
51 GdkModifierType *mask);
52 GdkWindow* singlehead_window_at_pointer (GdkDisplay *display,
56 GdkWindow* singlehead_default_window_get_pointer (GdkWindow *window,
59 GdkModifierType *mask);
60 GdkWindow* singlehead_default_window_at_pointer (GdkScreen *screen,
64 static guint signals[LAST_SIGNAL] = { 0 };
66 static GObjectClass *parent_class;
67 static char *gdk_sm_client_id;
69 static const GdkDisplayPointerHooks default_pointer_hooks = {
70 _gdk_windowing_get_pointer,
71 _gdk_windowing_window_get_pointer,
72 _gdk_windowing_window_at_pointer
75 static const GdkDisplayPointerHooks singlehead_pointer_hooks = {
76 singlehead_get_pointer,
77 singlehead_window_get_pointer,
78 singlehead_window_at_pointer
81 static const GdkPointerHooks singlehead_default_pointer_hooks = {
82 singlehead_default_window_get_pointer,
83 singlehead_default_window_at_pointer
86 static const GdkPointerHooks *singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
89 gdk_display_get_type (void)
92 static GType object_type = 0;
96 static const GTypeInfo object_info = {
97 sizeof (GdkDisplayClass),
99 (GBaseFinalizeFunc) NULL,
100 (GClassInitFunc) gdk_display_class_init,
101 NULL, /* class_finalize */
102 NULL, /* class_data */
105 (GInstanceInitFunc) gdk_display_init
107 object_type = g_type_register_static (G_TYPE_OBJECT,
108 "GdkDisplay", &object_info, 0);
115 gdk_display_class_init (GdkDisplayClass *class)
117 GObjectClass *object_class = G_OBJECT_CLASS (class);
119 parent_class = g_type_class_peek_parent (class);
121 object_class->finalize = gdk_display_finalize;
122 object_class->dispose = gdk_display_dispose;
125 g_signal_new ("closed",
126 G_OBJECT_CLASS_TYPE (object_class),
128 G_STRUCT_OFFSET (GdkDisplayClass, closed),
130 gdk_marshal_VOID__BOOLEAN,
137 gdk_display_init (GdkDisplay *display)
139 _gdk_displays = g_slist_prepend (_gdk_displays, display);
141 display->button_click_time[0] = display->button_click_time[1] = 0;
142 display->button_window[0] = display->button_window[1] = NULL;
143 display->button_number[0] = display->button_number[1] = -1;
145 display->double_click_time = 250;
147 display->pointer_hooks = &default_pointer_hooks;
151 gdk_display_dispose (GObject *object)
153 GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
155 g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
156 g_list_free (display->queued_events);
157 display->queued_events = NULL;
158 display->queued_tail = NULL;
160 _gdk_displays = g_slist_remove (_gdk_displays, object);
162 if (gdk_display_get_default() == display)
163 gdk_display_manager_set_default_display (gdk_display_manager_get(), NULL);
167 gdk_display_finalize (GObject *object)
169 parent_class->finalize (object);
174 * @display: a #GdkDisplay
176 * Closes the connection windowing system for the given display,
177 * and cleans up associated resources.
182 gdk_display_close (GdkDisplay *display)
184 g_return_if_fail (GDK_IS_DISPLAY (display));
186 if (!display->closed)
188 display->closed = TRUE;
190 g_signal_emit (display, signals[CLOSED], 0, FALSE);
191 g_object_run_dispose (G_OBJECT (display));
193 g_object_unref (display);
198 * gdk_display_get_event:
199 * @display: a #GdkDisplay
201 * Gets the next #GdkEvent to be processed for @display, fetching events from the
202 * windowing system if necessary.
204 * Return value: the next #GdkEvent to be processed, or %NULL if no events
205 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
210 gdk_display_get_event (GdkDisplay *display)
212 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
214 _gdk_events_queue (display);
215 return _gdk_event_unqueue (display);
219 * gdk_display_peek_event:
220 * @display: a #GdkDisplay
222 * Gets a copy of the first #GdkEvent in the @display's event queue, without
223 * removing the event from the queue. (Note that this function will
224 * not get more events from the windowing system. It only checks the events
225 * that have already been moved to the GDK event queue.)
227 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL
228 * if no events are in the queue. The returned #GdkEvent should be freed with
234 gdk_display_peek_event (GdkDisplay *display)
238 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
240 tmp_list = _gdk_event_queue_find_first (display);
243 return gdk_event_copy (tmp_list->data);
249 * gdk_display_put_event:
250 * @display: a #GdkDisplay
251 * @event: a #GdkEvent.
253 * Appends a copy of the given event onto the front of the event
254 * queue for @display.
259 gdk_display_put_event (GdkDisplay *display,
262 g_return_if_fail (GDK_IS_DISPLAY (display));
263 g_return_if_fail (event != NULL);
265 _gdk_event_queue_append (display, gdk_event_copy (event));
269 * gdk_pointer_ungrab:
270 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
271 * timestamp is available.
273 * Ungrabs the pointer, if it is grabbed by this application.
276 gdk_pointer_ungrab (guint32 time)
278 gdk_display_pointer_ungrab (gdk_display_get_default (), time);
282 * gdk_pointer_is_grabbed:
284 * Returns %TRUE if the pointer is currently grabbed by this application.
286 * Note that this does not take the inmplicit pointer grab on button
287 * presses into account.
289 * Return value: %TRUE if the pointer is currently grabbed by this application.*
292 gdk_pointer_is_grabbed (void)
294 return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
298 * gdk_keyboard_ungrab:
299 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
300 * timestamp is available.
302 * Ungrabs the keyboard, if it is grabbed by this application.
305 gdk_keyboard_ungrab (guint32 time)
307 gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
313 * Emits a short beep.
318 gdk_display_beep (gdk_display_get_default ());
322 * gdk_event_send_client_message:
323 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
324 * @winid: the window to send the X ClientMessage event to.
326 * Sends an X ClientMessage event to a given window (which must be
327 * on the default #GdkDisplay.)
328 * This could be used for communicating between different applications,
329 * though the amount of data is limited to 20 bytes.
331 * Return value: non-zero on success.
334 gdk_event_send_client_message (GdkEvent *event,
335 GdkNativeWindow winid)
337 g_return_val_if_fail (event != NULL, FALSE);
339 return gdk_event_send_client_message_for_display (gdk_display_get_default (),
344 * gdk_event_send_clientmessage_toall:
345 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
347 * Sends an X ClientMessage event to all toplevel windows on the default
350 * Toplevel windows are determined by checking for the WM_STATE property, as
351 * described in the Inter-Client Communication Conventions Manual (ICCCM).
352 * If no windows are found with the WM_STATE property set, the message is sent
353 * to all children of the root window.
356 gdk_event_send_clientmessage_toall (GdkEvent *event)
358 g_return_if_fail (event != NULL);
360 gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
364 * gdk_device_get_core_pointer:
366 * Returns the core pointer device for the default display.
368 * Return value: the core pointer device; this is owned by the
369 * display and should not be freed.
372 gdk_device_get_core_pointer (void)
374 return gdk_display_get_core_pointer (gdk_display_get_default ());
378 * gdk_display_get_core_pointer:
379 * @display: a #GdkDisplay
381 * Returns the core pointer device for the given display
383 * Return value: the core pointer device; this is owned by the
384 * display and should not be freed.
389 gdk_display_get_core_pointer (GdkDisplay *display)
391 return display->core_pointer;
395 * gdk_set_sm_client_id:
396 * @sm_client_id: the client id assigned by the session manager when the
397 * connection was opened, or %NULL to remove the property.
399 * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
400 * the window manager can save the application's state using the X11R6 ICCCM
401 * session management protocol.
403 * See the X Session Management Library documentation for more information on
404 * session management and the Inter-Client Communication Conventions Manual
405 * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property.
406 * (Both documents are part of the X Window System distribution.)
409 gdk_set_sm_client_id (const gchar* sm_client_id)
411 GSList *displays, *tmp_list;
413 g_free (gdk_sm_client_id);
414 gdk_sm_client_id = g_strdup (sm_client_id);
416 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
417 for (tmp_list = displays; tmp_list; tmp_list = tmp_list->next)
418 _gdk_windowing_display_set_sm_client_id (tmp_list->data, sm_client_id);
420 g_slist_free (displays);
424 * _gdk_get_sm_client_id:
426 * Gets the client ID set with gdk_set_sm_client_id(), if any.
428 * Return value: Session ID, or %NULL if gdk_set_sm_client_id()
429 * has never been called.
432 _gdk_get_sm_client_id (void)
434 return gdk_sm_client_id;
438 * gdk_display_get_pointer:
439 * @display: a #GdkDisplay
440 * @screen: location to store the screen that the
441 * cursor is on, or %NULL.
442 * @x: location to store root window X coordinate of pointer, or %NULL.
443 * @y: location to store root window Y coordinate of pointer, or %NULL.
444 * @mask: location to store current modifier mask, or %NULL
446 * Gets the current location of the pointer and the current modifier
447 * mask for a given display.
452 gdk_display_get_pointer (GdkDisplay *display,
456 GdkModifierType *mask)
458 GdkScreen *tmp_screen;
460 GdkModifierType tmp_mask;
462 g_return_if_fail (GDK_IS_DISPLAY (display));
464 display->pointer_hooks->get_pointer (display, &tmp_screen, &tmp_x, &tmp_y, &tmp_mask);
467 *screen = tmp_screen;
477 * gdk_display_get_window_at_pointer:
478 * @display: a #GdkDisplay
479 * @win_x: return location for origin of the window under the pointer
480 * @win_y: return location for origin of the window under the pointer
482 * Obtains the window underneath the mouse pointer, returning the location
483 * of that window in @win_x, @win_y for @screen. Returns %NULL if the window
484 * under the mouse pointer is not known to GDK (for example, belongs to
485 * another application).
487 * Returns: the window under the mouse pointer, or %NULL
492 gdk_display_get_window_at_pointer (GdkDisplay *display,
498 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
500 return display->pointer_hooks->window_at_pointer (display, &tmp_x, &tmp_y);
509 * gdk_display_set_pointer_hooks:
510 * @display: a #GdkDisplay
511 * @new_hooks: a table of pointers to functions for getting
512 * quantities related to the current pointer position,
513 * or %NULL to restore the default table.
515 * This function allows for hooking into the operation
516 * of getting the current location of the pointer on a particular
517 * display. This is only useful for such low-level tools as an
518 * event recorder. Applications should never have any
519 * reason to use this facility.
521 * Return value: the previous pointer hook table
525 GdkDisplayPointerHooks *
526 gdk_display_set_pointer_hooks (GdkDisplay *display,
527 const GdkDisplayPointerHooks *new_hooks)
529 const GdkDisplayPointerHooks *result;
531 g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
532 result = display->pointer_hooks;
535 display->pointer_hooks = new_hooks;
537 display->pointer_hooks = &default_pointer_hooks;
539 return (GdkDisplayPointerHooks *)result;
543 singlehead_get_pointer (GdkDisplay *display,
547 GdkModifierType *mask)
549 GdkScreen *default_screen = gdk_display_get_default_screen (display);
550 GdkWindow *root_window = gdk_screen_get_root_window (default_screen);
552 *screen = default_screen;
554 singlehead_current_pointer_hooks->get_pointer (root_window, x, y, mask);
558 singlehead_window_get_pointer (GdkDisplay *display,
562 GdkModifierType *mask)
564 return singlehead_current_pointer_hooks->get_pointer (window, x, y, mask);
568 singlehead_window_at_pointer (GdkDisplay *display,
572 GdkScreen *default_screen = gdk_display_get_default_screen (display);
574 return singlehead_current_pointer_hooks->window_at_pointer (default_screen,
579 singlehead_default_window_get_pointer (GdkWindow *window,
582 GdkModifierType *mask)
584 return _gdk_windowing_window_get_pointer (gdk_drawable_get_display (window),
589 singlehead_default_window_at_pointer (GdkScreen *screen,
593 return _gdk_windowing_window_at_pointer (gdk_screen_get_display (screen),
598 * gdk_set_pointer_hooks:
599 * @new_hooks: a table of pointers to functions for getting
600 * quantities related to the current pointer position,
601 * or %NULL to restore the default table.
603 * This function allows for hooking into the operation
604 * of getting the current location of the pointer. This
605 * is only useful for such low-level tools as an
606 * event recorder. Applications should never have any
607 * reason to use this facility.
609 * This function is not multihead safe. For multihead operation,
610 * see gdk_display_set_pointer_hooks().
612 * Return value: the previous pointer hook table
615 gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
617 const GdkPointerHooks *result = singlehead_current_pointer_hooks;
620 singlehead_current_pointer_hooks = new_hooks;
622 singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
624 gdk_display_set_pointer_hooks (gdk_display_get_default (),
625 &singlehead_pointer_hooks);
627 return (GdkPointerHooks *)result;