XHPAcknowledge(3X)XHPAcknowledge(3X)NAME
XHPAcknowledge - Send an Acknowledge to an extended input device.
SYNOPSIS
#include <X11/XHPlib.h>
int XHPAcknowledge (display, deviceid, acknowledge)
Display *display;
XID deviceid;
int acknowledge;
ARGUMENTS
display Specifies the connection to the X server.
deviceid Specifies the ID of the desired device.
acknowledge Specifies the acknowledge to be sent. Valid values are: GENERAL_ACKNOWLEDGE, ACKNOWLEDGE_1, ACKNOWLEDGE_2, ACKNOWLEDGE_3,
ACKNOWLEDGE_4, ACKNOWLEDGE_5, ACKNOWLEDGE_6, ACKNOWLEDGE_7.
DESCRIPTION
This request is part of an HP-proprietary extension to X. Its functionality has been superseded by the standard XChangeFeedbackControl
request. You should use XChangeFeedbackControl instead of XHPAcknowledge if possible.
This request sends an acknowledge to an input device. This allows a previously received prompt to be turned off.
A prompt is an audio or visual indication that the program controlling the input device is ready for input. The LED on an HP46086A
buttonbox is an example of a prompt. A program may indicate its status by turning on a prompt on the appropriate input device.
Not all input devices support prompts and acknowledges. Any device that does support a particular prompt will also support the
corresponding acknowledge.
To determine whether an input device supports a particular prompt and acknowledge, the io_byte field of the XHPDeviceList structure should
be examined. The format of this structure is described in the documentation for the XHPListInputDevices request.
RETURN VALUE
none
DIAGNOSTICS
BadDevice An invalid device ID was specified.
BadValue An invalid acknowledge was specified.
FILES
/usr/include/X11/XHPlib.h
ORIGIN
Hewlett-Packard Company
SEE ALSO XHPListInputDevices(3x)XHPPrompt(3x)X Version 11 Release 5 XHPAcknowledge(3X)
Check Out this Related Man Page
XHPChangeDeviceControl(3X)XHPChangeDeviceControl(3X)NAME
XHPChangeDeviceControl - Change the control attributes of an extension input device.
XHPChangeDeviceKeyMapping - Change the key mapping of an extension input device.
SYNOPSIS
int XHPChangeDeviceControl (display, deviceid, value_mask, values)
Display *display;
XID deviceid;
unsigned long value_mask;
XHPDeviceControl *values;
int XHPChangeDeviceKeyMapping (display, deviceid, first_keycode,
keysyms_per_keycode, keysyms, num_codes)
Display *display;
XID deviceid;
int first_keycode;
int keysyms_per_keycode;
KeySym *keysyms;
int num_codes;
ARGUMENTS
display Specifies the connection to the X server.
deviceid Specifies the ID of the device whose attributes are to be changed.
XHPChangeDeviceControl
value_mask Specifies which attributes are to be changed. Each bit in the mask specifies one attribute of the specified
device.
values Specifies a pointer to the XHPDeviceControl structure containing the values to be changed.
XHPChangeDeviceKeyMapping
first_keycode Specifies the first keycode that is to be changed.
keysyms_per_keycode Specifies the number of keysyms per keycode.
keysyms Specifies a pointer to an array of keysyms that are to be used.
num_codes Specifies the number of keycodes that are to be changed.
DESCRIPTION
These requests are part of an HP-proprietary extension to X. Their functionality has been superseded by standard X input device extension
requests. XHPChangeDeviceControl has been superseded by XChangeFeedbackControl, and XHPChangeDeviceKeyMapping has been superseded by
XChangeDeviceKeyMapping. You should use the standard requests instead of the HP-proprietary requests if possible.
These requests are provided to support the use of input devices other than the X keyboard and X pointer device. They allow the control
attributes and key mapping of those input devices to be changed. The specified device must have previously been opened (turned on) using
the XHPSetInputDevice request.
XHPChangeDeviceControl
The attributes to be changed are specified in the XHPDeviceControl structure. They are not actually changed unless the corresponding bit
is set in the value_mask parameter.
The following masks may be ORed into the value_mask:
#define DVKeyClickPercent (1L<<0)
#define DVBellPercent (1L<<1)
#define DVBellPitch (1L<<2)
#define DVBellDuration (1L<<3)
#define DVLed (1L<<4)
#define DVLedMode (1L<<5)
#define DVKey (1L<<6)
#define DVAutoRepeatMode (1L<<7)
#define DVAccelNum (1L<<8)
#define DVAccelDenom (1L<<9)
#define DVThreshold (1L<<10)
The fields of the XHPDeviceControl structure are defined as follows:
typedef struct {
int key_click_percent;
int bell_percent;
int bell_pitch;
int bell_duration;
int led;
int led_mode;
int key;
int auto_repeat_mode;
int accelNumerator;
int accelDenominator;
int threshold;
} XHPDeviceControl;
The key_click_percent member sets the volume for key clicks between 0 (off) and 100 (loud) inclusive, if possible. A setting of -1
restores the default. Other negative values generate a BadValue error.
The bell_percent sets the base volume for the bell between 0 (off) and 100 (loud) inclusive, if possible. A setting of -1 restores the
default. Other negative values generate a BadValue error.
The bell_pitch member sets the pitch (specified in Hz) of the bell, if possible. A setting of -1 restores the default. Other negative
values generate a BadValue error.
The bell_duration member sets the duration, specified in milliseconds, of the bell, if possible. A setting of -1 restores the default.
Other negative values generate a BadValue error.
If both the led_mode and led members are specified, the state of that LED is changed, if possible. The led_mode member can be set to
LedModeOn or LedModeOff. If only led_mode is specified, the state of all LEDs are changed, if possible. At most 32 LEDs numbered from one
are supported. No standard interpretation of LEDs is defined. If an led is specified without an led_mode, a BadMatch error is generated
If both the auto_repeat_mode and key members are specified, the auto_repeat_mode of that key is changed (according to AutoRepeatModeOn ,
AutoRepeatModeOff , or AutoRepeatModeDefault ), if possible. If only auto_repeat_mode is specified, the global auto_repeat mode for the
entire device is changed, if possible, and does not affect the per_key settings. If a key is specified without an auto_repeat_mode, a
BadMatch error is generated.
XHPChangeDeviceKeyMapping
The XHPChangeDeviceKeyMapping request, starting with first_keycode, defines the symbols for the specified number of KeyCodes. The symbols
for KeyCodes outside this range remained unchanged. The number of elements must be:
num_codes * keysyms_per_keycode
Otherwise, a BadLength error is generated. The specified first_keycode must be greater than or equal to min_keycode as returned by the
XHPListInputDevices request. Otherwise, it generates a BadValue error. In addition, the following expression must be less than or equal
to max_keycode as returned by the XHPListInputDevices request, otherwise a BadValue error is generated.
first_keycode + (num_codes / keysyms_per_keycode) - 1
KeySym number N, counting from zero, for KeyCode K has the following index in keysyms, counting from zero:
(K - first_keycode) * keysyms_per_keycode + N
The specified keysyms_per_keycode can be chosen arbitrarily by the client to be large enough to hold all desired symbols. Use a special
KeySym value of NoSymbol to fill in unused elements for individual KeyCodes. NoSymbol may appear in nontrailing positions of the effective
list for a KeyCode. XHPChangeDeviceKeyMapping generates a DeviceMappingNotify event.
There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients.
DIAGNOSTICS
XHPChangeDeviceControl can generate BadDevice, BadMatch, and BadValue errors.
XHPChangeDeviceKeyMapping can generate BadDevice, BadLength, and BadValue errors.
BadDevice The specified device does not exist, was not previously enabled via XHPSetInputDevice, or is the X system pointer or X system
keyboard.
BadMatch An LED was specified but no valid LED mode, or a key was specified but no valid AutoRepeat mode.
BadValue One of the values specified was beyond the range of valid values.
BadLength The number of elements passed was not equal to keysyms_per_code times num_codes.
RETURN VALUE
none
FILES
none
ORIGIN
Hewlett-Packard Company
SEE ALSO XHPGetDeviceKeyMapping(3x)XGetKeyboardMapping(3x)XChangeKeyboardMapping(3x)XHPGetDeviceControl(3x)XGetKeyboardControl(3x)XChangeKeyboardControl(3x)XGetPointerControl(3x)XChangePointerControl(3x)X Version 11 Release 5 XHPChangeDeviceControl(3X)