Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
The GdkDevice
object represents an input device, such
as a keyboard, a mouse, or a touchpad.
See the Seat
documentation for more information
about the various kinds of devices, and their relationships.
Synopsis
- newtype Device = Device (ManagedPtr Device)
- class (GObject o, IsDescendantOf Device o) => IsDevice o
- toDevice :: (MonadIO m, IsDevice o) => o -> m Device
- deviceGetCapsLockState :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Bool
- deviceGetDeviceTool :: (HasCallStack, MonadIO m, IsDevice a) => a -> m (Maybe DeviceTool)
- deviceGetDirection :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Direction
- deviceGetDisplay :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Display
- deviceGetHasCursor :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Bool
- deviceGetModifierState :: (HasCallStack, MonadIO m, IsDevice a) => a -> m [ModifierType]
- deviceGetName :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Text
- deviceGetNumLockState :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Bool
- deviceGetNumTouches :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Word32
- deviceGetProductId :: (HasCallStack, MonadIO m, IsDevice a) => a -> m (Maybe Text)
- deviceGetScrollLockState :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Bool
- deviceGetSeat :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Seat
- deviceGetSource :: (HasCallStack, MonadIO m, IsDevice a) => a -> m InputSource
- deviceGetSurfaceAtPosition :: (HasCallStack, MonadIO m, IsDevice a) => a -> m (Maybe Surface, Double, Double)
- deviceGetTimestamp :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Word32
- deviceGetVendorId :: (HasCallStack, MonadIO m, IsDevice a) => a -> m (Maybe Text)
- deviceHasBidiLayouts :: (HasCallStack, MonadIO m, IsDevice a) => a -> m Bool
- getDeviceCapsLockState :: (MonadIO m, IsDevice o) => o -> m Bool
- getDeviceDirection :: (MonadIO m, IsDevice o) => o -> m Direction
- constructDeviceDisplay :: (IsDevice o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)
- getDeviceDisplay :: (MonadIO m, IsDevice o) => o -> m Display
- getDeviceHasBidiLayouts :: (MonadIO m, IsDevice o) => o -> m Bool
- constructDeviceHasCursor :: (IsDevice o, MonadIO m) => Bool -> m (GValueConstruct o)
- getDeviceHasCursor :: (MonadIO m, IsDevice o) => o -> m Bool
- getDeviceModifierState :: (MonadIO m, IsDevice o) => o -> m [ModifierType]
- getDeviceNAxes :: (MonadIO m, IsDevice o) => o -> m Word32
- constructDeviceName :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o)
- getDeviceName :: (MonadIO m, IsDevice o) => o -> m Text
- getDeviceNumLockState :: (MonadIO m, IsDevice o) => o -> m Bool
- constructDeviceNumTouches :: (IsDevice o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getDeviceNumTouches :: (MonadIO m, IsDevice o) => o -> m Word32
- constructDeviceProductId :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o)
- getDeviceProductId :: (MonadIO m, IsDevice o) => o -> m (Maybe Text)
- getDeviceScrollLockState :: (MonadIO m, IsDevice o) => o -> m Bool
- clearDeviceSeat :: (MonadIO m, IsDevice o) => o -> m ()
- constructDeviceSeat :: (IsDevice o, MonadIO m, IsSeat a) => a -> m (GValueConstruct o)
- getDeviceSeat :: (MonadIO m, IsDevice o) => o -> m Seat
- setDeviceSeat :: (MonadIO m, IsDevice o, IsSeat a) => o -> a -> m ()
- constructDeviceSource :: (IsDevice o, MonadIO m) => InputSource -> m (GValueConstruct o)
- getDeviceSource :: (MonadIO m, IsDevice o) => o -> m InputSource
- getDeviceTool :: (MonadIO m, IsDevice o) => o -> m (Maybe DeviceTool)
- constructDeviceVendorId :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o)
- getDeviceVendorId :: (MonadIO m, IsDevice o) => o -> m (Maybe Text)
- type DeviceChangedCallback = IO ()
- afterDeviceChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceChangedCallback) -> m SignalHandlerId
- onDeviceChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceChangedCallback) -> m SignalHandlerId
- type DeviceToolChangedCallback = DeviceTool -> IO ()
- afterDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceToolChangedCallback) -> m SignalHandlerId
- onDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceToolChangedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Device Source # | |
GObject Device Source # | |
Defined in GI.Gdk.Objects.Device | |
ManagedPtrNewtype Device Source # | |
Defined in GI.Gdk.Objects.Device toManagedPtr :: Device -> ManagedPtr Device # | |
TypedObject Device Source # | |
Defined in GI.Gdk.Objects.Device | |
HasParentTypes Device Source # | |
Defined in GI.Gdk.Objects.Device | |
IsGValue (Maybe Device) Source # | Convert |
Defined in GI.Gdk.Objects.Device | |
type ParentTypes Device Source # | |
Defined in GI.Gdk.Objects.Device type ParentTypes Device = '[Object] |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, hasBidiLayouts, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCapsLockState, getData, getDeviceTool, getDirection, getDisplay, getHasCursor, getModifierState, getName, getNumLockState, getNumTouches, getProductId, getProperty, getQdata, getScrollLockState, getSeat, getSource, getSurfaceAtPosition, getTimestamp, getVendorId.
Setters
getCapsLockState
deviceGetCapsLockState Source #
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves whether the Caps Lock modifier of the keyboard is locked.
This is only relevant for keyboard devices.
getDeviceTool
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m (Maybe DeviceTool) | Returns: the |
Retrieves the current tool for device
.
getDirection
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Direction | Returns: |
Returns the direction of effective layout of the keyboard.
This is only relevant for keyboard devices.
The direction of a layout is the direction of the majority
of its symbols. See unicharDirection
.
getDisplay
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Display | Returns: a |
Returns the GdkDisplay
to which device
pertains.
getHasCursor
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Bool | Returns: |
Determines whether the pointer follows device motion.
This is not meaningful for keyboard devices, which don't have a pointer.
getModifierState
deviceGetModifierState Source #
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m [ModifierType] | Returns: the current modifier state |
Retrieves the current modifier state of the keyboard.
This is only relevant for keyboard devices.
getName
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Text | Returns: a name |
The name of the device, suitable for showing in a user interface.
getNumLockState
deviceGetNumLockState Source #
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves whether the Num Lock modifier of the keyboard is locked.
This is only relevant for keyboard devices.
getNumTouches
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Word32 | Returns: the number of touch points |
Retrieves the number of touch points associated to device
.
getProductId
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m (Maybe Text) | Returns: the product ID |
Returns the product ID of this device.
This ID is retrieved from the device, and does not change.
See deviceGetVendorId
for more information.
getScrollLockState
deviceGetScrollLockState Source #
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves whether the Scroll Lock modifier of the keyboard is locked.
This is only relevant for keyboard devices.
getSeat
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Seat | Returns: a |
Returns the GdkSeat
the device belongs to.
getSource
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m InputSource | Returns: a |
Determines the type of the device.
getSurfaceAtPosition
deviceGetSurfaceAtPosition Source #
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m (Maybe Surface, Double, Double) | Returns: the |
Obtains the surface underneath device
, returning the location of the
device in winX
and winY
.
Returns Nothing
if the surface tree under device
is not known to GDK
(for example, belongs to another application).
getTimestamp
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Word32 | Returns: the timestamp of the last activity for this device |
Returns the timestamp of the last activity for this device.
In practice, this means the timestamp of the last event that was received from the OS for this device. (GTK may occasionally produce events for a device that are not received from the OS, and will not update the timestamp).
Since: 4.2
getVendorId
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m (Maybe Text) | Returns: the vendor ID |
Returns the vendor ID of this device.
This ID is retrieved from the device, and does not change.
This function, together with deviceGetProductId
,
can be used to eg. compose GSettings
paths to store settings
for this device.
c code
static GSettings * get_device_settings (GdkDevice *device) { const char *vendor, *product; GSettings *settings; GdkDevice *device; char *path; vendor = gdk_device_get_vendor_id (device); product = gdk_device_get_product_id (device); path = g_strdup_printf ("/org/example/app/devices/%s:%s/", vendor, product); settings = g_settings_new_with_path (DEVICE_SCHEMA, path); g_free (path); return settings; }
hasBidiLayouts
:: (HasCallStack, MonadIO m, IsDevice a) | |
=> a |
|
-> m Bool | Returns: |
Determines if layouts for both right-to-left and left-to-right languages are in use on the keyboard.
This is only relevant for keyboard devices.
Properties
capsLockState
Whether Caps Lock is on.
This is only relevant for keyboard devices.
getDeviceCapsLockState :: (MonadIO m, IsDevice o) => o -> m Bool Source #
Get the value of the “caps-lock-state
” property.
When overloading is enabled, this is equivalent to
get
device #capsLockState
direction
The direction of the current layout.
This is only relevant for keyboard devices.
getDeviceDirection :: (MonadIO m, IsDevice o) => o -> m Direction Source #
Get the value of the “direction
” property.
When overloading is enabled, this is equivalent to
get
device #direction
display
The GdkDisplay
the GdkDevice
pertains to.
constructDeviceDisplay :: (IsDevice 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
.
getDeviceDisplay :: (MonadIO m, IsDevice o) => o -> m Display Source #
Get the value of the “display
” property.
When overloading is enabled, this is equivalent to
get
device #display
hasBidiLayouts
Whether the device has both right-to-left and left-to-right layouts.
This is only relevant for keyboard devices.
getDeviceHasBidiLayouts :: (MonadIO m, IsDevice o) => o -> m Bool Source #
Get the value of the “has-bidi-layouts
” property.
When overloading is enabled, this is equivalent to
get
device #hasBidiLayouts
hasCursor
Whether the device is represented by a cursor on the screen.
constructDeviceHasCursor :: (IsDevice o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “has-cursor
” property. This is rarely needed directly, but it is used by new
.
getDeviceHasCursor :: (MonadIO m, IsDevice o) => o -> m Bool Source #
Get the value of the “has-cursor
” property.
When overloading is enabled, this is equivalent to
get
device #hasCursor
modifierState
The current modifier state of the device.
This is only relevant for keyboard devices.
getDeviceModifierState :: (MonadIO m, IsDevice o) => o -> m [ModifierType] Source #
Get the value of the “modifier-state
” property.
When overloading is enabled, this is equivalent to
get
device #modifierState
nAxes
Number of axes in the device.
getDeviceNAxes :: (MonadIO m, IsDevice o) => o -> m Word32 Source #
Get the value of the “n-axes
” property.
When overloading is enabled, this is equivalent to
get
device #nAxes
name
The device name.
constructDeviceName :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “name
” property. This is rarely needed directly, but it is used by new
.
getDeviceName :: (MonadIO m, IsDevice o) => o -> m Text Source #
Get the value of the “name
” property.
When overloading is enabled, this is equivalent to
get
device #name
numLockState
Whether Num Lock is on.
This is only relevant for keyboard devices.
getDeviceNumLockState :: (MonadIO m, IsDevice o) => o -> m Bool Source #
Get the value of the “num-lock-state
” property.
When overloading is enabled, this is equivalent to
get
device #numLockState
numTouches
The maximal number of concurrent touches on a touch device.
Will be 0 if the device is not a touch device or if the number of touches is unknown.
constructDeviceNumTouches :: (IsDevice o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “num-touches
” property. This is rarely needed directly, but it is used by new
.
getDeviceNumTouches :: (MonadIO m, IsDevice o) => o -> m Word32 Source #
Get the value of the “num-touches
” property.
When overloading is enabled, this is equivalent to
get
device #numTouches
productId
Product ID of this device.
See deviceGetProductId
.
constructDeviceProductId :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “product-id
” property. This is rarely needed directly, but it is used by new
.
getDeviceProductId :: (MonadIO m, IsDevice o) => o -> m (Maybe Text) Source #
Get the value of the “product-id
” property.
When overloading is enabled, this is equivalent to
get
device #productId
scrollLockState
Whether Scroll Lock is on.
This is only relevant for keyboard devices.
getDeviceScrollLockState :: (MonadIO m, IsDevice o) => o -> m Bool Source #
Get the value of the “scroll-lock-state
” property.
When overloading is enabled, this is equivalent to
get
device #scrollLockState
seat
GdkSeat
of this device.
clearDeviceSeat :: (MonadIO m, IsDevice o) => o -> m () Source #
Set the value of the “seat
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#seat
constructDeviceSeat :: (IsDevice o, MonadIO m, IsSeat a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “seat
” property. This is rarely needed directly, but it is used by new
.
getDeviceSeat :: (MonadIO m, IsDevice o) => o -> m Seat Source #
Get the value of the “seat
” property.
When overloading is enabled, this is equivalent to
get
device #seat
setDeviceSeat :: (MonadIO m, IsDevice o, IsSeat a) => o -> a -> m () Source #
Set the value of the “seat
” property.
When overloading is enabled, this is equivalent to
set
device [ #seat:=
value ]
source
Source type for the device.
constructDeviceSource :: (IsDevice o, MonadIO m) => InputSource -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “source
” property. This is rarely needed directly, but it is used by new
.
getDeviceSource :: (MonadIO m, IsDevice o) => o -> m InputSource Source #
Get the value of the “source
” property.
When overloading is enabled, this is equivalent to
get
device #source
tool
The GdkDeviceTool
that is currently used with this device.
getDeviceTool :: (MonadIO m, IsDevice o) => o -> m (Maybe DeviceTool) Source #
Get the value of the “tool
” property.
When overloading is enabled, this is equivalent to
get
device #tool
vendorId
Vendor ID of this device.
See deviceGetVendorId
.
constructDeviceVendorId :: (IsDevice o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “vendor-id
” property. This is rarely needed directly, but it is used by new
.
getDeviceVendorId :: (MonadIO m, IsDevice o) => o -> m (Maybe Text) Source #
Get the value of the “vendor-id
” property.
When overloading is enabled, this is equivalent to
get
device #vendorId
Signals
changed
type DeviceChangedCallback = IO () Source #
Emitted either when the number of either axes or keys changes.
On X11 this will normally happen when the physical device routing events through the logical device changes (for example, user switches from the USB mouse to a tablet); in that case the logical device will change to reflect the axes and keys on the new physical device.
afterDeviceChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
device #changed 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.
onDeviceChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
device #changed callback
toolChanged
type DeviceToolChangedCallback Source #
= DeviceTool |
|
-> IO () |
Emitted on pen/eraser devices whenever tools enter or leave proximity.
afterDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceToolChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the toolChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
device #toolChanged 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.
onDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> ((?self :: a) => DeviceToolChangedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the toolChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
device #toolChanged callback