gdkdevice.c 46.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* GDK - The GIMP Drawing Kit
 * Copyright (C) 2009 Carlos Garnacho <carlosg@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser 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.
 */

#include "config.h"
21

22 23
#include <math.h>

24
#include "gdkdeviceprivate.h"
25 26
#include "gdkdisplayprivate.h"
#include "gdkinternals.h"
27
#include "gdkintl.h"
28

Matthias Clasen's avatar
Matthias Clasen committed
29 30 31 32 33 34 35 36 37 38 39 40 41
/**
 * SECTION:gdkdevice
 * @Short_description: Object representing an input device
 * @Title: GdkDevice
 * @See_also: #GdkDeviceManager
 *
 * The #GdkDevice object represents a single input device.
 *
 * See the #GdkDeviceManager documentation for more information
 * about the various kinds of master and slave devices, and their
 * relationships.
 */

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
typedef struct _GdkAxisInfo GdkAxisInfo;

struct _GdkAxisInfo
{
  GdkAtom label;
  GdkAxisUse use;

  gdouble min_axis;
  gdouble max_axis;

  gdouble min_value;
  gdouble max_value;
  gdouble resolution;
};

57 58 59 60 61 62 63 64
enum {
  CHANGED,
  LAST_SIGNAL
};

static guint signals [LAST_SIGNAL] = { 0 };


65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
static void gdk_device_dispose      (GObject      *object);
static void gdk_device_set_property (GObject      *object,
                                     guint         prop_id,
                                     const GValue *value,
                                     GParamSpec   *pspec);
static void gdk_device_get_property (GObject      *object,
                                     guint         prop_id,
                                     GValue       *value,
                                     GParamSpec   *pspec);


G_DEFINE_ABSTRACT_TYPE (GdkDevice, gdk_device, G_TYPE_OBJECT)

enum {
  PROP_0,
  PROP_DISPLAY,
  PROP_DEVICE_MANAGER,
  PROP_NAME,
  PROP_ASSOCIATED_DEVICE,
  PROP_TYPE,
  PROP_INPUT_SOURCE,
  PROP_INPUT_MODE,
  PROP_HAS_CURSOR,
  PROP_N_AXES
};


static void
gdk_device_class_init (GdkDeviceClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->dispose = gdk_device_dispose;
  object_class->set_property = gdk_device_set_property;
  object_class->get_property = gdk_device_get_property;

  /**
   * GdkDevice:display:
   *
   * The #GdkDisplay the #GdkDevice pertains to.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
109 110
                                   PROP_DISPLAY,
                                   g_param_spec_object ("display",
111
                                                        P_("Device Display"),
112
                                                        P_("Display which the device belongs to"),
113 114 115 116 117 118 119 120 121 122 123
                                                        GDK_TYPE_DISPLAY,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                        G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:device-manager:
   *
   * The #GdkDeviceManager the #GdkDevice pertains to.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
124 125
                                   PROP_DEVICE_MANAGER,
                                   g_param_spec_object ("device-manager",
126
                                                        P_("Device manager"),
127
                                                        P_("Device manager which the device belongs to"),
128 129 130 131 132 133 134 135 136 137 138
                                                        GDK_TYPE_DEVICE_MANAGER,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                        G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:name:
   *
   * The device name.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
139 140
                                   PROP_NAME,
                                   g_param_spec_string ("name",
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
                                                        P_("Device name"),
                                                        P_("Device name"),
                                                        NULL,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                        G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:type:
   *
   * Device role in the device manager.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
                                   PROP_TYPE,
                                   g_param_spec_enum ("type",
                                                      P_("Device type"),
                                                      P_("Device role in the device manager"),
                                                      GDK_TYPE_DEVICE_TYPE,
                                                      GDK_DEVICE_TYPE_MASTER,
                                                      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                      G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:associated-device:
   *
165
   * Associated pointer or keyboard with this device, if any. Devices of type #GDK_DEVICE_TYPE_MASTER
166 167 168 169 170
   * always come in keyboard/pointer pairs. Other device types will have a %NULL associated device.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
171 172
                                   PROP_ASSOCIATED_DEVICE,
                                   g_param_spec_object ("associated-device",
173
                                                        P_("Associated device"),
174
                                                        P_("Associated pointer or keyboard with this device"),
175 176 177 178 179 180 181 182 183 184
                                                        GDK_TYPE_DEVICE,
                                                        G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:input-source:
   *
   * Source type for the device.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
185 186
                                   PROP_INPUT_SOURCE,
                                   g_param_spec_enum ("input-source",
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
                                                      P_("Input source"),
                                                      P_("Source type for the device"),
                                                      GDK_TYPE_INPUT_SOURCE,
                                                      GDK_SOURCE_MOUSE,
                                                      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                      G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:input-mode:
   *
   * Input mode for the device.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
                                   PROP_INPUT_MODE,
Matthias Clasen's avatar
Matthias Clasen committed
202
                                   g_param_spec_enum ("input-mode",
203 204 205 206 207 208 209 210 211 212 213 214 215 216
                                                      P_("Input mode for the device"),
                                                      P_("Input mode for the device"),
                                                      GDK_TYPE_INPUT_MODE,
                                                      GDK_MODE_DISABLED,
                                                      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:has-cursor:
   *
   * Whether the device is represented by a cursor on the screen. Devices of type
   * %GDK_DEVICE_TYPE_MASTER will have %TRUE here.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
217 218
                                   PROP_HAS_CURSOR,
                                   g_param_spec_boolean ("has-cursor",
219
                                                         P_("Whether the device has a cursor"),
220 221 222 223 224 225 226 227 228 229 230 231
                                                         P_("Whether there is a visible cursor following device motion"),
                                                         FALSE,
                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                         G_PARAM_STATIC_STRINGS));
  /**
   * GdkDevice:n-axes:
   *
   * Number of axes in the device.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
232 233
                                   PROP_N_AXES,
                                   g_param_spec_uint ("n-axes",
234 235 236 237 238
                                                      P_("Number of axes in the device"),
                                                      P_("Number of axes in the device"),
                                                      0, G_MAXUINT, 0,
                                                      G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
  /**
   * GdkDevice::changed:
   * @device: the #GdkDevice that changed.
   *
   * The ::changed signal is emitted either when the #GdkDevice
   * has changed the number of either axes or keys. For example
   * In X this will normally happen when the slave device routing
   * events through the master device changes (for example, user
   * switches from the USB mouse to a tablet), in that case the
   * master device will change to reflect the new slave device
   * axes and keys.
   */
  signals[CHANGED] =
    g_signal_new (g_intern_static_string ("changed"),
                  G_TYPE_FROM_CLASS (object_class),
                  G_SIGNAL_RUN_LAST,
255
                  0, NULL, NULL,
256 257
                  g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE, 0);
258 259 260 261 262
}

