comtab-report

Arguments: &key (stream *terminal-io*) (comtab-list (list *text-edit-comtab*)) (max-column-width 40) (include-menu-bar t) (include-global t) include-help-strings extra-help-string-spacing

Generates a table of all keyboard shortcuts used by the IDE, including menubar shortcuts, comtabs, and global accelerators. If stream is nil, then the report is shown in a list-view control in a dialog (this is what the Help | Shortcut Keys command does). If stream is a stream, then a textual version of the report is printed to the stream. The default value of stream is the current value of *terminal-io*, which typically will print the output to a listener window.

Arguments other than stream

In releases prior to 8.2, the arguments were optional rather than keyword arguments (and the argument list contained only the first three items).

• comtab-list is a list of the comtabs to include in the report, and defaults to the comtab currently being used by the IDE lisp source code editor. Note that the list-view version of the report can include only a single comtab.
• max-column-width is used only by the textual version of the report, and indicates the maximum character-width that will be used for any column. Column values that are longer will push the next column value over a bit.
• If include-menu-bar is true, as it is by default, then shortcuts from the IDE's menu bar will be included in the report, and otherwise they will not be.
• If include-global is true, as it is by default, then global shortcuts (as defined with add-global-keyboard-accelerator) will be included in the report, and otherwise they will not be.
• If include-help-strings is true, then the help-string for each command (which is the documentation string for the function that the command calls) will be included in the report, and otherwise it will not be. Each help-string is printed on a separate line. The default is nil.
• If extra-help-string-spacing is true, then additional blank lines will be inserted in the report. This is done only when include-help-strings is also true. The default is nil.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
The object described on this page has been modified in the 8.2 release; see the Release Notes.
Created 2016.6.21.