XChangeKeyboardControl(3X) XChangeKeyboardControl(3X)NAME XChangeKeyboardControl, XGetKeyboardControl, XAutoRepeatOn, XAutoRepeatOff, XBell, XQueryKeymap - manipulate keyboard settings and the XKeyboardControl structure SYNOPSIS XChangeKeyboardControl(display, value-mask, values) Display *display; unsigned long value-mask; XKeyboardControl *values; XGetKeyboardControl(display, values-return) Display *display; XKeyboardState *values-return; XAutoRepeatOn(display) Display *display; XAutoRepeatOff(display) Display *display; XBell(display, percent) Display *display; int percent; XQueryKeymap(display, keys-return) Display *display; char keys-return[32]; DESCRIPTION The XChangeKeyboardControl function controls the keyboard characteristics defined by the XKeyboardControl structure. The value-mask argument specifies which values are to be changed. The XGetKeyboardControl function returns the current control values for the keyboard to the XKeyboardState structure. The XAutoRepeatOn function turns on keyboard auto-repeat for the keyboard on the specified display console. The XAutoRepeatOff function turns off keyboard auto-repeat for the keyboard on the specified display console. The XBell function rings the keyboard bell on the keyboard on the specified display, if supported. The specified volume is relative to the base volume for the keyboard. If the value for the percent argument is not in the range -100 to 100 inclusive, a BadValue error results. The volume at which the bell rings when the percent argument is nonnegative is: November, 1990 1
XChangeKeyboardControl(3X) XChangeKeyboardControl(3X)base - [(base * percent) / 100] + percent The volume at which the bell rings when the percent argument is negative is: base + [(base * percent) / 100] To change the base volume of the bell, use XChangeKeyboardControl. The XQueryKeymap function returns a bit vector for the logi- cal state of the keyboard, where each 1 bit indicates that the corresponding key is currently pressed down. The vector is represented as 32 bytes. Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least-significant bit in the byte representing key 8N. Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. Arguments These functions accept the following arguments: display Specifies the connection to the X server. keys-return Returns an array of bytes that identifies which keys are pressed down. Each bit represents one key of the keyboard. percent Specifies the base volume for the bell, which can range from -100 to 100 inclusive. value-mask Specifies one value for each 1 bit in the mask (ranging from the least to most significant bit). The values are associated with the set of keys for the previously specified keyboard. values Specifies a pointer to the XKeyboardControl struc- ture. values-return Returns the current keyboard parameter in the speci- fied XKeyboardState structure. Structures The XKeyboardControl structure is defined as follows. /* Mask bits for ChangeKeyboardControl */ #define KBKeyClickPercent(1L<<0) 2 November, 1990
XChangeKeyboardControl(3X) XChangeKeyboardControl(3X)#define KBBellPercent(1L<<1) #define KBBellPitch(1L<<2) #define KBBellDuration(1L<<3) #define KBLed (1L<<4) #define KBLedMode(1L<<5) #define KBKey (1L<<6) #define KBAutoRepeatMode(1L<<7) /* Values */ typedef struct { int key_click_percent; int bell_percent; int bell_pitch; int bell_duration; int led; int led_mode; /* LedModeOn, LedModeOff */ int key; int auto_repeat_mode;/* AutoRepeatModeOff, */ /* AutoRepeatModeOn, */ /* AutoRepeatModeDefault */ } XKeyboardControl; 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 member 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 Bad- Value error. The bell_duration member sets the duration of the bell specified in milliseconds, 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 led is specified without led_mode, a BadMatch error results. 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 AutoRepeatModeDe- fault), if possible. If only auto_repeat_mode is specified, the global auto_repeat_mode for the entire keyboard is changed, if possible, and does not affect the per key set- November, 1990 3
XChangeKeyboardControl(3X) XChangeKeyboardControl(3X)tings. If key is specified without specifying auto_repeat_mode, a BadMatch error results. Each key has an individual mode of whether or not it should auto-repeat and a default setting for the mode. In addition, there is a global mode of whether auto-repeat should be enabled or not and a default setting for that mode. When global mode is AutoRepeatModeOn, keys should obey their individual auto- repeat modes. When global mode is AutoRepeatModeOff, no keys should auto-repeat. An auto-repeating key generates alternating KeyPress and KeyRelease events. When a key is used as a modifier, it is desirable for the key not to auto-repeat, regardless of its auto-repeat setting. The XKeyboardState structure is defined as follows. typedef struct { int key_click_percent; int bell_percent; unsigned int bell_pitch, bell_duration; unsigned long led_mask; int global_auto_repeat; char auto_repeats[32]; } XKeyboardState; For the LEDs, the least-significant bit of led_mask corresponds to LED one, and each bit set to 1 in led_mask indicates an LED that is lit. The global_auto_repeat member can be set to AutoRepeatModeOn or AutoRepeatModeOff. The auto_repeats member is a bit vector. Each bit set to 1 in- dicates that auto-repeat is enabled for the corresponding key. The vector is represented as 32 bytes. Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least- significant bit in the byte representing key 8N. ERRORS BadMatch An argument or pair of arguments has the correct type and range but fails to match in some other re- quired way. BadValue A numeric value falls outside the range of values accepted by the request. Unless a range is speci- fied for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. XChangeKeyboardControl can generate BadMatch and BadValue errors. The XBell function can generate a BadValue error. 4 November, 1990
XChangeKeyboardControl(3X) XChangeKeyboardControl(3X)Setting negative values other than -1 in the key_click_percent, bell_percent, bell_pitch, and bell_duration members of the XKeyboardControl structure gen- erates a BadValue error. Setting led without setting led_mode generates a BadMatch error. Setting key without setting auto_repeat_mode, generates a BadMatch error. SEE ALSO XChangeKeyboardMapping(3X), XSetPointerMapping(3X)Xlib - C Language InterfaceNovember, 1990 5