Next: , Previous: Threads, Up: Top

25 Input Devices

Functions for handling extended input devices

25.1 Overview

In addition to the normal keyboard and mouse input devices, GTK+ also contains support for extended input devices. In particular, this support is targeted at graphics tablets. Graphics tablets typically return sub-pixel positioning information and possibly information about the pressure and tilt of the stylus. Under X, the support for extended devices is done through the XInput extension.

Because handling extended input devices may involve considerable overhead, they need to be turned on for each <gdk-window> individually using gdk-input-set-extension-events. (Or, more typically, for GtkWidgets, using gtk-widget-set-extension-events). As an additional complication, depending on the support from the windowing system, its possible that a normal mouse cursor will not be displayed for a particular extension device. If an application does not want to deal with displaying a cursor itself, it can ask only to get extension events from devices that will display a cursor, by passing the ‘GDK_EXTENSION_EVENTS_CURSOR’ value to gdk-input-set-extension-events. Otherwise, the application must retrieve the device information using gdk-devices-list, check the field, and, if it is ‘#f’, draw a cursor itself when it receives motion events.

Each pointing device is assigned a unique integer ID; events from a particular device can be identified by the field in the event structure. The events generated by pointer devices have also been extended to contain , and fields which contain the extended information reported as additional valuators from the device. The field is a a double value ranging from 0.0 to 1.0, while the tilt fields are double values ranging from -1.0 to 1.0. (With -1.0 representing the maximum tilt to the left or up, and 1.0 representing the maximum tilt to the right or down.)

One additional field in each event is the field, which contains an enumeration value describing the type of device; this currently can be one of ‘GDK_SOURCE_MOUSE’, ‘GDK_SOURCE_PEN’, ‘GDK_SOURCE_ERASER’, or ‘GDK_SOURCE_CURSOR’. This field is present to allow simple applications to (for instance) delete when they detect eraser devices without having to keep track of complicated per-device settings.

Various aspects of each device may be configured. The easiest way of creating a GUI to allow the user to configure such a device is to use the <gtk-input-dialog> widget in GTK+. However, even when using this widget, application writers will need to directly query and set the configuration parameters in order to save the state between invocations of the application. The configuration of devices is queried using gdk-devices-list. Each device must be activated using gdk-device-set-mode, which also controls whether the device's range is mapped to the entire screen or to a single window. The mapping of the valuators of the device onto the predefined valuator types is set using gdk-device-set-axis-use. And the source type for each device can be set with gdk-device-set-source.

Devices may also have associated keys or macro buttons. Such keys can be globally set to map into normal X keyboard events. The mapping is set using gdk-device-set-key.

The interfaces in this section will most likely be considerably modified in the future to accomodate devices that may have different sets of additional valuators than the pressure and .

25.2 Usage

— Class: <gdk-device>

Derives from <gobject>.

This class defines no direct slots.

— Function: gdk-devices-list ⇒  (ret glist-of)

Returns the list of available input devices for the default display. The list is statically allocated and should not be freed.

a list of <gdk-device>
— Function: gdk-device-set-source (self <gdk-device>) (source <gdk-input-source>)
— Method: set-source

Sets the source type for an input device.

a <gdk-device>.
the source type.
— Function: gdk-device-set-mode (self <gdk-device>) (mode <gdk-input-mode>) ⇒  (ret bool)
— Method: set-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.

a <gdk-device>.
the input mode.
#t’ if the mode was successfully changed.
— Function: gdk-device-set-key (self <gdk-device>) (index_ unsigned-int) (keyval unsigned-int) (modifiers <gdk-modifier-type>)
— Method: set-key

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

a <gdk-device>.
the index of the macro button to set.
the keyval to generate.
the modifiers to set.
— Function: gdk-device-set-axis-use (self <gdk-device>) (index_ unsigned-int) (use <gdk-axis-use>)
— Method: set-axis-use

Specifies how an axis of a device is used.

a <gdk-device>.
the index of the axis.
specifies how the axis is used.
— Function: gdk-device-get-core-pointer ⇒  (ret <gdk-device>)

Returns the core pointer device for the default display.

the core pointer device; this is owned by the display and should not be freed.
— Function: gdk-device-get-axis (self <gdk-device>) (use <gdk-axis-use>) ⇒  (ret bool) (axes double) (value double)
— Method: get-axis

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

a <gdk-device>
pointer to an array of axes
the use to look for
location to store the found value.
#t’ if the given axis use was found, otherwise ‘#f
— Function: gdk-input-set-extension-events (window <gdk-window>) (mask int) (mode <gdk-extension-mode>)

Turns extension events on or off for a particular window, and specifies the event mask for extension events.

a <gdk-window>.
the event mask
the type of extension events that are desired.