Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
In addition to a single pointer and keyboard for user interface input, GDK contains support for a variety of input devices, including graphics tablets, touchscreens and multiple pointers/keyboards interacting simultaneously with the user interface. Such input devices often have additional features, such as sub-pixel positioning information and additional device-dependent information.
In order to query the device hierarchy and be aware of changes in the
device hierarchy (such as virtual devices being created or removed, or
physical devices being plugged or unplugged), GDK provides
DeviceManager
.
By default, and if the platform supports it, GDK is aware of multiple
keyboard/pointer pairs and multitouch devices. This behavior can be
changed by calling disableMultidevice
before displayOpen
.
There should rarely be a need to do that though, since GDK defaults
to a compatibility mode in which it will emit just one enter/leave
event pair for all devices on a window. To enable per-device
enter/leave events and other multi-pointer interaction features,
windowSetSupportMultidevice
must be called on
GdkWindows
(or gtk_widget_set_support_multidevice()
on widgets).
window. See the windowSetSupportMultidevice
documentation
for more information.
On X11, multi-device support is implemented through XInput 2.
Unless disableMultidevice
is called, the XInput 2
DeviceManager
implementation will be used as the input source.
Otherwise either the core or XInput 1 implementations will be used.
For simple applications that don’t have any special interest in
input devices, the so-called “client pointer”
provides a reasonable approximation to a simple setup with a single
pointer and keyboard. The device that has been set as the client
pointer can be accessed via deviceManagerGetClientPointer
.
Conceptually, in multidevice mode there are 2 device types. Virtual devices (or master devices) are represented by the pointer cursors and keyboard foci that are seen on the screen. Physical devices (or slave devices) represent the hardware that is controlling the virtual devices, and thus have no visible cursor on the screen.
Virtual devices are always paired, so there is a keyboard device for every
pointer device. Associations between devices may be inspected through
deviceGetAssociatedDevice
.
There may be several virtual devices, and several physical devices could be controlling each of these virtual devices. Physical devices may also be “floating”, which means they are not attached to any virtual device.
Master and slave devices
carlos@sacarino:~$ xinput list ⎡ Virtual core pointer id=2 [master pointer (3)] ⎜ ↳ Virtual core XTEST pointer id=4 [slave pointer (2)] ⎜ ↳ Wacom ISDv4 E6 Pen stylus id=10 [slave pointer (2)] ⎜ ↳ Wacom ISDv4 E6 Finger touch id=11 [slave pointer (2)] ⎜ ↳ SynPS/2 Synaptics TouchPad id=13 [slave pointer (2)] ⎜ ↳ TPPS/2 IBM TrackPoint id=14 [slave pointer (2)] ⎜ ↳ Wacom ISDv4 E6 Pen eraser id=16 [slave pointer (2)] ⎣ Virtual core keyboard id=3 [master keyboard (2)] ↳ Virtual core XTEST keyboard id=5 [slave keyboard (3)] ↳ Power Button id=6 [slave keyboard (3)] ↳ Video Bus id=7 [slave keyboard (3)] ↳ Sleep Button id=8 [slave keyboard (3)] ↳ Integrated Camera id=9 [slave keyboard (3)] ↳ AT Translated Set 2 keyboard id=12 [slave keyboard (3)] ↳ ThinkPad Extra Buttons id=15 [slave keyboard (3)]
By default, GDK will automatically listen for events coming from all
master devices, setting the Device
for all events coming from input
devices. Events containing device information are GDK_MOTION_NOTIFY
,
GDK_BUTTON_PRESS
, GDK_2BUTTON_PRESS
, GDK_3BUTTON_PRESS
,
GDK_BUTTON_RELEASE
, GDK_SCROLL
, GDK_KEY_PRESS
, GDK_KEY_RELEASE
,
GDK_ENTER_NOTIFY
, GDK_LEAVE_NOTIFY
, GDK_FOCUS_CHANGE
,
GDK_PROXIMITY_IN
, GDK_PROXIMITY_OUT
, GDK_DRAG_ENTER
, GDK_DRAG_LEAVE
,
GDK_DRAG_MOTION
, GDK_DRAG_STATUS
, GDK_DROP_START
, GDK_DROP_FINISHED
and GDK_GRAB_BROKEN
. When dealing with an event on a master device,
it is possible to get the source (slave) device that the event originated
from via eventGetSourceDevice
.
On a standard session, all physical devices are connected by default to the "Virtual Core Pointer/Keyboard" master devices, hence routing all events through these. This behavior is only modified by device grabs, where the slave device is temporarily detached for as long as the grab is held, and more permanently by user modifications to the device hierarchy.
On certain application specific setups, it may make sense
to detach a physical device from its master pointer, and mapping it to
an specific window. This can be achieved by the combination of
deviceGrab
and deviceSetMode
.
In order to listen for events coming from devices
other than a virtual device, windowSetDeviceEvents
must be
called. Generally, this function can be used to modify the event mask
for any given device.
Input devices may also provide additional information besides X/Y.
For example, graphics tablets may also provide pressure and X/Y tilt
information. This information is device-dependent, and may be
queried through gdk_device_get_axis()
. In multidevice mode, virtual
devices will change axes in order to always represent the physical
device that is routing events through it. Whenever the physical device
changes, the Device
:n-axes
property will be notified, and
deviceListAxes
will return the new device axes.
Devices may also have associated “keys” or
macro buttons. Such keys can be globally set to map into normal X
keyboard events. The mapping is set using deviceSetKey
.
In GTK+ 3.20, a new Seat
object has been introduced that
supersedes DeviceManager
and should be preferred in newly
written code.
- newtype DeviceManager = DeviceManager (ManagedPtr DeviceManager)
- class GObject o => IsDeviceManager o
- toDeviceManager :: IsDeviceManager o => o -> IO DeviceManager
- noDeviceManager :: Maybe DeviceManager
- data DeviceManagerGetClientPointerMethodInfo
- deviceManagerGetClientPointer :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> m Device
- data DeviceManagerGetDisplayMethodInfo
- deviceManagerGetDisplay :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> m (Maybe Display)
- data DeviceManagerListDevicesMethodInfo
- deviceManagerListDevices :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> DeviceType -> m [Device]
- data DeviceManagerDisplayPropertyInfo
- constructDeviceManagerDisplay :: (IsDeviceManager o, IsDisplay a) => a -> IO (GValueConstruct o)
- deviceManagerDisplay :: AttrLabelProxy "display"
- getDeviceManagerDisplay :: (MonadIO m, IsDeviceManager o) => o -> m (Maybe Display)
- type C_DeviceManagerDeviceAddedCallback = Ptr () -> Ptr Device -> Ptr () -> IO ()
- type DeviceManagerDeviceAddedCallback = Device -> IO ()
- data DeviceManagerDeviceAddedSignalInfo
- afterDeviceManagerDeviceAdded :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceAddedCallback -> m SignalHandlerId
- genClosure_DeviceManagerDeviceAdded :: DeviceManagerDeviceAddedCallback -> IO Closure
- mk_DeviceManagerDeviceAddedCallback :: C_DeviceManagerDeviceAddedCallback -> IO (FunPtr C_DeviceManagerDeviceAddedCallback)
- noDeviceManagerDeviceAddedCallback :: Maybe DeviceManagerDeviceAddedCallback
- onDeviceManagerDeviceAdded :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceAddedCallback -> m SignalHandlerId
- wrap_DeviceManagerDeviceAddedCallback :: DeviceManagerDeviceAddedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO ()
- type C_DeviceManagerDeviceChangedCallback = Ptr () -> Ptr Device -> Ptr () -> IO ()
- type DeviceManagerDeviceChangedCallback = Device -> IO ()
- data DeviceManagerDeviceChangedSignalInfo
- afterDeviceManagerDeviceChanged :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceChangedCallback -> m SignalHandlerId
- genClosure_DeviceManagerDeviceChanged :: DeviceManagerDeviceChangedCallback -> IO Closure
- mk_DeviceManagerDeviceChangedCallback :: C_DeviceManagerDeviceChangedCallback -> IO (FunPtr C_DeviceManagerDeviceChangedCallback)
- noDeviceManagerDeviceChangedCallback :: Maybe DeviceManagerDeviceChangedCallback
- onDeviceManagerDeviceChanged :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceChangedCallback -> m SignalHandlerId
- wrap_DeviceManagerDeviceChangedCallback :: DeviceManagerDeviceChangedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO ()
- type C_DeviceManagerDeviceRemovedCallback = Ptr () -> Ptr Device -> Ptr () -> IO ()
- type DeviceManagerDeviceRemovedCallback = Device -> IO ()
- data DeviceManagerDeviceRemovedSignalInfo
- afterDeviceManagerDeviceRemoved :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceRemovedCallback -> m SignalHandlerId
- genClosure_DeviceManagerDeviceRemoved :: DeviceManagerDeviceRemovedCallback -> IO Closure
- mk_DeviceManagerDeviceRemovedCallback :: C_DeviceManagerDeviceRemovedCallback -> IO (FunPtr C_DeviceManagerDeviceRemovedCallback)
- noDeviceManagerDeviceRemovedCallback :: Maybe DeviceManagerDeviceRemovedCallback
- onDeviceManagerDeviceRemoved :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceRemovedCallback -> m SignalHandlerId
- wrap_DeviceManagerDeviceRemovedCallback :: DeviceManagerDeviceRemovedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO ()
Exported types
newtype DeviceManager Source #
GObject DeviceManager Source # | |
IsObject DeviceManager Source # | |
IsDeviceManager DeviceManager Source # | |
((~) * info (ResolveDeviceManagerMethod t DeviceManager), MethodInfo * info DeviceManager p) => IsLabel t (DeviceManager -> p) Source # | |
((~) * info (ResolveDeviceManagerMethod t DeviceManager), MethodInfo * info DeviceManager p) => IsLabelProxy t (DeviceManager -> p) Source # | |
HasAttributeList * DeviceManager Source # | |
type AttributeList DeviceManager Source # | |
type SignalList DeviceManager Source # | |
class GObject o => IsDeviceManager o Source #
toDeviceManager :: IsDeviceManager o => o -> IO DeviceManager Source #
Methods
getClientPointer
data DeviceManagerGetClientPointerMethodInfo Source #
((~) * signature (m Device), MonadIO m, IsDeviceManager a) => MethodInfo * DeviceManagerGetClientPointerMethodInfo a signature Source # | |
deviceManagerGetClientPointer Source #
:: (HasCallStack, MonadIO m, IsDeviceManager a) | |
=> a |
|
-> m Device | Returns: The client pointer. This memory is owned by GDK and must not be freed or unreferenced. |
Deprecated: (Since version 3.20)Use seatGetPointer
instead.
Returns the client pointer, that is, the master pointer that acts as the core pointer for this application. In X11, window managers may change this depending on the interaction pattern under the presence of several pointers.
You should use this function seldomly, only in code that isn’t triggered by a Event
and there aren’t other means to get a meaningful Device
to operate on.
Since: 3.0
getDisplay
data DeviceManagerGetDisplayMethodInfo Source #
((~) * signature (m (Maybe Display)), MonadIO m, IsDeviceManager a) => MethodInfo * DeviceManagerGetDisplayMethodInfo a signature Source # | |
deviceManagerGetDisplay Source #
:: (HasCallStack, MonadIO m, IsDeviceManager a) | |
=> a |
|
-> m (Maybe Display) | Returns: the |
Gets the Display
associated to deviceManager
.
Since: 3.0
listDevices
data DeviceManagerListDevicesMethodInfo Source #
((~) * signature (DeviceType -> m [Device]), MonadIO m, IsDeviceManager a) => MethodInfo * DeviceManagerListDevicesMethodInfo a signature Source # | |
deviceManagerListDevices Source #
:: (HasCallStack, MonadIO m, IsDeviceManager a) | |
=> a |
|
-> DeviceType |
|
-> m [Device] | Returns: a list of
|
Deprecated: (Since version 3.20), use seatGetPointer
, seatGetKeyboard
and seatGetSlaves
instead.
Returns the list of devices of type type
currently attached to
deviceManager
.
Since: 3.0
Properties
display
data DeviceManagerDisplayPropertyInfo Source #
constructDeviceManagerDisplay :: (IsDeviceManager o, IsDisplay a) => a -> IO (GValueConstruct o) Source #
deviceManagerDisplay :: AttrLabelProxy "display" Source #
getDeviceManagerDisplay :: (MonadIO m, IsDeviceManager o) => o -> m (Maybe Display) Source #
Signals
deviceAdded
type DeviceManagerDeviceAddedCallback = Device -> IO () Source #
afterDeviceManagerDeviceAdded :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceAddedCallback -> m SignalHandlerId Source #
mk_DeviceManagerDeviceAddedCallback :: C_DeviceManagerDeviceAddedCallback -> IO (FunPtr C_DeviceManagerDeviceAddedCallback) Source #
onDeviceManagerDeviceAdded :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceAddedCallback -> m SignalHandlerId Source #
wrap_DeviceManagerDeviceAddedCallback :: DeviceManagerDeviceAddedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO () Source #
deviceChanged
type DeviceManagerDeviceChangedCallback = Device -> IO () Source #
afterDeviceManagerDeviceChanged :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceChangedCallback -> m SignalHandlerId Source #
mk_DeviceManagerDeviceChangedCallback :: C_DeviceManagerDeviceChangedCallback -> IO (FunPtr C_DeviceManagerDeviceChangedCallback) Source #
onDeviceManagerDeviceChanged :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceChangedCallback -> m SignalHandlerId Source #
wrap_DeviceManagerDeviceChangedCallback :: DeviceManagerDeviceChangedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO () Source #
deviceRemoved
type DeviceManagerDeviceRemovedCallback = Device -> IO () Source #
afterDeviceManagerDeviceRemoved :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceRemovedCallback -> m SignalHandlerId Source #
mk_DeviceManagerDeviceRemovedCallback :: C_DeviceManagerDeviceRemovedCallback -> IO (FunPtr C_DeviceManagerDeviceRemovedCallback) Source #
onDeviceManagerDeviceRemoved :: (GObject a, MonadIO m) => a -> DeviceManagerDeviceRemovedCallback -> m SignalHandlerId Source #
wrap_DeviceManagerDeviceRemovedCallback :: DeviceManagerDeviceRemovedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO () Source #