All Manuals > CAPI User Guide

NextPrevTopContents

Index

A

abort-dialog function 118

:accelerator initarg 85

:action-callback initarg 41 , 45 , 48

:alternative initarg 85

:alternative-action-callback initarg 48

Application menu

for LispWorks applications 89

apply-in-pane-process function 25 , 69

apply-in-pane-process-if-alive function 25 , 69

apropos-color-alias-names function 167

apropos-color-names function 166

apropos-color-spec-names function 167

augment-font-description function 155

:auto-menus initarg 88

B

balloon help 23

:best-height initarg 132

:best-width initarg 132

boole function 152

break gesture 29

browser-pane class 20

bubble help 23

:buffer-name initarg 19

button panels

orientation 35

prompting with 112 - 113

button-panel class 34

buttons

check 21

push 21

radio 22

:buttons initarg 18

C

:callback initarg 17

callbacks

description of 8

general properties 48

graph panes 44

in interfaces 100 - 103

used for choices 39 - 41

using callback functions 11

:callback-type initarg 48 , 118

call-editor function 100

call-editor generic function 124

CAPI

basic objects 3

description of 1 - 3

linking code into 8

menu hierarchy 82

using the 5 - 6

check button panels 35

check buttons 21

check-button class 21 , 34

check-button-panel class 34 , 35 , 40 , 47

:children-function initarg 43

choice class 33

:choice-class initarg 112

choice-interaction accessor 47

choices 33 - 49

callbacks available 48

description of 33 - 49

general properties 47 - 49

relationship to menus 46

choice-selected-item accessor 48

choice-selected-items accessor 48

choice-selection accessor 41 , 48

classes

collections 34

creating your own 129 - 143

clear-external-image-conversions function 159

CLUE 2

clues 23

CLX 2

collection class 33

collection-items accessor 73

collections

description of 33

collector panes 20

collector-pane class 20

colors

prompting for 114

colors= function 170

color-spec-model function 168

color-spec-p function 168

column-layout class 35 , 52 , 96

column-layout class 53

combo box 45

combo boxes 45

complete-in-place function 127

compositing-mode graphics state parameter 153

confirm-yes-or-no function 108

contain function 7 , 25 , 135

convert-color function 161 , 171

convert-external-image function 160

convert-to-screen function 28 , 29 , 30

copy-area function 145

:create-callback initarg 70 , 160

create-pixmap-port function 146 , 148

creating menus 77

creating submenus 78

current-printer function 173

D

:data callback type 48

:data initarg 8 , 21

:data-interface callback type 49

default settings

selections 41

:default-initargs class option 93 , 96

defclass macro 91 , 93 , 132

define-color-alias function 168

define-color-models macro 171

define-interface macro 91

arguments supplied to 93

defpackage function 6

delete-color-translation function 168 , 171

deliver function 76

:description initarg 52

description of the CAPI 1 - 3

destroy generic function 76

dialogs

creating your own 117 - 122

description of 107 - 122

in front 117

modal 115

owners 117

display callback 132

display function 7 , 8 , 25 , 30

display panes 17

:display-callback initarg 160

display-dialog function 117 , 118 , 119 , 122

displaying text on screen 17

display-message function 9 , 108

display-pane class 17 , 54

dividers 67

document-frame class 68

double buffering 145

draw-arc function 149

draw-arcs function 149

draw-character function 149

draw-circle function 131

draw-ellipse function 150

draw-image function 156 , 157

draw-line function 149

draw-lines function 149

drawn-pinboard-object class 135 , 139 , 148

draw-path function 150

draw-point function 134

draw-polygon function 150

draw-polygons function 150

draw-rectangle function 150

draw-rectangles function 150

draw-string function 149

drop-down list box 45

E

Edit menu 88

editor panes 18

editor-pane class 18 , 54 , 100 , 122 , 127 , 146

subclasses 20

editor-pane-blink-rate function 19

editor-pane-text accessor 73 , 101

