All Manuals > CAPI User Guide

NextPrevTopContents

Index

A

abort-dialog function 120

:accelerator initarg 87

:action-callback initarg 42 , 46 , 50

:alternative initarg 87

:alternative-action-callback initarg 50

apply-in-pane-process function 27 , 71

apply-in-pane-process-if-alive function 27 , 71

apropos-color-alias-names function 167

apropos-color-names function 166

apropos-color-spec-names function 167

augment-font-description function 155

B

balloon help 24

:best-height initarg 134

:best-width initarg 134

boole function 152

break gesture 31

browser-pane class 20

bubble help 24

:buffer-name initarg 19

button panels

orientation 37

prompting with 114 - 115

button-panel class 36

buttons

check 22

push 21

radio 22

:buttons initarg 18

C

:callback initarg 18

callbacks

description of 8

general properties 50

graph panes 46

in interfaces 102 - 105

used for choices 41 - 42

using callback functions 11

:callback-type initarg 50 , 120

call-editor function 102

call-editor generic function 126

CAPI

basic objects 3

description of 1 - 3

linking code into 8

menu hierarchy 84

using the 5 - 6

check button panels 37

check buttons 22

check-button class 22 , 36

check-button-panel class 36 , 37 , 42 , 48

:children-function initarg 45

choice class 35

:choice-class initarg 114

choice-interaction accessor 49

choices 35 - 51

callbacks available 50

description of 35 - 51

general properties 48 - 51

relationship to menus 48

choice-selected-item accessor 49

choice-selected-items accessor 49

choice-selection accessor 43 , 49

classes

collections 36

creating your own 131 - 144

clear-external-image-conversions function 159

CLUE 2

clues 24

CLX 2

collection class 35

collection-items accessor 75

collections

description of 35

collector panes 20

collector-pane class 20

colors

prompting for 116

colors= function 170

color-spec-model function 168

color-spec-p function 168

column-layout class 37 , 54 , 98

column-layout class 55

combo box 47

combo boxes 47

complete-in-place function 129

compositing-mode graphics state parameter 153

confirm-yes-or-no function 110

contain function 7 , 27 , 136

convert-color function 161 , 171

convert-external-image function 160

convert-to-screen function 30 , 31 , 32

copy-area function 145

:create-callback initarg 72 , 160

create-pixmap-port function 146 , 148

creating menus 79

creating submenus 80

current-printer function 173

D

:data callback type 50

:data initarg 8 , 21

:data-interface callback type 50

default settings

selections 43

:default-initargs class option 95 , 98

defclass macro 93 , 95 , 134

define-color-alias function 168

define-color-models macro 171

define-interface macro 93

arguments supplied to 95

defpackage function 6

delete-color-translation function 168 , 171

deliver function 78

:description initarg 54

description of the CAPI 1 - 3

destroy generic function 78

dialogs

creating your own 119 - 124

description of 109 - 124

in front 119

modal 117

owners 119

display callback 133

display function 7 , 8 , 27 , 32

display panes 17

:display-callback initarg 160

display-dialog function 119 , 120 , 121 , 124

displaying text on screen 17

display-message function 9 , 110

display-pane class 17 , 56

dividers 69

document-frame class 70

double buffering 145

draw-arc function 149

draw-arcs function 149

draw-character function 149

draw-circle function 133

draw-ellipse function 150

draw-image function 156 , 157

draw-line function 149

draw-lines function 149

drawn-pinboard-object class 136 , 140 , 148

draw-path function 150

draw-point function 135

draw-polygon function 150

draw-polygons function 150

draw-rectangle function 150

draw-rectangles function 150

draw-string function 149

drop-down list box 47

E

editor panes 18

editor-pane class 19 , 56 , 102 , 124 , 129 , 146

subclasses 20

editor-pane-blink-rate function 20

editor-pane-text accessor 75 , 103

:element callback type 50

elements

creating your own 131 - 144

generic properties of 11 - 12

element-widget-name accessor 30

:enabled initarg 20 , 21

:enabled-function initarg 88

:enabled-function-for-dialog initarg 89

ensure-color function 170

ensure-model-color function 170

:evaluate keyword argument 117

event handlers 134 - 136 , ??- 136

execute-with-interface function 27 , 71

execute-with-interface-if-alive function 27 , 71

exit-confirmer function 122

exit-dialog function 120 , 122

:extend-callback initarg 42 , 46 , 50

extended selection

specifying 49

using on diferent platforms 49

:extended-selection interaction style 40 - 41 , 49

extended-selection-tree-view class 44

extension gesture 41

external constraints 61

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 61

:external-max-width initarg 61

:external-min-height initarg 61

:external-min-width initarg 61

F

:file-completion initarg 128

files

prompting for 115 - 117

:filter initarg 43

find-best-font function 154

