XkbSetIgnoreLockMods(3)   XKB FUNCTIONS   XkbSetIgnoreLockMods(3)



NAME
       XkbSetIgnoreLockMods - Sets the modifiers that, if locked,
       are not to be reported in matching events to passive grabs

SYNOPSIS
       Bool    XkbSetIgnoreLockMods   (   display,   device_spec,
       affect_real, real_values, affect_virtual, virtual_values )
             Display *display;
             unsigned int device_spec;
             unsigned int affect_real;
             unsigned int real_values;
             unsigned int affect_virtual;
             unsigned int virtual_values;

ARGUMENTS
       - display
              connection to the X server

       - device_spec
              device ID, or XkbUseCoreKbd

       - affect_real
              mask of real modifiers affected by this call

       - real_values
              values   for   affected   real  modifiers  (1=>set,
              0=>unset)

       - affect_virtual
              mask of virtual modifiers affected by this call

       - virtual_values
              values  for  affected  virtual  modifiers  (1=>set,
              0=>unset)

DESCRIPTION
       The  core  protocol does not provide a way to exclude spe-
       cific modifiers from grab calculations,  with  the  result
       that  locking  modifiers sometimes have unanticipated side
       effects.

       The IgnoreLockMods control specifies modifiers that should
       be  excluded  from  grab calculations. These modifiers are
       also not reported in any core events except  KeyPress  and
       KeyRelease  events that do not activate a passive grab and
       that do not occur while a grab is active.

       Manipulate the IgnoreLockMods control via the  ignore_lock
       field in the XkbControlsRec structure, then use XkbSetCon-
       trols and XkbGetControls to query and change this control.
       Alternatively, use XkbSetIgnoreLockMods.

       XkbSetIgnoreLockMods  sends  a  request  to  the server to
       change the server's IgnoreLockMods  control.   affect_real
       and real_values are masks of real modifier bits indicating
       which real modifiers are to be added and removed from  the
       server's  IgnoreLockMods  control.  Modifiers  selected by
       both affect_real and real_values are added to the server's
       IgnoreLockMods  control; those selected by affect_real but
       not by real_values are removed from the  server's  Ignore-
       LockMods   control.   Valid  values  for  affect_real  and
       real_values consist of any combination of the  eight  core
       modifier  bits: ShiftMask, LockMask, ControlMask, Mod1Mask
       - Mod5Mask.  affect_virtual and virtual_values  are  masks
       of  virtual  modifier  bits indicating which virtual modi-
       fiers are to  be  added  and  removed  from  the  server's
       IgnoreLockMods   control.   Modifiers   selected  by  both
       affect_virtual  and  virtual_values  are  added   to   the
       server's   IgnoreLockMods   control;   those  selected  by
       affect_virtual but not by virtual_values are removed  from
       the  server's IgnoreLockMods control. See below for a dis-
       cussion of virtual modifier masks to use in affect_virtual
       and virtual_values. XkbSetIgnoreLockMods does not wait for
       a reply from the server. It returns True  if  the  request
       was sent, and False otherwise.

       Virtual  modifiers  are  named  by converting their string
       name to an X Atom and storing the Atom in the  names.vmods
       array  in  an XkbDescRec structure. The position of a name
       Atom in the names.vmods array  defines  the  bit  position
       used  to represent the virtual modifier and also the index
       used  when  accessing  virtual  modifier  information   in
       arrays:  the  name  in  the  i-th  (0  relative)  entry of
       names.vmods is the i-th virtual modifier,  represented  by
       the  mask (1<SetNames(3)
       XkbAllComponentsMask   All Fields         (0x7f)

       SEE ALSO
              XkbGetControls(3), XkbGetNames(3), XkbSetControls(3), Xkb-



X Version 11               libX11 1.1.5   XkbSetIgnoreLockMods(3)