Previous: Extending Clouseau, Up: Inspector


21.3 API

The following symbols are exported from the clouseau package:

— Function: inspector object &key new-process

Inspect object. If new-process is t, Clouseau will be run in a new process.

— Generic Function: inspect-object object pane

Display inspected representation of object to the extended output stream pane. This requires that *application-frame* be bound to an inspector application frame, so it isn't safe to use in other applications.

— Generic Function: inspect-object-briefly object pane

A brief version of inspect-object. The output should be short, and should try to fit on one line.

— Generic Function: define-inspector-command name args &rest body

This is just an inspector-specific version of define-command. If you want to define an inspector command for some reason, use this.

— Macro: inspector-table (object pane) header \body body

Present object in tabular form on pane, with header evaluated to print a label in a box at the top. body should output the rows of the table, possibly using inspector-table-row.

— Macro: inspector-table-row (pane) left right

Output a table row with two items, produced by evaluating left and right, on pane. This should be used only within inspector-table.

When possible, you should try to use this and inspector-table for consistency, and because they handle quite a bit of effort for you.