Name

XtParseAcceleratorTable — compile an accelerator table into its internal representation. 

Synopsis

XtAccelerators XtParseAcceleratorTable(table)

    String table;

Arguments

tableSpecifies the accelerator table to compile. 

Description

XtParseAcceleratorTable compiles the accelerator table into its opaque internal representation.  This compiled table is then used to set the XtNaccelerators resource of a widget in the application code.  When an accelerator table is specified in a resource file, it is automatically parsed by one of Xt’s converters, and XtParseAcceleratorTable is not used. 

Another way to parse an accelerator table is to use the XtRString-to-XtRAcceleratorTable converter with the XtVaTypedArg feature at XtVaCreateWidget or XtVaSetValues. 

Accelerators can be specified in defaults files, and the string representation is the same as for a translation table.  However, the interpretation of the #augment and #override directives applies to what will happen when the accelerator is installed; that is, whether or not the accelerator translations will override the translations in the destination widget.  The default is #augment, which means that the accelerator translations have lower priority than the destination translations.  The #replace directive is ignored for accelerator tables. 

An accelerator, once installed, binds an event sequence in one widget (called the destination) to actions in another (called the source).  An accelerator table is similar to a translation table in appearance.  Accelerators that are set as a resource of the source widget do not take effect until they are installed on the destination widget. 

Each class of widget has a display_accelerator method to which Xt passes a displayable string representation of the accelerators so that widgets can display their current accelerators.  The representation is the accelerator table in canonical translation table form (see Appendix F, Translation Table Syntax). 

For more information, see Chapter 7, Events, Translations, and Accelerators, in Volume Four, X Toolkit Intrinsics Programming Manual. 

See Also

XtInstallAccelerators(1), XtInstallAllAccelerators(1),
display_accelerator(4).