:element callback type 48

elements

creating your own 129 - 143

generic properties of 11 - 12

element-widget-name accessor 28

:enabled initarg 19 , 21

:enabled-function initarg 86

:enabled-function-for-dialog initarg 87

ensure-color function 170

ensure-model-color function 170

:evaluate keyword argument 115

event handlers 133 - 135 , ??- 135

execute-with-interface function 25 , 69

execute-with-interface-if-alive function 25 , 69

exit-confirmer function 120

exit-dialog function 118 , 120

:extend-callback initarg 41 , 45 , 48

extended selection

specifying 47

using on diferent platforms 47

:extended-selection interaction style 38 - 39 , 47

extended-selection-tree-view class 42

extension gesture 39

external constraints 59

external image

dimensions 160

from displayed window 162

from on-screen window 162

width and height 160

external-image class 156

externalize-and-write-image function 158

externalize-image function 159

:external-max-height initarg 59

:external-max-width initarg 59

:external-min-height initarg 59

:external-min-width initarg 59

F

:file-completion initarg 126

files

prompting for 113 - 115

:filter initarg 42

find-best-font function 154

find-matching-fonts function 154

:font initarg 12

fonts 12

attributes 154

lookup 155

prompting for 114

frame 15

free-image function 156 , 160

free-image-access function 162

functions

sample 11

G

generic properties of elements 11 - 12

geometry of interfaces 104

geometry of interfaces, querying 26

geometry of layouts, specifying 58 - 62

get-all-color-names function 167

get-color-alias-translation function 168

get-color-spec function 167

get-page-area function 176

get-printer-metrics function 176

graph panes

callbacks 44

graphics

creating permanent displays 132

displaying 129 - 132

graphics ports 145

drawing functions 152

pixmap 153

graphics state 146

graphics state parameters 148

graphics-state type 147 , 148

graph-pane class 43 , 146

implementation of 136

grid-layout class 14 , 55

groupbox 15

GTK+

resources 28

H

hardcopy API 173 - 176

:help-callback initarg 24

:help-key initarg 24

hierarchy of menus 82

hints 23 , 58

:horizontal-scroll initarg 12 , 53

I

image class 156

image-access-pixel function 161

image-access-transfer-from-image function 161

image-access-transfer-to-image function 161

:image-function initarg 41 , 42 , 46 , 87

image-height accessor 160

image-list class 41 , 42

:image-lists initarg 41 , 42

image-width accessor 160

index of selected item 41 , 48

:initial-constraints initarg 63

:initial-value initarg 110

in-place completion

in applications 126

user interface 122

:in-place-completion-function initarg 126

:in-place-filter initarg 126

:input-model initarg 134

integers

prompting for 110 - 111

interaction

general properties 47

in lists 38

:interaction initarg 38 , 46 , 47 , 79 , 112

interactive streams 20

interactive-stream class 20

:interface callback type 48

interface class 3 , 15 , 23 , 24 , 91

interface-customize-toolbar function 23

interface-default-toolbar-states function 23

interface-display generic function 69 , 156

interface-extend-title generic function 15

interfaces

defining 91 - 103

description of 91

geometry 104

layouts, specifying 94

menus, specifying 97 - 100

panes, specifying 93

specifying geometry 26

title, specifying 93

interface-title accessor 15

interface-toolbar-state function 23

interface-update-toolbar function 23

internal constraints 59

:internal-max-height initarg 60

:internal-max-width initarg 59

:internal-min-height initarg 59

:internal-min-width initarg 59

item-pinboard-object class 135

:items initarg 38 , 77 , 81

K

key press 133 - 135

L

:layout-class initarg 35

layout-description accessor 72

layouts

combining different 56 - 58

description of 51 - 62

introduction to 7

specifying geometry 58 - 62

specifying size of panes in 53

:layouts interface option 91

letters

underlined in menus etc 13

Lisp forms

prompting for 115

list function 52

