GdkDevice

GdkDevice — Object representing an input device

Functions

Properties

GdkDevice * associated-device Read
GdkAxisFlags axes Read
GdkDisplay * display Read / Write / Construct Only
gboolean has-cursor Read / Write / Construct Only
GdkInputMode input-mode Read / Write
GdkInputSource input-source Read / Write / Construct Only
guint n-axes Read
gchar * name Read / Write / Construct Only
guint num-touches Read / Write / Construct Only
gchar * product-id Read / Write / Construct Only
GdkSeat * seat Read / Write
GdkDeviceTool * tool Read
GdkDeviceType type Read / Write / Construct Only
gchar * vendor-id Read / Write / Construct Only

Signals

void changed Run Last
void tool-changed Run Last

Types and Values

  GdkDevice
enum GdkInputSource
enum GdkInputMode
enum GdkAxisUse
enum GdkAxisFlags
enum GdkDeviceToolType
enum GdkDeviceType
enum GdkGrabOwnership
struct GdkTimeCoord

Object Hierarchy

    GObject
    ╰── GdkDevice

Known Derived Interfaces

GdkDevice is required by GdkDevicePad.

Includes

#include <gdk/gdk.h>

Description

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

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

Functions

gdk_device_get_name ()

const gchar *
gdk_device_get_name (GdkDevice *device);

Determines the name of the device.

Parameters

device

a GdkDevice

 

Returns

a name


gdk_device_get_vendor_id ()

const gchar *
gdk_device_get_vendor_id (GdkDevice *device);

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

This function, together with gdk_device_get_product_id(), can be used to eg. compose GSettings paths to store settings for this device.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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;
}

Parameters

device

a slave GdkDevice

 

Returns

the vendor ID, or NULL.

[nullable]


gdk_device_get_product_id ()

const gchar *
gdk_device_get_product_id (GdkDevice *device);

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

Parameters

device

a slave GdkDevice

 

Returns

the product ID, or NULL.

[nullable]


gdk_device_get_source ()

GdkInputSource
gdk_device_get_source (GdkDevice *device);

Determines the type of the device.

Parameters

device

a GdkDevice

 

Returns

a GdkInputSource


gdk_device_set_mode ()

gboolean
gdk_device_set_mode (GdkDevice *device,
                     GdkInputMode mode);

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 surface.

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.

Parameters

device

a GdkDevice.

 

mode

the input mode.

 

Returns

TRUE if the mode was successfully changed.


gdk_device_get_mode ()

GdkInputMode
gdk_device_get_mode (GdkDevice *device);

Determines the mode of the device.

Parameters

device

a GdkDevice

 

Returns

a GdkInputMode


gdk_device_set_key ()

void
gdk_device_set_key (GdkDevice *device,
                    guint index_,
                    guint keyval,
                    GdkModifierType modifiers);

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

Parameters

device

a GdkDevice

 

index_

the index of the macro button to set

 

keyval

the keyval to generate

 

modifiers

the modifiers to set

 

gdk_device_get_key ()

gboolean
gdk_device_get_key (GdkDevice *device,
                    guint index_,
                    guint *keyval,
                    GdkModifierType *modifiers);

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

Parameters

device

a GdkDevice.

 

index_

the index of the macro button to get.

 

keyval

return value for the keyval.

[out]

modifiers

return value for modifiers.

[out]

Returns

TRUE if keyval is set for index .


gdk_device_set_axis_use ()

void
gdk_device_set_axis_use (GdkDevice *device,
                         guint index_,
                         GdkAxisUse use);

Specifies how an axis of a device is used.

Parameters

device

a pointer GdkDevice

 

index_

the index of the axis

 

use

specifies how the axis is used

 

gdk_device_get_axis_use ()

GdkAxisUse
gdk_device_get_axis_use (GdkDevice *device,
                         guint index_);

Returns the axis use for index_ .

Parameters

device

a pointer GdkDevice.

 

index_

the index of the axis.

 

Returns

a GdkAxisUse specifying how the axis is used.


gdk_device_get_associated_device ()

GdkDevice *
gdk_device_get_associated_device (GdkDevice *device);

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

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

If device is of type GDK_DEVICE_TYPE_FLOATING, NULL will be returned, as there is no associated device.

Parameters

device

a GdkDevice

 

Returns

The associated device, or NULL.

[nullable][transfer none]


gdk_device_list_slave_devices ()

GList *
gdk_device_list_slave_devices (GdkDevice *device);

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

Parameters

device

a GdkDevice

 

Returns

the list of slave devices, or NULL. The list must be freed with g_list_free(), the contents of the list are owned by GTK+ and should not be freed.

[nullable][transfer container][element-type GdkDevice]


gdk_device_get_device_type ()

GdkDeviceType
gdk_device_get_device_type (GdkDevice *device);

Returns the device type for device .

