CAPI (Common Application Programmer's Interface)

https://www.lispworks.com/documentation/lw81/capi-m/capi.htm
Admin
CAPI is a Common Lisp toolkit for building graphical user interfaces (GUIs), providing functionality...
Tokens:3,318,958
Snippets:16,188
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Examples of Starting KnowledgeWorks Environment

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-u/kw-ref-59

Illustrates how to call the `start-kw` function to initialize the KnowledgeWorks programming environment, both with and without specifying a host.

```Lisp
(start-kw)
```

```Lisp
(start-kw :hostname "display1:0")
```

--------------------------------

### Open CAPI Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-getting-started-ug

This Lisp function opens an example file related to CAPI elements for editing. It's used to access extended example code mentioned in the guide, providing practical examples for learning CAPI.

```Lisp
(example-edit-file "capi/elements/")
```

--------------------------------

### Open CAPI Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-getting-started-ug

This Lisp function is used to open a specified CAPI example file for editing. It provides a convenient way to access and work with extended example code, particularly those demonstrating CAPI elements.

```Lisp
(example-edit-file "capi/elements/")
```

--------------------------------

### Open CAPI Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-getting-started-ug

This Lisp function is used to open and edit an example file located within the 'capi/elements/' directory. It provides a quick way to access and review extended example code for CAPI applications.

```Lisp
(example-edit-file "capi/elements/")
```

--------------------------------

### Accessing LispWorks Example Files

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/com/com-about

This snippet demonstrates how to open and view example files provided with the LispWorks installation. These files are located under `lib/8-1-0-0/examples/` and contain instructions for their use. Users should compile them within the IDE or copy them to a writable directory before manipulation.

```Common Lisp
(example-edit-file "com/automation/events/ie-events")
```

--------------------------------

### Example Lisp Code for Printing Setup

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-capi-ref-306

Demonstrates how to access a printing example file related to the CAPI's simple print port functionality.

```Lisp
(example-edit-file "capi/printing/simple-print-port")
```

--------------------------------

### Load CAPI Simple Graph Pane Example (Choice)

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads the `simple-graph-pane` example file from the CAPI choice directory, illustrating a straightforward graph pane setup, often used for basic demonstrations.

```Lisp
(example-edit-file "capi/choice/simple-graph-pane")
```

--------------------------------

### Lisp Example for Java DLL Setup Documentation

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-lw-ji-89

A minimal Lisp example demonstrating how to access documentation for delivering LispWorks for Java, pointing to a README file.

```Lisp
(example-edit-file "java/lisp-as-dll/README.txt")
```

--------------------------------

### CAPI Grid Prototype Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-13

Opens the source code for a prototype grid implementation example within the CAPI framework, showcasing basic grid functionality.

```Lisp
(example-edit-file "capi/elements/grid")
```

--------------------------------

### Open LispWorks Example Source File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-preface

This Lisp form is used to open and view example source files provided within the LispWorks installation. It takes a string representing the relative path to an example file (e.g., 'ssl/ssl-client') and opens it for editing or viewing. These files are located under the 'lib/8-1-0-0/examples/' directory of your LispWorks installation.

```Lisp
(example-edit-file "ssl/ssl-client")
```

--------------------------------

### Load CAPI Simple Graph Pane Example (Customization Context)

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads the `simple-graph-pane` example from the CAPI choice directory, presented in the context of demonstrating further customization possibilities for graph panes.

```Lisp
(example-edit-file "capi/choice/simple-graph-pane")
```

--------------------------------

### CAPI Grid Implementation Details Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-13

Opens the source code detailing the implementation of the CAPI prototype grid, providing insight into its internal workings.

```Lisp
(example-edit-file "capi/elements/grid-impl")
```

--------------------------------

### Display a simple CAPI editor pane

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-11

This example demonstrates how to open a basic editor pane using the `example-edit-file` function, loading a predefined example file for a simple editor setup.

```Lisp
(example-edit-file "capi/editor/editor-pane")
```

--------------------------------

### Load CAPI Basic Graph Pane Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads the `graph-pane` example file from the CAPI graphics directory, demonstrating fundamental graph functionality and display.

```Lisp
(example-edit-file "capi/graphics/graph-pane")
```

--------------------------------

### start-kw Function API Documentation

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-u/kw-ref-59

Detailed API documentation for the `start-kw` function, including its signature, arguments, and behavior when starting the KnowledgeWorks programming environment.

```APIDOC
Function: start-kw
Summary: Starts the KnowledgeWorks programming environment.
Package: kw
Signature: start-kw &key host
Arguments:
  host: A string.
Description: The function `start-kw` starts the KnowledgeWorks programming environment from the initial prompt when the KnowledgeWorks image is started. If the LispWorks IDE is already running, `start-kw` adds the KnowledgeWorks menu so that the podium becomes the KnowledgeWorks Podium.

On GTK+ and Motif the environment is displayed on the machine specified by host, defaulting to the machine on which the KnowledgeWorks image is running. Other platforms ignore host.
```

--------------------------------

### Start LispWorks CORBA Server

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/corba/corba-hellowld-1

The command to execute the `server-startup` function, which initializes the CORBA ORB and activates the server, making it ready to accept client connections.

```Lisp
(cl-user::server-startup)
```

--------------------------------

### Load KnowledgeWorks Tutorial System

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-m/kw-tutorial-2

This sequence of Lisp commands guides the user through initializing the KnowledgeWorks Listener, navigating to the tutorial's directory, and then compiling and loading the 'ANIMAL' demo system. It involves changing the Lisp package, setting the working directory, loading the system definition, and finally compiling the system.

```Lisp
(in-package "KW-USER")
```

```Lisp
(cd (lispworks:example-file "kw/animal/"))
```

```Lisp
(load "defsystem")
```

```Lisp
(compile-system "ANIMAL" :load t :target-directory (get-temp-directory))
```

--------------------------------

### Locate CORBA Bank Example Code Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/corba/corba-bank-setup-2

This snippet provides the relative path within the LispWorks installation where the CORBA bank example code is stored. The specified directory contains the core IDL definition, client implementation, and server implementation in separate subfolders.

```Shell
lib/8-1-0-0/examples/corba
```

--------------------------------

### Load Basic CAPI Editor Pane Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-11

This Lisp code loads a basic example demonstrating the core functionality of the CAPI `editor-pane`. It uses the `example-edit-file` function to open the 'capi/editor/editor-pane' file, which presumably contains the definition and setup for a simple editor pane.

```Lisp
(example-edit-file "capi/editor/editor-pane")

```

--------------------------------

### CAPI Choice: Basic Option Pane

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-9

Provides a fundamental example of a CAPI option pane. This example covers the basic setup and usage of a selectable choice component, demonstrating its core functionality.

```Lisp
(example-edit-file "capi/choice/option-pane")
```

--------------------------------

### Open CAPI Prompt with Buttons Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-examples-ug-10

This Lisp command opens the source file for a CAPI example that illustrates how to customize a prompt, specifically `prompt-with-list`, by adding custom buttons. This demonstrates advanced prompt interaction and customization.

```Lisp
(example-edit-file "capi/choice/prompt-with-buttons")
```

--------------------------------

### Example: Get COM Interface Name for IUnknown GUID

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/com/com-com-ref-41

Demonstrates how to use `refguid-interface-name` with a `refguid` object created from a string representation of the IUnknown GUID, showing its return value.

```Lisp
(refguid-interface-name
 (make-guid-from-string
  "00000000-0000-0000-C000-000000000046"))
=> i-unknown
```

--------------------------------

### Example of using page-setup-dialog in Lisp

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-capi-ref-306

This example shows how to open a file related to CAPI printing examples, likely containing a call to `page-setup-dialog` or related printing functionality.

```Lisp
(example-edit-file "capi/printing/simple-print-port")
```

--------------------------------

### Open Hello World CORBA Example Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/corba/corba-hellowld-1

This Common Lisp command opens the directory containing the 'Hello World' CORBA example files within the LispWorks environment, facilitating access to the project's source code.

```Common Lisp
(example-edit-file "corba/hello-world/")
```

--------------------------------

### Open CAPI Graphics Graph Pane Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-6

This Lisp code opens the 'graph-pane' example file located in 'capi/graphics'. It demonstrates a basic graph pane functionality within the CAPI library, serving as a simple starting point for graph visualizations.

```Lisp
(example-edit-file "capi/graphics/graph-pane")
```

--------------------------------

### Complete LispWorks CORBA Server Implementation

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/corba/corba-hellowld-1

Provides the full Lisp code for `hello-world-server.lisp`, including package definition, the `world-implementation` servant class, the `op:hello` method, and the `server-startup` function responsible for ORB initialization, POA activation, and object registration.

```Lisp
(in-package "CL-USER")

(defclass world-implementation (HelloWorld:world-servant) ())

(corba:define-method op:hello ((self world-implementation))
  (declare (ignore self))
  "Hello World!")

(defun server-startup ()
  (let* ((orb (op:orb_init nil "LispWorks ORB"))
         (poa (op:resolve_initial_references orb "RootPOA"))
         (impl (make-instance 'world-implementation))
         (world (op:narrow 'HelloWorld:world
                           (op:servant_to_reference poa impl))))
    (object-to-file orb world)
    (let ((manager (op:the_poamanager poa)))
      (op:activate manager))))
```

--------------------------------

### Locate LispWorks Example Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/rnig/rnig-about-shared-3

This Lisp code snippet helps users find the 'examples' directory within their LispWorks installation. Evaluating this expression in a LispWorks Listener will return the file path to the directory containing various demonstration examples, which can be copied and modified for custom use.

```Lisp
(example-file "")

```

--------------------------------

### Open Example for Output Pane Tooltips (Lisp)

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-common-elements-ug-12

This Lisp expression is a command to open an example file named 'pinboard-help'. This file demonstrates the implementation of tooltips specifically for CAPI output panes, particularly when dealing with pinboard layouts where tooltip content might vary based on the cursor's position or the underlying pinboard objects.

```Lisp
(example-edit-file "capi/graphics/pinboard-help")
```

--------------------------------

### Lisp CAPI Example: Multi-Column List Panel

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-examples-ug-9

Demonstrates the creation and usage of multi-column list panels in CAPI, allowing for tabular data display with distinct columns. This example file provides a basic setup for such panels, useful for structured data presentation.

```Lisp
(example-edit-file "capi/choice/multi-column-list-panels")
```

--------------------------------

### Open LispWorks Example Source File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/ide-w/ide-preface

This snippet demonstrates how to open a LispWorks example source file for viewing. These files are located in the LispWorks installation under `lib/8-1-0-0/examples/` and are read-only. Users should compile them within the IDE (e.g., via 'Compile Buffer' command) to avoid attempting to write a fasl file, or copy them elsewhere for modification.

```Lisp
(example-edit-file "tools/demo-defsys")
```

--------------------------------

### API Documentation for page-setup-dialog Function

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-capi-ref-306

Detailed API reference for the `page-setup-dialog` function in the CAPI package, including its signature, parameters, and behavior.

```APIDOC
Function: page-setup-dialog
Package: capi
Signature: page-setup-dialog &key screen owner printer continuation

Arguments:
  screen: A screen or any argument accepted by convert-to-screen. The CAPI screen on which to display the dialog.
  owner: A pane or nil. Specifies an owner window for the dialog.
  printer: A printer or nil. The printer for which to display the dialog. If not specified, the dialog for the current printer is displayed.
  continuation: A function or nil. If non-nil, it must be a function with a lambda list that accepts one argument. continuation is called with the values that would normally be returned by page-setup-dialog. On Cocoa, passing continuation causes the dialog to be made as a window-modal sheet and display-dialog returns immediately.

Description:
  The function page-setup-dialog displays the page setup dialog for printer. If printer is not specified, the dialog for the current printer is displayed.
  The CAPI screen on which to display the dialog is given by screen, which is the current screen by default.
  owner specifies an owner window for the dialog. See "10 Dialogs: Prompting for Input" for details.
  If continuation is non-nil, then it must be a function with a lambda list that accepts one argument. continuation is called with the values that would normally be returned by page-setup-dialog. On Cocoa, passing continuation causes the dialog to be made as a window-modal sheet and display-dialog returns immediately, leaving the dialog on the screen. The with-dialog-results macro provides a convenient way to create a continuation function.
```

--------------------------------

### Open LispWorks Example File in Editor

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/editor-w/editor-intro-3

This Lisp form allows users to open and view example source files from the LispWorks library directly within the editor. The files are located in the `lib/8-1-0-0/examples/` directory of your LispWorks installation. These example files are read-only; to modify or compile them on disk, they must first be copied to a writable location. Otherwise, they should be compiled within the IDE to avoid issues with writing fasl files.

```Lisp
(example-edit-file "editor/commands/space-show-arglist")
```

--------------------------------

### Load CAPI Examples from Output Panes Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-capi-ref-298

This LispWorks CAPI example demonstrates how to load and run examples from a specific directory. It uses `example-edit-file` to open the 'capi/output-panes/' directory, implying that further examples related to output panes can be found and executed from there.

```Lisp
(example-edit-file "capi/output-panes/")
```

--------------------------------

### View LispWorks Example Source File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-w/kw-introduction-2

This Lisp form provides a convenient way to open and view example source files that are part of the LispWorks installation. These files are typically located in a read-only directory, so for modification or disk compilation, they must first be copied to a writable location.

```Lisp
(example-edit-file "kw/animal/defsystem")

```

--------------------------------

### API Reference for LispWorks LW-JI Java Caller/Constructor Setup

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-lw-ji-91

Detailed API documentation for `setup-java-caller` and `setup-java-constructor` functions in the LispWorks LW-JI package. Includes signatures, arguments, return values, and behavioral notes.

```APIDOC
setup-java-caller:
  Summary: Define a Java caller, which is a function that calls a Java method.
  Package: lw-ji
  Signature: setup-java-caller name class-name method-name &key signatures static-p return-jobject non-virtual-p => result, condition
  Arguments:
    name: A symbol.
    class-name: A string.
    method-name: A string.
    signatures: A list of strings.
    static-p: `t`, `nil` or `:either` (the default).
    return-jobject: A boolean, default `nil`.
    non-virtual-p: A boolean. default `nil`.
  Values:
    result: name or `nil`.
    condition: A condition object.
  Description: Defines a Lisp function that invokes a specified Java method. This function performs an immediate lookup of the Java method, requiring a running Java environment. If the lookup fails, it returns `nil` and a condition indicating the failure reason.

setup-java-constructor:
  Summary: Define a Java caller, which is a function that calls a constructor.
  Package: lw-ji
  Signature: setup-java-constructor name class-name &key class-symbol signatures => result, condition
  Arguments:
    name: A symbol.
    class-name: A string.
    signatures: A list of strings.
    class-symbol: A symbol.
  Values:
    result: name or `nil`.
    condition: A condition object.
  Description: Defines a Lisp function that invokes a specified Java constructor. This function performs an immediate lookup of the Java constructor, requiring a running Java environment. If the lookup fails, it returns `nil` and a condition indicating the failure reason.
```

--------------------------------

### View LispWorks Example Source File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-m/kw-introduction-2

This Lisp form provides a convenient way to open and view example source files that are part of the LispWorks library. These files are typically located in a read-only directory within the LispWorks installation, meaning they should be compiled within the IDE or copied to a writable location if disk compilation is desired.

```Lisp
(example-edit-file "kw/animal/defsystem")

```

--------------------------------

### Load ASDF Integration Example File in LispWorks

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/ide-w/ide-system-9

This LispWorks function call loads the example file for ASDF integration, demonstrating how to enable ASDF within the LispWorks IDE's System Browser. It provides a quick way to get started with ASDF support without needing to delve into the full interface description immediately.

```Lisp
(lw:example-file "misc/asdf-integration.lisp")
```

--------------------------------

### MyApplication Class: LispWorks Initialization Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-android-ug-4

The `MyApplication` class serves as an example for initializing LispWorks at the application's startup. It demonstrates calling `com.lispworks.Manager.init` within the application's `onCreate` method to ensure the Lisp environment is set up early in the application lifecycle.

```APIDOC
Class MyApplication
  Purpose: Demonstrates LispWorks initialization at application startup.

  Methods & Interactions:
    - `onCreate()`: Calls `com.lispworks.Manager.init` to initialize LispWorks.
```

--------------------------------

### Open LispWorks Library Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/ide-u/ide-preface

This Lisp form is used to open and view an example source file from the LispWorks library. These files are located in the `lib/8-1-0-0/examples/` directory of your LispWorks installation. Since they are read-only, it's recommended to compile them within the IDE to prevent attempts at writing fasl files, or to copy them to a writable location for external manipulation.

```Lisp
(example-edit-file "tools/demo-defsys")
```

--------------------------------

### Start LispWorks IDE Environment

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/ide-u/ide-tutorial

Demonstrates how to start the LispWorks IDE environment from the command line or a script, ensuring the `DISPLAY` POSIX environment variable is correctly set for GUI operation.

```Lisp
(env:start-environment)

```

--------------------------------

### View LispWorks FLI Example Files

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/fli/fli-preface

This Lisp form allows users to open and view example source files related to the Foreign Language Interface (FLI) directly within the LispWorks environment. These files are read-only and located in the LispWorks installation's examples directory. Users should compile them within the IDE to avoid issues with writing fasl files to a read-only location. To manipulate or compile on disk, the file must first be copied.

```Lisp
(example-edit-file "fli/foreign-callable-example")
```

--------------------------------

### LispWorks SSL Example File References

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-comm-49

Shows how to load pre-defined example files for SSL certificate and server configurations using the `example-file` utility in LispWorks.

```Lisp
(example-file "ssl/ssl-certificates")
(example-file "ssl/ssl-server")
```

--------------------------------

### Opening General CAPI Choice Examples Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi/capi-capi-ref-236

This snippet utilizes `example-edit-file` to open the directory containing various CAPI choice-related examples, providing access to a broader set of demonstrations.

```Lisp
(example-edit-file "capi/choice/")
```

--------------------------------

### Lisp Example: Convert COM Interface GUID to String

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/com/com-com-ref-27

This Lisp example demonstrates the usage of the `guid-to-string` function. It shows how to obtain the GUID of the `i-unknown` COM interface using `com-interface-refguid` and then convert it into its standard string representation.

```Lisp
(guid-to-string (com-interface-refguid 'i-unknown))
=> "00000000-0000-0000-C000-000000000046"
```

--------------------------------

### Load and Start CLIM Demos

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/clim/clim-ch1-7

Instructions to load the CLIM demo software and start the main demo application in a Lisp listener. This will create a new window with a menu listing all available demos.

```Common Lisp
(require "clim-demo")

(clim-demo:start-demo)
```

--------------------------------

### LispWorks COM: Compare I-UNKNOWN GUID with String-Generated GUID

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/com/com-com-ref-26

This example illustrates the use of `guid-equal` to compare the GUID of the `i-unknown` interface with a GUID created from its canonical string representation. This comparison should return `t` if the string accurately represents the `i-unknown` GUID.

```Lisp
(guid-equal (com-interface-refguid 'i-unknown)
            (make-guid-from-string
             "00000000-0000-0000-C000-000000000046"))
=> t
```

--------------------------------

### Run Forward Chaining Inference Engine with Specific Contexts (Lisp)

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/kw-u/kw-ref-24

This Lisp example demonstrates how to invoke the `infer` function, specifying a list of contexts for the forward chaining inference engine to use. The function will process rules starting from the first context provided.

```Lisp
(infer :contexts '(my-context another-context))
```

--------------------------------

### Load CAPI Menu with Images Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-capi-ref-265

This snippet shows how to load a pre-existing example file that demonstrates creating menus with images. This is useful for exploring more complex features not fully detailed in the current document, providing a ready-to-run demonstration.

```Lisp
(example-edit-file "capi/elements/menu-with-images")
```

--------------------------------

### Open CAPI 'Hello World' Application Delivery Examples

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/deliv/deliv-examples-ug

These Lisp commands open the example files for building a basic CAPI 'Hello World' application. The set includes the README, the delivery script, and the main application code, all accessible via the `example-edit-file` function for easy viewing and modification within the LispWorks IDE.

```Lisp
(example-edit-file "delivery/hello/README.txt")
(example-edit-file "delivery/hello/deliver")
(example-edit-file "delivery/hello/hello")
```

--------------------------------

### Get Editor Buffer Start Point

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/editor-u/editor-advanced-3

Returns the starting point (position) of the specified editor buffer.

```APIDOC
editor:buffers-start Function
editor:buffers-start buffer => point
```

--------------------------------

### Lisp Examples for count-regexp-occurrences

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-lispworks-21

Illustrative Lisp code examples demonstrating the usage of `count-regexp-occurrences` with various parameters like `overlap` and `start`, and a real-world file processing example.

```Lisp
(count-regexp-occurrences "aaa" "aaaaa")
=>
1

(count-regexp-occurrences "aaa" "aaaaa" :overlap t)
=>
3

(count-regexp-occurrences "12" "81267124")
=>
2

(count-regexp-occurrences "12" "81267124" :start 4)
=>
1

(let* ((path (example-file
              "capi/elements/text-input-pane.lisp"))
       (file-string (file-string path)))
  (count-regexp-occurrences ":title" file-string))
=>
20   ; in LispWorks 7.1
```

--------------------------------

### Load CAPI Output Panes Examples Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-capi-ref-298

This snippet shows how to open the directory containing further CAPI output pane examples using the `example-edit-file` function, providing access to additional demonstrations.

```Lisp
(example-edit-file "capi/output-panes/")
```

--------------------------------

### Open CAPI Pinboard Help Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-common-elements-ug-12

This Lisp expression calls `example-edit-file` to open the 'capi/graphics/pinboard-help' file. This file serves as an example demonstrating the implementation of tooltips for CAPI output panes, particularly within a `pinboard-layout`, by utilizing the `display-tooltip` function via a `:motion` gesture.

```Lisp
(example-edit-file "capi/graphics/pinboard-help")
```

--------------------------------

### Run LispWorks CORBA Client

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/corba/corba-hellowld-1

The command to execute the `run-client` function, which initiates the CORBA client to interact with the running server.

```Lisp
(cl-user::run-client)
```

--------------------------------

### LispWorks Editor: Get Buffer Start Point

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/editor/editor-advanced-3

Returns the starting point (position) of a specified LispWorks editor buffer.

```APIDOC
editor:buffers-start Function
  Parameters:
    buffer: The buffer object.
  Returns: point
  Description: Returns the starting point of buffer.
```

--------------------------------

### Load CAPI General Graph Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-20

Loads a Lisp example file showcasing the creation and display of general graphs with CAPI Graphic Tools. This snippet is used to access and review the example's source code.

```Lisp
(example-edit-file "graphic-tools/graph-example")

```

--------------------------------

### Referencing CAPI Example Files

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-capi-ref-72

Demonstrates how to open a specific CAPI example file from the LispWorks installation directory using the `example-edit-file` utility function. This is useful for exploring pre-built CAPI examples.

```Common Lisp
(example-edit-file "capi/applications/argument-passing")
```

--------------------------------

### Lisp Application Startup with COM Server Registration

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/com/com-com-ref-44

This Lisp example demonstrates a `start-up-function` that handles command-line arguments for registering or unregistering COM servers. It checks for `/RegServer` to call `register-server` and `/UnRegServer` to call `unregister-server`, otherwise it initializes COM, starts factories, and enters the application's main loop.

```Lisp
(defun start-up-function ()
  (cond ((member "/RegServer"
                 system:*line-arguments-list*
                 :test 'equalp)
         (register-server))
        ((member "/UnRegServer"
                 system:*line-arguments-list*
                 :test 'equalp)
         (unregister-server))
        (t
         (co-initialize)
         (start-factories)
         (start-application-main-loop)))
  (quit))
```

--------------------------------

### Load CAPI Labelled Graph Edges Customization Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads an example showing how to customize the `graph-pane` by adding descriptive labels to graph edges, enhancing readability.

```Lisp
(example-edit-file "capi/graphics/labelled-graph-edges")
```

--------------------------------

### Load CAPI Circled Graph Nodes Customization Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads an example demonstrating how to customize the `graph-pane` by rendering graph nodes as circles, showcasing visual modifications.

```Lisp
(example-edit-file "capi/graphics/circled-graph-nodes")
```

--------------------------------

### LispWorks CAPI Simple Editor Pane Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-examples-ug-11

Demonstrates the basic setup and usage of a simple editor pane within the LispWorks CAPI environment. This snippet loads a predefined example file.

```Lisp
(example-edit-file "capi/editor/editor-pane")
```

--------------------------------

### Load CAPI Graph Color Edges Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads an example demonstrating how to change the appearance of graph edges by applying different colors, illustrating visual customization of connections.

```Lisp
(example-edit-file "capi/graphics/graph-color-edges")
```

--------------------------------

### Loading CAPI Accelerator Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-capi-ref-267

Provides the Lisp command to load an example file demonstrating the practical usage of accelerators and alternative menu items within the CAPI framework. This is useful for developers seeking to understand real-world implementations and advanced features.

```Lisp
(example-edit-file "capi/elements/accelerators")
```

--------------------------------

### Open CAPI Output Panes Examples Directory

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi/capi-capi-ref-298

This example shows how to open the directory containing further CAPI output pane examples, providing access to more demonstrations.

```Lisp
(example-edit-file "capi/output-panes/")
```

--------------------------------

### API Documentation for example-load-binary-file Function

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-lispworks-46

Detailed API reference for the `example-load-binary-file` function in LispWorks, including its signature, arguments, return values, and a description of its behavior and interaction with `example-compile-file` and `load`.

```APIDOC
Function: example-load-binary-file
Summary: Loads a fasl file compiled by example-compile-file.
Package: lispworks
Signature: example-load-binary-file file => result

Arguments:
  file: A pathname designator.

Values:
  result: A generalized boolean.

Description:
The function `example-load-binary-file` constructs the path to an output file associated with file, but in the temporary location that would be used as the output-file by example-compile-file.
It then calls load on that path, and returns the value result returned by load.

See also:
  example-compile-file
```

--------------------------------

### CAPI Choice: Stacked Tree View Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-9

Illustrates the usage of a `stacked-tree` component in CAPI. This example demonstrates how to create a hierarchical view where levels can be expanded or collapsed for better organization.

```Lisp
(example-edit-file "capi/choice/stacked-tree")
```

--------------------------------

### CAPI image-list Example File References

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-capi-ref-195

Examples demonstrating the usage of the `image-list` class by referencing example files within the CAPI choice directory, useful for understanding practical implementations.

```Lisp
(example-edit-file "capi/choice/tree-view")
(example-edit-file "capi/choice/extended-selection-tree-view")
```

--------------------------------

### page-setup-dialog Function API Reference

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-capi-ref-306

Detailed API documentation for the `page-setup-dialog` function in CAPI, including its signature, arguments, and behavior.

```APIDOC
Function: page-setup-dialog
  Package: capi
  Summary: Displays the page setup dialog for a given printer.
  Signature: page-setup-dialog &key screen owner printer continuation
  Arguments:
    screen: A screen or any argument accepted by convert-to-screen.
    owner: A pane or nil.
    printer: A printer or nil.
    continuation: A function or nil.
  Description:
    The function page-setup-dialog displays the page setup dialog for printer. If printer is not specified, the dialog for the current printer is displayed.
    The CAPI screen on which to display the dialog is given by screen, which is the current screen by default.
    owner specifies an owner window for the dialog. See 10 Dialogs: Prompting for Input for details.
    If continuation is non-nil, then it must be a function with a lambda list that accepts one argument. continuation is called with the values that would normally be returned by page-setup-dialog. On Cocoa, passing continuation causes the dialog to be made as a window-modal sheet and display-dialog returns immediately, leaving the dialog on the screen. The with-dialog-results macro provides a convenient way to create a continuation function.
```

--------------------------------

### Load CAPI Bar Chart Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-w/capi-examples-ug-20

Loads a Lisp example file that demonstrates how to create and display bar charts using the CAPI Graphic Tools. This snippet is typically used to open and explore the example code within the LispWorks environment.

```Lisp
(example-edit-file "graphic-tools/bar-chart-example")

```

--------------------------------

### Open Example for Toolbar Button Tooltips (Lisp)

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-common-elements-ug-12

This Lisp expression is a command to open an example file named 'simple-symbol-browser'. This file illustrates how to specify tooltips for toolbar buttons, especially when these buttons are grouped within a `toolbar-component` and the `:tooltips` initialization argument is used.

```Lisp
(example-edit-file "capi/applications/simple-symbol-browser")
```

--------------------------------

### Load CAPI Wiggly Line Graph Edges Customization Example

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-6

Loads an example illustrating how to customize the `graph-pane` to display graph edges as wiggly lines, demonstrating advanced visual styling.

```Lisp
(example-edit-file "capi/graphics/wiggly-line-graph")
```

--------------------------------

### Simple Printing Example in CAPI Lisp

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-u/capi-examples-ug-19

This snippet provides a command to open the source file for a basic printing example in the CAPI Lisp environment. It's useful for understanding the fundamental setup for printing operations.

```Lisp
(example-edit-file "capi/printing/simple-print-port")
```

--------------------------------

### Open CAPI Network Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/capi-m/capi-capi-ref-451

Demonstrates how to open an example file related to CAPI graphics and network functionalities using `example-edit-file`.

```Lisp
(example-edit-file "capi/graphics/network")
```

--------------------------------

### Open LispWorks Stream Example File

Source: https://www.lispworks.com/documentation/lw81/capi-m/capi.htm/lw/lw-examples-ug-2

This LispWorks command opens the source code for the 'buffered-stream' example, allowing users to inspect or modify the implementation of buffered stream operations within the LispWorks environment. It's a utility function to quickly navigate to example code.

```Lisp
(example-edit-file "streams/buffered-stream")
```
Tokens:
Raw