XkbChangeTypesOfKey(3) XKB FUNCTIONS XkbChangeTypesOfKey(3)

NAME
       XkbChangeTypesOfKey  -  Change the number of groups and the types bound
       to a key

SYNOPSIS
       Status XkbChangeTypesOfKey (XkbDescPtr  xkb,  int  key,  int  ngroups,
              unsigned   int   groups,   int  *newtypesin,  XkbMapChangesPtr
              pchanges);

ARGUMENTS
       - xkb  keyboard description to be changed

       - key  keycode for key of interest

       - ngroups
              new number of groups for key

       - groups
              mask indicating groups to change

       - newtypesin
              indices for new groups specified in groups

       - pchanges
              notes changes made to xkb

DESCRIPTION
       XkbChangeTypesOfKey reallocates the symbols and actions  bound  to  the
       key, if necessary, and initializes any new symbols or actions to NoSym‐
       bol or NoAction, as appropriate. If  the  pchanges  parameter  is  not
       NULL,  XkbChangeTypesOfKey adds the XkbKeySymsMask to the changes field
       of pchanges and modifies the firstkeysym and numkeysyms fields  of
       pchanges  to  include the key that was changed. See STRUCTURE for more
       information  on  the   XkbMapChangesPtr   structure.   If   successful,
       XkbChangeTypesOfKey returns Success.

       The  ngroups parameter specifies the new number of groups for the key.
       The groups parameter is a mask specifying  the  groups  for  which  new
       types  are  supplied  and  is  a  bitwise inclusive OR of the following
       masks: XkbGroup1Mask, XkbGroup2Mask, XkbGroup3Mask, and XkbGroup4Mask.

       The newtypesin parameter is an  integer  array  of  length  ngroups.
       Each  entry  represents the type to use for the associated group and is
       an index into xkb->map->types.  The newtypesin array  is  indexed  by
       group  index;  if  ngroups  is four and groups only has Group1Mask and
       Group3Mask set, newtypesin looks like this:

           newtypesin[0] = type for Group1
           newtypesin[1] = ignored
           newtypesin[2] = type for Group3
           newtypesin[3] = ignored

       For convenience, Xkb provides the following constants to use as indices
       to the groups:


       Table 1 Group Index Constants
       ──────────────────────────────
       Constant Name       Value
       ──────────────────────────────
       XkbGroup1Index      0

       XkbGroup2Index      1
       XkbGroup3Index      2
       XkbGroup4Index      3

       If  the Xkb extension has not been properly initialized, XkbChangeType‐
       sOfKey returns BadAccess. If the xkb parameter it not valid  (that  is,
       it  is  NULL or it does not contain a valid client map), XkbChangeType‐
       sOfKey returns BadMatch. If the key is not a valid keycode, ngroups is
       greater  than  XkbNumKbdGroups, or the groups mask does not contain any
       of the valid group mask bits, XkbChangeTypesOfKey returns BadValue.  If
       it is necessary to resize the key symbols or key actions arrays and any
       allocation errors occur, XkbChangeTypesOfKey returns BadAlloc.

STRUCTURES
       Use the XkbMapChangesRec structure to identify and track partial  modi‐
       fications to the mapping components and to reduce the amount of traffic
       between the server and clients.

       typedef struct XkbMapChanges {
           unsigned short   changed;            /∗ identifies valid components in
       structure */
           KeyCode          minkeycode;       /∗ lowest numbered keycode for device
       */
           KeyCode          maxkeycode;       /∗ highest numbered keycode for device
       */
           unsigned char    firsttype;         /∗ index of first key type modified */
           unsigned char    numtypes;          /∗ # types modified */
           KeyCode          firstkeysym;      /∗ first key whose keysymmap changed
       */
           unsigned char    numkeysyms;       /∗ # keysymmap entries changed */
           KeyCode          firstkeyact;      /∗ first key whose keyacts entry
       changed */
           unsigned char    numkeyacts;       /∗ # keyacts entries changed */
           KeyCode          firstkeybehavior; /∗ first key whose behaviors changed */
           unsigned char    numkeybehaviors;  /∗ # behaviors entries changed */
           KeyCode          firstkeyexplicit; /∗ first key whose explicit entry
       changed */
           unsigned char    numkeyexplicit;   /∗ # explicit entries changed */
           KeyCode          firstmodmapkey;   /∗ first key whose modmap entry changed
       */
           unsigned char    nummodmapkeys;    /∗ # modmap entries changed */
           KeyCode          firstvmodmapkey;  /∗ first key whose vmodmap changed */
           unsigned char    numvmodmapkeys;   /∗ # vmodmap entries changed */
           unsigned char    pad1;               /∗ reserved */
           unsigned short   vmods;              /∗ mask indicating which vmods changed
       */
       } XkbMapChangesRec,*XkbMapChangesPtr;


DIAGNOSTICS
       BadAccess      The Xkb extension has not been properly initialized

       BadAlloc       Unable to allocate storage

       BadMatch       A compatible version of Xkb was  not  available  in  the
                      server or an argument has correct type and range, but is
                      otherwise invalid

       BadValue       An argument is out of range



X Version 11                     libX11 1.6.5           XkbChangeTypesOfKey(3)