XtKeyProc(3x) — HPUX 9.05

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

displaySpecifies the display that the keycode is from.

keycodeSpecifies the keycode that is to be translated.

modifiersSpecifies 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 XtTranslateKey() directly to translate the standard keysyms.

Museum