Synopsis

class gtk.gdk.Device(gobject.GObject):
    def set_source(source)
    def set_mode(mode)
    def set_key(index, keyval, modifiers)
    def set_axis_use(index, use)
    def get_state(window)
    def get_history(window, start, stop)
    def get_axis(axes, use)

Functions

    def gtk.gdk.devices_list()
    def gtk.gdk.device_get_core_pointer()

Ancestry

+-- gobject.GObject
  +-- gtk.gdk.Device

Attributes

Description

In addition to the normal keyboard and mouse input devices, PyGTK 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 gtk.gdk.Window individually using gtk.gdk.Window.input_set_extension_events(). (Or, more typically, for gtk.Widget objects, using the gtk.Widget.set_extension_events() method). 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 gtk.gdk.EXTENSION_EVENTS_CURSOR value to the gtk.gdk.Window.input_set_extension_events() method. Otherwise, the application must retrieve the device information using the gtk.gdk.devices_list() function, 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 attribute in the event structure. The events generated by pointer devices have also been extended to contain pressure, xtilt and ytilt attributes which contain the extended information reported as additional valuators from the device. The pressure attribute ranges from 0.0 to 1.0, while the tilt attributes range 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 attribute in each event is the source attribute, which contains an enumeration value describing the type of device; this currently can be one of gtk.gdk.SOURCE_MOUSE, gtk.gdk.SOURCE_PEN, gtk.gdk.SOURCE_ERASER, or gtk.gdk.SOURCE_CURSOR. This attribute 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.InputDialog widget in PyGTK. 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 the gtk.gdk.devices_list() function. Each device must be activated using the set_mode() method, 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 the set_axis_use() method. And the source type for each device can be set with the set_source() method.

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 the set_key() method. The interfaces in this section will most likely be considerably modified in the future to accommodate devices that may have different sets of additional valuators than the pressure xtilt and ytilt.

Methods

    def set_source(source)

    def set_mode(mode)

    def set_key(index, keyval, modifiers)

    def set_axis_use(index, use)

    def get_state(window)

    def get_history(window, start, stop)

    def get_axis(axes, use)

Functions

    def gtk.gdk.devices_list()

    def gtk.gdk.device_get_core_pointer()