Class

Summary

The class simple-pane is the superclass for any elements that actually appear as a native window, and is itself an empty window.

Superclasses

element

Subclasses

display-pane
interface
title-pane
button-panel
list-panel
option-pane
output-pane
progress-bar
slider
text-input-pane
tree-view
toolbar
layout
button

Initargs

:enabled

A boolean controlling whether the pane is enabled.

:background

The background color of the pane.

:foreground

The foreground color of the pane.

:font

The default font for the pane.

:horizontal-scroll

Non- nil if the pane can scroll horizontally.

:vertical-scroll

Non- nil if the pane can scroll vertically.

:visible-border

A boolean controlling whether the pane has a border.

:cursor

A keyword determining the cursor for the pane, or nil .

:pane-menu

Specfies a menu to be raised by the :post-menu gesture.

Accessors

simple-pane-enabled
simple-pane-background
simple-pane-foreground
simple-pane-font
simple-pane-cursor
simple-pane-scroll-callback

Readers

simple-pane-horizontal-scroll
simple-pane-vertical-scroll
simple-pane-visible-border

Description

enabled determines whether the pane is enabled. The default value is t . Note that changing the enabled state of a visible pane changes its appearance.

background and foreground colors specified using the graphics ports color system.

font should be font, a font description, or nil .

The value for visible-border can be any of the following:

nil

Has no border.

t

Has a border.

:default

Use the default for the window type.

Any simple pane can be made scrollable by specifying t to :horizontal-scroll or :vertical-scroll . By default these values are nil , but some subclasses of simple-pane default them to t where appropriate (for instance editor-pane s always default to having a vertical scroll-bar). The height and width of a scrollable simple pane can be specified by the initargs :scroll-height and :scroll-width , which have the same meaning as :internal-min-height and :internal-min-width . See the LispWorks CAPI User Guide for more information about height and width initargs.

cursor specifies a cursor for the pane. nil means use the default cursor, and this is the default value. The other allowed values are: :busy , :i-beam , :h-double-arrow , :v-double-arrow , :crosshair , :bottom-right-corner , :bottom-left-corner , :top-right-corner , :top-left-corner , :left-side , :right-side , :top-side , :bottom-side , :hand , and :move .

pane-menu can be used to specify or create a menu to be displayed when the :post-menu gesture is received by the pane. It has the default value :default which means that make-pane-popup-menu is called to create the menu. For a full description of pane-menu , see the section "Popup menus for panes" in the LispWorks CAPI User Guide .

In order to display a simple pane, it needs to be contained within an interface. The two convenience functions make-container and contain are provided to create an interface with enough support for that pane. The function make-container just returns a container for an element, and the function contain displays an interface created for the pane using make-container.

Examples

(capi:contain (make-instance 'capi:output-pane

                  :background :red

                  :scroll-width 300

                  :horizontal-scroll t))

(setf ep

      (capi:contain

       (make-instance 'capi:editor-pane

                      :visible-border t)))

(setf (capi:simple-pane-cursor ep) :crosshair)

See also

contain