All Manuals > CAPI User Guide

NextPrevTopContents

Index

A

abort-dialog function 119

:accelerator initarg 85

:action-callback initarg 40 , 44 , 48

:alternative initarg 85

:alternative-action-callback initarg 48

apply-in-pane-process function 25 , 69

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

apropos-color-alias-names function 165

apropos-color-names function 164

apropos-color-spec-names function 165

augment-font-description function 153

B

balloon help 23

:best-height initarg 132

:best-width initarg 132

boole function 150

break gesture 29

browser-pane class 20

bubble help 23

:buffer-name initarg 19

button panels

orientation 35

prompting with 113 - 114

button-panel class 34

buttons

check 21

push 21

radio 22

:buttons initarg 18

C

:callback initarg 18

callbacks

description of 8

general properties 48

graph panes 44

in interfaces 100 - 103

used for choices 39 - 40

using callback functions 11

:callback-type initarg 48 , 119

call-editor function 101

call-editor generic function 125

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 22 , 34

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

:children-function initarg 43

choice class 33

:choice-class initarg 113

choice-interaction accessor 47

choices 33 - 49

callbacks available 48

description of 33 - 49

general properties 46 - 49

relationship to menus 46

choice-selected-item accessor 47

choice-selected-items accessor 47

choice-selection accessor 41 , 47

classes

collections 34

creating your own 129 - 142

clear-external-image-conversions function 157

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 115

colors= function 168

color-spec-model function 166

color-spec-p function 166

column-layout class 35 , 52 , 96

column-layout class 53

combo box 45

combo boxes 45

complete-in-place function 128

compositing-mode graphics state parameter 151

confirm-yes-or-no function 109

contain function 7 , 25 , 134

convert-color function 159 , 169

convert-external-image function 158

convert-to-screen function 28 , 29 , 30

copy-area function 143

:create-callback initarg 70 , 158

create-pixmap-port function 144 , 146

creating menus 77

creating submenus 78

current-printer function 171

D

:data callback type 48

:data initarg 8 , 21

:data-interface callback type 48

default settings

selections 41

:default-initargs class option 93 , 96

defclass macro 91 , 93 , 132

define-color-alias function 166

define-color-models macro 169

define-interface macro 91

arguments supplied to 93

defpackage function 6

delete-color-translation function 166 , 169

deliver function 76

:description initarg 52

description of the CAPI 1 - 3

destroy generic function 76

dialogs

creating your own 118 - 123

description of 107 - 123

in front 118

modal 116

owners 118

display callback 131

display function 7 , 8 , 25 , 30

display panes 17

:display-callback initarg 158

display-dialog function 118 , 119 , 120 , 123

displaying text on screen 17

display-message function 9 , 108

display-pane class 17 , 54

dividers 67

document-frame class 68

double buffering 143

draw-arc function 147

draw-arcs function 147

draw-character function 147

draw-circle function 131

draw-ellipse function 148

draw-image function 154 , 155

draw-line function 147

draw-lines function 147

drawn-pinboard-object class 134 , 138 , 146

draw-path function 148

draw-point function 133

draw-polygon function 148

draw-polygons function 148

draw-rectangle function 148

draw-rectangles function 148

draw-string function 147

drop-down list box 45

E

editor panes 18

editor-pane class 19 , 54 , 101 , 123 , 128 , 144

subclasses 20

editor-pane-blink-rate function 19

editor-pane-text accessor 73 , 101

:element callback type 48

elements

creating your own 129 - 142

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 168

ensure-model-color function 168

:evaluate keyword argument 116

event handlers 132 - 134 , ??- 134

execute-with-interface function 25 , 69

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

exit-confirmer function 121

exit-dialog function 119 , 121

:extend-callback initarg 40 , 44 , 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 158

from displayed window 160

from on-screen window 160

width and height 158

external-image class 154

externalize-and-write-image function 156

externalize-image function 157

:external-max-height initarg 59

:external-max-width initarg 59

:external-min-height initarg 59

:external-min-width initarg 59

F

:file-completion initarg 127

files

prompting for 114 - 116

:filter initarg 41

find-best-font function 152

find-matching-fonts function 152

:font initarg 12

fonts 12

attributes 152

lookup 153

prompting for 115

frame 16

free-image function 154 , 158

free-image-access function 160

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 165

get-color-alias-translation function 166

get-color-spec function 165

get-page-area function 174

get-printer-metrics function 174

graph panes

callbacks 44

graphics

creating permanent displays 131

displaying 129 - 132

graphics ports 143

drawing functions 150

pixmap 151

graphics state 144

graphics state parameters 146

graphics-state type 145 , 146

graph-pane class 42 , 144

implementation of 135

grid-layout class 14 , 55

groupbox 16

GTK+

resources 28

H

hardcopy API 171 - 174

:help-callback initarg 24

:help-key initarg 24

hierarchy of menus 82

hints 23 , 58

:horizontal-scroll initarg 12 , 53

I

image class 154

image-access-pixel function 159

image-access-transfer-from-image function 159

image-access-transfer-to-image function 159

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

image-height accessor 158

image-list class 41 , 42

:image-lists initarg 41 , 42

image-width accessor 158

index of selected item 41 , 47

:initial-constraints initarg 63

:initial-value initarg 110

in-place completion

in applications 127

user interface 123

:in-place-completion-function initarg 127

:in-place-filter initarg 127

:input-model initarg 133

integers

prompting for 110 - 111

interaction

general properties 46

in lists 38

:interaction initarg 38 , 46 , 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 , 154

interface-extend-title generic function 15

interfaces

defining 91 - 103

description of 91

geometry 104

layouts, specifying 94

menus, specifying 97 - 100