static void
gdk_device_init (GdkDevice *device)
{
Matthias Clasen's avatar
Matthias Clasen committed
263
  device->axes = g_array_new (FALSE, TRUE, sizeof (GdkAxisInfo));
264 265 266 267 268
}

static void
gdk_device_dispose (GObject *object)
{
Matthias Clasen's avatar
Matthias Clasen committed
269
  GdkDevice *device = GDK_DEVICE (object);
270

Matthias Clasen's avatar
Matthias Clasen committed
271 272
  if (device->type == GDK_DEVICE_TYPE_SLAVE)
    _gdk_device_remove_slave (device->associated, device);
273

Matthias Clasen's avatar
Matthias Clasen committed
274
  if (device->associated)
275
    {
Matthias Clasen's avatar
Matthias Clasen committed
276 277 278
      _gdk_device_set_associated_device (device->associated, NULL);
      g_object_unref (device->associated);
      device->associated = NULL;
279 280
    }

Matthias Clasen's avatar
Matthias Clasen committed
281
  if (device->axes)
282
    {
Matthias Clasen's avatar
Matthias Clasen committed
283 284
      g_array_free (device->axes, TRUE);
      device->axes = NULL;
285 286
    }

Matthias Clasen's avatar
Matthias Clasen committed
287 288
  g_free (device->name);
  g_free (device->keys);
289

Matthias Clasen's avatar
Matthias Clasen committed
290 291
  device->name = NULL;
  device->keys = NULL;
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306

  G_OBJECT_CLASS (gdk_device_parent_class)->dispose (object);
}

static void
gdk_device_set_property (GObject      *object,
                         guint         prop_id,
                         const GValue *value,
                         GParamSpec   *pspec)
{
  GdkDevice *device = GDK_DEVICE (object);

  switch (prop_id)
    {
    case PROP_DISPLAY:
Matthias Clasen's avatar
Matthias Clasen committed
307
      device->display = g_value_get_object (value);
308 309
      break;
    case PROP_DEVICE_MANAGER:
Matthias Clasen's avatar
Matthias Clasen committed
310
      device->manager = g_value_get_object (value);
311 312
      break;
    case PROP_NAME:
Matthias Clasen's avatar
Matthias Clasen committed
313 314
      if (device->name)
        g_free (device->name);
315

Matthias Clasen's avatar
Matthias Clasen committed
316
      device->name = g_value_dup_string (value);
317 318
      break;
    case PROP_TYPE:
Matthias Clasen's avatar
Matthias Clasen committed
319
      device->type = g_value_get_enum (value);
320 321
      break;
    case PROP_INPUT_SOURCE:
Matthias Clasen's avatar
Matthias Clasen committed
322
      device->source = g_value_get_enum (value);
323 324 325 326 327
      break;
    case PROP_INPUT_MODE:
      gdk_device_set_mode (device, g_value_get_enum (value));
      break;
    case PROP_HAS_CURSOR:
Matthias Clasen's avatar
Matthias Clasen committed
328
      device->has_cursor = g_value_get_boolean (value);
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gdk_device_get_property (GObject    *object,
                         guint       prop_id,
                         GValue     *value,
                         GParamSpec *pspec)
{
  GdkDevice *device = GDK_DEVICE (object);

  switch (prop_id)
    {
    case PROP_DISPLAY:
Matthias Clasen's avatar
Matthias Clasen committed
347
      g_value_set_object (value, device->display);
348 349
      break;
    case PROP_DEVICE_MANAGER:
Matthias Clasen's avatar
Matthias Clasen committed
350
      g_value_set_object (value, device->manager);
351 352
      break;
    case PROP_ASSOCIATED_DEVICE:
Matthias Clasen's avatar
Matthias Clasen committed
353
      g_value_set_object (value, device->associated);
354 355
      break;
    case PROP_NAME:
Matthias Clasen's avatar
Matthias Clasen committed
356
      g_value_set_string (value, device->name);
357 358
      break;
    case PROP_TYPE:
Matthias Clasen's avatar
Matthias Clasen committed
359
      g_value_set_enum (value, device->type);
360 361
      break;
    case PROP_INPUT_SOURCE:
Matthias Clasen's avatar
Matthias Clasen committed
362
      g_value_set_enum (value, device->source);
363 364
      break;
    case PROP_INPUT_MODE:
Matthias Clasen's avatar
Matthias Clasen committed
365
      g_value_set_enum (value, device->mode);
366 367
      break;
    case PROP_HAS_CURSOR:
Matthias Clasen's avatar
Matthias Clasen committed
368
      g_value_set_boolean (value, device->has_cursor);
369 370
      break;
    case PROP_N_AXES:
Matthias Clasen's avatar
Matthias Clasen committed
371
      g_value_set_uint (value, device->axes->len);
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

/**
 * gdk_device_get_state:
 * @device: a #GdkDevice.
 * @window: a #GdkWindow.
 * @axes: an array of doubles to store the values of the axes of @device in,
 * or %NULL.
 * @mask: location to store the modifiers, or %NULL.
 *
387
 * Gets the current state of a pointer device relative to @window.
388 389 390 391 392 393 394 395
 */
void
gdk_device_get_state (GdkDevice       *device,
                      GdkWindow       *window,
                      gdouble         *axes,
                      GdkModifierType *mask)
{
  g_return_if_fail (GDK_IS_DEVICE (device));
396
  g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
397 398 399 400 401 402
  g_return_if_fail (GDK_IS_WINDOW (window));

  if (GDK_DEVICE_GET_CLASS (device)->get_state)
    GDK_DEVICE_GET_CLASS (device)->get_state (device, window, axes, mask);
}

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
/**
 * gdk_device_get_position:
 * @device: pointer device to query status about.
 * @screen: (out) (transfer none) (allow-none): location to store the #GdkScreen
 *          the @device is on, or %NULL.
 * @x: (out) (allow-none): location to store root window X coordinate of @device, or %NULL.
 * @y: (out) (allow-none): location to store root window Y coordinate of @device, or %NULL.
 *
 * Gets the current location of @device.
 *
 * Since: 3.0
 **/
void
gdk_device_get_position (GdkDevice        *device,
                         GdkScreen       **screen,
                         gint             *x,
                         gint             *y)
{
  GdkDisplay *display;
  gint tmp_x, tmp_y;
423 424
  GdkScreen *default_screen;
  GdkWindow *root;
425 426 427 428 429

  g_return_if_fail (GDK_IS_DEVICE (device));
  g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);

  display = gdk_device_get_display (device);
430 431 432 433 434 435 436
  default_screen = gdk_display_get_default_screen (display);

  _gdk_device_query_state (device,
                           gdk_screen_get_root_window (default_screen),
                           &root, NULL,
                           &tmp_x, &tmp_y,
                           NULL, NULL, NULL);
437 438

  if (screen)
439
    *screen = gdk_window_get_screen (root);
440 441 442 443 444 445
  if (x)
    *x = tmp_x;
  if (y)
    *y = tmp_y;
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
/**
 * gdk_device_get_window_at_position:
 * @device: pointer #GdkDevice to query info to.
 * @win_x: (out) (allow-none): return location for the X coordinate of the device location,
 *         relative to the window origin, or %NULL.
 * @win_y: (out) (allow-none): return location for the Y coordinate of the device location,
 *         relative to the window origin, or %NULL.
 *
 * Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns
 * %NULL if the window tree under @device is not known to GDK (for example, belongs to another application).
 *
 * Returns: (transfer none): the #GdkWindow under the device position, or %NULL.
 *
 * Since: 3.0
 **/
GdkWindow *
gdk_device_get_window_at_position (GdkDevice  *device,
                                   gint       *win_x,
                                   gint       *win_y)
{
  gint tmp_x, tmp_y;
  GdkWindow *window;

  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);

Benjamin Otte's avatar
Benjamin Otte committed
472 473 474 475 476 477 478
  window = _gdk_device_window_at_position (device, &tmp_x, &tmp_y, NULL, FALSE);

  /* This might need corrections, as the native window returned
     may contain client side children */
  if (window)
    {
      double xx, yy;
479

Benjamin Otte's avatar
Benjamin Otte committed
480 481 482 483 484 485
      window = _gdk_window_find_descendant_at (window,
					       tmp_x, tmp_y,
					       &xx, &yy);
      tmp_x = floor (xx + 0.5);
      tmp_y = floor (yy + 0.5);
    }
486 487 488 489 490 491 492 493 494

  if (win_x)
    *win_x = tmp_x;
  if (win_y)
    *win_y = tmp_y;

  return window;
}

495 496 497 498 499 500
/**
 * gdk_device_get_history:
 * @device: a #GdkDevice
 * @window: the window with respect to which which the event coordinates will be reported
 * @start: starting timestamp for range of events to return
 * @stop: ending timestamp for the range of events to return
501
 * @events: (array length=n_events) (out) (transfer full): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
502 503
 * @n_events: location to store the length of @events, or %NULL
 *
504
 * Obtains the motion history for a pointer device; given a starting and
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
 * ending timestamp, return all events in the motion history for
 * the device in the given range of time. Some windowing systems
 * do not support motion history, in which case, %FALSE will
 * be returned. (This is not distinguishable from the case where
 * motion history is supported and no events were found.)
 *
 * Return value: %TRUE if the windowing system supports motion history and
 *  at least one event was found.
 **/
gboolean
gdk_device_get_history (GdkDevice      *device,
                        GdkWindow      *window,
                        guint32         start,
                        guint32         stop,
                        GdkTimeCoord ***events,
520
                        gint           *n_events)
521 522
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
523
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, FALSE);
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
  g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);

  if (n_events)
    *n_events = 0;

  if (events)
    *events = NULL;

  if (GDK_WINDOW_DESTROYED (window))
    return FALSE;

  if (!GDK_DEVICE_GET_CLASS (device)->get_history)
    return FALSE;

  return GDK_DEVICE_GET_CLASS (device)->get_history (device, window,
                                                     start, stop,
                                                     events, n_events);
}

