Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
XkbGetKeyModifierMap(3) 	  XKB FUNCTIONS 	 XkbGetKeyModifierMap(3)

NAME
     XkbGetKeyModifierMap  - Update the modifier map for one or more of the keys
     in a keyboard description

SYNOPSIS
     Status XkbGetKeyModifierMap (Display *dpy, unsigned int first, unsigned int
	    num, XkbDescPtr xkb);

ARGUMENTS
     dpy    connection to X server

     first  keycode of first key to get

     num    number of keys for which information is desired

     xkb    keyboard description to update

DESCRIPTION
     The modmap entry of the client map is an array, indexed by keycode,  speci-
     fying the real modifiers bound to a key. Each entry is a mask composed of a
     bitwise inclusive OR of the legal real modifiers: ShiftMask, LockMask, Con-
     trolMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, and Mod5Mask. If a bit is
     set in a modmap entry, the corresponding key is bound to that modifier.

     Pressing  or releasing the key bound to a modifier changes the modifier set
     and unset state. The particular manner in which the modifier set and  unset
     state  changes  is  determined  by the behavior and actions assigned to the
     key.

     XkbGetKeyModifierMap sends a request to the server for  the  modifier  map-
     pings  for num keys starting with the key whose keycode is first.	It waits
     for a reply and places the results in the xkb->map->modmap array.	If  suc-
     cessful, XkbGetKeyModifier returns Success.

     If  the  map  component  of  the  xkb parameter has not been allocated, Xk-
     bGetKeyModifierMap allocates and initializes it.

     If a compatible version of Xkb is not available in the server  or	the  Xkb
     extension	has  not been properly initialized, XkbGetKeySyms returns BadAc-
     cess. If any allocation errors occur while obtaining the modifier map,  Xk-
     bGetKeyModifierMap returns BadAlloc.

DIAGNOSTICS
     BadAccess	    The Xkb extension has not been properly initialized

     BadAlloc	    Unable to allocate storage

X Version 11			  libX11 1.8.13 	 XkbGetKeyModifierMap(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XkbGetKeyModifierMap&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help