GI.Gdk.Objects.Device

The Device object represents a single input device, such as a keyboard, a mouse, a touchpad, etc.

See the Seat documentation for more information about the various kinds of devices, and their relationships.

Exported types

newtype Device

Memory-managed wrapper type.

Constructors

Device (ManagedPtr Device)

Instances

Eq Device

Defined in GI.Gdk.Objects.Device

Methods

(==) :: Device -> Device -> Bool

(/=) :: Device -> Device -> Bool

GObject Device

Defined in GI.Gdk.Objects.Device

ManagedPtrNewtype Device

Defined in GI.Gdk.Objects.Device

Methods

toManagedPtr :: Device -> ManagedPtr Device

TypedObject Device

Defined in GI.Gdk.Objects.Device

Methods

glibType :: IO GType

HasParentTypes Device

Defined in GI.Gdk.Objects.Device

IsGValue (Maybe Device)

Convert Device to and from GValue. See toGValue and fromGValue.

Defined in GI.Gdk.Objects.Device

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Device -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Device)

type ParentTypes Device

Defined in GI.Gdk.Objects.Device

type ParentTypes Device = '[Object]

class (GObject o, IsDescendantOf Device o) => IsDevice o

Type class for types which can be safely cast to Device, for instance with toDevice.

Instances

(GObject o, IsDescendantOf Device o) => IsDevice o

Defined in GI.Gdk.Objects.Device

toDevice :: (MonadIO m, IsDevice o) => o -> m Device

Cast to Device, 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

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, getVendorId.

Setters

setData, setDataFull, setProperty.

getCapsLockState

deviceGetCapsLockState

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Bool

Returns: True if Caps Lock is on for device

Retrieves whether the Caps Lock modifier of the keyboard is locked, if device is a keyboard device.

getDeviceTool

deviceGetDeviceTool

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m DeviceTool

Returns: the DeviceTool

Retrieves the DeviceTool associated to device.

getDirection

deviceGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Direction

Returns: DirectionLtr or DirectionRtl if it can determine the direction. DirectionNeutral otherwise

Returns the direction of effective layout of the keyboard, if device is a keyboard device.

The direction of a layout is the direction of the majority of its symbols. See unicharDirection.

getDisplay

deviceGetDisplay

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Display

Returns: a Display. This memory is owned by GTK, and must not be freed or unreffed.

Returns the Display to which device pertains.

getHasCursor

deviceGetHasCursor

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Bool

Returns: True if the pointer follows device motion

Determines whether the pointer follows device motion. This is not meaningful for keyboard devices, which don't have a pointer.

getModifierState

deviceGetModifierState

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m [ModifierType]

Returns: the current modifier state

Retrieves the current modifier state of the keyboard, if device is a keyboard device.

getName

deviceGetName

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Text

Returns: a name

Determines the name of the device, suitable for showing in a user interface.

getNumLockState

deviceGetNumLockState

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Bool

Returns: True if Num Lock is on for device

Retrieves whether the Num Lock modifier of the keyboard is locked, if device is a keyboard device.

getNumTouches

deviceGetNumTouches

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Word32

Returns: the number of touch points

Retrieves the number of touch points associated to device.

getProductId

deviceGetProductId

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a physical Device

-> m (Maybe Text)

Returns: the product ID, or Nothing

Returns the product ID of this device, or Nothing if this information couldn't be obtained. This ID is retrieved from the device, and is thus constant for it. See deviceGetVendorId for more information.

getScrollLockState

deviceGetScrollLockState

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Bool

Returns: True if Scroll Lock is on for device

Retrieves whether the Scroll Lock modifier of the keyboard is locked, if device is a keyboard device.

getSeat

deviceGetSeat

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: A Device

-> m Seat

Returns: a Seat

Returns the Seat the device belongs to.

getSource

deviceGetSource

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m InputSource

Returns: a InputSource

Determines the type of the device.

getSurfaceAtPosition

deviceGetSurfaceAtPosition

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: pointer Device to query info to.

-> m (Maybe Surface, Double, Double)

Returns: the Surface under the device position, or Nothing.

Obtains the surface underneath device, returning the location of the device in winX and winY in double precision. Returns Nothing if the surface tree under device is not known to GDK (for example, belongs to another application).

getVendorId

deviceGetVendorId

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a physical Device

-> m (Maybe Text)

Returns: the vendor ID, or Nothing

Returns the vendor ID of this device, or Nothing if this information couldn't be obtained. This ID is retrieved from the device, and is thus constant for it.

