NAME

XChangeKeyboardControl, XGetKeyboardControl, XAutoRepeatOn, XAutoRepeatOff, XBell, XQueryKeymap, XKeyboardControl - manipulate keyboard settings and keyboard control structure

SYNTAX

int XChangeKeyboardControl(Display *_d_i_s_p_l_a_y, unsigned long _v_a_l_u_e___m_a_s_k, XKeyBoardControl *_v_a_l_u_e_s); int XGetKeyboardControl(Display *_d_i_s_p_l_a_y, XKeyBoardState *_v_a_l_u_e_s___r_e_t_u_r_n); int XAutoRepeatOn(Display *_d_i_s_p_l_a_y); int XAutoRepeatOff(Display *_d_i_s_p_l_a_y); int XBell(Display *_d_i_s_p_l_a_y, int _p_e_r_c_e_n_t); int XQueryKeymap(Display *_d_i_s_p_l_a_y, char _k_e_y_s___r_e_t_u_r_n[32]);

ARGUMENTS

_d_i_s_p_l_a_y Specifies the connection to the X server.
_k_e_y_s___r_e_t_u_r_n Returns an array of bytes that identifies which keys are pressed down.
Each bit represents one key of the keyboard.
_p_e_r_c_e_n_t Specifies the volume for the bell,
which can range from -100 to 100 inclusive.
_v_a_l_u_e___m_a_s_k Specifies which controls to change.
This mask is the bitwise inclusive OR of the valid control mask bits.
_v_a_l_u_e_s Specifies one value for each bit set to 1 in the mask.
_v_a_l_u_e_s___r_e_t_u_r_n Returns the current keyboard controls in the specified
_X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.

DESCRIPTION

The _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function controls the keyboard characteristics defined by the _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure. The value_mask argument specifies which values are to be changed.

_X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l can generate _B_a_d_M_a_t_c_h and _B_a_d_V_a_l_u_e errors.

The _X_G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function returns the current control values for the keyboard to the _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.

The _X_A_u_t_o_R_e_p_e_a_t_O_n function turns on auto-repeat for the keyboard on the specified display.

The _X_A_u_t_o_R_e_p_e_a_t_O_f_f function turns off auto-repeat for the keyboard on the specified display.

The _X_B_e_l_l function rings the bell on the keyboard on the specified display, if possible. 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 _B_a_d_V_a_l_u_e error results. The volume at which the bell rings when the percent argument is nonnegative is:

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 _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l.

_X_B_e_l_l can generate a _B_a_d_V_a_l_u_e error.

The _X_Q_u_e_r_y_K_e_y_m_a_p function returns a bit vector for the logical state of the keyboard, where each bit set to 1 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.

STRUCTURES

The _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure contains:

/* Mask bits for ChangeKeyboardControl */

lw(.5i) lw(2.5i) lw(.8i).
T{
#define
T}      T{
_K_B_K_e_y_C_l_i_c_k_P_e_r_c_e_n_t
T}      T{
(1L<<0)
T}
T{
#define
T}      T{
_K_B_B_e_l_l_P_e_r_c_e_n_t
T}      T{
(1L<<1)
T}
T{
#define
T}      T{
_K_B_B_e_l_l_P_i_t_c_h
T}      T{
(1L<<2)
T}
T{
#define
T}      T{
_K_B_B_e_l_l_D_u_r_a_t_i_o_n
T}      T{
(1L<<3)
T}
T{
#define
T}      T{
_K_B_L_e_d
T}      T{
(1L<<4)
T}
T{
#define
T}      T{
_K_B_L_e_d_M_o_d_e
T}      T{
(1L<<5)
T}
T{
#define
T}      T{
_K_B_K_e_y
T}      T{
(1L<<6)
T}
T{
#define
T}      T{
_K_B_A_u_t_o_R_e_p_e_a_t_M_o_d_e
T}      T{
(1L<<7)
T}

/* 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 _B_a_d_V_a_l_u_e 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 _B_a_d_V_a_l_u_e 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 _B_a_d_V_a_l_u_e 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 _B_a_d_V_a_l_u_e 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 _L_e_d_M_o_d_e_O_n or _L_e_d_M_o_d_e_O_f_f. 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 _B_a_d_M_a_t_c_h error results.

If both the auto_repeat_mode and key members are specified, the auto_repeat_mode of that key is changed (according to _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n, _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, or _A_u_t_o_R_e_p_e_a_t_M_o_d_e_D_e_f_a_u_l_t), 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 settings. If a key is specified without an auto_repeat_mode, a _B_a_d_M_a_t_c_h 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 _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n, keys should obey their individual auto-repeat modes. When global mode is _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, no keys should auto-repeat. An auto-repeating key generates alternating _K_e_y_P_r_e_s_s and _K_e_y_R_e_l_e_a_s_e 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 _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure contains:


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 _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n or _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f. The auto_repeats member is a bit vector. Each bit set to 1 indicates 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.

DIAGNOSTICS

_B_a_d_M_a_t_c_h
Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
_B_a_d_V_a_l_u_e
Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified 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.

SEE ALSO

XChangeKeyboardMapping(3X11), XSetPointerMapping(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e