Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xttranslatb(3) [hpux man page]

XtTranslateKey()														  XtTranslateKey()

Name
  XtTranslateKey - the default keycode-to-keysym translator.

Synopsis
  void XtTranslateKey(display, keycode, modifiers,
  modifiers_return, keysym_return)
	 Display *display;
	 KeyCode keycode;
	 Modifiers modifiers;
	 Modifiers *modifiers_return;
	 KeySym *keysym_return;

Inputs
  display   Specifies the display that the keycode is from.

  keycode   Specifies the keycode to translate.

  modifiers Specifies the modifiers to be applied to the keycode.

Outputs
  modifiers_return
	    Returns the modifiers examined by the key translator.

  keysym_return
	    Returns the resulting keysym.

Description
  XtTranslateKey() is the default XtKeyProc used by the Translation Manager.  It takes a keycode and returns the corresponding keysym, recog-
  nizing Shift, Lock, and group modifiers.  It handles all the keysyms defined by the X Protocol.

  XtTranslateKey() is provided for two main reasons: so that new translators with expanded functionality can call it to get default  keycode-
  to-keysym translations in addition to whatever they add, and so that the default translator can be reinstalled.

  See XtKeyProc(2) for more information on the behavior of this and all key translator procedures.

Usage
  The  Translation  Manager  invokes the currently registered key translator procedure to convert incoming keycodes to keysyms.  Only clients
  that need to work with non-standard keysyms should need to register alternate key translator procedures.

  XtTranslateKey() can be invoked directly, or the currently registered key translator can be invoked by calling XtTranslateKeycode().	A new
  translator  can  be registered by calling XtSetKeyTranslator().  There is no way to remove a translator; to reinstall the default behavior,
  call XtSetKeyTranslator() with XtTranslateKey() as the proc argument.

Structures
  The KeyCode and KeySym types are defined as follows:

     typedef unsigned char KeyCode;
     typedef XID KeySym;

  The Modifiers type and its legal values are defined as follows:

     typedef unsigned int Modifiers;
     #define ShiftMask	      (1<<0)
     #define LockMask	      (1<<1)
     #define ControlMask      (1<<2)
     #define Mod1Mask	      (1<<3)
     #define Mod2Mask	      (1<<4)
     #define Mod3Mask	      (1<<5)
     #define Mod4Mask	      (1<<6)
     #define Mod5Mask	      (1<<7)

See Also
  XtRegisterCaseConverter(1), XtSetKeyTranslator(1), XtTranslateKeycode(1),
  XtKeyProc(2).

Xt - Keyboard Handling														  XtTranslateKey()

Check Out this Related Man Page

XtKeyProc()															       XtKeyProc()

Name
  XtKeyProc - interface definition for keycode-to-keysym translation procedure.

Synopsis
  typedef void (*XtKeyProc)(Display *, KeyCode, Modifiers, Modifiers *,
      KeySym *);
	 Display *display;
	 KeyCode keycode;
	 Modifiers modifiers;
	 Modifiers *modifiers_return;
	 KeySym *keysym_return;

Inputs
  display   Specifies the display that the keycode is from.

  keycode   Specifies the keycode that is to be translated.

  modifiers Specifies the mask that indicates what modifier keys (Shift, Meta, Control, etc.) are pressed.

Outputs
  modifiers_return
	    Returns a mask that specifies the modifier keys that the function examined in making the conversion.

  keysym_return
	    Returns the resulting keysym.

Description
  An  XtKeyProc is registered in a call to XtSetKeyTranslator() and is invoked explicitly by a call to XtTranslateKeycode() and automatically
  by the Translation Manager in order to convert incoming keycodes to keysyms.

  An XtKeyProc must convert the keycode and modifiers into a keysym and return that keysym in keysym_return.  It should return the  modifiers
  that it considers in its translation in modifiers_return.  The value returned in this argument will be a constant for any given XtKeyProc.

  An XtKeyProc must be implemented so that multiple calls with the same display, keycode, and modifiers arguments will return the same result
  until either a new case converter (an XtCaseProc) is registered or a MappingNotify event is received.

Usage
  XtTranslateKey() is the default XtKeyProc.  It should be sufficient for all applications except those that use non-standard keysyms.

  When writing an XtKeyProc, you will probably need to call XtConvertCase(), and XtGetKeysymTable().  You may also want  to  invoke  XtTrans-
  lateKey() directly to translate the standard keysyms.

See Also
  XtConvertCase(1), XtGetKeysymTable(1), XtKeysymToKeycodeList(1), XtRegisterCaseConverter(1), XtSetKeyTranslator(1), XtTranslateKey(1),
  XtTranslateKeycode(1).

Xt - Keyboard Handling														       XtKeyProc()
Man Page