This function, together with deviceGetProductId, can be used to eg. compose Settings 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

deviceHasBidiLayouts

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Bool

Returns: True if there are layouts with both directions, False otherwise

Determines if keyboard layouts for both right-to-left and left-to-right languages are in use on the keyboard, if device is a keyboard device.

Properties

capsLockState

No description available in the introspection data.

getDeviceCapsLockState :: (MonadIO m, IsDevice o) => o -> m Bool

Get the value of the “caps-lock-state” property. When overloading is enabled, this is equivalent to

get device #capsLockState

direction

No description available in the introspection data.

getDeviceDirection :: (MonadIO m, IsDevice o) => o -> m Direction

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

get device #direction

display

The Display the Device pertains to.

constructDeviceDisplay :: (IsDevice o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)

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

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

get device #display

hasBidiLayouts

No description available in the introspection data.

getDeviceHasBidiLayouts :: (MonadIO m, IsDevice o) => o -> m Bool

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)

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

Get the value of the “has-cursor” property. When overloading is enabled, this is equivalent to

get device #hasCursor

modifierState

No description available in the introspection data.

getDeviceModifierState :: (MonadIO m, IsDevice o) => o -> m [ModifierType]

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

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)

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

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

get device #name

numLockState

No description available in the introspection data.

getDeviceNumLockState :: (MonadIO m, IsDevice o) => o -> m Bool

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)

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

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)

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)

Get the value of the “product-id” property. When overloading is enabled, this is equivalent to

get device #productId

scrollLockState

No description available in the introspection data.

getDeviceScrollLockState :: (MonadIO m, IsDevice o) => o -> m Bool

Get the value of the “scroll-lock-state” property. When overloading is enabled, this is equivalent to

get device #scrollLockState

seat

Seat of this device.

clearDeviceSeat :: (MonadIO m, IsDevice o) => o -> m ()

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)

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

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 ()

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)

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

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

get device #source

tool

No description available in the introspection data.

getDeviceTool :: (MonadIO m, IsDevice o) => o -> m (Maybe DeviceTool)

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)

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)

Get the value of the “vendor-id” property. When overloading is enabled, this is equivalent to

get device #vendorId

Signals

changed

type C_DeviceChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DeviceChangedCallback = IO ()

The changed signal is emitted either when the Device has changed the number of either axes or keys. For example 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 -> DeviceChangedCallback -> m SignalHandlerId

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

genClosure_DeviceChanged :: MonadIO m => DeviceChangedCallback -> m (GClosure C_DeviceChangedCallback)

Wrap the callback into a GClosure.

mk_DeviceChangedCallback :: C_DeviceChangedCallback -> IO (FunPtr C_DeviceChangedCallback)

Generate a function pointer callable from C code, from a C_DeviceChangedCallback.

noDeviceChangedCallback :: Maybe DeviceChangedCallback

A convenience synonym for Nothing :: Maybe DeviceChangedCallback.

onDeviceChanged :: (IsDevice a, MonadIO m) => a -> DeviceChangedCallback -> m SignalHandlerId

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

wrap_DeviceChangedCallback :: DeviceChangedCallback -> C_DeviceChangedCallback

Wrap a DeviceChangedCallback into a C_DeviceChangedCallback.

toolChanged

type C_DeviceToolChangedCallback = Ptr () -> Ptr DeviceTool -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DeviceToolChangedCallback

Arguments

 = DeviceTool

tool: The new current tool

-> IO ()

The toolChanged signal is emitted on pen/eraser GdkDevices whenever tools enter or leave proximity.

afterDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> DeviceToolChangedCallback -> m SignalHandlerId

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

genClosure_DeviceToolChanged :: MonadIO m => DeviceToolChangedCallback -> m (GClosure C_DeviceToolChangedCallback)

Wrap the callback into a GClosure.

mk_DeviceToolChangedCallback :: C_DeviceToolChangedCallback -> IO (FunPtr C_DeviceToolChangedCallback)

Generate a function pointer callable from C code, from a C_DeviceToolChangedCallback.

noDeviceToolChangedCallback :: Maybe DeviceToolChangedCallback

A convenience synonym for Nothing :: Maybe DeviceToolChangedCallback.

onDeviceToolChanged :: (IsDevice a, MonadIO m) => a -> DeviceToolChangedCallback -> m SignalHandlerId

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

wrap_DeviceToolChangedCallback :: DeviceToolChangedCallback -> C_DeviceToolChangedCallback

Wrap a DeviceToolChangedCallback into a C_DeviceToolChangedCallback.