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