list items, specifying 37

list panels 36

list-all-font-names function 154

listener panes 20

listener-pane class 20 , 54

list-known-image-formats function 157 , 158

list-panel class 14 , 36 , 125

lists

actions in 39

deselection in 39

extended selection in 38

extended selections 39

interaction in 38

multiple selection in 38

prompting with 111 - 113

retraction in 39

single selection in 38

load-color-database function 171

load-icon-image function 157 , 160

load-image function 160

M

make-container function 118

make-hsv function 167

make-image-access function 161

make-image-from-port function 153 , 160

make-instance function 5

make-menu-for-pane function 89

make-pane-popup-menu generic function 89

make-rgb function 167 , 168

make-sub-image function 160

:max keyword argument 110

max-height 60

max-width 60

MDI 68

menu class 3 , 77 , 87

:menu-bar interface option 91 , 97

:menu-bar-items initarg 78

menu-component class 78

menu-component class 3

menu-item class 3 , 81 , 87

menus

components 46

creating 77

creating submenus 78

description of 77 - 87

disabling items in 86 - 87

Edit 88

grouping items together 78 - 81

individual items in 81 - 82

menu hierarchy 82

nesting 78

specifying alternative items 85

:menus interface option 91 , 97

merge-font-descriptions function 155

Microsoft Windows

Multiple-Document Interface 68

themes 27

:min keyword argument 110

min-height 60

min-width 60

:mnemonic initarg 13 , 22

mnemonics 13

in a button-panel 36

in menus 84

:mnemonics initarg 36

:mnemonic-text initarg 22

:mnemonic-title initarg 14

modal dialogs 115

Motif

resources 28

multi-line-text-input-pane class 18

:multiple-selection interaction style 38 , 46 , 47 , 80

N

New in LispWorks 6.1

.ico image type supported on Microsoft Windows 157

browser-pane for browsing URLs and displaying HTML 20

High-quality drawing 147

More image formats can be exported 158

multiple monitors support 26

:none callback type 49

:no-selection interaction style 46 , 47

O

off screen 145

off-screen 145

offscreen 145

:ok-check keyword argument 110 , 115 , 122

on screen 145

on-screen 145

onscreen 145

operation graphics state parameter 147

option panes 45

option-pane class 14 , 45

organizing panes 52

output-pane class 23 , 88 , 129 , 145 , 146 , 166

P

page-setup-dialog function 173

:pane-args initarg 113

panel

button layout 35

pane-layout accessor 72

panels

check button 35

list 36

push button 34

radio button 35

:pane-menu initarg 88

pane-popup-menu-items generic function 89

panes

accessing 95

collector 20

creating your own 129 - 143

default title position 15

display 17

editor 18

finding 95

graphs 43

listener 20

lookup 95

option 45

organizing 52

sizing 53

text input 17

title 14

:panes interface option 91

pane-screen-internal-geometry function 26 , 104

pane-supports-menus-with-images function 88

:pathname keyword argument 114

pinboard

buffered display 136

double buffering 136

flickering 136

pinboard objects 135

creating your own 139 - 143

pinboard-layout class 23 , 56 , 135 , 136 , 146

pinboard-object class 135

popup-confirmer function 119 , 120 , 122

portable font descriptions 154 - 155

print function 33

print-dialog function 117 , 173

print-editor-buffer function 176

printer-configuration-dialog function 176

print-file function 176

:print-function initarg 33

print-text function 176

prompt-for-color function 114

prompt-for-confirmation function 109

prompt-for-directory function 114

prompt-for-file function 113 , 117

prompt-for-font function 114

prompt-for-form function 115

prompt-for-integer function 110 , 120

prompt-for-number function 111

prompt-for-string function 109 , 117 , 119

prompt-for-symbol function 115

prompt-with-list function 111

prompt-with-list-non-focus function 127

prompt-with-message function 9

push button panels

creating 34

push buttons 21

push-button class 7 , 21 , 34

