LispWorks CAPI User Guide

NextPrevTopContents

Index

A

abort-dialog function 105 , 106

:accelerator initarg 77

:action-callback initarg 37 , 39 , 43

:alternative initarg 77

Application menu

for LispWorks applications 80

apply-in-pane-process function 11 , 63

apropos-color-alias-names function 145

apropos-color-names function 144

apropos-color-spec-names function 145

augment-font-description function 135

:auto-menus initarg 79

B

:best-height initarg 116

:best-width initarg 116

boole function 133

break gesture 14

:buffer-name initarg 25

button panels

orientation 31

prompting with 100 - 101

button-panel class 30

buttons

check 27

push 26

radio 27

:buttons initarg 24

C

:callback initarg 23

callbacks

description of 8

general properties 42

graph panes 39

in interfaces 90 - 93

used for choices 35 - 37

using callback functions 17

:callback-type initarg 43 , 106

call-editor function 90

CAPI

basic objects 3

description of 1 - 3

linking code into 8

menu hierarchy 74

using the 6

check button panels 31

check buttons 27

check-button class 27 , 30

check-button-panel class 30 , 31 , 36 , 41

:children-function initarg 38

choice class 29

:choice-class initarg 100

choice-interaction accessor 42

choices 29 - 43

callbacks available 42

description of 29 - 43

general properties 41 - 43

relationship to menus 41

choice-selected-item accessor 42

choice-selected-items accessor 42

choice-selection accessor 37 , 42

classes

collections 30

creating your own 113 - 127

clear-external-image-conversions function 139

CLUE 2

CLX 2

collection class 29

collection-items accessor 66

collections

description of 29

collector panes 25

collector-pane class 25

colors

prompting for 102

colors= function 148

color-spec-model function 146

color-spec-p function 146

column-layout class 31 , 46 , 86

column-layout class 47

combo box 40

combo boxes 40

complete-in-place function 111

confirm-yes-or-no function 96

contain function 7 , 11 , 119

convert-color function 141 , 148

convert-external-image function 139

convert-to-screen function 12 , 13 , 14 , 15

:create-callback initarg 63 , 140

creating menus 69

creating submenus 70

current-printer function 151

D

:data callback type 43

:data initarg 8 , 26

:data-interface callback type 43

default settings

selections 37

:default-initargs class option 83 , 86

defclass macro 81 , 83 , 116

define-color-alias function 146

define-color-models macro 149

define-interface macro 81

arguments supplied to 83

defpackage function 6

delete-color-translation function 146 , 149

:description initarg 46

description of the CAPI 1 - 3

destroy generic function 67

dialogs

creating your own 105 - 109

description of 95 - 109

in front 104

modal 103

owners 104 - 105

display callback 116

display function 7 , 8 , 11 , 14 , 15

display panes 23

:display-callback initarg 140

display-dialog function 105 , 107 , 110

displaying text on screen 23

display-message function 9 , 96

display-pane class 23 , 48

dividers 60

document-frame class 61

double buffering 129

draw-circle function 115

draw-image function 137

drawn-pinboard-object class 119 , 123 , 131

draw-point function 118

drop-down list box 40

E

Edit menu 79

editor panes 24

editor-pane class 24 , 48 , 90 , 111

subclasses 25

editor-pane-blink-rate function 25

editor-pane-text accessor 66 , 91

:element callback type 43

elements

creating your own 113 - 127

generic properties of 17 - 18

element-widget-name accessor 12

:enabled initarg 25 , 26

:enabled-function initarg 78

:enabled-function-for-dialog initarg 78

ensure-color function 148

ensure-model-color function 148

:evaluate keyword argument 103

event handlers 116 - 119 , ??- 119

execute-with-interface function 11 , 63

execute-with-interface-if-alive function 11 , 63

exit-confirmer function 108

exit-dialog function 105 , 106 , 108

:extend-callback initarg 37 , 39 , 43

extended selection

specifying 42

using on diferent platforms 42

:extended-selection interaction style 34 - 35 , 42

extension gesture 35

external constraints 53

external image

dimensions 140

from displayed window 141

from on-screen window 141

width and height 140

external-image class 137

externalize-image function 139

:external-max-height initarg 53

:external-max-width initarg 53

:external-min-height initarg 53

:external-min-width initarg 53

F

:file-completion initarg 110

files

prompting for 101 - 103

:filter initarg 37

find-best-font function 135

find-matching-fonts function 135

:font initarg 18

fonts 18

