xtgetactionkeysym(3xt) [redhat man page]

XtGetActionKeysym(3Xt)						   XT FUNCTIONS 					    XtGetActionKeysym(3Xt)

NAME

       XtGetActionKeysym - obtain corresponding keysym

SYNTAX

       KeySym XtGetActionKeysym(event, modifiers_return)
	     XEvent* event;
	     Modifiers* modifiers_return;

ARGUMENTS

       event	 Specifies the event pointer passed to the action procedure by the Intrinsics.

       modifiers_return
		 Returns the modifiers that caused the match, if non-NULL.

DESCRIPTION

       If XtGetActionKeysym is called after an action procedure has been invoked by the Intrinsics and before that action procedure returns, and
       if the event pointer has the same value as the event pointer passed to that action routine, and if the event is a KeyPress or KeyRelease
       event, then XtGetActionKeysym returns the KeySym that matched the final event specification in the translation table and, if /fImodi-
       fiers_return/fP is non-NULL, the modifier state actually used to generate this KeySym; otherwise, if the event is a KeyPress or KeyRelease
       event, then XtGetActionKeysym calls XtTranslateKeycode and returns the results; else it returns NoSymbol and does not examine modi-
       fiers_return.

SEE ALSO

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

X Version 11							    Release 6.6 					    XtGetActionKeysym(3Xt)

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 modi-
	 fiers.

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.

Description
  XtGetActionKeysym() returns the keysym of the final event specification in the translation table entry that  invoked	the  current  action,
  provided that:

  o  XtGetActionKeysym() is called after an action procedure has been invoked by the Intrinsics and before that action procedure returns,

  o  the event pointer has the same value as the event pointer passed to that action routine, and

  o  the event is a KeyPress or a KeyRelease.

  XtGetActionKeysym() also returns the modifiers actually used to generate 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 procedure.  When an action procedure is invoked on a KeyPress or KeyRelease
  event, it often has a need to retrieve the keysym and modifiers corresponding 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 Also
  XtActionProc(1), XtAppAddActions(1), XtTranslateKeycode(1).

Xt - Translations and Actions												       XtGetActionKeysym()