1. NAME

XkbUpdateMapFromCore - Update a local Xkb keyboard map to reflect the mapping expressed by a core format mapping

2. SYNOPSIS

Bool XkbUpdateMapFromCore (XkbDescPtr xkb , KeyCode first_key , int num_keys , int map_width , KeySym * core_keysyms , XkbChangesPtr changes );

3. ARGUMENTS

  • - xkb
        keyboard description to update
  • - first_key
        keycode of first key description to update
  • - num_keys
        number of key descriptions to update
  • - map_width
        width of core protocol keymap
  • - core_keysyms
        symbols in core protocol keymap
  • - changes
        backfilled with changes made to Xkb

4. DESCRIPTION

Xkb provides several functions that make it easier to apply the compatibility map to configure a client-side Xkb keyboard mapping, given a core protocol representation of part or all of a keyboard mapping. Obtain a core protocol representation of a keyboard mapping from an actual server (by using XGetKeyboardMapping,for example), a data file, or some other source. XkbUpdateMapFromCoreinterprets input argument information representing a keyboard map in core format to update the Xkb keyboard description passed in xkb.Only a portion of the Xkb map is updated - the portion corresponding to keys with keycodes in the range first_keythrough first_key + num_keys - 1.If XkbUpdateMapFromCoreis being called in response to a MappingNotify event, first_keyand num_keysare reported in the MappingNotify event. core_keysymscontains the keysyms corresponding to the keycode range being updated, in core keyboard description order. map_widthis the number of keysyms per key in core_keysyms.Thus, the first map_widthentries in core_keysymsare for the key with keycode first_key,the next map_widthentries are for key first_key + 1,and so on. In addition to modifying the Xkb keyboard mapping in xkb, XkbUpdateMapFromCorebackfills the changes structure whose address is passed in changesto indicate the modifications that were made. You may then use changesin subsequent calls such as XkbSetMap,to propagate the local modifications to a server.

5. SEE ALSO

R XkbSetMap (3)