gdkdisplay.c 17.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * gdkdisplay.c
 * 
 * Copyright 2001 Sun Microsystems Inc. 
 *
 * Erwann Chenede <erwann.chenede@sun.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

24
#include "config.h"
25
#include <glib.h>
26
#include "gdk.h"		/* gdk_event_send_client_message() */
27 28
#include "gdkdisplay.h"
#include "gdkinternals.h"
29
#include "gdkmarshalers.h"
30
#include "gdkscreen.h"
31
#include "gdkalias.h"
32

33 34 35 36 37
enum {
  CLOSED,
  LAST_SIGNAL
};

38
static void gdk_display_dispose    (GObject         *object);
39 40
static void gdk_display_finalize   (GObject         *object);

41

Matthias Clasen's avatar
Matthias Clasen committed
42
static void       singlehead_get_pointer (GdkDisplay       *display,
43 44 45 46
					  GdkScreen       **screen,
					  gint             *x,
					  gint             *y,
					  GdkModifierType  *mask);
Matthias Clasen's avatar
Matthias Clasen committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
static GdkWindow* singlehead_window_get_pointer (GdkDisplay       *display,
						 GdkWindow        *window,
						 gint             *x,
						 gint             *y,
						 GdkModifierType  *mask);
static GdkWindow* singlehead_window_at_pointer  (GdkDisplay       *display,
						 gint             *win_x,
						 gint             *win_y);

static GdkWindow* singlehead_default_window_get_pointer (GdkWindow       *window,
							 gint            *x,
							 gint            *y,
							 GdkModifierType *mask);
static GdkWindow* singlehead_default_window_at_pointer  (GdkScreen       *screen,
							 gint            *win_x,
							 gint            *win_y);
63

64 65
static guint signals[LAST_SIGNAL] = { 0 };

66
static char *gdk_sm_client_id;
67

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
static const GdkDisplayPointerHooks default_pointer_hooks = {
  _gdk_windowing_get_pointer,
  _gdk_windowing_window_get_pointer,
  _gdk_windowing_window_at_pointer
};

static const GdkDisplayPointerHooks singlehead_pointer_hooks = {
  singlehead_get_pointer,
  singlehead_window_get_pointer,
  singlehead_window_at_pointer
};

static const GdkPointerHooks singlehead_default_pointer_hooks = {
  singlehead_default_window_get_pointer,
  singlehead_default_window_at_pointer
};

static const GdkPointerHooks *singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;

Matthias Clasen's avatar
Matthias Clasen committed
87
G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
88 89 90 91 92 93 94

static void
gdk_display_class_init (GdkDisplayClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
  
  object_class->finalize = gdk_display_finalize;
95
  object_class->dispose = gdk_display_dispose;
96

97 98 99 100 101 102 103 104 105 106
  /**
   * GdkDisplay::closed:
   * @display: the object on which the signal is emitted
   * @is_error: %TRUE if the display was closed due to an error
   *
   * The ::closed signal is emitted when the connection to the windowing
   * system for @display is closed.
   *
   * Since: 2.2
   */   
107
  signals[CLOSED] =
Matthias Clasen's avatar
Matthias Clasen committed
108
    g_signal_new (g_intern_static_string ("closed"),
109 110 111 112 113 114 115 116
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GdkDisplayClass, closed),
		  NULL, NULL,
		  gdk_marshal_VOID__BOOLEAN,
		  G_TYPE_NONE,
		  1,
		  G_TYPE_BOOLEAN);
117 118 119 120 121 122 123 124 125 126
}