attributes 135

lookup 136

prompting for 102

frame 21

free-image function 137 , 139

free-image-access function 141

functions

sample 17

G

generic properties of elements 17 - 18

geometry of layouts, specifying 52 - 56

get-all-color-names function 145

get-color-alias-translation function 146

get-color-spec function 145

get-page-area function 154

get-printer-metrics function 154

graph panes

callbacks 39

graphics

creating permanent displays 115

displaying 113 - 116

graphics ports 129

drawing functions 133

pixmap 134

graphics state 130

graphics state parameters 131

graph-pane class 37

implementation of 120

grid-layout class 20 , 49

groupbox 21

GTK+

resources 12

H

hardcopy API 151 - 154

hierarchy of menus 74

hints 52

:horizontal-scroll initarg 18 , 47

I

image class 136

image-access-pixel function 141

image-access-transfer-from-image function 141

image-access-transfer-to-image function 141

:image-function initarg 40 , 79

image-height accessor 140

image-width accessor 140

:initial-value initarg 98

:in-place-completion-function initarg 110

:in-place-filter initarg 111

:input-model initarg 118

integers

prompting for 98 - 99

interaction

general properties 41

in lists 34

:interaction initarg 34 , 41 , 71 , 100

interactive streams 26

interactive-stream class 26

:interface callback type 43

interface class 3 , 21 , 28 , 81

interface-customize-toolbar function 28

interface-default-toolbar-states function 28

interface-display generic function 64

interface-extend-title generic function 21

interfaces

defining 81 - 93

description of 81

layouts, specifying 84

menus, specifying 87 - 90

panes, specifying 83

title, specifying 83

interface-title accessor 21

interface-toolbar-state function 28

interface-update-toolbar function 28

internal constraints 53

:internal-max-height initarg 53

:internal-max-width initarg 53

:internal-min-height initarg 53

:internal-min-width initarg 53

item-pinboard-object class 119

:items initarg 34 , 69 , 73

K

key press 116 - 119

L

:layout-class initarg 31

layout-description accessor 66

layouts

combining different 50 - 52

description of 45 - 56

introduction to 7

specifying geometry 52 - 56

specifying size of panes in 47

:layouts interface option 81

letters

underlined in menus etc 19

Lisp forms

prompting for 103

list function 46

list items, specifying 33

list panels 32

list-all-font-names function 135

listener panes 26

listener-pane class 26 , 48

list-panel class 20 , 32

lists

actions in 35

deselection in 35

extended selection in 34

extended selections 35

interaction in 34

multiple selection in 34

prompting with 99 - 101

retraction in 35

single selection in 34

load-color-database function 149

load-icon-image function 137 , 139

load-image function 139

M

make-container function 106

make-graphics-state function 131

make-hsv function 145

make-image-access function 140

make-image-from-port function 139

make-instance function 5

make-menu-for-pane function 80

make-pane-popup-menu generic function 80

make-rgb function 145

make-sub-image function 139

:max keyword argument 98

max-height 54

max-width 54

MDI 61

menu class 3 , 69 , 79

:menu-bar interface option 81 , 87

:menu-bar-items initarg 70

menu-component class 70

menu-component class 3

menu-item class 3 , 73 , 78

menus

components 41

creating 69

creating submenus 70

description of 69 - 78

disabling items in 78

Edit 79

grouping items together 70 - 73

individual items in 73 - 74

menu hierarchy 74

nesting 70

specifying alternative items 77

:menus interface option 81 , 87

merge-font-descriptions function 135

Microsoft Windows

Multiple-Document Interface 61

themes 12

:min keyword argument 98

min-height 54

min-width 54

:mnemonic initarg 19 , 28

mnemonics 19

in a button-panel 32

in menus 76

:mnemonics initarg 32

:mnemonic-text initarg 28

:mnemonic-title initarg 20

modal dialogs 103

Motif

resources 13

multi-line-text-input-pane class 24

:multiple-selection interaction style 34 , 41 , 72

N

:none callback type 43

:no-selection interaction style 41 , 42

O

off screen 129

off-screen 129

offscreen 129

:ok-check keyword argument 98 , 103 , 109

on screen 129

on-screen 129

onscreen 129

option panes 40

option-pane class 20 , 40

organizing panes 46

output-pane class 79 , 113 , 144

P

page-setup-dialog function 151

:pane-args initarg 101

panel

button layout 31

pane-layout accessor 65

panels

check button 31

list 32

push button 30

radio button 31

