xkbtranslatekeysym(3) [x11r4 man page]

XkbTranslateKeySym(3)						   XKB FUNCTIONS					     XkbTranslateKeySym(3)

NAME

       XkbTranslateKeySym - Find the string and symbol associated with a keysym for a given keyboard state

SYNOPSIS

       int XkbTranslateKeySym ( dpy , sym_inout , mods , buf , nbytes , extra_rtrn )
	     Display *dpy;
	     KeySym *sym_inout;
	     unsigned int  mods;
	     char *buf;
	     int nbytes;
	     int *extra_rtrn;

ARGUMENTS

       - dpy  connection to X server

       - sym_inout
	      symbol to be translated; result of translation

       - mods modifiers to apply to sym_inout

       - buf  buffer into which returned string is written

       - nbytes
	      size of buffer in bytes

       - extra_rtrn
	      number of bytes overflow

DESCRIPTION

       XkbTranslateKeySym  applies  the  transformations specified in mods to the symbol specified by sym_inout.  It returns in buf the string, if
       any, associated with the keysym for the current locale. If the transformations in mods changes the keysym,  sym_inout  is  updated  accord-
       ingly.  If  the	string	returned is larger than nbytes, a count of bytes that does not fit into the buffer is returned in extra_rtrn. Xkb-
       TranslateKeySym returns the number of bytes it placed into buf.

RETURN VALUES

       buf	      Returns the string, if any, associated with the keysym for the current locale.

X Version 11							   libX11 1.2.1 					     XkbTranslateKeySym(3)

XkbTranslateKeyCode(3)						   XKB FUNCTIONS					    XkbTranslateKeyCode(3)

NAME

       XkbTranslateKeyCode -  Translate a keycode to a key symbol and modifiers

SYNOPSIS

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

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

DESCRIPTION

       mods_rtrn  is  backfilled  with	the  modifiers	consumed by the translation process.  mods is 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  XkbTranslateKeyCode  to  consume  shift and lock.  XkbTranslateKeyCode returns True if the translation
       resulted in a keysym, and False if it resulted in NoSymbol.

       The AlwaysConsumeShiftAndLock control, if enabled, forces XLookupString to 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.

SEE ALSO

       XLookupString(3)

X Version 11							   libX11 1.5.0 					    XkbTranslateKeyCode(3)