static void
gdk_display_init (GdkDisplay *display)
{
  _gdk_displays = g_slist_prepend (_gdk_displays, display);

  display->button_click_time[0] = display->button_click_time[1] = 0;
  display->button_window[0] = display->button_window[1] = NULL;
  display->button_number[0] = display->button_number[1] = -1;
127 128
  display->button_x[0] = display->button_x[1] = 0;
  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 137 138 139
static void
gdk_display_dispose (GObject *object)
{
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
140 141 142 143 144 145 146 147 148

  g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
  g_list_free (display->queued_events);
  display->queued_events = NULL;
  display->queued_tail = NULL;

  _gdk_displays = g_slist_remove (_gdk_displays, object);

  if (gdk_display_get_default() == display)
149 150 151 152 153 154 155 156
    {
      if (_gdk_displays)
        gdk_display_manager_set_default_display (gdk_display_manager_get(),
                                                 _gdk_displays->data);
      else
        gdk_display_manager_set_default_display (gdk_display_manager_get(),
                                                 NULL);
    }
157

Matthias Clasen's avatar
Matthias Clasen committed
158
  G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
159 160
}

161 162 163
static void
gdk_display_finalize (GObject *object)
{
Matthias Clasen's avatar
Matthias Clasen committed
164
  G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
165 166 167 168 169 170
}

/**
 * gdk_display_close:
 * @display: a #GdkDisplay
 *
171
 * Closes the connection to the windowing system for the given display,
172
 * and cleans up associated resources.
Matthias Clasen's avatar
Matthias Clasen committed
173 174
 *
 * Since: 2.2
175 176 177 178 179
 */
void
gdk_display_close (GdkDisplay *display)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
180 181 182 183

  if (!display->closed)
    {
      display->closed = TRUE;
184 185
      
      g_signal_emit (display, signals[CLOSED], 0, FALSE);
186 187
      g_object_run_dispose (G_OBJECT (display));
      
188
      g_object_unref (display);
189
    }
190 191 192 193 194 195 196 197 198 199 200
}

/**
 * gdk_display_get_event:
 * @display: a #GdkDisplay
 * 
 * Gets the next #GdkEvent to be processed for @display, fetching events from the
 * windowing system if necessary.
 * 
 * Return value: the next #GdkEvent to be processed, or %NULL if no events
 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
Matthias Clasen's avatar
Matthias Clasen committed
201 202
 *
 * Since: 2.2
203 204 205 206 207 208 209 210 211 212 213 214
 **/
GdkEvent*
gdk_display_get_event (GdkDisplay *display)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  
  _gdk_events_queue (display);
  return _gdk_event_unqueue (display);
}

/**
 * gdk_display_peek_event:
Alexander Larsson's avatar
Alexander Larsson committed
215
 * @display: a #GdkDisplay 
216 217 218 219 220 221
 * 
 * Gets a copy of the first #GdkEvent in the @display's event queue, without
 * removing the event from the queue.  (Note that this function will
 * not get more events from the windowing system.  It only checks the events
 * that have already been moved to the GDK event queue.)
 * 
Matthias Clasen's avatar
Matthias Clasen committed
222 223
 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL 
 * if no events are in the queue. The returned #GdkEvent should be freed with
224
 * gdk_event_free().
Matthias Clasen's avatar
Matthias Clasen committed
225 226
 *
 * Since: 2.2
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
 **/
GdkEvent*
gdk_display_peek_event (GdkDisplay *display)
{
  GList *tmp_list;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  tmp_list = _gdk_event_queue_find_first (display);
  
  if (tmp_list)
    return gdk_event_copy (tmp_list->data);
  else
    return NULL;
}

/**
 * gdk_display_put_event:
 * @display: a #GdkDisplay
 * @event: a #GdkEvent.
 *
 * Appends a copy of the given event onto the front of the event
 * queue for @display.
Matthias Clasen's avatar
Matthias Clasen committed
250 251
 *
 * Since: 2.2
252 253
 **/
void
254 255
gdk_display_put_event (GdkDisplay     *display,
		       const GdkEvent *event)
256 257 258 259 260
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (event != NULL);

  _gdk_event_queue_append (display, gdk_event_copy (event));
261 262
  /* If the main loop is blocking in a different thread, wake it up */
  g_main_context_wakeup (NULL); 
263
}
264 265 266

/**
 * gdk_pointer_ungrab:
Matthias Clasen's avatar
Matthias Clasen committed
267 268
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no 
 *  timestamp is available.
269
 *
270 271
 * Ungrabs the pointer on the default display, if it is grabbed by this 
 * application.
272 273 274 275
 **/