find-matching-fonts function 154

:font initarg 12

fonts 12

attributes 154

lookup 155

prompting for 116

frame 16

free-image function 156 , 160

free-image-access function 162

functions

sample 11

G

generic properties of elements 11 - 12

geometry of interfaces 106

geometry of interfaces, querying 28

geometry of layouts, specifying 60 - 64

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 46

graphics

creating permanent displays 133

displaying 131 - 134

graphics ports 145

drawing functions 152

pixmap 153

graphics state 146

graphics state parameters 148

graphics-state type 147 , 148

graph-pane class 44 , 146

implementation of 137

grid-layout class 14 , 57

groupbox 16

GTK+

resources 30

H

hardcopy API 173 - 176

:help-callback initarg 24

:help-key initarg 24

hierarchy of menus 84

hints 24 , 60

:horizontal-scroll initarg 12 , 55

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 43 , 44 , 47 , 90

image-height accessor 160

image-list class 43 , 44

:image-lists initarg 43 , 44

image-width accessor 160

index of selected item 43 , 49

:initial-constraints initarg 65

:initial-value initarg 112

in-place completion

in applications 128

user interface 124

:in-place-completion-function initarg 128

:in-place-filter initarg 128

:input-model initarg 135

integers

prompting for 112 - 113

interaction

general properties 48

in lists 40

:interaction initarg 40 , 48 , 81 , 113

interactive streams 21

interactive-stream class 21

:interface callback type 50

interface class 3 , 15 , 23 , 24 , 93

interface-customize-toolbar function 23

interface-default-toolbar-states function 23

interface-display generic function 71 , 156

interface-extend-title generic function 15

interfaces

defining 93 - 105

description of 93

geometry 106

layouts, specifying 96

menus, specifying 99 - 102

panes, specifying 96

specifying geometry 28

title, specifying 95

interface-title accessor 15

interface-toolbar-state function 23

interface-update-toolbar function 23

internal constraints 61

:internal-max-height initarg 62

:internal-max-width initarg 61

:internal-min-height initarg 61

:internal-min-width initarg 61

item-pinboard-object class 136

:items initarg 39 , 79 , 83

K

key press 134 - 136

L

:layout-class initarg 37

layout-description accessor 74

layouts

combining different 58 - 60

description of 53 - 64

introduction to 7

specifying geometry 60 - 64

specifying size of panes in 55

:layouts interface option 93

letters

underlined in menus etc 13

Lisp forms

prompting for 117

list function 54

list items, specifying 39

list panels 38

list-all-font-names function 154

listener panes 21

listener-pane class 21 , 56

list-known-image-formats function 157 , 158

list-panel class 14 , 38 , 127

lists

actions in 41

deselection in 41

extended selection in 40

extended selections 40

interaction in 40

multiple selection in 40

prompting with 113 - 115

retraction in 41

single selection in 40

load-color-database function 171

load-icon-image function 157 , 160

load-image function 160

M

make-container function 120

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 90

make-pane-popup-menu generic function 90

make-rgb function 167 , 168

make-sub-image function 160

:max keyword argument 112

max-height 62

max-width 62

MDI 6 , 70

menu class 3 , 79 , 90

:menu-bar interface option 93 , 99

:menu-bar-items initarg 80

menu-component class 80

menu-component class 3

menu-item class 3 , 83 , 89

menus

components 48

creating 79

creating submenus 80

description of 79 - 89

disabling items in 88 - 89

grouping items together 80 - 83

individual items in 83 - 84

menu hierarchy 84

nesting 80

specifying alternative items 87

:menus interface option 93 , 99

merge-font-descriptions function 155

Microsoft Windows

Multiple-Document Interface 6 , 70

themes 29

:min keyword argument 112

min-height 62

min-width 62

:mnemonic initarg 13 , 23

mnemonics 13

in a button-panel 38

in menus 86

:mnemonics initarg 38

:mnemonic-text initarg 23

:mnemonic-title initarg 14

modal dialogs 117

Motif

resources 30

multi-line-text-input-pane class 18

:multiple-selection interaction style 40 , 48 , 82

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 28

:none callback type 50

:no-selection interaction style 48 , 49

O

off screen 145

off-screen 145

offscreen 145

:ok-check keyword argument 112 , 117 , 124

on screen 145

on-screen 145

onscreen 145

operation graphics state parameter 147

option panes 47

option-pane class 14 , 47

organizing panes 54

output-pane class 24 , 90 , 131 , 145 , 146 , 166

P

page-setup-dialog function 173

:pane-args initarg 115

panel

button layout 37

pane-layout accessor 74

panels

check button 37

list 38

push button 36

radio button 37

:pane-menu initarg 90

pane-popup-menu-items generic function 90

panes

accessing 97

collector 20

creating your own 131 - 144

