Class

Summary

A collector-pane is an editor-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.

Package

capi

Superclasses

editor-pane

Initargs

:buffer-name

The name of a buffer onto an editor stream.

:stream

The editor stream to be collected.

Readers

collector-pane-stream

Description

A new collector-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 buffer-name which does not match any existing buffer, or do not pass buffer-name in which case the CAPI will create a unique buffer name for you.

To access the stream, use the reader collector-pane-stream on the collector-pane.

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

Example

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
Stream panes