void
gdk_pointer_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
276
  gdk_display_pointer_ungrab (gdk_display_get_default (), time);
277 278 279 280 281
}

/**
 * gdk_pointer_is_grabbed:
 * 
282 283
 * Returns %TRUE if the pointer on the default display is currently 
 * grabbed by this application.
284 285 286 287 288 289 290 291 292
 *
 * Note that this does not take the inmplicit pointer grab on button
 * presses into account.

 * Return value: %TRUE if the pointer is currently grabbed by this application.* 
 **/
gboolean
gdk_pointer_is_grabbed (void)
{
Owen Taylor's avatar
Owen Taylor committed
293
  return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
294 295 296 297
}

/**
 * gdk_keyboard_ungrab:
298
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
299 300
 *        timestamp is available.
 * 
301 302
 * Ungrabs the keyboard on the default display, if it is grabbed by this 
 * application.
303 304 305 306
 **/
void
gdk_keyboard_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
307
  gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
308 309 310 311 312
}

/**
 * gdk_beep:
 * 
313
 * Emits a short beep on the default display.
314 315 316 317
 **/
void
gdk_beep (void)
{
Owen Taylor's avatar
Owen Taylor committed
318
  gdk_display_beep (gdk_display_get_default ());
319 320 321 322 323
}

/**
 * gdk_event_send_client_message:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
Owen Taylor's avatar
Owen Taylor committed
324
 * @winid:  the window to send the X ClientMessage event to.
325 326 327 328 329 330 331 332 333
 * 
 * Sends an X ClientMessage event to a given window (which must be
 * on the default #GdkDisplay.)
 * This could be used for communicating between different applications,
 * though the amount of data is limited to 20 bytes.
 * 
 * Return value: non-zero on success.
 **/
gboolean
Owen Taylor's avatar
Owen Taylor committed
334 335
gdk_event_send_client_message (GdkEvent        *event,
			       GdkNativeWindow  winid)
336 337 338
{
  g_return_val_if_fail (event != NULL, FALSE);

Owen Taylor's avatar
Owen Taylor committed
339
  return gdk_event_send_client_message_for_display (gdk_display_get_default (),
Owen Taylor's avatar
Owen Taylor committed
340
						    event, winid);
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
}

/**
 * gdk_event_send_clientmessage_toall:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
 *
 * Sends an X ClientMessage event to all toplevel windows on the default
 * #GdkScreen.
 *
 * Toplevel windows are determined by checking for the WM_STATE property, as
 * described in the Inter-Client Communication Conventions Manual (ICCCM).
 * If no windows are found with the WM_STATE property set, the message is sent
 * to all children of the root window.
 **/
void
gdk_event_send_clientmessage_toall (GdkEvent *event)
{
  g_return_if_fail (event != NULL);

Owen Taylor's avatar
Owen Taylor committed
360
  gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
361 362
}

363 364 365 366 367 368 369 370 371 372 373
/**
 * gdk_device_get_core_pointer:
 * 
 * Returns the core pointer device for the default display.
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
 **/
GdkDevice *
gdk_device_get_core_pointer (void)
{
Owen Taylor's avatar
Owen Taylor committed
374
  return gdk_display_get_core_pointer (gdk_display_get_default ());
375 376 377 378 379 380 381 382 383 384
}

/**
 * gdk_display_get_core_pointer:
 * @display: a #GdkDisplay
 * 
 * Returns the core pointer device for the given display
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
385 386
 *
 * Since: 2.2
387 388 389 390 391 392
 **/
GdkDevice *
gdk_display_get_core_pointer (GdkDisplay *display)
{
  return display->core_pointer;
}
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

/**
 * gdk_set_sm_client_id:
 * @sm_client_id: the client id assigned by the session manager when the
 *    connection was opened, or %NULL to remove the property.
 * 
 * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
 * the window manager can save the application's state using the X11R6 ICCCM
 * session management protocol.
 *
 * See the X Session Management Library documentation for more information on
 * session management and the Inter-Client Communication Conventions Manual
 * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property. 
 * (Both documents are part of the X Window System distribution.)
 **/
