XkbSetNamedIndicator(3) XKB FUNCTIONS XkbSetNamedIndicator(3)

NAME
       XkbSetNamedIndicator  -  Names an indicator if it is not already named;
       toggles the state of the indicator; sets the indicator to  a  specified
       state and sets the indicator map for the indicator

SYNOPSIS
       Bool XkbSetNamedIndicator (Display *dpy, unsigned int devicespec, Atom
              name, Bool changestate, Bool state, Bool createnew, XkbIndica‐
              torMapPtr map);

ARGUMENTS
       - dpy  connection to the X server

       - devicespec
              device ID, or XkbUseCoreKbd

       - name name of the indicator to change

       - changestate
              whether to change the indicator state or not

       - state
              desired new state for the indicator

       - createnew
              whether  a  new indicator with the specified name should be cre‐
              ated when necessary

       - map  new map for the indicator

DESCRIPTION
       If a compatible version of the Xkb extension is not  available  in  the
       server,  XkbSetNamedIndicator  returns  False.  Otherwise,  it  sends a
       request to the X server to change the indicator specified by  name  and
       returns True.

       If  changestate  is  True,  and  the optional parameter, state, is not
       NULL, XkbSetNamedIndicator tells the server to change the state of  the
       named indicator to the value specified by state.

       If an indicator with the name specified by name does not already exist,
       the createnew parameter tells the server whether it  should  create  a
       new  named indicator. If createnew is True, the server finds the first
       indicator that doesn't have a name and gives it the name  specified  by
       name.   If the optional parameter, map, is not NULL, XkbSetNamedIndica‐
       tor tells the server to change the indicator's map to the values speci‐
       fied in map.

       In  addition,  it can also generate XkbIndicatorStateNotify, XkbIndica‐
       torMapNotify, and XkbNamesNotify events.

RETURN VALUES
       True           The XkbSetNamedIndicator function returns True if a com‐
                      patible version of the Xkb extension is available in the
                      server.

       False          The XkbSetNamedIndicator function  returns  False  if  a
                      compatible version of the Xkb extension is not available
                      in the server.

DIAGNOSTICS
       BadAtom        A name is neither a valid Atom or None

       BadImplementation
                      Invalid reply from server

SEE ALSO
       XkbIndicatorMapNotify(3), XkbIndicatorStateNotify(3), XkbNamesNotify(3)




X Version 11                     libX11 1.6.5          XkbSetNamedIndicator(3)