GdkTimeCoord **
_gdk_device_allocate_history (GdkDevice *device,
545
                              gint       n_events)
546 547 548 549 550 551
{
  GdkTimeCoord **result = g_new (GdkTimeCoord *, n_events);
  gint i;

  for (i = 0; i < n_events; i++)
    result[i] = g_malloc (sizeof (GdkTimeCoord) -
Matthias Clasen's avatar
Matthias Clasen committed
552
                          sizeof (double) * (GDK_MAX_TIMECOORD_AXES - device->axes->len));
553 554 555 556
  return result;
}

/**
557 558
 * gdk_device_free_history: (skip)
 * @events: an array of #GdkTimeCoord.
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
 * @n_events: the length of the array.
 *
 * Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
 */
void
gdk_device_free_history (GdkTimeCoord **events,
                         gint           n_events)
{
  gint i;

  for (i = 0; i < n_events; i++)
    g_free (events[i]);

  g_free (events);
}

/**
 * gdk_device_get_name:
 * @device: a #GdkDevice
 *
 * Determines the name of the device.
 *
 * Return value: a name
 *
 * Since: 2.20
 **/
const gchar *
gdk_device_get_name (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);

Matthias Clasen's avatar
Matthias Clasen committed
590
  return device->name;
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
}

/**
 * gdk_device_get_has_cursor:
 * @device: a #GdkDevice
 *
 * Determines whether the pointer follows device motion.
 *
 * Return value: %TRUE if the pointer follows device motion
 *
 * Since: 2.20
 **/
gboolean
gdk_device_get_has_cursor (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
607
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, FALSE);
608

Matthias Clasen's avatar
Matthias Clasen committed
609
  return device->has_cursor;
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
}

/**
 * gdk_device_get_source:
 * @device: a #GdkDevice
 *
 * Determines the type of the device.
 *
 * Return value: a #GdkInputSource
 *
 * Since: 2.20
 **/
GdkInputSource
gdk_device_get_source (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), 0);

Matthias Clasen's avatar
Matthias Clasen committed
627
  return device->source;
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
}

/**
 * gdk_device_get_mode:
 * @device: a #GdkDevice
 *
 * Determines the mode of the device.
 *
 * Return value: a #GdkInputSource
 *
 * Since: 2.20
 **/
