Device

Description 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 GdkWindow 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 has_cursor field, and, if it is FALSE, 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 deviceid field in the event structure. The events generated by pointer devices have also been extended to contain pressure, xtilt and ytilt fields which contain the extended information reported as additional valuators from the device. The pressure 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 source 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 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 xtilt and ytilt.

Constructors

this
this(GdkDevice* gdkDevice)

Sets our main struct and passes it to the parent class

Members

Functions

getAxis
int getAxis(double[] axes, GdkAxisUse use, double 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.

getAxisUse
GdkAxisUse getAxisUse(uint index)

Returns the axis use for index. Since 2.22

getDeviceStruct
GdkDevice* getDeviceStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getHistory
int getHistory(Window window, uint start, uint stop, GdkTimeCoord*[] events)

Obtains the motion history for a 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.)

getKey
void getKey(uint index, uint keyval, GdkModifierType modifiers)

If index has a valid keyval, this function will fill in keyval and modifiers with the keyval settings. Since 2.22

getMode
GdkInputMode getMode()

Determines the mode of the device. Since 2.22

getNAxes
int getNAxes()

Gets the number of axes of a device. Since 2.22

getName
string getName()

Determines the name of the device. Since 2.22

getSource
GdkInputSource getSource()

Determines the type of the device. Since 2.22

getState
void getState(Window window, double[] axes, GdkModifierType mask)

Gets the current state of a device.

getStruct
void* getStruct()

the main Gtk struct as a void*

setAxisUse
void setAxisUse(uint index, GdkAxisUse use)

Specifies how an axis of a device is used.

setKey
void setKey(uint index, uint keyval, GdkModifierType modifiers)

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

setMode
int setMode(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 window.

setSource
void setSource(GdkInputSource source)

Sets the source type for an input device.

Static functions

freeHistory
void freeHistory(GdkTimeCoord[] events)

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

gdkDevicesList
ListG gdkDevicesList()

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

gdkInputSetExtensionEvents
void gdkInputSetExtensionEvents(Window window, int mask, GdkExtensionMode mode)

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

getCorePointer
Device getCorePointer()

Returns the core pointer device for the default display.

Variables

gdkDevice
GdkDevice* gdkDevice;

the main Gtk struct

Meta