default title position 15

display 17

editor 18

finding 97

graphs 44

listener 21

lookup 97

option 47

organizing 54

sizing 55

text input 17

title 14

:panes interface option 93

pane-screen-internal-geometry function 28 , 106

pane-supports-menus-with-images function 90

:pathname keyword argument 116

pinboard

buffered display 137

double buffering 137

flickering 137

pinboard objects 136

creating your own 140 - 144

pinboard-layout class 24 , 58 , 136 , 137 , 146

pinboard-object class 136

popup-confirmer function 121 , 122 , 124

portable font descriptions 154 - 155

print function 35

print-dialog function 119 , 173

print-editor-buffer function 176

printer-configuration-dialog function 176

print-file function 176

:print-function initarg 35

print-text function 176

prompt-for-color function 116

prompt-for-confirmation function 111

prompt-for-directory function 116

prompt-for-file function 115 , 119

prompt-for-font function 116

prompt-for-form function 117

prompt-for-integer function 112 , 122

prompt-for-number function 113

prompt-for-string function 111 , 119 , 121

prompt-for-symbol function 117

prompt-with-list function 113

prompt-with-list-non-focus function 129

push button panels

creating 36

push buttons 21

push-button class 7 , 21 , 36

push-button-panel class 36

Q

quit-interface function 78

R

radio button panels

creating 37

radio buttons 22

radio-button class 23

radio-button-panel class 36 , 37 , 48

read-and-convert-external-image function 160

read-color-db function 171

:reader slot option 97

redisplay-interface function 123

register-image-translation function 159

Resources

GTK+ 30

X11/Motif 30

:retract-callback initarg 22 , 41 , 46 , 50

rich-text-pane class 20

row-layout class 37 , 54 , 55 , 98

S

screen-internal-geometries function 28 , 106 , 107

screen-internal-geometry function 28

screen-monitor-geometries function 28 , 106

screentips 24

scroll bars

programmatic control 73

specifying 12

scroll generic function 73

scroll-if-not-visible-p accessor 74

:selected initarg 23

:selected-item initarg 47 , 49

:selected-items initarg 49

selecting nth item 43 , 49

selection gesture 41

:selection initarg 43 , 49

:selection-callback initarg 36 , 39 , 41 , 46 , 50 , 104

selections 40 - 43

default settings 43

extending 40

general properties 49

specifying multiple 48

separators 69

set-application-themed function 29

set-default-interface-prefix-suffix function 15

setf function 16 , 21

set-graphics-state function 149

set-hint-table function 65

set-printer-metrics function 176

set-printer-options function 173

set-top-level-interface-geometry function 72

shape-mode graphics state parameter 147

simple-print-port function 146 , 176

single selection

specifying 48

:single-selection interaction style 40 , 48 , 81

slot 5

slot-value function 5

Spaces on Mac OS X 28

:state-image-function initarg 43 , 44

streams

interactive 21

strings

prompting for 111

subclasses

finding 15

subclasses, finding 15

symbols

prompting for 117

T

text

displaying 16 , 20

displaying on screen 17

editing 16 , 20

entering 16 , 20

:text initarg 12 , 17 , 18 , 19

text input panes 17

text-input-pane class 14 , 18 , 124 , 128

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

text-mode graphics state parameter 147

tips 24

:title initarg 15 , 95

title panes 14

titled-object class 14

titled-object-title accessor 103

:title-font initarg 16

title-pane class 14 , 166

:title-position initarg 16 , 55

titles

changing 16 , 105

changing interactively 16

for elements 15

for interfaces 15 , 105

for windows 15 , 105

specifying 14 , 14 - 16

specifying directly 15

toolbar

customize 23

folding 23

toolbar buttons 23

toolbar-button class 24

toolbar-component class 25

toolbars 23

tooltips 24

:tooltips initarg 25

top-level-interface-display-state function 77

top-level-interface-geometry function 28 , 73 , 106

tree-view class 43 , 44

Truetype fonts 147

U

unconvert-color function 161

underlined letters 13

user input 109 - 124

using callback functions 11

using the CAPI 5 - 6

V

:value-function keyword argument 122

values

prompting for 111 - 117

:vertical-scroll initarg 12 , 55

virtual-screen-geometry function 28 , 107

visible constraints 61

:visible-max-height initarg 61

:visible-max-width initarg 61

:visible-min-height initarg 61

:visible-min-width initarg 61

W

window titles 15 , 105

window-modal dialogs 117

Windows themes 29

Windows XP themes 29

with-dialog-results macro 118

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 28

X

X resources

fallback resources 31

in delivered applications 31

X11

resources 30

:x-ratios initarg 55

Y

:y-ratios initarg 55


CAPI User Guide (Windows version) - 30 Aug 2011

NextPrevTopContents