Pileus Git - ~andy/gtk/blob - gdk/gdkdisplay.c

   1 /* GDK - The GIMP Drawing Kit
   2  * gdkdisplay.c
   3  *
   4  * Copyright 2001 Sun Microsystems Inc.
   5  *
   6  * Erwann Chenede <erwann.chenede@sun.com>
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 #include <config.h>
  25 #include <glib.h>
  26 #include "gdk.h"                /* gdk_event_send_client_message() */
  27 #include "gdkdisplay.h"
  28 #include "gdkinternals.h"
  29 #include "gdkmarshalers.h"
  30 #include "gdkscreen.h"
  31 #include "gdkalias.h"
  32
  33 enum {
  34   CLOSED,
  35   LAST_SIGNAL
  36 };
  37
  38 static void gdk_display_dispose    (GObject         *object);
  39 static void gdk_display_finalize   (GObject         *object);
  40
  41
  42 static void       singlehead_get_pointer (GdkDisplay       *display,
  43                                           GdkScreen       **screen,
  44                                           gint             *x,
  45                                           gint             *y,
  46                                           GdkModifierType  *mask);
  47 static GdkWindow* singlehead_window_get_pointer (GdkDisplay       *display,
  48                                                  GdkWindow        *window,
  49                                                  gint             *x,
  50                                                  gint             *y,
  51                                                  GdkModifierType  *mask);
  52 static GdkWindow* singlehead_window_at_pointer  (GdkDisplay       *display,
  53                                                  gint             *win_x,
  54                                                  gint             *win_y);
  55
  56 static GdkWindow* singlehead_default_window_get_pointer (GdkWindow       *window,
  57                                                          gint            *x,
  58                                                          gint            *y,
  59                                                          GdkModifierType *mask);
  60 static GdkWindow* singlehead_default_window_at_pointer  (GdkScreen       *screen,
  61                                                          gint            *win_x,
  62                                                          gint            *win_y);
  63
  64 static guint signals[LAST_SIGNAL] = { 0 };
  65
  66 static char *gdk_sm_client_id;
  67
  68 static const GdkDisplayPointerHooks default_pointer_hooks = {
  69   _gdk_windowing_get_pointer,
  70   _gdk_windowing_window_get_pointer,
  71   _gdk_windowing_window_at_pointer
  72 };
  73
  74 static const GdkDisplayPointerHooks singlehead_pointer_hooks = {
  75   singlehead_get_pointer,
  76   singlehead_window_get_pointer,
  77   singlehead_window_at_pointer
  78 };
  79
  80 static const GdkPointerHooks singlehead_default_pointer_hooks = {
  81   singlehead_default_window_get_pointer,
  82   singlehead_default_window_at_pointer
  83 };
  84
  85 static const GdkPointerHooks *singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
  86
  87 G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT);
  88
  89 static void
  90 gdk_display_class_init (GdkDisplayClass *class)
  91 {
  92   GObjectClass *object_class = G_OBJECT_CLASS (class);
  93
  94   object_class->finalize = gdk_display_finalize;
  95   object_class->dispose = gdk_display_dispose;
  96
  97   /**
  98    * GdkDisplay::closed:
  99    * @display: the object on which the signal is emitted
 100    * @is_error: %TRUE if the display was closed due to an error
 101    *
 102    * The ::closed signal is emitted when the connection to the windowing
 103    * system for @display is closed.
 104    *
 105    * Since: 2.2
 106    */
 107   signals[CLOSED] =
 108     g_signal_new (g_intern_static_string ("closed"),
 109                   G_OBJECT_CLASS_TYPE (object_class),
 110                   G_SIGNAL_RUN_LAST,
 111                   G_STRUCT_OFFSET (GdkDisplayClass, closed),
 112                   NULL, NULL,
 113                   gdk_marshal_VOID__BOOLEAN,
 114                   G_TYPE_NONE,
 115                   1,
 116                   G_TYPE_BOOLEAN);
 117 }
 118
 119 static void
 120 gdk_display_init (GdkDisplay *display)
 121 {
 122   _gdk_displays = g_slist_prepend (_gdk_displays, display);
 123
 124   display->button_click_time[0] = display->button_click_time[1] = 0;
 125   display->button_window[0] = display->button_window[1] = NULL;
 126   display->button_number[0] = display->button_number[1] = -1;
 127   display->button_x[0] = display->button_x[1] = 0;
 128   display->button_y[0] = display->button_y[1] = 0;
 129
 130   display->double_click_time = 250;
 131   display->double_click_distance = 5;
 132
 133   display->pointer_hooks = &default_pointer_hooks;
 134 }
 135
 136 static void
 137 gdk_display_dispose (GObject *object)
 138 {
 139   GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
 140
 141   g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
 142   g_list_free (display->queued_events);
 143   display->queued_events = NULL;
 144   display->queued_tail = NULL;
 145
 146   _gdk_displays = g_slist_remove (_gdk_displays, object);
 147
 148   if (gdk_display_get_default() == display)
 149     {
 150       if (_gdk_displays)
 151         gdk_display_manager_set_default_display (gdk_display_manager_get(),
 152                                                  _gdk_displays->data);
 153       else
 154         gdk_display_manager_set_default_display (gdk_display_manager_get(),
 155                                                  NULL);
 156     }
 157
 158   G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
 159 }
 160
 161 static void
 162 gdk_display_finalize (GObject *object)
 163 {
 164   G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
 165 }
 166
 167 /**
 168  * gdk_display_close:
 169  * @display: a #GdkDisplay
 170  *
 171  * Closes the connection to the windowing system for the given display,
 172  * and cleans up associated resources.
 173  *
 174  * Since: 2.2
 175  */
 176 void
 177 gdk_display_close (GdkDisplay *display)
 178 {
 179   g_return_if_fail (GDK_IS_DISPLAY (display));
 180
 181   if (!display->closed)
 182     {
 183       display->closed = TRUE;
 184
 185       g_signal_emit (display, signals[CLOSED], 0, FALSE);
 186       g_object_run_dispose (G_OBJECT (display));
 187
 188       g_object_unref (display);
 189     }
 190 }
 191
 192 /**
 193  * gdk_display_get_event:
 194  * @display: a #GdkDisplay
 195  *
 196  * Gets the next #GdkEvent to be processed for @display, fetching events from the
 197  * windowing system if necessary.
 198  *
 199  * Return value: the next #GdkEvent to be processed, or %NULL if no events
 200  * are pending. The returned #GdkEvent should be freed with gdk_event_free().
 201  *
 202  * Since: 2.2
 203  **/
 204 GdkEvent*
 205 gdk_display_get_event (GdkDisplay *display)
 206 {
 207   g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
 208
 209   _gdk_events_queue (display);
 210   return _gdk_event_unqueue (display);
 211 }
 212
 213 /**
 214  * gdk_display_peek_event:
 215  * @display: a #GdkDisplay
 216  *
 217  * Gets a copy of the first #GdkEvent in the @display's event queue, without
 218  * removing the event from the queue.  (Note that this function will
 219  * not get more events from the windowing system.  It only checks the events
 220  * that have already been moved to the GDK event queue.)
 221  *
 222  * Return value: a copy of the first #GdkEvent on the event queue, or %NULL
 223  * if no events are in the queue. The returned #GdkEvent should be freed with
 224  * gdk_event_free().
 225  *
 226  * Since: 2.2
 227  **/
 228 GdkEvent*
 229 gdk_display_peek_event (GdkDisplay *display)
 230 {
 231   GList *tmp_list;
 232
 233   g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
 234
 235   tmp_list = _gdk_event_queue_find_first (display);
 236
 237   if (tmp_list)
 238     return gdk_event_copy (tmp_list->data);
 239   else
 240     return NULL;
 241 }
 242
 243 /**
 244  * gdk_display_put_event:
 245  * @display: a #GdkDisplay
 246  * @event: a #GdkEvent.
 247  *
 248  * Appends a copy of the given event onto the front of the event
 249  * queue for @display.
 250  *
 251  * Since: 2.2
 252  **/
 253 void
 254 gdk_display_put_event (GdkDisplay *display,
 255                        GdkEvent   *event)
 256 {
 257   g_return_if_fail (GDK_IS_DISPLAY (display));
 258   g_return_if_fail (event != NULL);
 259
 260   _gdk_event_queue_append (display, gdk_event_copy (event));
 261 }
 262
 263 /**
 264  * gdk_pointer_ungrab:
 265  * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
 266  *  timestamp is available.
 267  *
 268  * Ungrabs the pointer, if it is grabbed by this application.
 269  **/
 270 void
 271 gdk_pointer_ungrab (guint32 time)
 272 {
 273   gdk_display_pointer_ungrab (gdk_display_get_default (), time);
 274 }
 275
 276 /**
 277  * gdk_pointer_is_grabbed:
 278  *
 279  * Returns %TRUE if the pointer is currently grabbed by this application.
 280  *
 281  * Note that this does not take the inmplicit pointer grab on button
 282  * presses into account.
 283
 284  * Return value: %TRUE if the pointer is currently grabbed by this application.*
 285  **/
 286 gboolean
 287 gdk_pointer_is_grabbed (void)
 288 {
 289   return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
 290 }
 291
 292 /**
 293  * gdk_keyboard_ungrab:
 294  * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
 295  *        timestamp is available.
 296  *
 297  * Ungrabs the keyboard, if it is grabbed by this application.
 298  **/
 299 void
 300 gdk_keyboard_ungrab (guint32 time)
 301 {
 302   gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
 303 }
 304
 305 /**
 306  * gdk_beep:
 307  *
 308  * Emits a short beep.
 309  **/
 310 void
 311 gdk_beep (void)
 312 {
 313   gdk_display_beep (gdk_display_get_default ());
 314 }
 315
 316 /**
 317  * gdk_event_send_client_message:
 318  * @event: the #GdkEvent to send, which should be a #GdkEventClient.
 319  * @winid:  the window to send the X ClientMessage event to.
 320  *
 321  * Sends an X ClientMessage event to a given window (which must be
 322  * on the default #GdkDisplay.)
 323  * This could be used for communicating between different applications,
 324  * though the amount of data is limited to 20 bytes.
 325  *
 326  * Return value: non-zero on success.
 327  **/
 328 gboolean
 329 gdk_event_send_client_message (GdkEvent        *event,
 330                                GdkNativeWindow  winid)
 331 {
 332   g_return_val_if_fail (event != NULL, FALSE);
 333
 334   return gdk_event_send_client_message_for_display (gdk_display_get_default (),
 335                                                     event, winid);
 336 }
 337
 338 /**
 339  * gdk_event_send_clientmessage_toall:
 340  * @event: the #GdkEvent to send, which should be a #GdkEventClient.
 341  *
 342  * Sends an X ClientMessage event to all toplevel windows on the default
 343  * #GdkScreen.
 344  *
 345  * Toplevel windows are determined by checking for the WM_STATE property, as
 346  * described in the Inter-Client Communication Conventions Manual (ICCCM).
 347  * If no windows are found with the WM_STATE property set, the message is sent
 348  * to all children of the root window.
 349  **/
 350 void
 351 gdk_event_send_clientmessage_toall (GdkEvent *event)
 352 {
 353   g_return_if_fail (event != NULL);
 354
 355   gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
 356 }
 357
 358 /**
 359  * gdk_device_get_core_pointer:
 360  *
 361  * Returns the core pointer device for the default display.
 362  *
 363  * Return value: the core pointer device; this is owned by the
 364  *   display and should not be freed.
 365  **/
 366 GdkDevice *
 367 gdk_device_get_core_pointer (void)
 368 {
 369   return gdk_display_get_core_pointer (gdk_display_get_default ());
 370 }
 371
 372 /**
 373  * gdk_display_get_core_pointer:
 374  * @display: a #GdkDisplay
 375  *
 376  * Returns the core pointer device for the given display
 377  *
 378  * Return value: the core pointer device; this is owned by the
 379  *   display and should not be freed.
 380  *
 381  * Since: 2.2
 382  **/
 383 GdkDevice *
 384 gdk_display_get_core_pointer (GdkDisplay *display)
 385 {
 386   return display->core_pointer;
 387 }
 388
 389 /**
 390  * gdk_set_sm_client_id:
 391  * @sm_client_id: the client id assigned by the session manager when the
 392  *    connection was opened, or %NULL to remove the property.
 393  *
 394  * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
 395  * the window manager can save the application's state using the X11R6 ICCCM
 396  * session management protocol.
 397  *
 398  * See the X Session Management Library documentation for more information on
 399  * session management and the Inter-Client Communication Conventions Manual
 400  * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property.
 401  * (Both documents are part of the X Window System distribution.)
 402  **/
 403 void
 404 gdk_set_sm_client_id (const gchar* sm_client_id)
 405 {
 406   GSList *displays, *tmp_list;
 407
 408   g_free (gdk_sm_client_id);
 409   gdk_sm_client_id = g_strdup (sm_client_id);
 410
 411   displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
 412   for (tmp_list = displays; tmp_list; tmp_list = tmp_list->next)
 413     _gdk_windowing_display_set_sm_client_id (tmp_list->data, sm_client_id);
 414
 415   g_slist_free (displays);
 416 }
 417
 418 /**
 419  * _gdk_get_sm_client_id:
 420  *
 421  * Gets the client ID set with gdk_set_sm_client_id(), if any.
 422  *
 423  * Return value: Session ID, or %NULL if gdk_set_sm_client_id()
 424  *               has never been called.
 425  **/
 426 const char *
 427 _gdk_get_sm_client_id (void)
 428 {
 429   return gdk_sm_client_id;
 430 }
 431
 432 /**
 433  * gdk_display_get_pointer:
 434  * @display: a #GdkDisplay
 435  * @screen: location to store the screen that the
 436  *          cursor is on, or %NULL.
 437  * @x: location to store root window X coordinate of pointer, or %NULL.
 438  * @y: location to store root window Y coordinate of pointer, or %NULL.
 439  * @mask: location to store current modifier mask, or %NULL
 440  *
 441  * Gets the current location of the pointer and the current modifier
 442  * mask for a given display.
 443  *
 444  * Since: 2.2
 445  **/
 446 void
 447 gdk_display_get_pointer (GdkDisplay      *display,
 448                          GdkScreen      **screen,
 449                          gint            *x,
 450                          gint            *y,
 451                          GdkModifierType *mask)
 452 {
 453   GdkScreen *tmp_screen;
 454   gint tmp_x, tmp_y;
 455   GdkModifierType tmp_mask;
 456
 457   g_return_if_fail (GDK_IS_DISPLAY (display));
 458
 459   display->pointer_hooks->get_pointer (display, &tmp_screen, &tmp_x, &tmp_y, &tmp_mask);
 460
 461   if (screen)
 462     *screen = tmp_screen;
 463   if (x)
 464     *x = tmp_x;
 465   if (y)
 466     *y = tmp_y;
 467   if (mask)
 468     *mask = tmp_mask;
 469 }
 470
 471 /**
 472  * gdk_display_get_window_at_pointer:
 473  * @display: a #GdkDisplay
 474  * @win_x: return location for origin of the window under the pointer
 475  * @win_y: return location for origin of the window under the pointer
 476  *
 477  * Obtains the window underneath the mouse pointer, returning the location
 478  * of that window in @win_x, @win_y for @screen. Returns %NULL if the window
 479  * under the mouse pointer is not known to GDK (for example, belongs to
 480  * another application).
 481  *
 482  * Returns: the window under the mouse pointer, or %NULL
 483  *
 484  * Since: 2.2
 485  **/
 486 GdkWindow *
 487 gdk_display_get_window_at_pointer (GdkDisplay *display,
 488                                    gint       *win_x,
 489                                    gint       *win_y)
 490 {
 491   gint tmp_x, tmp_y;
 492   GdkWindow *window;
 493
 494   g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
 495
 496   window = display->pointer_hooks->window_at_pointer (display, &tmp_x, &tmp_y);
 497
 498   if (win_x)
 499     *win_x = tmp_x;
 500   if (win_y)
 501     *win_y = tmp_y;
 502
 503   return window;
 504 }
 505
 506 /**
 507  * gdk_display_set_pointer_hooks:
 508  * @display: a #GdkDisplay
 509  * @new_hooks: a table of pointers to functions for getting
 510  *   quantities related to the current pointer position,
 511  *   or %NULL to restore the default table.
 512  *
 513  * This function allows for hooking into the operation
 514  * of getting the current location of the pointer on a particular
 515  * display. This is only useful for such low-level tools as an
 516  * event recorder. Applications should never have any
 517  * reason to use this facility.
 518  *
 519  * Return value: the previous pointer hook table
 520  *
 521  * Since: 2.2
 522  **/
 523 GdkDisplayPointerHooks *
 524 gdk_display_set_pointer_hooks (GdkDisplay                   *display,
 525                                const GdkDisplayPointerHooks *new_hooks)
 526 {
 527   const GdkDisplayPointerHooks *result;
 528
 529   g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
 530   result = display->pointer_hooks;
 531
 532   if (new_hooks)
 533     display->pointer_hooks = new_hooks;
 534   else
 535     display->pointer_hooks = &default_pointer_hooks;
 536
 537   return (GdkDisplayPointerHooks *)result;
 538 }
 539
 540 static void
 541 singlehead_get_pointer (GdkDisplay       *display,
 542                         GdkScreen       **screen,
 543                         gint             *x,
 544                         gint             *y,
 545                         GdkModifierType  *mask)
 546 {
 547   GdkScreen *default_screen = gdk_display_get_default_screen (display);
 548   GdkWindow *root_window = gdk_screen_get_root_window (default_screen);
 549
 550   *screen = default_screen;
 551
 552   singlehead_current_pointer_hooks->get_pointer (root_window, x, y, mask);
 553 }
 554
 555 static GdkWindow*
 556 singlehead_window_get_pointer (GdkDisplay       *display,
 557                                GdkWindow        *window,
 558                                gint             *x,
 559                                gint             *y,
 560                                GdkModifierType  *mask)
 561 {
 562   return singlehead_current_pointer_hooks->get_pointer (window, x, y, mask);
 563 }
 564
 565 static GdkWindow*
 566 singlehead_window_at_pointer   (GdkDisplay *display,
 567                                 gint       *win_x,
 568                                 gint       *win_y)
 569 {
 570   GdkScreen *default_screen = gdk_display_get_default_screen (display);
 571
 572   return singlehead_current_pointer_hooks->window_at_pointer (default_screen,
 573                                                               win_x, win_y);
 574 }
 575
 576 static GdkWindow*
 577 singlehead_default_window_get_pointer (GdkWindow       *window,
 578                                        gint            *x,
 579                                        gint            *y,
 580                                        GdkModifierType *mask)
 581 {
 582   return _gdk_windowing_window_get_pointer (gdk_drawable_get_display (window),
 583                                             window, x, y, mask);
 584 }
 585
 586 static GdkWindow*
 587 singlehead_default_window_at_pointer  (GdkScreen       *screen,
 588                                        gint            *win_x,
 589                                        gint            *win_y)
 590 {
 591   return _gdk_windowing_window_at_pointer (gdk_screen_get_display (screen),
 592                                            win_x, win_y);
 593 }
 594
 595 /**
 596  * gdk_set_pointer_hooks:
 597  * @new_hooks: a table of pointers to functions for getting
 598  *   quantities related to the current pointer position,
 599  *   or %NULL to restore the default table.
 600  *
 601  * This function allows for hooking into the operation
 602  * of getting the current location of the pointer. This
 603  * is only useful for such low-level tools as an
 604  * event recorder. Applications should never have any
 605  * reason to use this facility.
 606  *
 607  * This function is not multihead safe. For multihead operation,
 608  * see gdk_display_set_pointer_hooks().
 609  *
 610  * Return value: the previous pointer hook table
 611  **/
 612 GdkPointerHooks *
 613 gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
 614 {
 615   const GdkPointerHooks *result = singlehead_current_pointer_hooks;
 616
 617   if (new_hooks)
 618     singlehead_current_pointer_hooks = new_hooks;
 619   else
 620     singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
 621
 622   gdk_display_set_pointer_hooks (gdk_display_get_default (),
 623                                  &singlehead_pointer_hooks);
 624
 625   return (GdkPointerHooks *)result;
 626 }
 627
 628 #define __GDK_DISPLAY_C__
 629 #include "gdkaliasdef.c"