void
gdk_set_sm_client_id (const gchar* sm_client_id)
{
411 412 413 414 415 416 417 418 419 420
  GSList *displays, *tmp_list;
  
  g_free (gdk_sm_client_id);
  gdk_sm_client_id = g_strdup (sm_client_id);

  displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
  for (tmp_list = displays; tmp_list; tmp_list = tmp_list->next)
    _gdk_windowing_display_set_sm_client_id (tmp_list->data, sm_client_id);

  g_slist_free (displays);
421 422
}

423 424 425 426 427 428 429 430 431 432 433 434 435
/**
 * _gdk_get_sm_client_id:
 * 
 * Gets the client ID set with gdk_set_sm_client_id(), if any.
 * 
 * Return value: Session ID, or %NULL if gdk_set_sm_client_id()
 *               has never been called.
 **/
const char *
_gdk_get_sm_client_id (void)
{
  return gdk_sm_client_id;
}
436 437 438 439 440 441 442 443 444 445 446 447

/**
 * gdk_display_get_pointer:
 * @display: a #GdkDisplay
 * @screen: location to store the screen that the
 *          cursor is on, or %NULL.
 * @x: location to store root window X coordinate of pointer, or %NULL.
 * @y: location to store root window Y coordinate of pointer, or %NULL.
 * @mask: location to store current modifier mask, or %NULL
 * 
 * Gets the current location of the pointer and the current modifier
 * mask for a given display.
Matthias Clasen's avatar
Matthias Clasen committed
448 449
 *
 * Since: 2.2
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
 **/
void
gdk_display_get_pointer (GdkDisplay      *display,
			 GdkScreen      **screen,
			 gint            *x,
			 gint            *y,
			 GdkModifierType *mask)
{
  GdkScreen *tmp_screen;
  gint tmp_x, tmp_y;
  GdkModifierType tmp_mask;
  
  g_return_if_fail (GDK_IS_DISPLAY (display));

  display->pointer_hooks->get_pointer (display, &tmp_screen, &tmp_x, &tmp_y, &tmp_mask);

  if (screen)
    *screen = tmp_screen;
  if (x)
    *x = tmp_x;
  if (y)
    *y = tmp_y;
  if (mask)
    *mask = tmp_mask;
}

/**
 * gdk_display_get_window_at_pointer:
 * @display: a #GdkDisplay
479 480 481 482
 * @win_x: return location for x coordinate of the pointer location relative 
 *    to the window origin, or %NULL
 * @win_y: return location for y coordinate of the pointer location relative
 &    to the window origin, or %NULL
483 484
 * 
 * Obtains the window underneath the mouse pointer, returning the location
485 486 487
 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL 
 * if the window under the mouse pointer is not known to GDK (for example, 
 * belongs to another application).
488 489
 * 
 * Returns: the window under the mouse pointer, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
490 491
 *
 * Since: 2.2
492 493 494 495 496 497 498
 **/
GdkWindow *
gdk_display_get_window_at_pointer (GdkDisplay *display,
				   gint       *win_x,
				   gint       *win_y)
{
  gint tmp_x, tmp_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
499
  GdkWindow *window;
500 501

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
502 503

  window = display->pointer_hooks->window_at_pointer (display, &tmp_x, &tmp_y);
504 505 506 507 508

  if (win_x)
    *win_x = tmp_x;
  if (win_y)
    *win_y = tmp_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
509 510

  return window;
511 512 513 514
}

/**
 * gdk_display_set_pointer_hooks:
Matthias Clasen's avatar
Matthias Clasen committed
515
 * @display: a #GdkDisplay
516 517 518 519 520 521 522 523 524 525 526
 * @new_hooks: a table of pointers to functions for getting
 *   quantities related to the current pointer position,
 *   or %NULL to restore the default table.
 * 
 * This function allows for hooking into the operation
 * of getting the current location of the pointer on a particular
 * display. This is only useful for such low-level tools as an
 * event recorder. Applications should never have any
 * reason to use this facility.
 *
 * Return value: the previous pointer hook table
Matthias Clasen's avatar
Matthias Clasen committed
527 528
 *
 * Since: 2.2
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
 **/
