NAME
XkbGetNamedIndicator - Look up the indicator map and other information for an indicator by name SYNOPSIS Bool XkbGetNamedIndicator (Display *dpy, unsigned int devspec, Atom name, int *ndxrtrn, Bool *statertrn, XkbIndicatorMapPtr maprtrn, Bool *realrtrn); ARGUMENTS
- dpy connection to the X server
- devspec keyboard device ID, or XkbUseCoreKbd
- name name of the indicator to be retrieved
- ndxrtrn backfilled with the index of the retrieved indicator
- statertrn backfilled with the current state of the retrieved indicator
- maprtrn backfilled with the mapping for the retrieved indicator
- realrtrn backfilled with True if the named indicator is real (physical) DESCRIPTION Xkb also allows applications to refer to indicators by name. Use XkbGetNames to get the indicator names. Using names eliminates the need
for hard-coding bitmask values for particular keyboards. For example,
instead of using vendor-specific constants such as WSKBLedScrollLock mask on Digital workstations or XLEDSCROLLLOCK on Sun workstations, you can instead use XkbGetNamedIndicator to look up information on the indicator named "Scroll Lock." If the device specified by devicespec has an indicator named name, XkbGetNamedIndicator returns True and populates the rest of the parame‐ ters with information about the indicator. Otherwise, XkbGetNamedIndi‐ cator returns False.
The ndxrtrn field returns the zero-based index of the named indicator. This index is the bit position to use in any function call that requires a mask of indicator bits, as well as the indicator's index into the XkbIndicatorRec array of indicator maps. statertrn returns the current state of the named indicator (True = on, False = off). maprtrn returns the indicator map for the named indicator. In addi‐ tion, if the indicator is mapped to a physical LED, the realrtrn parameter is set to True. Each of the " rtrn " arguments is optional; you can pass NULL for any unneeded " rtrn " arguments. RETURN VALUES True The XkbGetNamedIndicator function returns True if the device specified by devicespec has an indicator named name. False The XkbGetNamedIndicator function returns False if the device specified by devicespec does not have an indica‐ tor named name. SEE ALSO XkbGetNames(3) X Version 11 libX11 1.6.5 XkbGetNamedIndicator(3)