GdkInputMode
gdk_device_get_mode (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), 0);

Matthias Clasen's avatar
Matthias Clasen committed
645
  return device->mode;
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
}

/**
 * gdk_device_set_mode:
 * @device: a #GdkDevice.
 * @mode: the input mode.
 *
 * Sets a the mode of an input device. The mode controls if the
 * device is active and whether the device's range is mapped to the
 * entire screen or to a single window.
 *
 * Returns: %TRUE if the mode was successfully changed.
 **/
gboolean
gdk_device_set_mode (GdkDevice    *device,
                     GdkInputMode  mode)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);

Matthias Clasen's avatar
Matthias Clasen committed
665
  if (device->mode == mode)
666 667 668 669 670 671
    return TRUE;

  if (mode == GDK_MODE_DISABLED &&
      gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER)
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
672
  device->mode = mode;
673 674 675 676 677
  g_object_notify (G_OBJECT (device), "input-mode");

  return TRUE;
}

678 679 680 681 682 683 684 685
/**
 * gdk_device_get_n_keys:
 * @device: a #GdkDevice
 *
 * Returns the number of keys the device currently has.
 *
 * Returns: the number of keys.
 *
686
 * Since: 2.24
687 688 689 690 691 692
 **/
gint
gdk_device_get_n_keys (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), 0);

Matthias Clasen's avatar
Matthias Clasen committed
693
  return device->num_keys;
694 695
}

696 697 698 699
/**
 * gdk_device_get_key:
 * @device: a #GdkDevice.
 * @index_: the index of the macro button to get.
700 701
 * @keyval: (out): return value for the keyval.
 * @modifiers: (out): return value for modifiers.
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
 *
 * If @index_ has a valid keyval, this function will return %TRUE
 * and fill in @keyval and @modifiers with the keyval settings.
 *
 * Returns: %TRUE if keyval is set for @index.
 *
 * Since: 2.20
 **/
gboolean
gdk_device_get_key (GdkDevice       *device,
                    guint            index_,
                    guint           *keyval,
                    GdkModifierType *modifiers)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
Matthias Clasen's avatar
Matthias Clasen committed
717
  g_return_val_if_fail (index_ < device->num_keys, FALSE);
718

Matthias Clasen's avatar
Matthias Clasen committed
719 720
  if (!device->keys[index_].keyval &&
      !device->keys[index_].modifiers)
721 722 723
    return FALSE;

  if (keyval)
Matthias Clasen's avatar
Matthias Clasen committed
724
    *keyval = device->keys[index_].keyval;
725 726

  if (modifiers)
Matthias Clasen's avatar
Matthias Clasen committed
727
    *modifiers = device->keys[index_].modifiers;
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

  return TRUE;
}

/**
 * gdk_device_set_key:
 * @device: a #GdkDevice
 * @index_: the index of the macro button to set
 * @keyval: the keyval to generate
 * @modifiers: the modifiers to set
 *
 * Specifies the X key event to generate when a macro button of a device
 * is pressed.
 **/
void
gdk_device_set_key (GdkDevice      *device,
Matthias Clasen's avatar
Matthias Clasen committed
744 745 746
                    guint           index_,
                    guint           keyval,
                    GdkModifierType modifiers)
747 748
{
  g_return_if_fail (GDK_IS_DEVICE (device));
Matthias Clasen's avatar
Matthias Clasen committed
749
  g_return_if_fail (index_ < device->num_keys);
750

Matthias Clasen's avatar
Matthias Clasen committed
751 752
  device->keys[index_].keyval = keyval;
  device->keys[index_].modifiers = modifiers;
753 754 755 756
}

/**
 * gdk_device_get_axis_use:
757
 * @device: a pointer #GdkDevice.
758 759 760 761 762 763 764 765 766 767 768 769
 * @index_: the index of the axis.
 *
 * Returns the axis use for @index_.
 *
 * Returns: a #GdkAxisUse specifying how the axis is used.
 *
 * Since: 2.20
 **/
GdkAxisUse
gdk_device_get_axis_use (GdkDevice *device,
                         guint      index_)
{
770 771
  GdkAxisInfo *info;

772
  g_return_val_if_fail (GDK_IS_DEVICE (device), GDK_AXIS_IGNORE);
773
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, GDK_AXIS_IGNORE);
Matthias Clasen's avatar
Matthias Clasen committed
774
  g_return_val_if_fail (index_ < device->axes->len, GDK_AXIS_IGNORE);
775

Matthias Clasen's avatar
Matthias Clasen committed
776
  info = &g_array_index (device->axes, GdkAxisInfo, index_);
777

778
  return info->use;
779 780 781 782
}

/**
 * gdk_device_set_axis_use:
783
 * @device: a pointer #GdkDevice
784 785 786 787 788 789 790
 * @index_: the index of the axis
 * @use: specifies how the axis is used
 *
 * Specifies how an axis of a device is used.
 **/
void
gdk_device_set_axis_use (GdkDevice   *device,
Matthias Clasen's avatar
Matthias Clasen committed
791 792
                         guint        index_,
                         GdkAxisUse   use)
793 794 795 796
{
  GdkAxisInfo *info;

  g_return_if_fail (GDK_IS_DEVICE (device));
797
  g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
Matthias Clasen's avatar
Matthias Clasen committed
798
  g_return_if_fail (index_ < device->axes->len);
799

Matthias Clasen's avatar
Matthias Clasen committed
800
  info = &g_array_index (device->axes, GdkAxisInfo, index_);
801 802 803 804 805 806
  info->use = use;

  switch (use)
    {
    case GDK_AXIS_X:
    case GDK_AXIS_Y:
807 808
      info->min_axis = 0;
      info->max_axis = 0;
809 810 811
      break;
    case GDK_AXIS_XTILT:
    case GDK_AXIS_YTILT:
812 813
      info->min_axis = -1;
      info->max_axis = 1;
814 815
      break;
    default:
816 817
      info->min_axis = 0;
      info->max_axis = 1;
818 819 820 821 822 823 824 825 826 827
      break;
    }
}

/**
 * gdk_device_get_display:
 * @device: a #GdkDevice
 *
 * Returns the #GdkDisplay to which @device pertains.
 *
828 829
 * Returns: (transfer none): a #GdkDisplay. This memory is owned
 *          by GTK+, and must not be freed or unreffed.
830 831 832 833 834 835 836 837
 *
 * Since: 3.0
 **/
