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 XkbGetNamedDeviceIndicator (Display *dpy, unsigned  int  dev_spec,
11              unsigned  int  led_class,  unsigned  int  led_id, Atom name, int
12              *ndx_rtrn, Bool *state_rtrn, XkbIndicatorMapPtr  map_rtrn,  Bool
13              *real_rtrn);
14
15       Bool XkbGetNamedIndicator (Display *dpy, Atom name, int *ndx_rtrn, Bool
16              *state_rtrn, XkbIndicatorMapPtr map_rtrn, Bool *real_rtrn);
17

ARGUMENTS

19       - dpy  connection to the X server
20
21       - dev_spec
22              keyboard device ID, or XkbUseCoreKbd
23
24       - led_class
25              feedback class, or XkbDfltXIClass
26
27       - led_id
28              feedback ID, or XkbDfltXIId
29
30       - name name of the indicator to be retrieved
31
32       - ndx_rtrn
33              backfilled with the index of the retrieved indicator
34
35       - state_rtrn
36              backfilled with the current state of the retrieved indicator
37
38       - map_rtrn
39               backfilled with the mapping for the retrieved indicator
40
41       - real_rtrn
42              backfilled with True if the named indicator is real (physical)
43

DESCRIPTION

45       Xkb also allows applications to refer to indicators by  name.  Use  Xk‐
46       bGetNames  to  get the indicator names. Using names eliminates the need
47       for hard-coding bitmask values for particular keyboards.  For  example,
48       instead  of  using vendor-specific constants such as WSKBLed_ScrollLock
49       mask on Digital workstations or XLED_SCROLL_LOCK on  Sun  workstations,
50       you  can  instead use XkbGetNamedDeviceIndicator to look up information
51       on the indicator named "Scroll Lock."
52
53       If the device specified by device_spec has an indicator named name, Xk‐
54       bGetNamedDeviceIndicator returns True and populates the rest of the pa‐
55       rameters with information about the indicator. Otherwise,  XkbGetNamed‐
56       DeviceIndicator returns False.
57
58       The ndx_rtrn field returns the zero-based index of the named indicator.
59       This index is the bit position to use in any  function  call  that  re‐
60       quires  a mask of indicator bits, as well as the indicator's index into
61       the XkbIndicatorRec array of indicator maps.   state_rtrn  returns  the
62       current  state  of  the  named  indicator  (True  =  on,  False = off).
63       map_rtrn returns the indicator map for the named  indicator.  In  addi‐
64       tion,  if  the indicator is mapped to a physical LED, the real_rtrn pa‐
65       rameter is set to True.
66
67       Each of the " _rtrn " arguments is optional; you can pass NULL for  any
68       unneeded " _rtrn " arguments.
69
70
71       XkbGetNamedIndicator  is a convenience function that calls XkbGetNamed‐
72       DeviceIndicator with a device_spec of  XkbUseCoreKbd,  a  led_class  of
73       XkbDfltXIClass,  and  a  led_id  of XkbDfltXIId.  It returns the return
74       value from XkbGetNamedDeviceIndicator.
75
76

RETURN VALUES

78       True           The XkbGetNamedIndicator and  XkbGetNamedDeviceIndicator
79                      functions  return  True  if  the device specified by de‐
80                      vice_spec has an indicator named name.
81
82       False          The XkbGetNamedIndicator and  XkbGetNamedDeviceIndicator
83                      functions  return  False  if the device specified by de‐
84                      vice_spec does not have an indicator named name.
85

SEE ALSO

87       XkbGetNames(3)
88
89
90
91X Version 11                    libX11 1.7.3.1         XkbGetNamedIndicator(3)
Impressum