Query: xtgetkeysymtable
OS: hpux
Section: 1
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
XtGetKeysymTable() XtGetKeysymTable()
Name
XtGetKeysymTable - return a pointer to the keycode-to-keysym mapping table of a display.
Synopsis
KeySym *XtGetKeysymTable(display, min_keycode_return,
keysyms_per_keycode_return)
Display *display;
KeyCode *min_keycode_return;
int *keysyms_per_keycode_return;
Inputs
display Specifies the display whose table is required.
Outputs
min_keycode_return
Returns the minimum keycode valid for the display.
keysyms_per_keycode_return
Returns the number of keysyms stored for each keycode.
Returns
The keycode-to-keysym table for display.
Availability
Release 4 and later.
Description
XtGetKeysymTable() returns a pointer to the Intrinsics' copy of the X server's keycode-to-keysym table, which must not be modified by the
application. This table is simply an array of KeySym. The number of keysyms associated with each keycode is returned in keysyms_per_key-
code_return. The first keysyms in the table are for the keycode returned in min_keycode_return. The keysyms for a keycode k begin at
index:
k - min_keycode_return) * keysyms_per_keycode_return
Any entries in the table that have no keysyms associated with them contain the value NoSymbol.
Usage
The Intrinsics maintains a table internally to map keycodes to keysyms for each open display. The Translation Manager uses this table, and
custom keycode-to-keysym translator procedures (see XtSetKeyTranslator()) and other clients may also need to use it. Most applications and
widgets will never need to use this function.
You should not cache this keysym table but should call XtGetKeysymTable() each time the value is needed, because the table may change at
any time.
See Also
XtConvertCase(1), XtKeysymToKeycodeList(1), XtRegisterCaseConverter(1), XtSetKeyTranslator(1), XtTranslateKeycode(1).
Xt - Keyboard Handling XtGetKeysymTable()