GdkDisplay *
gdk_device_get_display (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);

Matthias Clasen's avatar
Matthias Clasen committed
838
  return device->display;
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
}

/**
 * gdk_device_get_associated_device:
 * @device: a #GdkDevice
 *
 * Returns the associated device to @device, if @device is of type
 * %GDK_DEVICE_TYPE_MASTER, it will return the paired pointer or
 * keyboard.
 *
 * If @device is of type %GDK_DEVICE_TYPE_SLAVE, it will return
 * the master device to which @device is attached to.
 *
 * If @device is of type %GDK_DEVICE_TYPE_FLOATING, %NULL will be
 * returned, as there is no associated device.
 *
855
 * Returns: (transfer none): The associated device, or %NULL
856 857 858 859 860 861 862 863
 *
 * Since: 3.0
 **/
GdkDevice *
gdk_device_get_associated_device (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);

Matthias Clasen's avatar
Matthias Clasen committed
864
  return device->associated;
865 866
}

867 868 869 870
static void
_gdk_device_set_device_type (GdkDevice     *device,
                             GdkDeviceType  type)
{
Matthias Clasen's avatar
Matthias Clasen committed
871
  if (device->type != type)
872
    {
Matthias Clasen's avatar
Matthias Clasen committed
873
      device->type = type;
874 875 876 877 878

      g_object_notify (G_OBJECT (device), "type");
    }
}

879 880 881 882 883
void
_gdk_device_set_associated_device (GdkDevice *device,
                                   GdkDevice *associated)
{
  g_return_if_fail (GDK_IS_DEVICE (device));
884
  g_return_if_fail (associated == NULL || GDK_IS_DEVICE (associated));
885

Matthias Clasen's avatar
Matthias Clasen committed
886
  if (device->associated == associated)
887 888
    return;

Matthias Clasen's avatar
Matthias Clasen committed
889
  if (device->associated)
890
    {
Matthias Clasen's avatar
Matthias Clasen committed
891 892
      g_object_unref (device->associated);
      device->associated = NULL;
893 894 895
    }

  if (associated)
Matthias Clasen's avatar
Matthias Clasen committed
896
    device->associated = g_object_ref (associated);
897

Matthias Clasen's avatar
Matthias Clasen committed
898
  if (device->type != GDK_DEVICE_TYPE_MASTER)
899
    {
Matthias Clasen's avatar
Matthias Clasen committed
900
      if (device->associated)
901 902 903 904 905 906 907 908 909 910 911 912 913 914
        _gdk_device_set_device_type (device, GDK_DEVICE_TYPE_SLAVE);
      else
        _gdk_device_set_device_type (device, GDK_DEVICE_TYPE_FLOATING);
    }
}

/**
 * gdk_device_list_slave_devices:
 * @device: a #GdkDevice
 *
 * If the device if of type %GDK_DEVICE_TYPE_MASTER, it will return
 * the list of slave devices attached to it, otherwise it will return
 * %NULL
 *
915 916 917 918
 * Returns: (transfer container) (element-type GdkDevice): the list of
 *          slave devices, or %NULL. The list must be freed with
 *          g_list_free(), the contents of the list are owned by GTK+
 *          and should not be freed.
919 920 921 922 923 924 925
 **/
GList *
gdk_device_list_slave_devices (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
  g_return_val_if_fail (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER, NULL);

Matthias Clasen's avatar
Matthias Clasen committed
926
  return g_list_copy (device->slaves);
927 928 929 930 931 932 933 934 935
}

void
_gdk_device_add_slave (GdkDevice *device,
                       GdkDevice *slave)
{
  g_return_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER);
  g_return_if_fail (gdk_device_get_device_type (slave) != GDK_DEVICE_TYPE_MASTER);

Matthias Clasen's avatar
Matthias Clasen committed
936 937
  if (!g_list_find (device->slaves, slave))
    device->slaves = g_list_prepend (device->slaves, slave);
938 939 940 941 942 943 944 945 946 947 948
}

void
_gdk_device_remove_slave (GdkDevice *device,
                          GdkDevice *slave)
{
  GList *elem;

  g_return_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER);
  g_return_if_fail (gdk_device_get_device_type (slave) != GDK_DEVICE_TYPE_MASTER);

Matthias Clasen's avatar
Matthias Clasen committed
949
  elem = g_list_find (device->slaves, slave);
950 951 952 953

  if (!elem)
    return;

Matthias Clasen's avatar
Matthias Clasen committed
954
  device->slaves = g_list_delete_link (device->slaves, elem);
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
}

/**
 * gdk_device_get_device_type:
 * @device: a #GdkDevice
 *
 * Returns the device type for @device.
 *
 * Returns: the #GdkDeviceType for @device.
 *
 * Since: 3.0
 **/
GdkDeviceType
gdk_device_get_device_type (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), GDK_DEVICE_TYPE_MASTER);

Matthias Clasen's avatar
Matthias Clasen committed
972
  return device->type;
973 974 975 976
}

/**
 * gdk_device_get_n_axes:
977
 * @device: a pointer #GdkDevice
978 979 980 981 982 983 984
 *
 * Returns the number of axes the device currently has.
 *
 * Returns: the number of axes.
 *
 * Since: 3.0
 **/
985
gint
986 987 988
gdk_device_get_n_axes (GdkDevice *device)
{
  g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
989
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, 0);
990

Matthias Clasen's avatar
Matthias Clasen committed
991
  return device->axes->len;
992 993 994 995
}

/**
 * gdk_device_list_axes:
996
 * @device: a pointer #GdkDevice
997 998 999 1000
 *
 * Returns a #GList of #GdkAtom<!-- -->s, containing the labels for
 * the axes that @device currently has.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1001 1002
 * Returns: (transfer container) (element-type GdkAtom):
 *     A #GList of #GdkAtom<!-- -->s, free with g_list_free().
1003 1004 1005 1006 1007 1008 1009 1010 1011
 *
 * Since: 3.0
 **/
GList *
gdk_device_list_axes (GdkDevice *device)
{
  GList *axes = NULL;
  gint i;

1012 1013 1014
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);

Matthias Clasen's avatar
Matthias Clasen committed
1015
  for (i = 0; i < device->axes->len; i++)
