Class

Summary

An editor pane is an editor that has all of the functionality described in the LispWorks Guide To The Editor .

Superclasses

output-pane

Subclasses

interactive-pane
collector-pane

Initargs

:text

The text in the editor pane.

:enabled

If t the editor pane will accept input from the mouse and keyboard.

:buffer-name

The name of the editor buffer.

:echo-area

A flag determining whether the editor pane has an Echo Area.

:fixed-fill

An integer specifying the fill length, or nil .

Accessors

editor-pane-text
editor-pane-enabled
editor-pane-fixed-fill

Description

The accessor editor-pane-text is provided to read and write the text in the editor buffer. The accessor editor-pane-enabled is used to enable and disable the editor (when it is disabled, it ignores all input from the mouse and keyboard).

The editor-pane stores text in buffers which are uniquely named, and so to create an editor-pane using an existing buffer you should pass the buffer-name . To create an editor-pane with a new buffer, pass a buffer-name that does not match any existing buffer. If buffer-name is not passed, then the editor-pane uses some existing buffer.

If echo-area is non- nil . then an Echo Area is added. echo-area defaults to nil .

If fixed-fill is non- nil , the editor pane tries to form lines of length close to, but no more than, fixed-fill . It does this by forcing line breaks at spaces between words. fixed-fill defaults to nil .

Note: editor panes support both GNU Emacs keys and MS Windows keys. Exactly one style of emulation is on any time for each editor pane. By default, editor panes in the Common LispWorks development environment use Emacs emulation on all platforms. By default, editor panes in delivered applications use Windows emulation on Windows, and Emacs emulation on other platforms. To alter the choice of emulation, see interface-keys-style.

Example

(capi:contain (make-instance 'capi:editor-pane

                             :text "Hello world"))

(setq editor (capi:contain

              (make-instance 'capi:editor-pane

                             :text "Hello world"

                             :enabled nil)

              :process nil))

(setf (capi:editor-pane-enabled editor) t)

(setf (capi:editor-pane-text editor)

                             "New text")

Also see the example in the directory examples/capi/editor/ .

See also

call-editor
*editor-cursor-active-style*
*editor-cursor-color*
*editor-cursor-drag-style*
*editor-cursor-inactive-style*
interface-keys-style
modify-editor-pane-buffer