xtappaddactionhook(3) [suse man page]

XtAppAddActionHook(3)						   XT FUNCTIONS 					     XtAppAddActionHook(3)

NAME

       XtAppAddActionHook, XtRemoveActionHook - register an action hook procedure

SYNTAX

       XtActionHookId XtAppAddActionHook(XtAppContext app_context, XtActionHookProc proc, XtPointer client_data);

       void XtRemoveActionHook(XtActionHookId id);

ARGUMENTS

       app_context
		 Specifies the application context.

       proc	 Specifies the action hook procedure.

       num_args  Specifies the application-specific data to be passed to the action hook.

DESCRIPTION

       XtAppAddActionHook adds the specified procedure to the front of a list maintained in the application context. In the future, when an action
       routine is about to be invoked for any widget in this application context, either through the translation manager or via XtCallActionProc,
       the action hohok procedures will be called in reverse order of registration jut prior to invoking the action routine.

       Action hook procedures are removed automatically and the XtActionHookId s destroyed when the application context in which they were added
       is destroyed.

       XtRemoveActionHook removes the specified action hook procedure from the list in which it was registered.

SEE ALSO

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

X Version 11							    libXt 1.0.7 					     XtAppAddActionHook(3)

XtActionHookProc()														XtActionHookProc()

Name
  XtActionHookProc - interface definition for action hook procedure.

Synopsis
  typedef void (*XtActionHookProc)(Widget, XtPointer, String, XEvent*, String*, Cardinal*);
	 Widget w;
	 XtPointer client_data;
	 String action_name;
	 XEvent* event;
	 String* params;
	 Cardinal* num_params;

Inputs
  w	    Specifies the widget whose action is about to be dispatched.

  client_data
	    Specifies data that was registered with this procedure in a call to XtAppAddActionHook().

  action_name
	    Specifies the name of the action to be dispatched.

  event     Specifies the event argument that will be passed to the action routine.

  params    Specifies the action parameters that will be passed to the action routine.

  num_params
	    Specifies the number of elements in params.

Availability
  Release 4 and later.

Description
  An XtActionHookProc registered with XtAppAddActionHook() will be called just before any action procedure is invoked by the Translation Man-
  ager.  client_data is whatever data was registered with the action hook procedure in the call to XtAppAddActionHook().  action_name is  the
  name	of  the  action procedure that is about to be invoked.	It is the name the action procedure was registered with, and can be used in a
  call to XtCallActionProc().  The w, event, params, and num_params arguments are the arguments that will be passed directly  to  the  action
  procedure.

  Action hooks should not modify any of the data pointed to by the arguments other than the client_data argument.

Usage
  One  use of an XtActionHookProc is to record the arguments passed to each action so that user actions are recorded for later playback using
  XtCallActionProc().  This is one way to implement keyboard macros.

See Also
  XtAppAddActionHook(1), XtCallActionProc(1), XtRemoveActionHook(1),
  XtActionProc(2).

Xt - Translations and Actions													XtActionHookProc()