1016 1017 1018
    {
      GdkAxisInfo axis_info;

Matthias Clasen's avatar
Matthias Clasen committed
1019
      axis_info = g_array_index (device->axes, GdkAxisInfo, i);
1020 1021 1022 1023 1024 1025 1026 1027
      axes = g_list_prepend (axes, GDK_ATOM_TO_POINTER (axis_info.label));
    }

  return g_list_reverse (axes);
}

/**
 * gdk_device_get_axis_value:
1028
 * @device: a pointer #GdkDevice.
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
 * @axes: pointer to an array of axes
 * @axis_label: #GdkAtom with the axis label.
 * @value: location to store the found value.
 *
 * Interprets an array of double as axis values for a given device,
 * and locates the value in the array for a given axis label, as returned
 * by gdk_device_list_axes()
 *
 * Returns: %TRUE if the given axis use was found, otherwise %FALSE.
 *
 * Since: 3.0
 **/
gboolean
gdk_device_get_axis_value (GdkDevice *device,
                           gdouble   *axes,
                           GdkAtom    axis_label,
                           gdouble   *value)
{
  gint i;

  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
1050
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, FALSE);
1051 1052 1053 1054

  if (axes == NULL)
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1055
  for (i = 0; i < device->axes->len; i++)
1056 1057 1058
    {
      GdkAxisInfo axis_info;

Matthias Clasen's avatar
Matthias Clasen committed
1059
      axis_info = g_array_index (device->axes, GdkAxisInfo, i);
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093

      if (axis_info.label != axis_label)
        continue;

      if (value)
        *value = axes[i];

      return TRUE;
    }

  return FALSE;
}

/**
 * gdk_device_get_axis:
 * @device: a #GdkDevice
 * @axes: pointer to an array of axes
 * @use: the use to look for
 * @value: location to store the found value.
 *
 * Interprets an array of double as axis values for a given device,
 * and locates the value in the array for a given axis use.
 *
 * Return value: %TRUE if the given axis use was found, otherwise %FALSE
 **/
gboolean
gdk_device_get_axis (GdkDevice  *device,
                     gdouble    *axes,
                     GdkAxisUse  use,
                     gdouble    *value)
{
  gint i;

  g_return_val_if_fail (GDK_IS_DEVICE (device), FALSE);
1094
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, FALSE);
1095 1096 1097 1098

  if (axes == NULL)
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1099
  g_return_val_if_fail (device->axes != NULL, FALSE);
1100

Matthias Clasen's avatar
Matthias Clasen committed
1101
  for (i = 0; i < device->axes->len; i++)
1102 1103 1104
    {
      GdkAxisInfo axis_info;

Matthias Clasen's avatar
Matthias Clasen committed
1105
      axis_info = g_array_index (device->axes, GdkAxisInfo, i);
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137

      if (axis_info.use != use)
        continue;

      if (value)
        *value = axes[i];

      return TRUE;
    }

  return FALSE;
}

static GdkEventMask
get_native_grab_event_mask (GdkEventMask grab_mask)
{
  /* Similar to the above but for pointer events only */
  return
    GDK_POINTER_MOTION_MASK |
    GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
    GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
    GDK_SCROLL_MASK |
    (grab_mask &
     ~(GDK_POINTER_MOTION_HINT_MASK |
       GDK_BUTTON_MOTION_MASK |
       GDK_BUTTON1_MOTION_MASK |
       GDK_BUTTON2_MOTION_MASK |
       GDK_BUTTON3_MOTION_MASK));
}

/**
 * gdk_device_grab:
1138 1139 1140 1141
 * @device: a #GdkDevice. To get the device you can use gtk_get_current_event_device()
 *   or gdk_event_get_device() if the grab is in reaction to an event. Also, you can use
 *   gdk_device_manager_get_client_pointer() but only in code that isn't triggered by a
 *   #GdkEvent and there aren't other means to get a meaningful #GdkDevice to operate on.
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
 * @window: the #GdkWindow which will own the grab (the grab window)
 * @grab_ownership: specifies the grab ownership.
 * @owner_events: if %FALSE then all device events are reported with respect to
 *                @window and are only reported if selected by @event_mask. If
 *                %TRUE then pointer events for this application are reported
 *                as normal, but pointer events outside this application are
 *                reported with respect to @window and only if selected by
 *                @event_mask. In either mode, unreported events are discarded.
 * @event_mask: specifies the event mask, which is used in accordance with
 *              @owner_events.
 * @cursor: the cursor to display while the grab is active if the device is
 *          a pointer. If this is %NULL then the normal cursors are used for
 *          @window and its descendants, and the cursor for @window is used
 *          elsewhere.
 * @time_: the timestamp of the event which led to this pointer grab. This
 *         usually comes from the #GdkEvent struct, though %GDK_CURRENT_TIME
 *         can be used if the time isn't known.
 *
 * Grabs the device so that all events coming from this device are passed to
 * this application until the device is ungrabbed with gdk_device_ungrab(),
 * or the window becomes unviewable. This overrides any previous grab on the device
 * by this client.
 *
 * Device grabs are used for operations which need complete control over the
 * given device events (either pointer or keyboard). For example in GTK+ this
 * is used for Drag and Drop operations, popup menus and such.
 *
 * Note that if the event mask of an X window has selected both button press
 * and button release events, then a button press event will cause an automatic
 * pointer grab until the button is released. X does this automatically since
 * most applications expect to receive button press and release events in pairs.
 * It is equivalent to a pointer grab on the window with @owner_events set to
 * %TRUE.
 *
 * If you set up anything at the time you take the grab that needs to be
 * cleaned up when the grab ends, you should handle the #GdkEventGrabBroken
 * events that are emitted when the grab ends unvoluntarily.
 *
 * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
 *
 * Since: 3.0
 **/
