XHPListInputDevices(3X)XHPListInputDevices(3X)NAMEXHPListInputDevices - List all available X input devices.
SYNOPSIS
#include <X11/XHPlib.h>
typedef struct
{
unsigned int resolution; /* resolution in counts/ meter*/
unsigned short min_val; /* min value this axis returns*/
unsigned short max_val; /* max value this axis returns*/
} XHPaxis_info;
typedef struct
{
XID x_id; /* device X identifier */
char *name; /* device name */
XHPaxis_info *axes; /* pointer to axes array */
unsigned short type; /* device type */
unsigned short min_keycode; /* min X keycode from this dev*/
unsigned short max_keycode; /* max X keycode from this dev*/
unsigned char hil_id; /* device HIL identifier */
unsigned char mode; /* ABSOLUTE or RELATIVE */
unsigned char num_axes; /* # axes this device has */
unsigned char num_buttons; /* # buttons on this device */
unsigned char num_keys; /* # keys on this device */
unsigned char io_byte; /* device i/o descriptor byte */
unsigned short detailed_id /* device id detail */
unsigned char pad[6]; /* reserved for future use */
} XHPDeviceList;
XHPDeviceList *XHPListInputDevices (display, ndevices)
Display *display;
int *ndevices; /* RETURN */
ARGUMENTS
display Specifies the connection to the X server.
ndevices Specifies the address of a variable into which the server
can return the number of input devices available to the X
server.
DESCRIPTION
This request is part of an HP-proprietary extension to X. Its
functionality has been superseded by the standard X input device
extension XListInputDevices request. You should use XListInputDevices
instead of XHPListInputDevices if possible.
This request allows a client to determine which devices are available
for X input and obtain information about those devices. The X pointer
device and X keyboard are listed as well as any extension input devices
available to the X server.
The X pointer device is listed first. The x_id field in the
XHPDeviceList structure corresponding to the X pointer device contains
the value XPOINTER. The X keyboard device is listed second. The x_id
field in the XHPDeviceList structure corresponding to the X keyboard
device contains the value XKEYBOARD.
XHPListInputDevices returns an array of XHPDeviceList structures, one
for each device available to the X server. The number of entries in
the list is returned in the ndevices parameter.
The device name is a null-terminated string consisting of an ordinal
number describing the position of the device, an underscore, and the
type of the device. The device position is determined by following the
HIL cable from the computer to the device and counting how many devices
of that same type there are. The device type is described below. As
an example, if a computer was configured with a keyboard and two
graphics tablets connected in that order, the device names would be as
follows:
FIRST_KEYBOARD
FIRST_TABLET
SECOND_TABLET
Client programs may use this name to search for a particular instance
of a particular device.
The following device types are defined in the file <X11/XHPproto.h>.
This file is automatically included when you include <X11/XHPlib.h>.
MOUSE
TABLET
KEYBOARD
TOUCHSCREEN
TOUCHPAD
BUTTONBOX
BARCODE
ONE_KNOB
NINE_KNOB
TRACKBALL
QUADRATURE
ID_MODULE
These constants may be compared with the type field of the
XHPDeviceList structure to locate a particular type of device.
The min_keycode, max_keycode, and num_keys fields are valid only for
devices that have keys. They will otherwise be zero.
The max_val field of the XHPAxis_info structure contains a value that
may be used to scale the input of an absolute pointing device such as a
touchscreen or graphics tablet. For each axis of absolute pointing
devices, the minimum and maximum values it can generate will be
returned.
For relative pointing devices, the min_val and max_val fields will
contain 0.
The io_byte field contains the information from the device I/O
Descriptor byte. The 8 bits are interpreted as follows:
Bit 7 Set if the device implements the general purpose Prompt and
Acknowledge requests.
Bits 6, 5, and 4
Indicates specific Prompt/Acknowledges implemented in the
device. Zeros indicate that none of the specific
Prompt/Acknowledges are implemented. A non-zero value
means that Prompt/Acknowledges 1 through that value
inclusive are implemented in the device.
Bit 3 Set if the device reports Proximity In/Out information.
Bits 2, 1, and 0
Indicates which buttons the device reports. Zeros indicate
that no buttons are reported. A non-zero value means that
buttons 1 through that value are reported by the device.
This request returns NULL if there are no input devices to list.
RETURN VALUEXHPListInputDevices returns an array of XHPDeviceList structures.
XHPListInputDevices returns NULL if no input devices are available to
the X server.
FILES
/usr/include/X11/XHPlib.h
ORIGIN
Hewlett-Packard Company
SEE ALSOXHPFreeDeviceList(3x)X Version 11 Release 5 XHPListInputDevices(3X)