GdkDisplayPointerHooks *
gdk_display_set_pointer_hooks (GdkDisplay                   *display,
			       const GdkDisplayPointerHooks *new_hooks)
{
  const GdkDisplayPointerHooks *result;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  result = display->pointer_hooks;

  if (new_hooks)
    display->pointer_hooks = new_hooks;
  else
    display->pointer_hooks = &default_pointer_hooks;

  return (GdkDisplayPointerHooks *)result;
}

Matthias Clasen's avatar
Matthias Clasen committed
547
static void
548 549 550 551 552 553 554 555 556 557 558 559 560 561
singlehead_get_pointer (GdkDisplay       *display,
			GdkScreen       **screen,
			gint             *x,
			gint             *y,
			GdkModifierType  *mask)
{
  GdkScreen *default_screen = gdk_display_get_default_screen (display);
  GdkWindow *root_window = gdk_screen_get_root_window (default_screen);

  *screen = default_screen;

  singlehead_current_pointer_hooks->get_pointer (root_window, x, y, mask);
}

Matthias Clasen's avatar
Matthias Clasen committed
562
static GdkWindow*
563 564 565 566 567 568 569 570 571
singlehead_window_get_pointer (GdkDisplay       *display,
			       GdkWindow        *window,
			       gint             *x,
			       gint             *y,
			       GdkModifierType  *mask)
{
  return singlehead_current_pointer_hooks->get_pointer (window, x, y, mask);
}

Matthias Clasen's avatar
Matthias Clasen committed
572
static GdkWindow*
573 574 575 576 577 578 579 580 581 582
singlehead_window_at_pointer   (GdkDisplay *display,
				gint       *win_x,
				gint       *win_y)
{
  GdkScreen *default_screen = gdk_display_get_default_screen (display);

  return singlehead_current_pointer_hooks->window_at_pointer (default_screen,
							      win_x, win_y);
}

Matthias Clasen's avatar
Matthias Clasen committed
583
static GdkWindow*
584 585 586 587 588 589 590 591 592
singlehead_default_window_get_pointer (GdkWindow       *window,
				       gint            *x,
				       gint            *y,
				       GdkModifierType *mask)
{
  return _gdk_windowing_window_get_pointer (gdk_drawable_get_display (window),
					    window, x, y, mask);
}

Matthias Clasen's avatar
Matthias Clasen committed
593
static GdkWindow*
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
singlehead_default_window_at_pointer  (GdkScreen       *screen,
				       gint            *win_x,
				       gint            *win_y)
{
  return _gdk_windowing_window_at_pointer (gdk_screen_get_display (screen),
					   win_x, win_y);
}

/**
 * gdk_set_pointer_hooks:
 * @new_hooks: a table of pointers to functions for getting
 *   quantities related to the current pointer position,
 *   or %NULL to restore the default table.
 * 
 * This function allows for hooking into the operation
 * of getting the current location of the pointer. This
 * is only useful for such low-level tools as an
 * event recorder. Applications should never have any
 * reason to use this facility.
 *
 * This function is not multihead safe. For multihead operation,
 * see gdk_display_set_pointer_hooks().
 * 
 * Return value: the previous pointer hook table
 **/
GdkPointerHooks *
gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
{
  const GdkPointerHooks *result = singlehead_current_pointer_hooks;

  if (new_hooks)
    singlehead_current_pointer_hooks = new_hooks;
  else
    singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;

  gdk_display_set_pointer_hooks (gdk_display_get_default (),
				 &singlehead_pointer_hooks);
  
  return (GdkPointerHooks *)result;
}

635 636
#define __GDK_DISPLAY_C__
#include "gdkaliasdef.c"