push-button-panel class 34

Q

quit-interface function 76

R

radio button panels

creating 35

radio buttons 22

radio-button class 22

radio-button-panel class 34 , 35 , 47

read-and-convert-external-image function 160

read-color-db function 171

:reader slot option 95

redisplay-interface function 121

register-image-translation function 159

Resources

GTK+ 28

X11/Motif 28

:retract-callback initarg 21 , 40 , 45 , 48

rich-text-pane class 19

row-layout class 35 , 52 , 53 , 96

S

screen-internal-geometries function 26 , 104 , 105

screen-internal-geometry function 26

screen-monitor-geometries function 26 , 104

screentips 23

scroll bars

programmatic control 71

specifying 12

scroll generic function 71

scroll-if-not-visible-p accessor 72

:selected initarg 22

:selected-item initarg 45 , 48

:selected-items initarg 48

selecting nth item 41 , 48

selection gesture 39

:selection initarg 41 , 48

:selection-callback initarg 34 , 38 , 40 , 45 , 48 , 102

selections 38 - 41

default settings 41

extending 39

general properties 48

specifying multiple 47

separators 67

set-application-themed function 27

set-default-interface-prefix-suffix function 15

setf function 16 , 21

set-graphics-state function 149

set-hint-table function 63

set-printer-metrics function 176

set-printer-options function 173

set-top-level-interface-geometry function 70

shape-mode graphics state parameter 147

simple-print-port function 146 , 176

single selection

specifying 47

:single-selection interaction style 38 , 46 , 47 , 79

slot 5

slot-value function 5

Spaces on Mac OS X 26

:state-image-function initarg 41 , 42

streams

interactive 20

strings

prompting for 109

subclasses

finding 15

subclasses, finding 15

symbols

prompting for 115

T

text

displaying 16 , 19 , 20

displaying on screen 17

editing 16 , 19 , 20

entering 16 , 19 , 20

:text initarg 12 , 17 , 18 , 19

text input panes 17

text-input-pane class 14 , 17 , 122 , 126

text-input-pane-in-place-complete function 126

text-mode graphics state parameter 147

tips 23

:title initarg 15 , 93

title panes 14

titled-object class 14

titled-object-title accessor 101

:title-font initarg 16

title-pane class 14 , 166

:title-position initarg 16 , 53

titles

changing 16 , 103

changing interactively 16

for elements 15

for interfaces 15 , 103

for windows 15 , 103

specifying 14 , 14 - 16

specifying directly 15

toolbar

customize 23

folding 23

toolbar buttons 23

toolbar-button class 24

toolbar-component class 24

toolbars 23

tooltips 23

:tooltips initarg 24

top-level-interface-display-state function 75

top-level-interface-geometry function 26 , 71 , 104

tree-view class 42

Truetype fonts 147

U

unconvert-color function 161

underlined letters 13

user input 107 - 122

using callback functions 11

using the CAPI 5 - 6

V

:value-function keyword argument 120

values

prompting for 109 - 115

:vertical-scroll initarg 12 , 53

virtual-screen-geometry function 26 , 104

visible constraints 59

:visible-max-height initarg 59

:visible-max-width initarg 59

:visible-min-height initarg 59

:visible-min-width initarg 59

W

window titles 15 , 103

window-modal dialogs 115

Windows themes 27

Windows XP themes 27

with-dialog-results macro 116

with-document-pages macro 175

with-external-metafile macro 146

with-graphics-state macro 149

with-internal-metafile macro 146

with-page macro 175

with-page-transform macro 176

with-pixmap-graphics-port macro 146 , 162

with-print-job macro 146 , 173

Works menu

in CAPI objects 6

workspaces on Linux 26

X

X resources

fallback resources 29

in delivered applications 29

X11

resources 28

:x-ratios initarg 54

Y

:y-ratios initarg 54


CAPI User Guide (Macintosh version) - 30 Aug 2011

NextPrevTopContents