1XkbGetAccessXTimeout(3)          XKB FUNCTIONS         XkbGetAccessXTimeout(3)
2
3
4

NAME

6       XkbGetAccessXTimeout - Queries the current AccessXTimeout options for a
7       keyboard device
8

SYNOPSIS

10       Bool XkbGetAccessXTimeout (Display *display, unsigned int  device_spec,
11              unsigned short *timeout_rtrn, unsigned int *ctrls_mask_rtrn, un‐
12              signed   int    *ctrls_values_rtrn,    unsigned    short    *op‐
13              tions_mask_rtrn, unsigned short *options_values_rtrn);
14

ARGUMENTS

16       - display
17              unsigned short
18
19       - device_spec
20              device to query, or XkbUseCoreKbd
21
22       - timeout_rtrn
23              delay until AccessXTimeout, seconds
24
25       - ctrls_mask_rtrn
26              backfilled with controls to modify
27
28       - ctrls_values_rtrn
29              backfilled with on/off status for controls
30
31       - options_mask_rtrn
32              backfilled with ax_options to modify
33
34       - options_values_rtrn
35              backfilled with values for ax_options
36

DESCRIPTION

38       In  environments  where computers are shared, features such as SlowKeys
39       present a problem: if SlowKeys is on, the keyboard can appear to be un‐
40       responsive because keys are not accepted until they are held for a cer‐
41       tain period of time. To help solve this problem, Xkb  provides  an  Ac‐
42       cessXTimeout control to automatically change the enabled/disabled state
43       of any boolean controls and to change the value of the AccessXKeys  and
44       AccessXFeedback control attributes if the keyboard is idle for a speci‐
45       fied period of time.
46
47       When a timeout as specified by AccessXTimeout occurs and a  control  is
48       consequently modified, Xkb generates an XkbControlsNotify event.
49
50       XkbGetAccessXTimeout sends a request to the X server to obtain the cur‐
51       rent values for the AccessXTimeout attributes, waits for a  reply,  and
52       backfills the values into the appropriate arguments. The parameters op‐
53       tions_mask_rtrn and options_values_rtrn are backfilled with the options
54       to  modify  and the values for ax_options, which is a field in the Xkb‐
55       ControlsRec structure.  XkbGetAccessXTimeout returns True  if  success‐
56       ful;  if  a compatible version of the Xkb extension is not available in
57       the server, XkbGetAccessXTimeout returns False.
58

RETURN VALUES

60       True           The XkbGetAccessXTimeout returns True when  it  success‐
61                      fully sends a request to the X server to obtain the cur‐
62                      rent values for the AccessXTimeout attributes, waits for
63                      a  reply,  and backfills the values into the appropriate
64                      arguments.
65
66       False          The XkbGetAccessXTimeout function  returns  False  if  a
67                      compatible version of the Xkb extension is not available
68                      in the server.
69

STRUCTURES

71       The XkbControlsRec structure is defined as follows:
72
73       #define XkbMaxLegalKeyCode     255
74       #define XkbPerKeyBitArraySize  ((XkbMaxLegalKeyCode+1)/8)
75
76       typedef struct {
77           unsigned char   mk_dflt_btn;      /* default button for keyboard driven mouse */
78           unsigned char   num_groups;       /* number of keyboard groups */
79           unsigned char   groups_wrap;      /* how to wrap out-of-bounds groups */
80           XkbModsRec      internal;         /* defines server internal modifiers */
81           XkbModsRec      ignore_lock;      /* modifiers to ignore when checking for grab */
82           unsigned int    enabled_ctrls;    /* 1 bit => corresponding boolean control enabled */
83           unsigned short  repeat_delay;     /* ms delay until first repeat */
84           unsigned short  repeat_interval;  /* ms delay between repeats */
85           unsigned short  slow_keys_delay;  /* ms minimum time key must be down to be ok */
86           unsigned short  debounce_delay;   /* ms delay before key reactivated */
87           unsigned short  mk_delay;         /* ms delay to second mouse motion event */
88           unsigned short  mk_interval;      /* ms delay between repeat mouse events */
89           unsigned short  mk_time_to_max;   /* # intervals until constant mouse move */
90           unsigned short  mk_max_speed;     /* multiplier for maximum mouse speed */
91           short           mk_curve;         /* determines mouse move curve type */
92           unsigned short  ax_options;       /* 1 bit => Access X option enabled */
93           unsigned short  ax_timeout;       /* seconds until Access X disabled */
94           unsigned short  axt_opts_mask;    /* 1 bit => options to reset on Access X timeout */
95           unsigned short  axt_opts_values;  /* 1 bit => turn option on, 0=> off */
96           unsigned int    axt_ctrls_mask;   /* which bits in enabled_ctrls to modify */
97           unsigned int    axt_ctrls_values; /* values for new bits in enabled_ctrls */
98           unsigned char   per_key_repeat[XkbPerKeyBitArraySize];  /* per key auto repeat */
99       } XkbControlsRec, *XkbControlsPtr;
100
101
102
103X Version 11                    libX11 1.7.3.1         XkbGetAccessXTimeout(3)
Impressum