panes, specifying 94

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 134

:items initarg 37 , 77 , 81

K

key press 132 - 134

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 116

list function 52

list items, specifying 37

list panels 36

list-all-font-names function 152

listener panes 20

listener-pane class 21 , 54

list-known-image-formats function 155 , 156

list-panel class 14 , 36 , 126

lists

actions in 39

deselection in 39

extended selection in 38

extended selections 38

interaction in 38

multiple selection in 38

prompting with 111 - 114

retraction in 39

single selection in 38

load-color-database function 169

load-icon-image function 155 , 158

load-image function 158

M

make-container function 119

make-hsv function 165

make-image-access function 159

make-image-from-port function 151 , 158

make-instance function 5

make-menu-for-pane function 88

make-pane-popup-menu generic function 88

make-rgb function 165 , 166

make-sub-image function 158

:max keyword argument 110

max-height 60

max-width 60

MDI 68

menu class 3 , 77 , 87

:menu-bar interface option 91 , 98

: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

grouping items together 78 - 81

individual items in 81 - 82

menu hierarchy 82

nesting 78

specifying alternative items 85

:menus interface option 91 , 98

merge-font-descriptions function 153

Microsoft Windows

Multiple-Document Interface 68

themes 27

:min keyword argument 110

min-height 60

min-width 60

:mnemonic initarg 14 , 23

mnemonics 13

in a button-panel 36

in menus 84

:mnemonics initarg 36

:mnemonic-text initarg 23

:mnemonic-title initarg 14

modal dialogs 116

Motif

resources 28

multi-line-text-input-pane class 18

:multiple-selection interaction style 38 , 46 , 81

N

New in LispWorks 6.1

.ico image type supported on Microsoft Windows 155

browser-pane for browsing URLs and displaying HTML 20

High-quality drawing 145

More image formats can be exported 156

multiple monitors support 26

:none callback type 48

:no-selection interaction style 46 , 47

O

off screen 143

off-screen 143

offscreen 143

:ok-check keyword argument 110 , 116 , 123

on screen 143

on-screen 143

onscreen 143

operation graphics state parameter 145

option panes 45

option-pane class 14 , 45

organizing panes 52

output-pane class 24 , 88 , 129 , 143 , 144 , 164

P

page-setup-dialog function 171

:pane-args initarg 114

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 88

panes

accessing 95

collector 20

creating your own 129 - 142

default title position 16

display 17

editor 18

finding 95

graphs 42

listener 20

lookup 95

option 45

organizing 52

sizing 53

text input 17

title 15

:panes interface option 91

pane-screen-internal-geometry function 26 , 104

pane-supports-menus-with-images function 88

:pathname keyword argument 115

pinboard

buffered display 135

double buffering 135

flickering 135

pinboard objects 134

creating your own 138 - 142

pinboard-layout class 24 , 56 , 134 , 135 , 144

pinboard-object class 134

popup-confirmer function 120 , 121 , 123

portable font descriptions 152 - 153

print function 33

print-dialog function 118 , 171

print-editor-buffer function 174

printer-configuration-dialog function 174

print-file function 174

:print-function initarg 33

print-text function 174

prompt-for-color function 115

prompt-for-confirmation function 109

prompt-for-directory function 115

prompt-for-file function 114 , 118

prompt-for-font function 115

prompt-for-form function 116

prompt-for-integer function 110 , 121

prompt-for-number function 111

prompt-for-string function 109 , 118 , 120

prompt-for-symbol function 116

prompt-with-list function 111

prompt-with-list-non-focus function 128

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 , 46

read-and-convert-external-image function 158

read-color-db function 169

:reader slot option 95

redisplay-interface function 122

register-image-translation function 157

Resources

GTK+ 28

X11/Motif 28

:retract-callback initarg 22 , 39 , 44 , 48

rich-text-pane class 20

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 , 47

:selected-items initarg 47

selecting nth item 41 , 47

selection gesture 39

:selection initarg 41 , 47

:selection-callback initarg 34 , 37 , 39 , 44 , 48 , 102

selections 38 - 41

default settings 41

extending 38

general properties 47

specifying multiple 46

separators 67

set-application-themed function 27

set-default-interface-prefix-suffix function 15

setf function 16 , 21

set-graphics-state function 147

set-hint-table function 63

set-printer-metrics function 174

set-printer-options function 171

set-top-level-interface-geometry function 70

shape-mode graphics state parameter 145

simple-print-port function 144 , 174

single selection

specifying 46

:single-selection interaction style 38 , 46 , 80

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 116

T

text

displaying 17 , 19 , 20

displaying on screen 17

editing 17 , 20

entering 17 , 20

:text initarg 12 , 17 , 18 , 19

text input panes 17

text-input-pane class 14 , 18 , 123 , 127

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

text-mode graphics state parameter 145

tips 23

:title initarg 15 , 93

title panes 15

titled-object class 14

titled-object-title accessor 101

:title-font initarg 16

title-pane class 14 , 164

:title-position initarg 16 , 53

titles

changing 16 , 103

changing interactively 16

for elements 16

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 41 , 42

Truetype fonts 145

U

unconvert-color function 159

underlined letters 13

user input 107 - 123

using callback functions 11

using the CAPI 5 - 6

V

:value-function keyword argument 121

values

prompting for 109 - 116

: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 116

Windows themes 27

Windows XP themes 27

with-dialog-results macro 117

with-document-pages macro 173

with-external-metafile macro 144

with-graphics-state macro 147

with-internal-metafile macro 144

with-page macro 173

with-page-transform macro 174

with-pixmap-graphics-port macro 144 , 160

with-print-job macro 144 , 171

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 (Unix version) - 30 Aug 2011

NextPrevTopContents