xtkeyproc(2) [hpux 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()

XtSetKeyTranslator(3Xt) 					   XT FUNCTIONS 					   XtSetKeyTranslator(3Xt)

NAME

       XtSetKeyTranslator, XtTranslateKeycode, XtRegisterCaseConverter, XtConvertCase - convert KeySym to KeyCodes

SYNTAX

       void XtSetKeyTranslator(display, proc)
	   Display *display;
	   XtKeyProc proc;

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

       void XtRegisterCaseConverter(display, proc, start, stop)
	   Display *display;
	   XtCaseProc proc;
	   KeySym start;
	   KeySym stop;

       void XtConvertCase(display, keysym, lower_return, upper_return)
	   Display *display;
	   KeySym keysym;
	   KeySym *lower_return;
	   KeySym *upper_return;

ARGUMENTS

       display	 Specifies the display.

       keycode	 Specifies the KeyCode to translate.

       keysym	 Specifies the KeySym to convert.

       keysym_return
		 Returns the resulting KeySym.

       lower_return
		 Returns the lowercase equivalent of the KeySym.

       upper_return
		 Returns the uppercase equivalent of the KeySym.

       modifiers Specifies the modifiers to the KeyCode.

       modifiers_return
		 Returns a mask that indicates the modifiers actually used to generate the KeySym.

       proc	 Specifies the procedure that is to perform key translations or conversions.

       start	 Specifies the first KeySym for which this converter is valid.

       stop	 Specifies the last KeySym for which this converter is valid.

DESCRIPTION

       The XtSetKeyTranslator function sets the specified procedure as the current key translator.  The default translator is XtTranslateKey, an
       XtKeyProc that uses Shift and Lock modifiers with the interpretations defined by the core protocol.  It is provided so that new translators
       can call it to get default KeyCode-to-KeySym translations and so that the default translator can be reinstalled.

       The XtTranslateKeycode function passes the specified arguments directly to the currently registered KeyCode to KeySym translator.

       The XtRegisterCaseConverter registers the specified case converter.  The start and stop arguments provide the inclusive range of KeySyms
       for which this converter is to be called.  The new converter overrides any previous converters for KeySyms in that range.  No interface
       exists to remove converters; you need to register an identity converter.  When a new converter is registered, the Intrinsics  refreshes the
       keyboard state if necessary.  The default converter understands case conversion for all KeySyms defined in the core protocol.

       The XtConvertCase function calls the appropriate converter and returns the results.  A user-supplied XtKeyProc may need to use this func-
       tion.

SEE ALSO

       X Toolkit Intrinsics - C Language Interface
       Xlib - C Language X Interface

X Version 11							    Release 6.6 					   XtSetKeyTranslator(3Xt)