Function

Summary

The display function displays a CAPI interface on a specified screen.

Package

capi

Signature

display interface &key screen owner window-styles process => interface

Arguments

interface

A CAPI interface.

screen

A screen, or any argument accepted by convert-to-screen.

owner

A CAPI interface.

window-styles

A list of keywords.

process

On Windows or Motif, a CAPI process, t or nil . On Cocoa, this argument is not supported.

Values

interface

A CAPI interface.

Description

The function display displays the CAPI interface interface on the specified screen (or the current one if not supplied).

If process is not supplied, then if owner is supplied interface runs in owner 's process, otherwise interface runs in the process of the parent of interface if it is a document-container, or in a new process created for interface if not.

On Windows and Motif, if process is t , then interface runs in a newly-created process. If process is nil , interface runs in the current process. Otherwise process is expected to be a CAPI process, and interface runs in it. A CAPI process is a mp:process which was created by calling display . You can pass only a CAPI process as process , because it needs to handle messages using the LispWorks event loop. The default value of process is t .

On Cocoa, all CAPI interfaces run in the Cocoa Event Loop process (which is the main thread of LispWorks) and therefore the process argument is not supported. If the value of process is any process other than the Cocoa Event Loop process an error is signalled.

owner specifies an owner for interface , which should be another CAPI interface. interface inherits a number of attributes from owner , including the default process, default screen and default display state.

window-styles , if supplied, sets the window-styles slot of interface . See interface for information about window-styles .

display returns its interface argument.

Note: Use the function contain to display objects other than interfaces.

Note: A generic function interface-display is called immediately after display displays an interface. You can add post-display code by defining your own :after method.

Example

(capi:display (make-instance 'capi:interface

                             :title "Test"))

See also

contain
convert-to-screen
display-dialog
document-container
execute-with-interface
interface
interface-display
quit-interface
*update-screen-interfaces-hooks*