XtGetActionKeysym()XtGetActionKeysym()Name
XtGetActionKeysym - retrieve the keysym and modifiers that matched the
final event specification in the translation table entry.
Synopsis
KeySym XtGetActionKeysym(event, modifiers_return)
XEvent *event;
Modifiers *modifiers_return;
Inputs
event Specifies the event pointer passed to the action procedure by
the Intrinsics.
Outputs
modifiers_return
Returns the modifier state actually used to generate the
returned keysym. You may pass NULL if you are not interested in
the modifiers.
Returns
The keysym of the final event specification in the translation table
entry that dispatched the current action, or NoSymbol.
Availability
Release 4 and later.
DescriptionXtGetActionKeysym() returns the keysym of the final event specification
in the translation table entry that invoked the current action, pro‐
vided that:
· XtGetActionKeysym() is called after an action procedure has been
invoked by the Intrinsics and before that action procedure returns,
· the event pointer has the same value as the event pointer passed to
that action routine, and
· the event is a KeyPress or a KeyRelease.
XtGetActionKeysym() also returns the modifiers actually used to gener‐
ate this keysym if modifiers_return is non-NULL.
If XtGetActionKeysym() is not called from an action procedure, or if
event does not match the event that invoked the action, but if the
event is a KeyPress or KeyRelease, then XtGetActionKeysym() calls
XtTranslateKeycode() and returns the results.
If the event is not a KeyPress or KeyRelease, then XtGetActionKeysym()
returns NoSymbol and does not examine modifiers_return.
Note that if an action procedure which was invoked by the Intrinsics
invokes a subsequent action procedure (and so on) via XtCallAction‐
Proc(), the nested action procedure may also call XtGetActionKeysym()
to retrieve the Intrinsics' keysym and modifiers.
Usage
You should only call XtGetActionKeysym() from within an action proce‐
dure. When an action procedure is invoked on a KeyPress or KeyRelease
event, it often has a need to retrieve the keysym and modifiers corre‐
sponding to the event that caused it to be invoked. In order to avoid
repeating the processing that was just performed by the Intrinsics to
match the translation entry, the keysym and modifiers are stored for
the duration of the action procedure and can be obtained with this
function.
Structures
A KeySym is an X server resource:
typedef XID KeySym;
The Modifiers type and its possible values are 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 AlsoXtActionProc(1), XtAppAddActions(1), XtTranslateKeycode(1).
Xt - Translations and Actions XtGetActionKeysym()
