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

   1 /* GDK - The GIMP Drawing Kit
   2  * Copyright (C) 2009 Carlos Garnacho <carlosg@gnome.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21
  22 #include "gdkdevicemanager.h"
  23
  24 #include "gdkintl.h"
  25 #include "gdkinternals.h"
  26
  27
  28 /**
  29  * SECTION:gdkdevicemanager
  30  * @Short_description: Functions for handling input devices
  31  * @Long_description: In addition to a single pointer and keyboard for user interface input, GDK
  32  *                    contains support for a variety of input devices, including graphics tablets,
  33  *                    touchscreens and multiple pointers/keyboards interacting simultaneously with
  34  *                    the user interface. Under X, the support for multiple input devices is done
  35  *                    through the <firstterm>XInput 2</firstterm> extension, which also supports
  36  *                    additional features such as sub-pixel positioning information and additional
  37  *                    device-dependent information.
  38  * @Title: GdkDeviceManager
  39  * @See_also: #GdkDevice, #GdkEvent, gdk_enable_multidevice()
  40  *
  41  * By default, GDK supports the traditional single keyboard/pointer input scheme (Plus additional
  42  * special input devices such as tablets. In short, backwards compatible with 2.X). Since version 3.0,
  43  * if gdk_enable_multidevice() is called before gdk_display_open() and the platform supports it, GDK
  44  * will be aware of multiple keyboard/pointer pairs interacting simultaneously with the user interface.
  45  *
  46  * Conceptually, in multidevice mode there are 2 device types, virtual devices (or master devices)
  47  * are represented by the pointer cursors and keyboard foci that are seen on the screen. physical
  48  * devices (or slave devices) represent the hardware that is controlling the virtual devices, and
  49  * thus has no visible cursor on the screen.
  50  *
  51  * Virtual devices are always paired, there is a keyboard device for every pointer device,
  52  * associations between devices may be inspected through gdk_device_get_associated_device().
  53  *
  54  * There may be several virtual devices, and several physical devices could be controlling each of
  55  * these virtual devices. Physical devices may also be "floating", which means they are not attached
  56  * to any virtual device.
  57  *
  58  * By default, GDK will automatically listen for events coming from all master devices, setting the
  59  * #GdkDevice for all events coming from input devices
  60  * <footnote>
  61  *   Events containing device information are #GDK_MOTION_NOTIFY, #GDK_BUTTON_PRESS, #GDK_2BUTTON_PRESS,
  62  *   #GDK_3BUTTON_PRESS, #GDK_BUTTON_RELEASE, #GDK_SCROLL, #GDK_KEY_PRESS, #GDK_KEY_RELEASE,
  63  *   #GDK_ENTER_NOTIFY, #GDK_LEAVE_NOTIFY, #GDK_FOCUS_CHANGE, #GDK_PROXIMITY_IN, #GDK_PROXIMITY_OUT,
  64  *   #GDK_DRAG_ENTER, #GDK_DRAG_LEAVE, #GDK_DRAG_MOTION, #GDK_DRAG_STATUS, #GDK_DROP_START,
  65  *   #GDK_DROP_FINISHED and #GDK_GRAB_BROKEN.
  66  * </footnote>
  67  * , although gdk_window_set_support_multidevice() has to be called on #GdkWindow<!-- --> in order to
  68  * support additional features of multiple pointer interaction, such as multiple, per-device enter/leave
  69  * events. The default setting will emit just one enter/leave event pair for all devices on the window.
  70  * See gdk_window_set_support_multidevice() documentation for more information.
  71  *
  72  * In order to listen for events coming from other than a virtual device, gdk_window_set_device_events()
  73  * must be called. Generally, this function can be used to modify the event mask for any given device.
  74  *
  75  * Input devices may also provide additional information besides X/Y. For example, graphics tablets may
  76  * also provide pressure and X/Y tilt information. This information is device-dependent, and may be
  77  * queried through gdk_device_get_axis(). In multidevice mode, virtual devices will change axes in order
  78  * to always represent the physical device that is routing events through it. Whenever the physical device
  79  * changes, the #GdkDevice:n-axes property will be notified, and gdk_device_list_axes() will return the
  80  * new device axes.
  81  *
  82  * Devices may also have associated <firstterm>keys</firstterm> or macro buttons. Such keys can be
  83  * globally set to map into normal X keyboard events. The mapping is set using gdk_device_set_key().
  84  *
  85  * In order to query the device hierarchy and be aware of changes in the device hierarchy (such as
  86  * virtual devices being created or removed, or physical devices being plugged or unplugged), GDK
  87  * provides #GdkDeviceManager. On X11, multidevice support is implemented through XInput 2. If
  88  * gdk_enable_multidevice() is called, the XInput 2.x #GdkDeviceManager implementation will be used
  89  * as input source, else either the core or XInput 1.x implementations will be used.
  90  */
  91
  92 static void gdk_device_manager_set_property (GObject      *object,
  93                                              guint         prop_id,
  94                                              const GValue *value,
  95                                              GParamSpec   *pspec);
  96 static void gdk_device_manager_get_property (GObject      *object,
  97                                              guint         prop_id,
  98                                              GValue       *value,
  99                                              GParamSpec   *pspec);
 100
 101
 102 G_DEFINE_ABSTRACT_TYPE (GdkDeviceManager, gdk_device_manager, G_TYPE_OBJECT)
 103
 104 enum {
 105   PROP_0,
 106   PROP_DISPLAY
 107 };
 108
 109 enum {
 110   DEVICE_ADDED,
 111   DEVICE_REMOVED,
 112   DEVICE_CHANGED,
 113   LAST_SIGNAL
 114 };
 115
 116 static guint signals [LAST_SIGNAL] = { 0 };
 117
 118
 119 struct _GdkDeviceManagerPrivate
 120 {
 121   GdkDisplay *display;
 122 };
 123
 124
 125 static void
 126 gdk_device_manager_class_init (GdkDeviceManagerClass *klass)
 127 {
 128   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 129
 130   object_class->set_property = gdk_device_manager_set_property;
 131   object_class->get_property = gdk_device_manager_get_property;
 132
 133   g_object_class_install_property (object_class,
 134                                    PROP_DISPLAY,
 135                                    g_param_spec_object ("display",
 136                                                         P_("Display"),
 137                                                         P_("Display for the device manager"),
 138                                                         GDK_TYPE_DISPLAY,
 139                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
 140                                                         G_PARAM_STATIC_STRINGS));
 141
 142   /**
 143    * GdkDeviceManager::device-added:
 144    * @device_manager: the object on which the signal is emitted
 145    * @device: the newly added #GdkDevice.
 146    *
 147    * The ::device-added signal is emitted either when a new master
 148    * pointer is created, or when a slave (Hardware) input device
 149    * is plugged in.
 150    */
 151   signals [DEVICE_ADDED] =
 152     g_signal_new (g_intern_static_string ("device-added"),
 153                   G_TYPE_FROM_CLASS (klass),
 154                   G_SIGNAL_RUN_LAST,
 155                   G_STRUCT_OFFSET (GdkDeviceManagerClass, device_added),
 156                   NULL, NULL,
 157                   g_cclosure_marshal_VOID__OBJECT,
 158                   G_TYPE_NONE, 1,
 159                   GDK_TYPE_DEVICE);
 160
 161   /**
 162    * GdkDeviceManager::device-removed:
 163    * @device_manager: the object on which the signal is emitted
 164    * @device: the just removed #GdkDevice.
 165    *
 166    * The ::device-removed signal is emitted either when a master
 167    * pointer is removed, or when a slave (Hardware) input device
 168    * is unplugged.
 169    */
 170   signals [DEVICE_REMOVED] =
 171     g_signal_new (g_intern_static_string ("device-removed"),
 172                   G_TYPE_FROM_CLASS (klass),
 173                   G_SIGNAL_RUN_LAST,
 174                   G_STRUCT_OFFSET (GdkDeviceManagerClass, device_removed),
 175                   NULL, NULL,
 176                   g_cclosure_marshal_VOID__OBJECT,
 177                   G_TYPE_NONE, 1,
 178                   GDK_TYPE_DEVICE);
 179
 180   /**
 181    * GdkDeviceManager::device-changed:
 182    * @device_manager: the object on which the signal is emitted
 183    * @device: the #GdkDevice that changed.
 184    *
 185    * The ::device-changed signal is emitted either when some
 186    * #GdkDevice has changed the number of either axes or keys.
 187    * For example In X this will normally happen when the slave
 188    * device routing events through the master device changes,
 189    * in that case the master device will change to reflect the
 190    * new slave device axes and keys.
 191    */
 192   signals [DEVICE_CHANGED] =
 193     g_signal_new (g_intern_static_string ("device-changed"),
 194                   G_TYPE_FROM_CLASS (klass),
 195                   G_SIGNAL_RUN_LAST,
 196                   G_STRUCT_OFFSET (GdkDeviceManagerClass, device_changed),
 197                   NULL, NULL,
 198                   g_cclosure_marshal_VOID__OBJECT,
 199                   G_TYPE_NONE, 1,
 200                   GDK_TYPE_DEVICE);
 201
 202   g_type_class_add_private (object_class, sizeof (GdkDeviceManagerPrivate));
 203 }
 204
 205 static void
 206 gdk_device_manager_init (GdkDeviceManager *device_manager)
 207 {
 208   GdkDeviceManagerPrivate *priv;
 209
 210   device_manager->priv = priv = G_TYPE_INSTANCE_GET_PRIVATE (device_manager,
 211                                                              GDK_TYPE_DEVICE_MANAGER,
 212                                                              GdkDeviceManagerPrivate);
 213 }
 214
 215 static void
 216 gdk_device_manager_set_property (GObject      *object,
 217                                  guint         prop_id,
 218                                  const GValue *value,
 219                                  GParamSpec   *pspec)
 220 {
 221   GdkDeviceManagerPrivate *priv;
 222
 223   priv = GDK_DEVICE_MANAGER (object)->priv;
 224
 225   switch (prop_id)
 226     {
 227     case PROP_DISPLAY:
 228       priv->display = g_value_get_object (value);
 229       break;
 230     default:
 231       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 232       break;
 233     }
 234 }
 235
 236 static void
 237 gdk_device_manager_get_property (GObject      *object,
 238                                  guint         prop_id,
 239                                  GValue       *value,
 240                                  GParamSpec   *pspec)
 241 {
 242   GdkDeviceManagerPrivate *priv;
 243
 244   priv = GDK_DEVICE_MANAGER (object)->priv;
 245
 246   switch (prop_id)
 247     {
 248     case PROP_DISPLAY:
 249       g_value_set_object (value, priv->display);
 250       break;
 251     default:
 252       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 253       break;
 254     }
 255 }
 256
 257 /**
 258  * gdk_device_manager_get_display:
 259  * @device_manager: a #GdkDeviceManager
 260  *
 261  * Gets the #GdkDisplay associated to @device_manager.
 262  *
 263  * Returns: (transfer none): the #GdkDisplay to which @device_manager is
 264  *          associated to, or #NULL. This memory is owned by GDK and
 265  *          must not be freed or unreferenced.
 266  *
 267  * Since: 3.0
 268  **/
 269 GdkDisplay *
 270 gdk_device_manager_get_display (GdkDeviceManager *device_manager)
 271 {
 272   GdkDeviceManagerPrivate *priv;
 273
 274   g_return_val_if_fail (GDK_IS_DEVICE_MANAGER (device_manager), NULL);
 275
 276   priv = device_manager->priv;
 277
 278   return priv->display;
 279 }
 280
 281 /**
 282  * gdk_device_manager_list_devices:
 283  * @device_manager: a #GdkDeviceManager
 284  * @type: device type to get.
 285  *
 286  * Returns the list of devices of type @type currently attached to
 287  * @device_manager.
 288  *
 289  * Returns: (transfer container) (element-type Gdk.Device): a list of
 290  *          #GdkDevice<!-- -->s. The returned list must be
 291  *          freed with g_list_free (). The list elements are owned by
 292  *          GTK+ and must not be freed or unreffed.
 293  *
 294  * Since: 3.0
 295  **/
 296 GList *
 297 gdk_device_manager_list_devices (GdkDeviceManager *device_manager,
 298                                  GdkDeviceType     type)
 299 {
 300   g_return_val_if_fail (GDK_IS_DEVICE_MANAGER (device_manager), NULL);
 301
 302   return GDK_DEVICE_MANAGER_GET_CLASS (device_manager)->list_devices (device_manager, type);
 303 }
 304
 305 /**
 306  * gdk_device_manager_get_client_pointer:
 307  * @device_manager: a #GdkDeviceManager
 308  *
 309  * Returns the client pointer, that is, the master pointer that acts as the core pointer
 310  * for this application. In X11, window managers may change this depending on the interaction
 311  * pattern under the presence of several pointers.
 312  *
 313  * You should use this function sheldomly, only in code that isn't triggered by a #GdkEvent
 314  * and there aren't other means to get a meaningful #GdkDevice to operate on.
 315  *
 316  * Returns: (transfer none): The client pointer. This memory is
 317  *          owned by GDK and must not be freed or unreferenced.
 318  *
 319  * Since: 3.0
 320  **/
 321 GdkDevice *
 322 gdk_device_manager_get_client_pointer (GdkDeviceManager *device_manager)
 323 {
 324   g_return_val_if_fail (GDK_IS_DEVICE_MANAGER (device_manager), NULL);
 325
 326   return GDK_DEVICE_MANAGER_GET_CLASS (device_manager)->get_client_pointer (device_manager);
 327 }