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

NAME

6       XkbGetIndicatorState  - Obtains the current state of the keyboard indi‐
7       cators
8

SYNOPSIS

10       Status  XkbGetIndicatorState  (Display  *display,  unsigned   int   de‐
11              vice_spec, unsigned int state_return);
12

ARGUMENTS

14       - display
15              connection to the X server
16
17       - device_spec
18              device ID, or XkbUseCoreKbd
19
20       - state_return
21              backfilled with a mask of the indicator state
22

DESCRIPTION

24       Xkb  allows  applications  to obtain information about indicators using
25       two different methods. The first method, which is similar to the core X
26       implementation,  uses  a  mask  to  specify  the indicators. The second
27       method, which is more suitable for applications concerned with interop‐
28       erability, uses indicator names. The correspondence between the indica‐
29       tor name and the bit position in masks is as follows: one of the param‐
30       eters  returned  from XkbGetNamedIndicators is an index that is the bit
31       position to use in any function call that requires a mask of  indicator
32       bits,  as  well as the indicator's index into the XkbIndicatorRec array
33       of indicator maps.
34
35       XkbGetIndicatorState queries the display for the state of  the  indica‐
36       tors  on  the  device specified by the device_spec.  For each indicator
37       that is "turned on" on  the  device,  the  associated  bit  is  set  in
38       state_return.   If  a  compatible  version  of the Xkb extension is not
39       available in the server, XkbGetIndicatorState returns a BadMatch error.
40       Otherwise,  it  sends  the request to the X server, places the state of
41       the indicators into state_return, and returns Success. Thus  the  value
42       reported  by XkbGetIndicatorState is identical to the value reported by
43       the core protocol.
44

DIAGNOSTICS

46       BadMatch       A compatible version of Xkb was  not  available  in  the
47                      server or an argument has correct type and range, but is
48                      otherwise invalid
49

SEE ALSO

51       XkbGetNamedIndicators(3)
52
53
54
55
56X Version 11                    libX11 1.7.3.1         XkbGetIndicatorState(3)
Impressum