NextPrevUpTopContentsIndex

simple-pane

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.

Package

capi

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

t , :without-bar , or nil . If true the pane can scroll horizontally.

:vertical-scroll

t , :without-bar , or nil . If true the pane can scroll vertically.

:visible-border

A boolean controlling whether the pane has a border.

:internal-border

A non-negative integer, or nil . Controls the width of the internal 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 are colors specified using the Graphics Ports color system. Additionally on Cocoa, the special value :transparent is supported, which makes the pane's background match that of its parent.

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.

If internal-border is non- nil , it should be a non-negative integer specifying the width of an empty region around the edge of the pane.

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

For a pane which is scrollable but does not display a scroll bar, pass the value :without-bar for :horizontal-scroll or :vertical-scroll . See the example in output-panes/scrolling-without-bar.lisp .

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 supported on each platform as shown in the table below.

 

 

cursor

Cocoa

Windows

Motif

:busy

No

Yes

Yes

:i-beam

Yes

Yes

Yes

:top-left-arrow

Yes

Yes

Yes

:h-double-arrow

Yes

Yes

Yes

:v-double-arrow

Yes

Yes

Yes

:left-side

Yes

Yes

Yes

:right-side

Yes

Yes

Yes

:top-side

Yes

Yes

Yes

:bottom-side

Yes

Yes

Yes

:wait

No

Yes

Yes

:crosshair

Yes

Yes

Yes

:gc-notification

No

Yes

Yes

:top-left-corner

No

Yes

Yes

:top-right-corner

No

Yes

Yes

:bottom-left-corner

No

Yes

Yes

:bottom-right-corner

No

Yes

Yes

:hand

Yes

Yes

Yes

:fleur

Yes

Yes

Yes

:move

Yes

Yes

Yes

:closed-hand

Yes

No

No

:open-hand

Yes

No

No

:disappearing-item

Yes

No

No

Note: On Cocoa in Mac OS X 10.2, only :i-beam is supported.

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


LispWorks CAPI Reference Manual - 11 Apr 2005

NextPrevUpTopContentsIndex