1. NAME

XkbTranslateKeyCode - Translate a keycode to a key symbol and modifiers

2. SYNOPSIS

Bool XkbTranslateKeyCode (XkbDescPtr xkb , KeyCode key , unsigned int mods , unsigned int * mods_rtrn , KeySym * keysym_rtrn );

3. ARGUMENTS

  • - xkb
        keyboard description to use for translation
  • - key
        keycode to translate
  • - mods
        modifiers to apply when translating key
  • - mods_rtrn
        backfilled with unconsumed modifiers
  • - keysym_rtrn
        keysym resulting from translation

4. DESCRIPTION

mods_rtrnis backfilled with the modifiers consumed by the translation process. modsis a bitwise inclusive OR of the legal modifier masks: ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask.The AlwaysConsumeShiftAndLock library control (see below), if enabled, causes XkbTranslateKeyCodeto consume shift and lock. XkbTranslateKeyCodereturns True if the translation resulted in a keysym, and False if it resulted in NoSymbol. The AlwaysConsumeShiftAndLock control, if enabled, forces XLookupStringto consume the Shift and Lock modifiers when processing all keys, even if the definition for the key type does not specify these modifiers. The AlwaysConsumeShiftAndLock control is unset by default.

5. SEE ALSO

R XLookupString (3)