Parameters

device

a GdkDevice

 

Returns

the GdkDeviceType for device .


gdk_device_get_display ()

GdkDisplay *
gdk_device_get_display (GdkDevice *device);

Returns the GdkDisplay to which device pertains.

Parameters

device

a GdkDevice

 

Returns

a GdkDisplay. This memory is owned by GTK+, and must not be freed or unreffed.

[transfer none]


gdk_device_get_has_cursor ()

gboolean
gdk_device_get_has_cursor (GdkDevice *device);

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

Parameters

device

a GdkDevice

 

Returns

TRUE if the pointer follows device motion


gdk_device_get_n_axes ()

gint
gdk_device_get_n_axes (GdkDevice *device);

Returns the number of axes the device currently has.

Parameters

device

a pointer GdkDevice

 

Returns

the number of axes.


gdk_device_get_n_keys ()

gint
gdk_device_get_n_keys (GdkDevice *device);

Returns the number of keys the device currently has.

Parameters

device

a GdkDevice

 

Returns

the number of keys.


gdk_device_get_axes ()

GdkAxisFlags
gdk_device_get_axes (GdkDevice *device);

Returns the axes currently available on the device.

Parameters

device

a GdkDevice

 

gdk_device_get_seat ()

GdkSeat *
gdk_device_get_seat (GdkDevice *device);

Returns the GdkSeat the device belongs to.

Parameters

device

A GdkDevice

 

Returns

A GdkSeat. This memory is owned by GTK+ and must not be freed.

[transfer none]


gdk_device_get_state ()

void
gdk_device_get_state (GdkDevice *device,
                      GdkSurface *surface,
                      gdouble *axes,
                      GdkModifierType *mask);

Gets the current state of a pointer device relative to surface . As a slave device’s coordinates are those of its master pointer, this function may not be called on devices of type GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them. See gdk_seat_grab().

[skip]

Parameters

device

a GdkDevice.

 

surface

a GdkSurface.

 

axes

an array of doubles to store the values of the axes of device in, or NULL.

[nullable][array]

mask

location to store the modifiers, or NULL.

[optional][out]

gdk_device_get_surface_at_position ()

GdkSurface *
gdk_device_get_surface_at_position (GdkDevice *device,
                                    double *win_x,
                                    double *win_y);

Obtains the surface underneath device , returning the location of the device in win_x and win_y in double precision. Returns NULL if the surface 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 GDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see gdk_seat_grab().

Parameters

device

pointer GdkDevice to query info to.

 

win_x

return location for the X coordinate of the device location, relative to the surface origin, or NULL.

[out][allow-none]

win_y

return location for the Y coordinate of the device location, relative to the surface origin, or NULL.

[out][allow-none]

Returns

the GdkSurface under the device position, or NULL.

[nullable][transfer none]


gdk_device_get_history ()

gboolean
gdk_device_get_history (GdkDevice *device,
                        GdkSurface *surface,
                        guint32 start,
                        guint32 stop,
                        GdkTimeCoord ***events,
                        gint *n_events);

Obtains the motion history for a pointer device; given a starting and ending timestamp, return all events in the motion history for the device in the given range of time. Some windowing systems do not support motion history, in which case, FALSE will be returned. (This is not distinguishable from the case where motion history is supported and no events were found.)

Note that there is also gdk_surface_set_event_compression() to get more motion events delivered directly, independent of the windowing system.

[skip]

Parameters

device

a GdkDevice

 

surface

the surface with respect to which which the event coordinates will be reported

 

start

starting timestamp for range of events to return

 

stop

ending timestamp for the range of events to return

 

events

location to store a newly-allocated array of GdkTimeCoord, or NULL.

[array length=n_events][out][transfer full][optional]

n_events

location to store the length of events , or NULL.

[out][optional]

Returns

TRUE if the windowing system supports motion history and at least one event was found.


gdk_device_free_history ()

void
gdk_device_free_history (GdkTimeCoord **events,
                         gint n_events);

Frees an array of GdkTimeCoord that was returned by gdk_device_get_history().

[skip]

Parameters

events

an array of GdkTimeCoord.

[array length=n_events]

n_events

the length of the array.

 

gdk_device_get_axis ()

gboolean
gdk_device_get_axis (GdkDevice *device,
                     gdouble *axes,
                     GdkAxisUse use,
                     gdouble *value);

Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use.

[skip]

Parameters

device

a GdkDevice

 

axes

pointer to an array of axes.

[array]

use

the use to look for

 

value

location to store the found value.

[out]

Returns

TRUE if the given axis use was found, otherwise FALSE


gdk_device_list_axes ()

GList *
gdk_device_list_axes (GdkDevice *device);

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

Parameters

device

a pointer GdkDevice

 

Returns

A GList of strings, free with g_list_free().

[transfer container][element-type GdkAtom]


