XkbGetNamedIndicator(3)   XKB FUNCTIONS   XkbGetNamedIndicator(3)



NAME
       XkbGetNamedIndicator - Look up the indicator map and other
       information for an indicator by name

SYNOPSIS
       Bool XkbGetNamedIndicator ( dpy, dev_spec, name, ndx_rtrn,
       state_rtrn, map_rtrn, real_rtrn )
             Display *dpy;
             unsigned int dev_spec;
             Atom name;
             int *ndx_rtrn;
             Bool *state_rtrn;
             XkbIndicatorMapPtr map_rtrn;
             Bool *real_rtrn;

ARGUMENTS
       - dpy  connection to the X server

       - dev_spec
              keyboard device ID, or XkbUseCoreKbd

       - name name of the indicator to be retrieved

       - ndx_rtrn
              backfilled  with the index of the retrieved indica-
              tor

       - state_rtrn
              backfilled with the current state of the  retrieved
              indicator

       - map_rtrn
               backfilled  with  the  mapping  for  the retrieved
              indicator

       - real_rtrn
              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 WSKBLed_ScrollLock mask
       on Digital workstations or XLED_SCROLL_LOCK on  Sun  work-
       stations, you can instead use XkbGetNamedIndicator to look
       up information on the indicator named "Scroll Lock."

       If the device specified by device_spec  has  an  indicator
       named  name,  XkbGetNamedIndicator  returns True and popu-
       lates the rest of the parameters  with  information  about
       the  indicator.  Otherwise,  XkbGetNamedIndicator  returns
       False.

       The ndx_rtrn 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.  state_rtrn returns  the  current
       state  of  the  named  indicator (True = on, False = off).
       map_rtrn  returns  the  indicator  map   for   the   named
       indicator.  In  addition,  if the indicator is mapped to a
       physical LED, the real_rtrn 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 device_spec
                      has an indicator named name.

       False          The  XkbGetNamedIndicator  function returns
                      False   if   the   device   specified    by
                      device_spec  does  not  have  an  indicator
                      named name.

SEE ALSO
       XkbGetNames(3)



X Version 11               libX11 1.1.5   XkbGetNamedIndicator(3)