gi-gdk-3.0.28: Gdk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | Safe-Inferred
Language | Haskell2010

GI.Gdk.Objects.DeviceManager

Contents

- Exported types
- Methods
  - getClientPointer
  - getDisplay
  - listDevices
- Properties
  - display
- Signals
  - deviceAdded
  - deviceChanged
  - deviceRemoved

Description

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:nAxes 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.

Synopsis

- newtype DeviceManager = DeviceManager (ManagedPtr DeviceManager)
- class (GObject o, IsDescendantOf DeviceManager o) => IsDeviceManager o
- toDeviceManager :: (MonadIO m, IsDeviceManager o) => o -> m DeviceManager
- deviceManagerGetClientPointer :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> m Device
- deviceManagerGetDisplay :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> m (Maybe Display)
- deviceManagerListDevices :: (HasCallStack, MonadIO m, IsDeviceManager a) => a -> DeviceType -> m [Device]
- constructDeviceManagerDisplay :: (IsDeviceManager o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)
- getDeviceManagerDisplay :: (MonadIO m, IsDeviceManager o) => o -> m (Maybe Display)
- type DeviceManagerDeviceAddedCallback = Device -> IO ()
- afterDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId
- onDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId
- type DeviceManagerDeviceChangedCallback = Device -> IO ()
- afterDeviceManagerDeviceChanged :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceChangedCallback) -> m SignalHandlerId
- onDeviceManagerDeviceChanged :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceChangedCallback) -> m SignalHandlerId
- type DeviceManagerDeviceRemovedCallback = Device -> IO ()
- afterDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId
- onDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId

# Exported types

newtype DeviceManager Source #

Memory-managed wrapper type.

Constructors

DeviceManager (ManagedPtr DeviceManager) |

#### Instances

Instances details

Eq DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager Methods (==) :: DeviceManager -> DeviceManager -> Bool Source # (/=) :: DeviceManager -> DeviceManager -> Bool Source #
GObject DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager
ManagedPtrNewtype DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager Methods toManagedPtr :: DeviceManager -> ManagedPtr DeviceManager Source #
TypedObject DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager Methods glibType :: IO GType Source #
HasParentTypes DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager
IsGValue (Maybe DeviceManager) Source # | Convert `DeviceManager` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Objects.DeviceManager Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe DeviceManager -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe DeviceManager) Source #
type ParentTypes DeviceManager Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager type ParentTypes DeviceManager = '[Object]

class (GObject o, IsDescendantOf DeviceManager o) => IsDeviceManager o Source #

Type class for types which can be safely cast to `DeviceManager`, for instance with `toDeviceManager`.

#### Instances

Instances details

(GObject o, IsDescendantOf DeviceManager o) => IsDeviceManager o Source # |
Instance details Defined in GI.Gdk.Objects.DeviceManager

toDeviceManager :: (MonadIO m, IsDeviceManager o) => o -> m DeviceManager Source #

Cast to `DeviceManager`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, listDevices, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getClientPointer, getData, getDisplay, getProperty, getQdata.

#### Setters

setData, setDataFull, setProperty.

## getClientPointer

deviceManagerGetClientPointer Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceManager a) |
=> a | `deviceManager`: a `DeviceManager`
-> 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

deviceManagerGetDisplay Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceManager a) |
=> a | `deviceManager`: a `DeviceManager`
-> m (Maybe Display) | Returns: the `Display` to which `deviceManager` is associated to, or `Nothing`. This memory is owned by GDK and must not be freed or unreferenced.

Gets the `Display` associated to `deviceManager`.

Since: 3.0

## listDevices

deviceManagerListDevices Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceManager a) |
=> a | `deviceManager`: a `DeviceManager`
-> DeviceType | `type`: device type to get.
-> m [Device] | Returns: a list of `GdkDevices`. The returned list must be freed with g_list_free (). The list elements are owned by GTK+ and must not be freed or unreffed.

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

No description available in the introspection data.

constructDeviceManagerDisplay :: (IsDeviceManager o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`display`” property. This is rarely needed directly, but it is used by `new`.

getDeviceManagerDisplay :: (MonadIO m, IsDeviceManager o) => o -> m (Maybe Display) Source #

Get the value of the “`display`” property. When overloading is enabled, this is equivalent to

    get deviceManager #display

# Signals

## deviceAdded

type DeviceManagerDeviceAddedCallback Source #

Arguments

= Device | `device`: the newly added `Device`.
-> IO () |

The deviceAdded signal is emitted either when a new master pointer is created, or when a slave (Hardware) input device is plugged in.

afterDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after deviceManager #deviceAdded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onDeviceManagerDeviceAdded :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceAddedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on deviceManager #deviceAdded callback

## deviceChanged

type DeviceManagerDeviceChangedCallback Source #

Arguments

= Device | `device`: the `Device` that changed.
-> IO () |

The deviceChanged signal is emitted whenever a device has changed in the hierarchy, either slave devices being disconnected from their master device or connected to another one, or master devices being added or removed a slave device.

If a slave device is detached from all master devices (`deviceGetAssociatedDevice` returns `Nothing`), its `DeviceType` will change to `DeviceTypeFloating`, if it's attached, it will change to `DeviceTypeSlave`.

afterDeviceManagerDeviceChanged :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after deviceManager #deviceChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onDeviceManagerDeviceChanged :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on deviceManager #deviceChanged callback

## deviceRemoved

type DeviceManagerDeviceRemovedCallback Source #

Arguments

= Device | `device`: the just removed `Device`.
-> IO () |

The deviceRemoved signal is emitted either when a master pointer is removed, or when a slave (Hardware) input device is unplugged.

afterDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after deviceManager #deviceRemoved callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onDeviceManagerDeviceRemoved :: (IsDeviceManager a, MonadIO m) => a -> ((?self :: a) => DeviceManagerDeviceRemovedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the deviceRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on deviceManager #deviceRemoved callback