XkbLookupKeySym(3)

XkbLookupKeySym3

Find the symbol associated with a key for a particular state

Usage

Bool XkbLookupKeySym (Display *dpy, KeyCode key, unsigned int state, unsigned int *mods_rtrn, KeySym *sym_rtrn);

Arguments

dpy

connection to X server

key

key for which symbols are to be found

state

state for which symbol should be found

mods_rtrn

backfilled with consumed modifiers

sym_rtrn

backfilled with symbol associated with key + state

Overview

XkbLookupKeySym is the equivalent of the core XLookupKeySym function. For the core keyboard, given a keycode key and an Xkb state state, XkbLookupKeySym returns the symbol associated with the key in sym_rtrn and the list of modifiers that should still be applied in mods_rtrn. The state parameter is the state from a KeyPress or KeyRelease event. XkbLookupKeySym returns True if it succeeds.

Releases

10 releases since Debian 5.0 (Lenny); the text changed 9 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10
  7. 11
  8. 12
  9. 13
  10. Arch

From libx11 1.8.14-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.