1 CAPI Reference Entries

collector-pane

Class

Summary

Acollector-pane is aneditor-pane which displays the output sent to a particular type of character stream called an editor stream, the contents of which are stored in an editor buffer.

Superclasses

editor-pane

Slots

buffer-name: The name of a buffer onto an editor stream.
stream: The editor stream to be collected.

Readers

collector-pane-stream

Description

A newcollector-pane can be created to view an existing editor stream by passing the stream itself or by passing the buffer name of that stream.

To create a new stream, either specify abuffer-name of a non-existent stream or specify nothing, in which case the CAPI will create a unique buffer name for you. To then get hold of that stream, use the readercollector-pane-stream on thecollector-pane.

Note that the editor buffer "Background Output" is a buffer onto the output stream*standard-output*.

Examples

Here is an example that creates two collector panes onto a new stream (that is created by the first collector pane).

(setq collector (capi:contain
                 (make-instance 'capi:collector-pane)))

(setq *test-stream* 
  (capi:collector-pane-stream collector))

(capi:contain
  (make-instance 'capi:collector-pane
                 :stream *test-stream*))

(format *test-stream* "Hello World~%")

: Finally, this example shows how to create a collector pane onto the "Background Output" stream.

(capi:contain (make-instance 'capi:collector-pane
               :buffer-name "Background Output"))

See also
: with-random-typeout
map-typeout
unmap-typeout