Preface

This manual contains reference entries for the functions, classes, macros and accessors in the


capi

package, and the


graphics-ports

and


color

packages. 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

and


color

packages are not strictly part of the CAPI, they are included in this manual because the functionality is usually called from CAPI elements such as output panes. Please also see the relevant chapters in the LispWorks CAPI User Guide for further information on Graphics Ports and the LispWorks Color System.

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", "Signature", "Arguments", "Values","Initial Value", "Superclasses", "Subclasses", "Initargs", "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 so on, unless stated otherwise in the "Package" section of an entry.

Throughout, variable arguments are italicised. They look like this in the Description.

Throughout, exported symbols are printed like-this . The package qualifier is usually omitted, as if the current package is capi (or graphics-ports or color .)

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 "Signature" section provides details of the arguments taken by the functions and macros.

The "Subclasses" section of each CAPI class entry lists the external subclasses, though not subclasses of those.

The "Superclasses" sections of each CAPI class entry lists the external superclasses, though not superclasses of those.

The "Initargs" section describes the initialization arguments of the class. Initargs of superclasses are also valid.

Note: in LispWorks4.2 and previous versions, the "Initargs" section was headed "Slots".

Examples of the use of commands are given under the "Examples" heading. The code is written with explicit package qualifiers such as capi:interface , so that it can be run as-is, regardless of the current package. Some example files can also be found in your installation directory under 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 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.

These books are all available in online form, in both HTML format and PDF format. Also in PDF and plain text format is:

The LispWorks Release Notes and Installation Guide which contains notes explaining how to install LispWorks and get it running. It also contains a set of release notes which lists new features and any last minute issues that could not be included in the main manual set.

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 .

Documentation is also provided in PDF form. You can use Adobe® Reader® to browse the PDF documentation online or to print it. Adobe Reader is available from Adobe's web site, http://www.adobe.com/ .

Please let us know at lisp-support@lispworks.com if you find any mistakes in the LispWorks documentation, or if you have any suggestions for improvements.