Memory-managed wrapper type.

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

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

Returns the associated device to device, if device is of type DeviceTypeMaster, it will return the paired pointer or keyboard.

If device is of type DeviceTypeSlave, it will return the master device to which device is attached to.

If device is of type DeviceTypeFloating, Nothing will be returned, as there is no associated device.

Since: 3.0

Returns the axes currently available on the device.

Since: 3.22

Returns the axis use for index_.

Since: 2.20

Returns the device type for device.

Since: 3.0

Returns the Display to which device pertains.

Since: 3.0

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

Since: 2.20

If index_ has a valid keyval, this function will return True and fill in keyval and modifiers with the keyval settings.

Since: 2.20

Gets information about which window the given pointer device is in, based on events that have been received so far from the display server. If another application has a pointer grab, or this application has a grab with owner_events = False, Nothing may be returned even if the pointer is physically over one of this application's windows.

Since: 3.12

Determines the mode of the device.

Since: 2.20

Returns the number of axes the device currently has.

Since: 3.0

Returns the number of keys the device currently has.

Since: 2.24

Determines the name of the device.

Since: 2.20

Gets the current location of device. As a slave device coordinates are those of its master pointer, This function may not be called on devices of type DeviceTypeSlave, unless there is an ongoing grab on them, see deviceGrab.

Since: 3.0

Gets the current location of device in double precision. As a slave device's coordinates are those of its master pointer, this function may not be called on devices of type DeviceTypeSlave, unless there is an ongoing grab on them. See deviceGrab.

Since: 3.10

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.

Since: 3.16

Returns the Seat the device belongs to.

Since: 3.20

Determines the type of the device.

Since: 2.20

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 gchar *vendor, *product;
  GSettings *settings;
  GdkDevice *device;
  gchar *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;
}

Since: 3.16

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

As a slave device coordinates are those of its master pointer, This function may not be called on devices of type DeviceTypeSlave, unless there is an ongoing grab on them, see deviceGrab.

Since: 3.0

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

As a slave device coordinates are those of its master pointer, This function may not be called on devices of type DeviceTypeSlave, unless there is an ongoing grab on them, see deviceGrab.

Since: 3.0

Grabs the device so that all events coming from this device are passed to this application until the device is ungrabbed with deviceUngrab, or the window becomes unviewable. This overrides any previous grab on the device by this client.

Note that device and window need to be on the same display.

Device grabs are used for operations which need complete control over the given device events (either pointer or keyboard). For example in GTK+ this is used for Drag and Drop operations, popup menus and such.

Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with ownerEvents set to True.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the EventGrabBroken events that are emitted when the grab ends unvoluntarily.

Since: 3.0

Determines information about the current keyboard grab. This is not public API and must not be used by applications.

Returns a List of GdkAtoms, containing the labels for the axes that device currently has.

Since: 3.0

If the device if of type DeviceTypeMaster, it will return the list of slave devices attached to it, otherwise it will return Nothing

Specifies how an axis of a device is used.

Specifies the X key event to generate when a macro button of a device is pressed.

Sets a the mode of an input device. The mode controls if the device is active and whether the device’s range is mapped to the entire screen or to a single window.

Note: This is only meaningful for floating devices, master devices (and slaves connected to these) drive the pointer cursor, which is not limited by the input mode.

Release any grab on device.

Since: 3.0

Warps device in display to the point x,y on the screen screen, unless the device is confined to a window by a grab, in which case it will be moved as far as allowed by the grab. Warping the pointer creates events as if the user had moved the mouse instantaneously to the destination.

Note that the pointer should normally be under the control of the user. This function was added to cover some rare use cases like keyboard navigation support for the color picker in the GtkColorSelectionDialog.

Since: 3.0

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

get device #associatedDevice

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

get device #axes

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

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

get device #deviceManager

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

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

get device #display

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

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

get device #hasCursor

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

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

get device #inputMode

Set the value of the “input-mode” property. When overloading is enabled, this is equivalent to

set device [ #inputMode := value ]

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

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

get device #inputSource

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

get device #nAxes

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

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

get device #name

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

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

get device #numTouches

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

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

get device #productId

Set the value of the “seat” property to Nothing. When overloading is enabled, this is equivalent to

clear #seat

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

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

get device #seat

Set the value of the “seat” property. When overloading is enabled, this is equivalent to

set device [ #seat := value ]

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

get device #tool

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

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

get device #type

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

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

get device #vendorId

The changed signal is emitted either when the Device has changed the number of either axes or keys. For example In X this will normally happen when the slave device routing events through the master device changes (for example, user switches from the USB mouse to a tablet), in that case the master device will change to reflect the new slave device axes and keys.

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.

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

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

Since: 3.22

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.

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