Preface

This manual contains reference entries for the functions, classes, macros and accessors in the CAPI package and its sub-packages, and the graphics port package. Entries are listed alphabetically, and the typographical conventions used are similar to those used in Common Lisp: the Language (2nd Edition). Further details on the conventions used are given below. For a more tutorial approach to the CAPI with further examples see the LispWorks CAPI User Guide .

Note: Although the graphics-ports package is not strictly part of the CAPI , its reference entries are included in this manual because Graphics Port functions and macros are usually called from CAPI elements such as output panes. Please also see the relevant chapter in the LispWorks CAPI User Guide for further information on Graphics Ports.

Conventions used for reference entries

Each entry is headed by the symbol name and type, followed by a number of fields providing further details. These fields consist of a subset of the following: "Package", "Summary", "Syntax", "Superclasses", "Subclasses", "Slots", "Accessors", "Readers", "Compatibility Note", "Description", "Examples", and "See Also".

The default package containing each symbol is the capi package in the CAPI reference chapter, and the gp package in the graphics ports reference chapter, unless stated otherwise in the "Package" section of an entry.

Entries with a long "Description" section usually have as their first field a short "Summary" providing a quick overview of the purpose of the symbol being described.

The "Syntax" section provides details of the arguments taken by the functions and macros. Variable arguments for the command are printed like this .

Only immediate sub- and superclasses are detailed in the "Subclasses" and "Superclasses" sections of each CAPI class entry.

Examples of the use of commands are given under the "Examples" heading. Some example files can also be found in your installation directory under lib/4-2-0-0/examples/capi/ .

Finally, the "See also" section provides a reference to other related symbols.

The LispWorks manuals

The LispWorks manual set comprises the following books:

The LispWorks User Guide describes the features and tools available in LispWorks.
The LispWorks Reference Manual contains detailed information on all functions, macros, variables and classes available in LispWorks, in alphabetical order.
The Common LispWorks User Guide describes Common LispWorks, the user interface for LispWorks. Common LispWorks is a set of windowing tools that let you develop and test Common Lisp code more easily and quickly.
The LispWorks Editor User Guide describes the keyboard commands and programming interface to the Common LispWorks editor tool.
The LispWorks CAPI User Guide and the LispWorks CAPI Reference Manual describe the CAPI. This is a library of classes, functions, and macros for developing graphical user interfaces for your applications. The LispWorks CAPI User Guide is a tutorial guide to the CAPI, and the LispWorks CAPI Reference Manual is an in-depth reference text.
The LispWorks Foreign Language Interface User Guide and Reference Manual explains how you can use C source code in applications developed using LispWorks.
The LispWorks Delivery User Guide describes how you can deliver working, standalone versions of your LispWorks applications for distribution to your customers.
The LispWorks KnowledgeWorks and Prolog User Guide describes the LispWorks toolkit for building knowledge-based systems. Prolog is a logic programming system within Common Lisp.
The Common Lisp Interface Manager 2.0 User's Guide describes the portable Lisp-based GUI toolkit.
A set of installation notes explain how to install LispWorks and start it running, also containing a set of release notes is provided that documents last minute issues that could not be included in the main manual set.

These books are all available in online form, in HTML format and PS format.

Commands in the Help menu of any of the Common LispWorks tools give you direct access to the online documentation in HTML format, using the HTML browser that is supplied with LispWorks. Details of how to use these commands can be found in the Common LispWorks User Guide .

Please let us know if you find any mistakes in the LispWorks documentation, or if you have any suggestions for improvements.