Function

Summary

The contain function creates a container for a CAPI element and is provided as a convenient way of testing CAPI functionality.

Signature

contain element &key screen process title &allow-other-keys

Description

This displays a window containing element and returns element as its result.

contain is mainly used during interactive sessions as a convenient way of testing CAPI functionality, and many of the CAPI examples use it for this purpose. The container is created using make-container, which can make containers for any of the following classes:

simple-pane
layout
interface
pinboard-object
menu
menu-item
menu-component
list

In the case of a list , the CAPI tries to see what sort of objects they are and makes an appropriate container. For instance, if they were all simple-panes it would put them into a column-layout.

The values of the arguments screen and process are passed to display when displaying the container. title is used as the title of the container.

Example

(capi:contain (make-instance 'capi:text-input-pane))

(capi:contain (make-instance

               'capi:column-layout

               :description `("Title:"

                              ,(make-instance

                                'capi:text-input-pane))))

(capi:contain (make-instance 'capi:menu-item)

              :title "Test")

See also

make-container
display
element