GdkGrabStatus
gdk_device_grab (GdkDevice        *device,
                 GdkWindow        *window,
                 GdkGrabOwnership  grab_ownership,
                 gboolean          owner_events,
                 GdkEventMask      event_mask,
                 GdkCursor        *cursor,
                 guint32           time_)
{
  GdkGrabStatus res;
  GdkWindow *native;

1196 1197
  g_return_val_if_fail (GDK_IS_DEVICE (device), GDK_GRAB_SUCCESS);
  g_return_val_if_fail (GDK_IS_WINDOW (window), GDK_GRAB_SUCCESS);
1198 1199 1200 1201 1202 1203

  if (_gdk_native_windows)
    native = window;
  else
    native = gdk_window_get_toplevel (window);

1204
  while (native->window_type == GDK_WINDOW_OFFSCREEN)
1205 1206 1207 1208
    {
      native = gdk_offscreen_window_get_embedder (native);

      if (native == NULL ||
1209 1210 1211
          (!_gdk_window_has_impl (native) &&
           !gdk_window_is_viewable (native)))
        return GDK_GRAB_NOT_VIEWABLE;
1212 1213 1214 1215

      native = gdk_window_get_toplevel (native);
    }

1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
  if (native == NULL || GDK_WINDOW_DESTROYED (native))
    return GDK_GRAB_NOT_VIEWABLE;

  res = GDK_DEVICE_GET_CLASS (device)->grab (device,
                                             native,
                                             owner_events,
                                             get_native_grab_event_mask (event_mask),
                                             NULL,
                                             cursor,
                                             time_);
1226 1227 1228 1229 1230 1231

  if (res == GDK_GRAB_SUCCESS)
    {
      GdkDisplay *display;
      gulong serial;

1232
      display = gdk_window_get_display (window);
1233
      serial = _gdk_display_get_next_serial (display);
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249

      _gdk_display_add_device_grab (display,
                                    device,
                                    window,
                                    native,
                                    grab_ownership,
                                    owner_events,
                                    event_mask,
                                    serial,
                                    time_,
                                    FALSE);
    }

  return res;
}

1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
/**
 * gdk_device_ungrab:
 * @device: a #GdkDevice
 * @time_: a timestap (e.g. %GDK_CURRENT_TIME).
 *
 * Release any grab on @device.
 *
 * Since: 3.0
 */
void
gdk_device_ungrab (GdkDevice  *device,
                   guint32     time_)
{
  g_return_if_fail (GDK_IS_DEVICE (device));

  GDK_DEVICE_GET_CLASS (device)->ungrab (device, time_);
}

1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
/**
 * gdk_device_warp:
 * @device: the device to warp.
 * @screen: the screen to warp @device to.
 * @x: the X coordinate of the destination.
 * @y: the Y coordinate of the destination.
 *
 * Warps @device in @display to the point @x,@y on
 * the screen @screen, unless the device is confined
 * to a window by a grab, in which case it will be moved
 * as far as allowed by the grab. Warping the pointer
 * creates events as if the user had moved the mouse
 * instantaneously to the destination.
 *
 * Note that the pointer should normally be under the
 * control of the user. This function was added to cover
 * some rare use cases like keyboard navigation support
 * for the color picker in the #GtkColorSelectionDialog.
 *
 * Since: 3.0
 **/
void
gdk_device_warp (GdkDevice  *device,
                 GdkScreen  *screen,
                 gint        x,
                 gint        y)
{
  g_return_if_fail (GDK_IS_DEVICE (device));
  g_return_if_fail (GDK_IS_SCREEN (screen));
  g_return_if_fail (gdk_device_get_display (device) == gdk_screen_get_display (screen));

  GDK_DEVICE_GET_CLASS (device)->warp (device, screen, x, y);
}

1302 1303 1304 1305 1306 1307
/* Private API */
void
_gdk_device_reset_axes (GdkDevice *device)
{
  gint i;

Matthias Clasen's avatar
Matthias Clasen committed
1308 1309
  for (i = device->axes->len - 1; i >= 0; i--)
    g_array_remove_index (device->axes, i);
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348

  g_object_notify (G_OBJECT (device), "n-axes");
}

guint
_gdk_device_add_axis (GdkDevice   *device,
                      GdkAtom      label_atom,
                      GdkAxisUse   use,
                      gdouble      min_value,
                      gdouble      max_value,
                      gdouble      resolution)
{
  GdkAxisInfo axis_info;
  guint pos;

  axis_info.use = use;
  axis_info.label = label_atom;
  axis_info.min_value = min_value;
  axis_info.max_value = max_value;
  axis_info.resolution = resolution;

  switch (use)
    {
    case GDK_AXIS_X:
    case GDK_AXIS_Y:
      axis_info.min_axis = 0;
      axis_info.max_axis = 0;
      break;
    case GDK_AXIS_XTILT:
    case GDK_AXIS_YTILT:
      axis_info.min_axis = -1;
      axis_info.max_axis = 1;
      break;
    default:
      axis_info.min_axis = 0;
      axis_info.max_axis = 1;
      break;
    }

Matthias Clasen's avatar
Matthias Clasen committed
1349 1350
  device->axes = g_array_append_val (device->axes, axis_info);
  pos = device->axes->len - 1;
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360

  g_object_notify (G_OBJECT (device), "n-axes");

  return pos;
}

void
_gdk_device_set_keys (GdkDevice *device,
                      guint      num_keys)
{
Matthias Clasen's avatar
Matthias Clasen committed
1361 1362
  if (device->keys)
    g_free (device->keys);
1363

Matthias Clasen's avatar
Matthias Clasen committed
1364 1365
  device->num_keys = num_keys;
  device->keys = g_new0 (GdkDeviceKey, num_keys);
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
}

static GdkAxisInfo *
find_axis_info (GArray     *array,
                GdkAxisUse  use)
{
  GdkAxisInfo *info;
  gint i;

  for (i = 0; i < GDK_AXIS_LAST; i++)
    {
      info = &g_array_index (array, GdkAxisInfo, i);

      if (info->use == use)
        return info;
    }

  return NULL;
}

GdkAxisUse
_gdk_device_get_axis_use (GdkDevice *device,
                          guint      index_)
{
  GdkAxisInfo info;

Matthias Clasen's avatar
Matthias Clasen committed
1392
  info = g_array_index (device->axes, GdkAxisInfo, index_);
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
  return info.use;
}

