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

NAME

6       XkbGetNamedIndicator  - Look up the indicator map and other information
7       for an indicator by name
8

SYNOPSIS

10       Bool XkbGetNamedIndicator (Display *dpy, unsigned  int  dev_spec,  Atom
11              name,   int   *ndx_rtrn,  Bool  *state_rtrn,  XkbIndicatorMapPtr
12              map_rtrn, Bool *real_rtrn);
13

ARGUMENTS

15       - dpy  connection to the X server
16
17       - dev_spec
18              keyboard device ID, or XkbUseCoreKbd
19
20       - name name of the indicator to be retrieved
21
22       - ndx_rtrn
23              backfilled with the index of the retrieved indicator
24
25       - state_rtrn
26              backfilled with the current state of the retrieved indicator
27
28       - map_rtrn
29               backfilled with the mapping for the retrieved indicator
30
31       - real_rtrn
32              backfilled with True if the named indicator is real (physical)
33

DESCRIPTION

35       Xkb also allows applications  to  refer  to  indicators  by  name.  Use
36       XkbGetNames to get the indicator names. Using names eliminates the need
37       for hard-coding bitmask values for particular keyboards.  For  example,
38       instead  of  using vendor-specific constants such as WSKBLed_ScrollLock
39       mask on Digital workstations or XLED_SCROLL_LOCK on  Sun  workstations,
40       you  can instead use XkbGetNamedIndicator to look up information on the
41       indicator named "Scroll Lock."
42
43       If the device specified by device_spec has  an  indicator  named  name,
44       XkbGetNamedIndicator returns True and populates the rest of the parame‐
45       ters with information about the indicator. Otherwise,  XkbGetNamedIndi‐
46       cator returns False.
47
48       The ndx_rtrn field returns the zero-based index of the named indicator.
49       This index is the bit  position  to  use  in  any  function  call  that
50       requires  a  mask  of  indicator bits, as well as the indicator's index
51       into the XkbIndicatorRec array of indicator maps.   state_rtrn  returns
52       the  current  state  of  the  named indicator (True = on, False = off).
53       map_rtrn returns the indicator map for the named  indicator.  In  addi‐
54       tion,  if  the  indicator  is  mapped  to a physical LED, the real_rtrn
55       parameter is set to True.
56
57       Each of the " _rtrn " arguments is optional; you can pass NULL for  any
58       unneeded " _rtrn " arguments.
59

RETURN VALUES

61       True           The  XkbGetNamedIndicator  function  returns True if the
62                      device specified by device_spec has an  indicator  named
63                      name.
64
65       False          The  XkbGetNamedIndicator  function returns False if the
66                      device specified by device_spec does not have an indica‐
67                      tor named name.
68

SEE ALSO

70       XkbGetNames(3)
71
72
73
74X Version 11                     libX11 1.3.4          XkbGetNamedIndicator(3)
Impressum