XkbSetMap(3) XKB FUNCTIONS XkbSetMap(3) # [NAME](#NAME) XkbSetMap - Send a complete new set of values for entire components to the server. # [SYNOPSIS](#SYNOPSIS) **Bool XkbSetMap** **(Display \*dpy,** **unsigned int which,** **XkbDescPtr xkb);** # [ARGUMENTS](#ARGUMENTS) [*dpy*](#dpy) connection to X server [*which*](#which) mask selecting subcomponents to update [*xkb*](#xkb) description from which new values are taken # [DESCRIPTION](#DESCRIPTION) There are two ways to make changes to map components: either change a local copy of the keyboard map and call *XkbSetMap* to send the modified map to the server, or, to reduce network traffic, use an XkbMapChangesRec structure and call *XkbChangeMap.* Use *XkbSetMap* to send a complete new set of values for entire components (for example, all symbols, all actions, and so on) to the server. The *which* parameter specifies the components to be sent to the server, and is a bitwise inclusive OR of the masks listed in Table 1. The *xkb* parameter is a pointer to an XkbDescRec structure and contains the information to be copied to the server. For each bit set in the *which* parameter, *XkbSetMap* takes the corresponding structure values from the *xkb* parameter and sends it to the server specified by *dpy*. If any components specified by *which* are not present in the *xkb* parameter, *XkbSetMap* returns False. Otherwise, it sends the update request to the server and returns True. *XkbSetMap* can generate BadAlloc, BadLength, and BadValue protocol errors. Key types, symbol maps, and actions are all interrelated; changes in one require changes in the others. Xkb provides functions to make it easier to edit these components and handle the interdependencies. Table 1 lists these helper functions and provides a pointer to where they are defined. Table 1 Xkb Mapping Component Masks and Convenience Functions Mask Value Map Fields Convenience Functions XkbKeyTypesMask (1<<0) client types size\_types num\_types XkbGetKeyTypes XkbResizeKeyType XkbCopyKeyType XkbCopyKeyTypes XkbKeySymsMask (1<<1) client syms size\_syms num\_syms key\_sym\_map XkbGetKeySyms XkbResizeKeySyms XkbChangeTypesOfKey XkbModifierMapMask (1<<2) client modmap XkbGetKeyModifierMap XkbExplicitComponentsMask (1<<3) server explicit XkbGetKeyExplicitComponents XkbKeyActionsMask (1<<4) server key\_acts acts num\_acts size\_acts XkbGetKeyActions XkbResizeKeyActions XkbKeyBehaviorsMask (1<<5) server behaviors XkbGetKeyBehaviors XkbVirtualModsMask (1<<6) server vmods XkbGetVirtualMods XkbVirtualModMapMask (1<<7) server vmodmap XkbGetVirtualModMap The *changed* field identifies the map components that have changed in an XkbDescRec structure and may contain any of the bits in Table 1, which are also shown in Table 2. Every 1 bit in *changed* also identifies which other fields in the XkbMapChangesRec structure contain valid values, as indicated in Table 2. The *min\_key\_code* and *max\_key\_code* fields are for reference only; they are ignored on any requests sent to the server and are always updated by the server whenever it returns the data for an XkbMapChangesRec. Table 2 XkbMapChangesRec Masks Valid Mask XkbMapChangesRec XkbDescRec Field Containing Fields Changed Data XkbKeyTypesMask first\_type, map->type\[first\_type] .. num\_types map->type\[first\_type + num\_types - 1] XkbKeySymsMask first\_key\_sym, map->key\_sym\_map\[first\_key\_sym] .. num\_key\_syms map->key\_sym\_map\[first\_key\_sym + num\_key\_syms - 1] XkbModifierMapMask first\_modmap\_key, map->modmap\[first\_modmap\_key] .. num\_modmap\_keys map->modmap\[first\_modmap\_key + num\_modmap\_keys - 1] XkbExplicitComponentsMask first\_key\_explicit, server->explicit\[first\_key\_explicit] .. num\_key\_explicit server->explicit\[first\_key\_explicit + num\_key\_explicit - 1] XkbKeyActionsMask first\_key\_act, server->key\_acts\[first\_key\_act] .. num\_key\_acts server->key\_acts\[first\_key\_act + num\_key\_acts - 1] XkbKeyBehaviorsMask first\_key\_behavior, server->behaviors\[first\_key\_behavior] .. num\_key\_behaviors server->behaviors\[first\_key\_behavior + num\_key\_behaviors - 1] XkbVirtualModsMask vmods server->vmods\[\*] XkbVirtualModMapMask first\_vmodmap\_key, server->vmodmap\[first\_vmodmap\_key] .. num\_vmodmap\_keys server->vmodmap\[first\_vmodmap\_key + num\_vmodmap\_keys - 1] # [RETURN VALUES](#RETURN_VALUES) [True](#True) The *XkbSetMap* function returns True all components specified by *which* are present in the *xkb* parameter. [False](#False) The *XkbSetMap* function returns False if any component specified by *which* is not present in the *xkb* parameter. # [STRUCTURES](#STRUCTURES) Use the XkbMapChangesRec structure to identify and track partial modifications 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 min_key_code; /* lowest numbered keycode for device */ KeyCode max_key_code; /* highest numbered keycode for device */ unsigned char first_type; /* index of first key type modified */ unsigned char num_types; /* # types modified */ KeyCode first_key_sym; /* first key whose key_sym_map changed */ unsigned char num_key_syms; /* # key_sym_map entries changed */ KeyCode first_key_act; /* first key whose key_acts entry changed */ unsigned char num_key_acts; /* # key_acts entries changed */ KeyCode first_key_behavior; /* first key whose behaviors changed */ unsigned char num_key_behaviors; /* # behaviors entries changed */ KeyCode first_key_explicit; /* first key whose explicit entry changed */ unsigned char num_key_explicit; /* # explicit entries changed */ KeyCode first_modmap_key; /* first key whose modmap entry changed */ unsigned char num_modmap_keys; /* # modmap entries changed */ KeyCode first_vmodmap_key; /* first key whose vmodmap changed */ unsigned char num_vmodmap_keys; /* # vmodmap entries changed */ unsigned char pad1; /* reserved */ unsigned short vmods; /* mask indicating which vmods changed */ } XkbMapChangesRec,*XkbMapChangesPtr; ``` The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components. ``` typedef struct { struct _XDisplay * display; /* connection to X server */ unsigned short flags; /* private to Xkb, do not modify */ unsigned short device_spec; /* device of interest */ KeyCode min_key_code; /* minimum keycode for device */ KeyCode max_key_code; /* maximum keycode for device */ XkbControlsPtr ctrls; /* controls */ XkbServerMapPtr server; /* server keymap */ XkbClientMapPtr map; /* client keymap */ XkbIndicatorPtr indicators; /* indicator map */ XkbNamesPtr names; /* names for all components */ XkbCompatMapPtr compat; /* compatibility map */ XkbGeometryPtr geom; /* physical geometry of keyboard */ } XkbDescRec, *XkbDescPtr; ``` The *display* field points to an X display structure. The *flags field is private to the library: modifying* *flags* may yield unpredictable results. The *device\_spec* field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The *min\_key\_code* and *max\_key\_code* fields specify the least and greatest keycode that can be returned by the keyboard. Each structure component has a corresponding mask bit that is used in function calls to indicate that the structure should be manipulated in some manner, such as allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 3. Table 3 Mask Bits for XkbDescRec Mask Bit XkbDescRec Field Value XkbControlsMask ctrls (1L<<0) XkbServerMapMask server (1L<<1) XkbIClientMapMask map (1L<<2) XkbIndicatorMapMask indicators (1L<<3) XkbNamesMask names (1L<<4) XkbCompatMapMask compat (1L<<5) XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (0x7f) # [DIAGNOSTICS](#DIAGNOSTICS) [**BadAlloc**](#BadAlloc) Unable to allocate storage [**BadLength**](#BadLength) The length of a request is shorter or longer than that required to minimally contain the arguments [**BadValue**](#BadValue) An argument is out of range # [SEE ALSO](#SEE_ALSO) [**XkbChangeMap**(3)](/man/os/libx11/XkbChangeMap.3), [**XkbChangeTypesOfKey**(3)](/man/os/libx11/XkbChangeTypesOfKey.3), [**XkbCopyKeyType**(3)](/man/os/libx11/XkbCopyKeyType.3), [**XkbCopyKeyTypes**(3)](/man/os/libx11/XkbCopyKeyTypes.3), [**XkbGetKeyActions**(3)](/man/os/libx11/XkbGetKeyActions.3), [**XkbGetKeyBehaviors**(3)](/man/os/libx11/XkbGetKeyBehaviors.3), [**XkbGetKeyExplicitComponents**(3)](/man/os/libx11/XkbGetKeyExplicitComponents.3), [**XkbGetKeyModifierMap**(3)](/man/os/libx11/XkbGetKeyModifierMap.3), [**XkbGetKeySyms**(3)](/man/os/libx11/XkbGetKeySyms.3), [**XkbGetKeyTypes**(3)](/man/os/libx11/XkbGetKeyTypes.3), [**XkbResizeKeyActions**(3)](/man/os/libx11/XkbResizeKeyActions.3), [**XkbResizeKeySyms**(3)](/man/os/libx11/XkbResizeKeySyms.3), [**XkbResizeKeyType**(3)](/man/os/libx11/XkbResizeKeyType.3), [**XkbGetVirtualModMap**(3)](/man/os/libx11/XkbGetVirtualModMap.3), [**XkbGetVirtualMods**(3)](/man/os/libx11/XkbGetVirtualMods.3) libX11 1.8.14 X Version 11 --- Document: XkbSetMap(3) from libx11 1.8.14-r3 (Chainguard OS) Source: https://gitlab.freedesktop.org/xorg/lib/libx11.git