All Manuals > Common Lisp Interface Manager 2.0 User's Guide > Chapter 11 Commands > 11.10 Advanced Topics

NextPrevUpTopContentsIndex

11.10.1 CLIM Command Tables

For more information on CLIM command tables, see 11.4, CLIM Command Tables.

do-command-table-inheritance [Macro]	

Arguments: (command-table-var command-table) &body body

Summary: Successively executes body with command-table-var bound first to the command table specified by the command table designator command-table , and then (recursively) to all of the command tables from which command-table inherits.

The command-table-var argument is not evaluated. body may have zero or more declarations as its first forms.

map-over-command-table-commands [Function]	

Arguments: function command-table &key (inherited t )

Summary: Applies function to all of the commands accessible in the command table specified by the command table designator command-table . function must be a function that takes a single argument, the command name; it has dynamic extent.

If inherited is nil , this applies function only to those commands present in command-table , that is, it does not map over any inherited command tables. If inherited is t , then the inherited command tables are traversed in the same order as for do-command-table-inheritance .

map-over-command-table-names [Function]	

Arguments: function command-table &key (inherited t )

Summary: Applies function to all of the command-line name accessible in the command table specified by the command table designator command-table . function must be a function of two arguments, the command-line name and the command name; it has dynamic extent.

If inherited is nil , this applies function only to those command-line names present in command-table , that is, it does not map over any inherited command tables. If inherited is t , then the inherited command tables are traversed in the same order as for do-command-table-inheritance .

command-present-in-command-table-p [Function]	

Arguments: command-name command-table

Summary: Returns t if the command named by command-name is present in the command table specified by the command table designator command-table ; otherwise, it returns nil .

command-accessible-in-command-table-p [Function]	

Arguments: command-name command-table

Summary: If the command named by command-name is not accessible in the command table specified by the command table designator command-table , then this function returns nil . Otherwise, it returns the command table in which the command was found.

find-command-from-command-line-name [Function]	

Arguments: name command-table &key (errorp t )

Summary: Given a command-line name name and a command table, returns two values, the command name and the command table in which the command was found. If the command is not accessible in command-table and errorp is t , the command-not-accessible error will be signaled. command-table is a command table designator.

find-command-from-command-line-name ignores character case.

command-line-name-for-command [Function]	

Arguments: command-name command-table &key (errorp t )

Summary: Returns the command-line name for command-name as it is installed in command-table . command-table is a command table designator.

If the command is not accessible in command-table or has no command-line name, then there are three possible results. If errorp is nil , then the returned value will be nil . If errorp is :create , then a command-line name will be generated, as described in add-command-to-command-table . Otherwise, if errorp is t , then the command-not-accessible error will be signaled. The returned command-line name should not be modified.

command-table-complete-input [Function]	

Arguments: command-table string action &key frame

Summary: A function that can be used as in conjunction with complete-input in order to complete over all of the command lines names accessible in the command table command-table . string is the input string to complete over, and action is as for complete-from-possibilities .

frame is either an application frame, or nil . If frame is supplied, no disabled commands should be offered as valid completions.


Common Lisp Interface Manager 2.0 User's Guide - 20 Sep 2011

NextPrevUpTopContentsIndex