Manual Pages for UNIX Operating System command usage for man XkbChangeIndicators

XKB FUNCTIONS                           XkbChangeIndicators(3x11)



NAME
     XkbChangeIndicators  -  Changes  indicator  maps  or   state
     without passing the entire keyboard description

SYNOPSIS
     cc [ flag... ] file... -lX11 [ library... ]

     Bool  XkbChangeIndicators  (Display  *dpy,  XkbDescPtr  xkb,
          XkbIndicatorChangesPtr changes, unsigned int state);

ARGUMENTS
     - dpy
          connection to the X server

     - xkb
          keyboard description from which names are to be taken.

     - changes
          indicators to be updated on the server

     - state
          new   state   of   indicators   listed   in    changes-
          >state_changes

DESCRIPTION
     The XkbIndicatorChangesRec identifies small modifications to
     the indicator map. Use it with the function XkbChangeIndica-
     tors to reduce the amount of traffic sent to the server (see
     STRUCTURES).

     The state_changes field is a mask that specifies the indica-
     tors that have changed state, and map_changes is a mask that
     specifies the indicators whose maps have changed.

     XkbChangeIndicators copies any  maps  specified  by  changes
     from  the keyboard description, xkb, to the server specified
     by dpy. If any bits are set in the  state_changes  field  of
     changes,  XkbChangeIndicators  also  sets the state of those
     indicators to the values specified in the state  mask.  A  1
     bit  in  state turns the corresponding indicator on, a 0 bit
     turns it off.

     In addition, it can  also  generate  XkbIndicatorStateNotify
     and XkbIndicatorMapNotify events.

     Whenever an indicator changes state, the server sends XkbIn-
     dicatorStateNotify  events  to all interested clients. Simi-
     larly, whenever an indicator's map changes, the server sends
     XkbIndicatorMapNotify events to all interested clients.

     To receive  XkbIndicatorStateNotify  events,  use  XkbSelec-
     tEvents  with  both  the  bits_to_change and values_for_bits



X Version 11        Last change: libX11 1.3.5                   1






XKB FUNCTIONS                           XkbChangeIndicators(3x11)



     parameters   containing   XkbIndicatorStateNotifyMask.    To
     receive  XkbIndicatorMapNotify  events,  use XkbSelectEvents
     with XkbIndicatorMapNotifyMask.

     To  receive  events  for  only  specific   indicators,   use
     XkbSelectEventDetails.   Set  the  event_type  parameter  to
     XkbIndicatorStateNotify or  XkbIndicatorMapNotify,  and  set
     both  the  bits_to_change and values_for_bits detail parame-
     ters to a mask where each bit specifies one indicator, turn-
     ing  on those bits that specify the indicators for which you
     want to receive events.

     xkb_type is either XkbIndicatorStateNotify or  XkbIndicator-
     MapNotify,  depending  on  whether  the event is a kbIndica-
     torStateNotify event or kbIndicatorMapNotify event.

     The  changed  parameter  is  a  mask  that  is  the  bitwise
     inclusive  OR  of  the  indicators that have changed. If the
     event is of type XkbIndicatorMapNotify, changed reports  the
     maps  that changed. If the event is of type XkbIndicatorSta-
     teNotify, changed reports the indicators that  have  changed
     state.  state  is a mask that specifies the current state of
     all indicators, whether they have changed or not,  for  both
     XkbIndicatorStateNotify and IndicatorMapNotify events.

STRUCTURES
          typedef struct _XkbIndicatorChanges {
              unsigned int          state_changes;
              unsigned int           map_changes;
          }XkbIndicatorChangesRec,*XkbIndicatorChangesPtr;

     Both types of indicator events use the same structure:

         typedef struct _XkbIndicatorNotify {
             int            type;        /* Xkb extension base event code */
             unsigned long  serial;      /* X server serial number for event */
             Bool           send_event;  /* True => synthetically generated */
             Display *      display;     /* server connection where event generated */
             Time           time;        /* server time when event generated */
             int            xkb_type;    /* specifies state or map notify */
             int            device;      /* Xkb device ID, will not be XkbUseCoreKbd*/
             unsigned int   changed;     /* mask of indicators with new state or map */
             unsigned int   state;       /* current state of all indicators */
         } XkbIndicatorNotifyEvent;


DIAGNOSTICS
     BadAtom        A name is neither a valid Atom or None

     BadImplementation
                    Invalid reply from server




X Version 11        Last change: libX11 1.3.5                   2






XKB FUNCTIONS                           XkbChangeIndicators(3x11)



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


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libx11          |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|






































X Version 11        Last change: libX11 1.3.5                   3