:pane-menu initarg 79

pane-popup-menu-items generic function 80

panes

accessing 85

collector 25

creating your own 113 - 127

default title position 21

display 23

editor 24

finding 85

graphs 37

listener 26

lookup 85

option 40

organizing 46

sizing 47

text input 23

title 20

:panes interface option 81

pane-supports-menus-with-images function 79

:pathname keyword argument 102

pinboard

buffered display 120

double buffering 120

flickering 120

pinboard objects 119

creating your own 123 - 127

pinboard-layout class 50 , 119 , 120

pinboard-object class 119

pixblt function 129

popup-confirmer function 107 , 108 , 110

portable font descriptions 134 - 135

print function 29

print-dialog function 105 , 151

print-editor-buffer function 154

printer-configuration-dialog function 154

print-file function 154

:print-function initarg 29

print-text function 154

prompt-for-color function 102

prompt-for-confirmation function 97

prompt-for-directory function 102

prompt-for-file function 101 , 105

prompt-for-font function 102

prompt-for-form function 103

prompt-for-integer function 98 , 108

prompt-for-number function 99

prompt-for-string function 97 , 105 , 107

prompt-for-symbol function 103

prompt-with-list function 99

prompt-with-list-non-focus function 111

prompt-with-message function 9

push button panels

creating 30

push buttons 26

push-button class 7 , 26 , 30

push-button-panel class 30

R

radio button panels

creating 31

radio buttons 27

radio-button class 28

radio-button-panel class 30 , 31 , 41

read-and-convert-external-image function 139

read-color-db function 149

:reader slot option 85

redisplay-interface function 109

register-image-translation function 139

Resources

GTK+ 12

X11/Motif 13

:retract-callback initarg 27 , 36 , 39 , 43

row-layout class 31 , 46 , 47 , 86

S

scroll bars

programmatic control 65

specifying 18

scroll generic function 65

scroll-if-not-visible-p accessor 65

:selected initarg 28

:selected-item initarg 40 , 42

:selected-items initarg 42

selection gesture 35

:selection initarg 37 , 42

:selection-callback initarg 30 , 34 , 36 , 39 , 43 , 92

selections 34 - 37

default settings 37

extending 35

general properties 42

specifying multiple 41

separators 60

set-application-themed function 12

set-default-interface-prefix-suffix function 21

setf function 22 , 26

set-graphics-state function 131

set-hint-table function 56

set-printer-metrics function 154

set-printer-options function 151

set-top-level-interface-geometry function 64

simple-print-port function 154

single selection

specifying 41

:single-selection interaction style 34 , 41 , 71

slot 5

slot-value function 5

streams

interactive 26

strings

prompting for 97

subclasses

finding 21

subclasses, finding 21

symbols

prompting for 103

T

text

displaying 22

displaying on screen 23

editing 22

entering 22

:text initarg 18 , 23 , 24 , 25

text input panes 23

text-input-pane class 20 , 23 , 110

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

:title initarg 21 , 83

title panes 20

titled-object class 20

titled-pane-title accessor 91

:title-font initarg 21

title-pane class 20 , 144

:title-position initarg 22 , 47

titles

changing 22 , 93

changing interactively 22

for elements 21

for interfaces 21 , 93

for windows 21 , 93

specifying 20 , 20 - 22

specifying directly 21

toolbar

customize 28

folding 28

toolbar buttons 28

toolbars 28

top-level-interface-display-state function 67

U

unconvert-color function 141

underlined letters 19

user input 95 - 109

using callback functions 17

using the CAPI 6

V

:value-function keyword argument 108

values

prompting for 97 - 103

:vertical-scroll initarg 18 , 47

visible constraints 53

:visible-max-height initarg 53

:visible-max-width initarg 53

:visible-min-height initarg 53

:visible-min-width initarg 53

W

window titles 21 , 93

window-modal dialogs 103

Windows themes 12

Windows XP themes 12

with-dialog-results macro 104

with-document-pages macro 153

with-external-metafile macro 129

with-graphics-state macro 131

with-page macro 153

with-page-transform macro 154

with-pixmap-graphics-port macro 129 , 130 , 141

with-print-job macro 129 , 151

Works menu

in CAPI objects 6

X

X resources

fallback resources 13

in delivered applications 13

X11

resources 12 , 13

:x-ratios initarg 48

Y

:y-ratios initarg 48


LispWorks CAPI User Guide (Macintosh version) - 22 Dec 2009

NextPrevTopContents