gboolean
_gdk_device_translate_window_coord (GdkDevice *device,
                                    GdkWindow *window,
                                    guint      index_,
                                    gdouble    value,
                                    gdouble   *axis_value)
{
  GdkAxisInfo axis_info;
  GdkAxisInfo *axis_info_x, *axis_info_y;
  gdouble device_width, device_height;
  gdouble x_offset, y_offset;
  gdouble x_scale, y_scale;
  gdouble x_min, y_min;
  gdouble x_resolution, y_resolution;
  gdouble device_aspect;
  gint window_width, window_height;

Matthias Clasen's avatar
Matthias Clasen committed
1413
  if (index_ >= device->axes->len)
1414 1415
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1416
  axis_info = g_array_index (device->axes, GdkAxisInfo, index_);
1417 1418 1419 1420 1421 1422 1423 1424

  if (axis_info.use != GDK_AXIS_X &&
      axis_info.use != GDK_AXIS_Y)
    return FALSE;

  if (axis_info.use == GDK_AXIS_X)
    {
      axis_info_x = &axis_info;
Matthias Clasen's avatar
Matthias Clasen committed
1425
      axis_info_y = find_axis_info (device->axes, GDK_AXIS_Y);
1426 1427 1428
    }
  else
    {
Matthias Clasen's avatar
Matthias Clasen committed
1429
      axis_info_x = find_axis_info (device->axes, GDK_AXIS_X);
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
      axis_info_y = &axis_info;
    }

  device_width = axis_info_x->max_value - axis_info_x->min_value;
  device_height = axis_info_y->max_value - axis_info_y->min_value;

  if (device_width > 0)
    x_min = axis_info_x->min_value;
  else
    {
1440
      device_width = gdk_screen_get_width (gdk_window_get_screen (window));
1441 1442 1443 1444 1445 1446 1447
      x_min = 0;
    }

  if (device_height > 0)
    y_min = axis_info_y->min_value;
  else
    {
1448
      device_height = gdk_screen_get_height (gdk_window_get_screen (window));
1449 1450 1451
      y_min = 0;
    }

1452 1453
  window_width = gdk_window_get_width (window);
  window_height = gdk_window_get_height (window);
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518

  x_resolution = axis_info_x->resolution;
  y_resolution = axis_info_y->resolution;

  /*
   * Some drivers incorrectly report the resolution of the device
   * as zero (in partiular linuxwacom < 0.5.3 with usb tablets).
   * This causes the device_aspect to become NaN and totally
   * breaks windowed mode.  If this is the case, the best we can
   * do is to assume the resolution is non-zero is equal in both
   * directions (which is true for many devices).  The absolute
   * value of the resolution doesn't matter since we only use the
   * ratio.
   */
  if (x_resolution == 0 || y_resolution == 0)
    {
      x_resolution = 1;
      y_resolution = 1;
    }

  device_aspect = (device_height * y_resolution) /
    (device_width * x_resolution);

  if (device_aspect * window_width >= window_height)
    {
      /* device taller than window */
      x_scale = window_width / device_width;
      y_scale = (x_scale * x_resolution) / y_resolution;

      x_offset = 0;
      y_offset = - (device_height * y_scale - window_height) / 2;
    }
  else
    {
      /* window taller than device */
      y_scale = window_height / device_height;
      x_scale = (y_scale * y_resolution) / x_resolution;

      y_offset = 0;
      x_offset = - (device_width * x_scale - window_width) / 2;
    }

  if (axis_value)
    {
      if (axis_info.use == GDK_AXIS_X)
        *axis_value = x_offset + x_scale * (value - x_min);
      else
        *axis_value = y_offset + y_scale * (value - y_min);
    }

  return TRUE;
}

gboolean
_gdk_device_translate_screen_coord (GdkDevice *device,
                                    GdkWindow *window,
                                    gint       window_root_x,
                                    gint       window_root_y,
                                    guint      index_,
                                    gdouble    value,
                                    gdouble   *axis_value)
{
  GdkAxisInfo axis_info;
  gdouble axis_width, scale, offset;

Matthias Clasen's avatar
Matthias Clasen committed
1519
  if (device->mode != GDK_MODE_SCREEN)
1520 1521
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1522
  if (index_ >= device->axes->len)
1523 1524
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1525
  axis_info = g_array_index (device->axes, GdkAxisInfo, index_);
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535

  if (axis_info.use != GDK_AXIS_X &&
      axis_info.use != GDK_AXIS_Y)
    return FALSE;

  axis_width = axis_info.max_value - axis_info.min_value;

  if (axis_info.use == GDK_AXIS_X)
    {
      if (axis_width > 0)
1536
        scale = gdk_screen_get_width (gdk_window_get_screen (window)) / axis_width;
1537 1538 1539
      else
        scale = 1;

1540
      offset = - window_root_x - window->abs_x;
1541 1542 1543 1544
    }
  else
    {
      if (axis_width > 0)
1545
        scale = gdk_screen_get_height (gdk_window_get_screen (window)) / axis_width;
1546 1547 1548
      else
        scale = 1;

1549
      offset = - window_root_y - window->abs_y;
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
    }

  if (axis_value)
    *axis_value = offset + scale * (value - axis_info.min_value);

  return TRUE;
}

gboolean
_gdk_device_translate_axis (GdkDevice *device,
                            guint      index_,
                            gdouble    value,
                            gdouble   *axis_value)
{
  GdkAxisInfo axis_info;
  gdouble axis_width, out;

Matthias Clasen's avatar
Matthias Clasen committed
1567
  if (index_ >= device->axes->len)
1568 1569
    return FALSE;

Matthias Clasen's avatar
Matthias Clasen committed
1570
  axis_info = g_array_index (device->axes, GdkAxisInfo, index_);
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584

  if (axis_info.use == GDK_AXIS_X ||
      axis_info.use == GDK_AXIS_Y)
    return FALSE;

  axis_width = axis_info.max_value - axis_info.min_value;
  out = (axis_info.max_axis * (value - axis_info.min_value) +
         axis_info.min_axis * (axis_info.max_value - value)) / axis_width;

  if (axis_value)
    *axis_value = out;

  return TRUE;
}
1585

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
gboolean
_gdk_device_query_state (GdkDevice        *device,
                         GdkWindow        *window,
                         GdkWindow       **root_window,
                         GdkWindow       **child_window,
                         gint             *root_x,
                         gint             *root_y,
                         gint             *win_x,
                         gint             *win_y,
                         GdkModifierType  *mask)
{
  return GDK_DEVICE_GET_CLASS (device)->query_state (device,
                                                     window,
                                                     root_window,
                                                     child_window,
                                                     root_x,
                                                     root_y,
                                                     win_x,
                                                     win_y,
                                                     mask);
}

GdkWindow *
_gdk_device_window_at_position (GdkDevice        *device,
                                gint             *win_x,
                                gint             *win_y,
                                GdkModifierType  *mask,
                                gboolean          get_toplevel)
{
  return GDK_DEVICE_GET_CLASS (device)->window_at_position (device,
                                                            win_x,
                                                            win_y,
                                                            mask,
                                                            get_toplevel);
}