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 feedback ID, or XkbDfltXIId
28
29       name   name of the indicator to be retrieved
30
31       ndx_rtrn
32              backfilled with the index of the retrieved indicator
33
34       state_rtrn
35              backfilled with the current state of the retrieved indicator
36
37       map_rtrn
38              backfilled with the mapping for the retrieved indicator
39
40       real_rtrn
41              backfilled with True if the named indicator is real (physical)
42

DESCRIPTION

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

RETURN VALUES

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

SEE ALSO

86       XkbGetNames(3)
87
88
89
90X Version 11                     libX11 1.8.7          XkbGetNamedIndicator(3)
Impressum