cdk_device_get_name ()

const gchar *
cdk_device_get_name (CdkDevice *device);

Determines the name of the device.

Since: 2.20

cdk_device_get_vendor_id ()

const gchar *
cdk_device_get_vendor_id (CdkDevice *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 cdk_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 (CdkDevice *device)
{
  const gchar *vendor, *product;
  GSettings *settings;
  CdkDevice *device;
  gchar *path;

  vendor = cdk_device_get_vendor_id (device);
  product = cdk_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

cdk_device_get_product_id ()

const gchar *
cdk_device_get_product_id (CdkDevice *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 cdk_device_get_vendor_id() for more information.

Since: 3.16

cdk_device_get_source ()

CdkInputSource
cdk_device_get_source (CdkDevice *device);

Determines the type of the device.

Since: 2.20

cdk_device_set_mode ()

gboolean
cdk_device_set_mode (CdkDevice *device,
                     CdkInputMode 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 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.

cdk_device_get_mode ()

CdkInputMode
cdk_device_get_mode (CdkDevice *device);

Determines the mode of the device.

Since: 2.20

cdk_device_set_key ()

void
cdk_device_set_key (CdkDevice *device,
                    guint index_,
                    guint keyval,
                    CdkModifierType modifiers);

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

cdk_device_get_key ()

gboolean
cdk_device_get_key (CdkDevice *device,
                    guint index_,
                    guint *keyval,
                    CdkModifierType *modifiers);

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

Since: 2.20

cdk_device_set_axis_use ()

void
cdk_device_set_axis_use (CdkDevice *device,
                         guint index_,
                         CdkAxisUse use);

Specifies how an axis of a device is used.

cdk_device_get_axis_use ()

CdkAxisUse
cdk_device_get_axis_use (CdkDevice *device,
                         guint index_);

Returns the axis use for index_ .

Since: 2.20

cdk_device_get_associated_device ()

CdkDevice *
cdk_device_get_associated_device (CdkDevice *device);

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

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

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

Since: 3.0

cdk_device_list_slave_devices ()

GList *
cdk_device_list_slave_devices (CdkDevice *device);

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

cdk_device_get_device_type ()

CdkDeviceType
cdk_device_get_device_type (CdkDevice *device);

Returns the device type for device .

Since: 3.0

cdk_device_get_display ()

CdkDisplay *
cdk_device_get_display (CdkDevice *device);

Returns the CdkDisplay to which device pertains.

Since: 3.0

cdk_device_get_has_cursor ()

gboolean
cdk_device_get_has_cursor (CdkDevice *device);

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

Since: 2.20

cdk_device_get_n_axes ()

gint
cdk_device_get_n_axes (CdkDevice *device);

Returns the number of axes the device currently has.

Since: 3.0

cdk_device_get_n_keys ()

gint
cdk_device_get_n_keys (CdkDevice *device);

Returns the number of keys the device currently has.

Since: 2.24

cdk_device_get_axes ()

CdkAxisFlags
cdk_device_get_axes (CdkDevice *device);

Returns the axes currently available on the device.

Since: 3.22

cdk_device_warp ()

void
cdk_device_warp (CdkDevice *device,
                 CdkScreen *screen,
                 gint x,
                 gint y);

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

Since: 3.0

cdk_device_get_seat ()

CdkSeat *
cdk_device_get_seat (CdkDevice *device);

Returns the CdkSeat the device belongs to.

Since: 3.20

cdk_device_grab ()

CdkGrabStatus
cdk_device_grab (CdkDevice *device,
                 CdkWindow *window,
                 CdkGrabOwnership grab_ownership,
                 gboolean owner_events,
                 CdkEventMask event_mask,
                 CdkCursor *cursor,
                 guint32 time_);

Grabs the device so that all events coming from this device are passed to this application until the device is ungrabbed with cdk_device_ungrab(), 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 CTK+ 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 owner_events 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 CdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

Since: 3.0

cdk_device_ungrab ()

void
cdk_device_ungrab (CdkDevice *device,
                   guint32 time_);

Release any grab on device .

Since: 3.0

cdk_device_get_state ()

void
cdk_device_get_state (CdkDevice *device,
                      CdkWindow *window,
                      gdouble *axes,
                      CdkModifierType *mask);

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

[skip]

cdk_device_get_position ()

void
cdk_device_get_position (CdkDevice *device,
                         CdkScreen **screen,
                         gint *x,
                         gint *y);

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 CDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see cdk_device_grab().

Since: 3.0

cdk_device_get_position_double ()

void
cdk_device_get_position_double (CdkDevice *device,
                                CdkScreen **screen,
                                gdouble *x,
                                gdouble *y);

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 CDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them. See cdk_device_grab().

Since: 3.10

cdk_device_get_window_at_position ()

CdkWindow *
cdk_device_get_window_at_position (CdkDevice *device,
                                   gint *win_x,
                                   gint *win_y);

Obtains the window underneath device , returning the location of the device in win_x and win_y . Returns NULL if the window tree under device is not known to CDK (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 CDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see cdk_device_grab().

Since: 3.0

cdk_device_get_window_at_position_double ()

CdkWindow *
cdk_device_get_window_at_position_double
                               (CdkDevice *device,
                                gdouble *win_x,
                                gdouble *win_y);

Obtains the window underneath device , returning the location of the device in win_x and win_y in double precision. Returns NULL if the window tree under device is not known to CDK (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 CDK_DEVICE_TYPE_SLAVE, unless there is an ongoing grab on them, see cdk_device_grab().

Since: 3.0

cdk_device_get_history ()

gboolean
cdk_device_get_history (CdkDevice *device,
                        CdkWindow *window,
                        guint32 start,
                        guint32 stop,
                        CdkTimeCoord ***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 cdk_window_set_event_compression() to get more motion events delivered directly, independent of the windowing system.

[skip]

cdk_device_free_history ()

void
cdk_device_free_history (CdkTimeCoord **events,
                         gint n_events);

Frees an array of CdkTimeCoord that was returned by cdk_device_get_history().

[skip]

cdk_device_get_axis ()

gboolean
cdk_device_get_axis (CdkDevice *device,
                     gdouble *axes,
                     CdkAxisUse 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]

cdk_device_list_axes ()

GList *
cdk_device_list_axes (CdkDevice *device);

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

Since: 3.0

cdk_device_get_axis_value ()

gboolean
cdk_device_get_axis_value (CdkDevice *device,
                           gdouble *axes,
                           CdkAtom 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 cdk_device_list_axes()

[skip]

Since: 3.0

cdk_device_get_last_event_window ()

CdkWindow *
cdk_device_get_last_event_window (CdkDevice *device);

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, NULL may be returned even if the pointer is physically over one of this application's windows.

Since: 3.12

cdk_device_tool_get_serial ()

guint64
cdk_device_tool_get_serial (CdkDeviceTool *tool);

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

Since: 3.22

cdk_device_tool_get_tool_type ()

CdkDeviceToolType
cdk_device_tool_get_tool_type (CdkDeviceTool *tool);

Gets the CdkDeviceToolType of the tool.

Since: 3.22

CdkDevice

typedef struct _CdkDevice CdkDevice;

enum CdkInputSource

An enumeration describing the type of an input device in general terms.

enum CdkInputMode

An enumeration that describes the mode of an input device.

enum CdkAxisUse

An enumeration describing the way in which a device axis (valuator) maps onto the predefined valuator types that CTK+ understands.

Note that the X and Y axes are not really needed; pointer devices report their location via the x/y members of events regardless. Whether X and Y are present as axes depends on the CDK backend.

enum CdkAxisFlags

Flags describing the current capabilities of a device/tool.

Since: 3.22

enum CdkDeviceToolType

Indicates the specific type of tool being used being a tablet. Such as an airbrush, pencil, etc.

Since: 3.22

enum CdkDeviceType

Indicates the device type. See above for more information about the meaning of these device types.

enum CdkGrabOwnership

Defines how device grabs interact with other devices.

struct CdkTimeCoord

struct CdkTimeCoord {
  guint32 time;
  gdouble axes[CDK_MAX_TIMECOORD_AXES];
};

A CdkTimeCoord stores a single event in a motion history.

The “associated-device” property

  “associated-device”        CdkDevice *

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

Owner: CdkDevice

Flags: Read

Since: 3.0

The “axes” property

  “axes”                     CdkAxisFlags

The axes currently available for this device.

Owner: CdkDevice

Flags: Read

Since: 3.22

The “device-manager” property

  “device-manager”           CdkDeviceManager *

The CdkDeviceManager the CdkDevice pertains to.

Owner: CdkDevice

Flags: Read / Write / Construct Only

Since: 3.0

The “display” property

  “display”                  CdkDisplay *

The CdkDisplay the CdkDevice pertains to.

Owner: CdkDevice

Flags: Read / Write / Construct Only

Since: 3.0

The “has-cursor” property

  “has-cursor”               gboolean

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

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: FALSE

Since: 3.0

The “input-mode” property

  “input-mode”               CdkInputMode

Input mode for the device.

Owner: CdkDevice

Flags: Read / Write

Default value: CDK_MODE_DISABLED

The “input-source” property

  “input-source”             CdkInputSource

Source type for the device.

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: CDK_SOURCE_MOUSE

Since: 3.0

The “n-axes” property

  “n-axes”                   guint

Number of axes in the device.

Owner: CdkDevice

Flags: Read

Default value: 0

Since: 3.0

The “name” property

  “name”                     char *

The device name.

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.0

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: CdkDevice

Flags: Read / Write / Construct Only

Default value: 0

Since: 3.20

The “product-id” property

  “product-id”               char *

Product ID of this device, see cdk_device_get_product_id().

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.16

The “seat” property

  “seat”                     CdkSeat *

CdkSeat of this device.

Owner: CdkDevice

Flags: Read / Write

Since: 3.20

The “tool” property

  “tool”                     CdkDeviceTool *

The tool that is currently used with this device.

Owner: CdkDevice

Flags: Read

The “type” property

  “type”                     CdkDeviceType

Device role in the device manager.

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: CDK_DEVICE_TYPE_MASTER

Since: 3.0

The “vendor-id” property

  “vendor-id”                char *

Vendor ID of this device, see cdk_device_get_vendor_id().

Owner: CdkDevice

Flags: Read / Write / Construct Only

Default value: NULL

Since: 3.16

The “changed” signal

void
user_function (CdkDevice *device,
               gpointer   user_data)

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

Flags: Run Last

The “tool-changed” signal

void
user_function (CdkDevice     *device,
               CdkDeviceTool *tool,
               gpointer       user_data)

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

Flags: Run Last

Since: 3.22