gdk_device_get_axis_value ()

gboolean
gdk_device_get_axis_value (GdkDevice *device,
                           gdouble *axes,
                           GdkAtom axis_label,
                           gdouble *value);

Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis label, as returned by gdk_device_list_axes()

[skip]

Parameters

device

a pointer GdkDevice.

 

axes

pointer to an array of axes.

[array]

axis_label

name of the label

 

value

location to store the found value.

[out]

Returns

TRUE if the given axis use was found, otherwise FALSE.


gdk_device_get_last_event_surface ()

GdkSurface *
gdk_device_get_last_event_surface (GdkDevice *device);

Gets information about which surface 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, NULL may be returned even if the pointer is physically over one of this application's surfaces.

Parameters

device

a GdkDevice, with a source other than GDK_SOURCE_KEYBOARD

 

Returns

the last surface the device.

[transfer none][allow-none]


gdk_device_tool_get_serial ()

guint64
gdk_device_tool_get_serial (GdkDeviceTool *tool);

Gets the serial of this tool, this value can be used to identify a physical tool (eg. a tablet pen) across program executions.

Parameters

tool

a GdkDeviceTool

 

Returns

The serial ID for this tool


gdk_device_tool_get_tool_type ()

GdkDeviceToolType
gdk_device_tool_get_tool_type (GdkDeviceTool *tool);

Gets the GdkDeviceToolType of the tool.

Parameters

tool

a GdkDeviceTool

 

Returns

The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil.


gdk_device_tool_get_hardware_id ()

guint64
gdk_device_tool_get_hardware_id (GdkDeviceTool *tool);

Gets the hardware ID of this tool, or 0 if it's not known. When non-zero, the identificator is unique for the given tool model, meaning that two identical tools will share the same hardware_id , but will have different serial numbers (see gdk_device_tool_get_serial()).

This is a more concrete (and device specific) method to identify a GdkDeviceTool than gdk_device_tool_get_tool_type(), as a tablet may support multiple devices with the same GdkDeviceToolType, but having different hardware identificators.

Parameters

tool

a GdkDeviceTool

 

Returns

The hardware identificator of this tool.

Property Details

The “associated-device” property

  “associated-device”        GdkDevice *

Associated pointer or keyboard with this device, if any. Devices of type GDK_DEVICE_TYPE_MASTER always come in keyboard/pointer pairs. Other device types will have a NULL associated device.

Owner: GdkDevice

Flags: Read


The “axes” property

  “axes”                     GdkAxisFlags

The axes currently available for this device.

Owner: GdkDevice

Flags: Read


The “display” property

  “display”                  GdkDisplay *

The GdkDisplay the GdkDevice pertains to.

Owner: GdkDevice

Flags: Read / Write / Construct Only


The “has-cursor” property

  “has-cursor”               gboolean

Whether the device is represented by a cursor on the screen. Devices of type GDK_DEVICE_TYPE_MASTER will have TRUE here.

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: FALSE


The “input-mode” property

  “input-mode”               GdkInputMode

Input mode for the device.

Owner: GdkDevice

Flags: Read / Write

Default value: GDK_MODE_DISABLED


The “input-source” property

  “input-source”             GdkInputSource

Source type for the device.

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: GDK_SOURCE_MOUSE


The “n-axes” property

  “n-axes”                   guint

Number of axes in the device.

Owner: GdkDevice

Flags: Read

Default value: 0


The “name” property

  “name”                     gchar *

The device name.

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: NULL


The “num-touches” property

  “num-touches”              guint

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.

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: 0


The “product-id” property

  “product-id”               gchar *

Product ID of this device, see gdk_device_get_product_id().

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: NULL


The “seat” property

  “seat”                     GdkSeat *

GdkSeat of this device.

Owner: GdkDevice

Flags: Read / Write


The “tool” property

  “tool”                     GdkDeviceTool *

The tool that is currently used with this device.

Owner: GdkDevice

Flags: Read


The “type” property

  “type”                     GdkDeviceType

Device role in the device manager.

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: GDK_DEVICE_TYPE_MASTER


The “vendor-id” property

  “vendor-id”                gchar *

Vendor ID of this device, see gdk_device_get_vendor_id().

Owner: GdkDevice

Flags: Read / Write / Construct Only

Default value: NULL

Signal Details

The “changed” signal

void
user_function (GdkDevice *device,
               gpointer   user_data)

The ::changed signal is emitted either when the GdkDevice 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.

Parameters

device

the GdkDevice that changed.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “tool-changed” signal

void
user_function (GdkDevice     *device,
               GdkDeviceTool *tool,
               gpointer       user_data)

The ::tool-changed signal is emitted on pen/eraser GdkDevices whenever tools enter or leave proximity.

Parameters

device

the GdkDevice that changed.

 

tool

The new current tool

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

See Also

GdkSeat