NAME
XkbSetNames - Change the symbolic names in the server SYNOPSIS Bool XkbSetNames (Display *dpy, unsigned int which, unsigned int firsttype, unsigned int numtypes, XkbDescPtr xkb); ARGUMENTS
- dpy connection to the X server
- which mask of names or map components to be changed
- firsttype first type whose name is to be changed
- numtypes number of types for which names are to be changed
- xkb keyboard description from which names are to be taken DESCRIPTION To change the symbolic names in the server, first modify a local copy of the keyboard description and then use either XkbSetNames, or, to save network traffic, use a XkbNameChangesRecstructure and call XkbChangeNames to download the changes to the server. XkbSetNames and XkbChangeNames can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation errors. Use XkbSetNames to change many names at the same time. For each bit set in which, XkbSetNames takes the corresponding value (or values in the case of arrays) from the keyboard description xkb and sends it to the server. The firsttype and numtypes arguments are used only if XkbKeyType‐ NamesMask or XkbKTLevelNamesMask is set in which and specify a subset of the types for which the corresponding names are to be changed. If either or both of these mask bits are set but the specified types are illegal, XkbSetNames returns False and does not update any of the names specified in which. The specified types are illegal if xkb does not include a map component or if firsttype and numtypes specify types that are not defined in the keyboard description. STRUCTURES The XkbNameChangesRec allows applications to identify small modifica‐ tions to the symbolic names and effectively reduces the amount of traf‐ fic sent to the server: typedef struct XkbNameChanges { unsigned int changed; /∗ name components that have changed */ unsigned char firsttype; /∗ first key type with a new name */ unsigned char numtypes; /∗ number of types with new names */ unsigned char firstlvl; /∗ first key type with new level names */ unsigned char numlvls; /∗ number of key types with new level names */ unsigned char numaliases; /∗ if key aliases changed, total number of key aliases */ unsigned char numrg; /∗ if radio groups changed, total number of radio groups */ unsigned char firstkey; /∗ first key with a new name */ unsigned char numkeys; /∗ number of keys with new names */ unsigned short changedvmods; /∗ mask of virtual modifiers for which names have changed */ unsigned long changedindicators; /∗ mask of indicators for which names were changed */ unsigned char changedgroups; /∗ mask of groups for which names were changed */ } XkbNameChangesRec, *XkbNameChangesPtr The changed field specifies the name components that have changed and is the bitwise inclusive OR of the valid names mask bits defined in Ta‐ ble 1. The rest of the fields in the structure specify the ranges that have changed for the various kinds of symbolic names, as shown in Table 2. Xkb provides several functions that work with symbolic names. Each of these functions uses a mask to specify individual fields of the struc‐ tures described above. These masks and their relationships to the fields in a keyboard description are shown in Table 1. Table 1 Symbolic Names Masks ───────────────────────────────────────────────────────────────────────────────── Mask Bit Value Keyboard Field Component ─────────────────────────────────────────────────────────────────────────────────
XkbKeycodesNameMask (1<<0) Xkb->names keycodes
XkbGeometryNameMask (1<<1) Xkb->names geometry
XkbSymbolsNameMask (1<<2) Xkb->names symbols
XkbPhysSymbolsNameMask (1<<3) Xkb->names physsymbols
XkbTypesNameMask (1<<4) Xkb->names type
XkbCompatNameMask (1<<5) Xkb->names compat
XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name
XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvlnames[*]
XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*]
XkbKeyNamesMask (1<<9) Xkb->names keys[*], numkeys
XkbKeyAliasesMask (1<<10) Xkb->names keyaliases[*], numkeyaliases
XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*]
XkbGroupNamesMask (1<<12) Xkb->names groups[*]
XkbRGNamesMask (1<<13) Xkb->names radiogroups[*], numrg
XkbComponentNamesMask (0x3f) Xkb->names keycodes, geometry, symbols, physical symbols, types, and compatibility map
XkbAllNamesMask (0x3fff) Xkb->names all name components Table 2 XkbNameChanges Fields ──────────────────────────────────────────────────────────────────────────────── Mask Fields Component Field ────────────────────────────────────────────────────────────────────────────────
XkbKeyTypeNamesMask firsttype, Xkb->map type[*].name numtypes
XkbKTLevelNamesMask firstlvl, Xkb->map type[*].lvlnames[*] numlvls
XkbKeyAliasesMask numaliases Xkb->names keyaliases[*]
XkbRGNamesMask numrg Xkb->names radiogroups[*]
XkbKeyNamesMask firstkey, Xkb->names keys[*] numkeys
XkbVirtualModNamesMask changedvmods Xkb->names vmods[*]
XkbIndicatorNamesMask changedindicators Xkb->names indicators[*]
XkbGroupNamesMask changedgroups Xkb->names groups[*] DIAGNOSTICS BadAlloc Unable to allocate storage BadAtom A name is neither a valid Atom or None BadImplementation Invalid reply from server BadLength The length of a request is shorter or longer than that required to minimally contain the arguments BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid SEE ALSO XkbChangeNames(3) X Version 11 libX11 1.6.5 XkbSetNames(3)