LispWorks CAPI User Guide

NextPrevTopContents

Index

A

abort-dialog function 109 , 110

:accelerator initarg 79

:action-callback initarg 39 , 41 , 45

:alternative initarg 79

apply-in-pane-process function 11 , 65

apropos-color-alias-names function 147

apropos-color-names function 146

apropos-color-spec-names function 147

augment-font-description function 137

B

:best-height initarg 120

:best-width initarg 120

boole function 135

break gesture 14

:buffer-name initarg 25

button panels

orientation 33

prompting with 104 - 105

button-panel class 32

buttons

check 27

push 26

radio 28

:buttons initarg 24

C

:callback initarg 23

callbacks

description of 8

general properties 45

graph panes 41

in interfaces 94 - 97

used for choices 37 - 39

using callback functions 17

:callback-type initarg 45 , 110

call-editor function 94

CAPI

basic objects 3

description of 1 - 3

linking code into 8

menu hierarchy 76

using the 6

check button panels 33

check buttons 27

check-button class 27 , 32

check-button-panel class 32 , 33 , 38 , 43

:children-function initarg 40

choice class 31

:choice-class initarg 104

choice-interaction accessor 44

choices 31 - 46

callbacks available 45

description of 31 - 46

general properties 43 - 46

relationship to menus 43

choice-selected-item accessor 44

choice-selected-items accessor 44

choice-selection accessor 39 , 44

classes

collections 32

creating your own 117 - 129

clear-external-image-conversions function 141

CLUE 2

CLX 2

collection class 31

collection-items accessor 68

collections

description of 31

collector panes 26

collector-pane class 26

colors

prompting for 106

colors= function 150

color-spec-model function 148

color-spec-p function 148

column-layout class 33 , 48 , 90

column-layout class 49

combo box 42

combo boxes 42

complete-in-place function 115

confirm-yes-or-no function 100

contain function 7 , 11 , 122

convert-color function 143 , 150

convert-external-image function 141

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

:create-callback initarg 65 , 142

creating menus 71

creating submenus 72

current-printer function 153

D

:data callback type 45

:data initarg 8 , 27

:data-interface callback type 45

default settings

selections 39

:default-initargs class option 87 , 90

defclass macro 85 , 87 , 120

define-color-alias function 148

define-color-models macro 151

define-interface macro 85

arguments supplied to 87

defpackage function 6

delete-color-translation function 148 , 151

:description initarg 48

description of the CAPI 1 - 3

destroy generic function 69

dialogs

creating your own 109 - 113

description of 99 - 113

in front 108

modal 107

owners 108 - 109

display callback 119

display function 7 , 8 , 11 , 14 , 15

display panes 23

:display-callback initarg 142

display-dialog function 109 , 111 , 114

displaying text on screen 23

display-message function 9 , 100

display-pane class 23 , 50

dividers 62

document-frame class 63

double buffering 131

draw-circle function 119

draw-image function 139

drawn-pinboard-object class 122 , 126 , 133

draw-point function 121

drop-down list box 42

E

editor panes 24

editor-pane class 24 , 50 , 94 , 115

subclasses 26

editor-pane-blink-rate function 25

editor-pane-text accessor 68 , 95

:element callback type 45

elements

creating your own 117 - 129

generic properties of 17 - 18

element-widget-name accessor 12

:enabled initarg 25 , 27

:enabled-function initarg 80

:enabled-function-for-dialog initarg 81

ensure-color function 150

ensure-model-color function 150

:evaluate keyword argument 107

event handlers 120 - 122 , ??- 122

execute-with-interface function 11 , 65

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

exit-confirmer function 112

exit-dialog function 109 , 110 , 112

:extend-callback initarg 38 , 41 , 45

extended selection

specifying 44

using on diferent platforms 44

:extended-selection interaction style 36 - 37 , 44

extension gesture 37

external constraints 55

external image

dimensions 142

from displayed window 143

from on-screen window 143

width and height 142

external-image class 139

externalize-image function 141

:external-max-height initarg 55

:external-max-width initarg 55

:external-min-height initarg 55

:external-min-width initarg 55

F

:file-completion initarg 114

files

prompting for 105 - 107

:filter initarg 39

find-best-font function 137

find-matching-fonts function 137

:font initarg 18

fonts 18

attributes 137

lookup 138

prompting for 106

frame 21

free-image function 139 , 141

free-image-access function 143

functions

sample 17

G

generic properties of elements 17 - 18

geometry of layouts, specifying 54 - 58

get-all-color-names function 147

get-color-alias-translation function 148

get-color-spec function 147

get-page-area function 156

get-printer-metrics function 156

graph panes

callbacks 41

graphics

creating permanent displays 119

displaying 117 - 120

graphics ports 131

drawing functions 135

pixmap 136

graphics state 132

graphics state parameters 133

graph-pane class 39

implementation of 123

grid-layout class 20 , 51

groupbox 21

GTK+

resources 12

H

hardcopy API 153 - 156

hierarchy of menus 76

hints 54

:horizontal-scroll initarg 18 , 49

I

image class 138

image-access-pixel function 143

image-access-transfer-from-image function 143

image-access-transfer-to-image function 143

:image-function initarg 42 , 81

image-height accessor 142

image-width accessor 142

:initial-value initarg 102

:in-place-completion-function initarg 114

:in-place-filter initarg 115

:input-model initarg 121

integers

prompting for 102 - 103

interaction

general properties 43

in lists 36

:interaction initarg 36 , 43 , 73 , 103

interactive streams 26

interactive-stream class 26

:interface callback type 45

interface class 3 , 21 , 29 , 85

interface-customize-toolbar function 29

interface-default-toolbar-states function 29

interface-display generic function 66

interface-extend-title generic function 21

interfaces

defining 85 - 97

description of 85

layouts, specifying 88

menus, specifying 91 - 94

panes, specifying 88

title, specifying 87

interface-title accessor 21

interface-toolbar-state function 29

interface-update-toolbar function 29

internal constraints 55

:internal-max-height initarg 56

:internal-max-width initarg 55

:internal-min-height initarg 56

:internal-min-width initarg 55

item-pinboard-object class 122

:items initarg 35 , 71 , 75

K

key press 120 - 122

L

:layout-class initarg 33

layout-description accessor 68

layouts

combining different 52 - 54

description of 47 - 58

introduction to 7

specifying geometry 54 - 58

specifying size of panes in 49

:layouts interface option 85

letters

underlined in menus etc 19

Lisp forms

prompting for 107

list function 48

list items, specifying 35

list panels 34

list-all-font-names function 137

listener panes 26

listener-pane class 26 , 50

list-panel class 20 , 34

lists

actions in 37

deselection in 37

extended selection in 36

extended selections 36

interaction in 36

multiple selection in 36

prompting with 103 - 105

retraction in 37

single selection in 36

load-color-database function 151

load-icon-image function 139 , 141

load-image function 141

M

make-container function 110

make-graphics-state function 133

make-hsv function 147

make-image-access function 142

make-image-from-port function 141

make-instance function 5

make-menu-for-pane function 82

make-pane-popup-menu generic function 82

make-rgb function 147

make-sub-image function 141

:max keyword argument 102

max-height 56

max-width 56

MDI 7 , 63

menu class 3 , 71 , 81

:menu-bar interface option 85 , 91

:menu-bar-items initarg 72

menu-component class 72

menu-component class 3

menu-item class 3 , 75 , 81

menus

components 43

creating 71

creating submenus 72

description of 71 - 81

disabling items in 80 - 81

grouping items together 72 - 75

individual items in 75 - 76

menu hierarchy 76

nesting 72

specifying alternative items 79

:menus interface option 85 , 91

merge-font-descriptions function 137

Microsoft Windows

Multiple-Document Interface 7 , 63

themes 12

:min keyword argument 102

min-height 56

min-width 56

:mnemonic initarg 19 , 28

mnemonics 19

in a button-panel 34

in menus 78

:mnemonics initarg 34

:mnemonic-text initarg 28

:mnemonic-title initarg 20

modal dialogs 107

Motif

resources 13

multi-line-text-input-pane class 24

:multiple-selection interaction style 36 , 43 , 74

N

:none callback type 45

:no-selection interaction style 43 , 44

O

off screen 131

off-screen 131

offscreen 131

:ok-check keyword argument 102 , 107 , 113

on screen 131

on-screen 131

onscreen 131

option panes 42

option-pane class 20 , 42

organizing panes 48

output-pane class 82 , 117 , 146

P

page-setup-dialog function 153

:pane-args initarg 105

panel

button layout 33

pane-layout accessor 67

panels

check button 33

list 34

push button 32

radio button 33

:pane-menu initarg 82

pane-popup-menu-items generic function 82

panes

accessing 89

collector 26

creating your own 117 - 129

default title position 21

display 23

editor 24

finding 89

graphs 39

listener 26

lookup 89

option 42

organizing 48

sizing 49

text input 23

title 20

:panes interface option 85

pane-supports-menus-with-images function 82

:pathname keyword argument 106

pinboard

buffered display 123

double buffering 123

flickering 123

pinboard objects 122

creating your own 126 - 129

pinboard-layout class 52 , 122 , 123

pinboard-object class 122

pixblt function 131

popup-confirmer function 111 , 112 , 114

portable font descriptions 136 - 137

print function 31

print-dialog function 109 , 153

print-editor-buffer function 156

printer-configuration-dialog function 156

print-file function 156

:print-function initarg 31

print-text function 156

prompt-for-color function 106

prompt-for-confirmation function 101

prompt-for-directory function 106

prompt-for-file function 105 , 109

prompt-for-font function 106

prompt-for-form function 107

prompt-for-integer function 102 , 112

prompt-for-number function 103

prompt-for-string function 101 , 109 , 111

prompt-for-symbol function 107

prompt-with-list function 103

prompt-with-list-non-focus function 115

push button panels

creating 32

push buttons 26

push-button class 7 , 27 , 32

push-button-panel class 32

R

radio button panels

creating 33

radio buttons 28

radio-button class 28

radio-button-panel class 32 , 33 , 43

read-and-convert-external-image function 141

read-color-db function 151

:reader slot option 89

redisplay-interface function 113

register-image-translation function 141

Resources

GTK+ 12

X11/Motif 13

:retract-callback initarg 27 , 37 , 41 , 45

row-layout class 33 , 48 , 49 , 90

S

scroll bars

programmatic control 67

specifying 18

scroll generic function 67

scroll-if-not-visible-p accessor 67

:selected initarg 28

:selected-item initarg 42 , 44

:selected-items initarg 44

selection gesture 37

:selection initarg 39 , 44

:selection-callback initarg 32 , 35 , 37 , 41 , 45 , 96

selections 36 - 39

default settings 39

extending 36

general properties 44

specifying multiple 43

separators 62

set-application-themed function 12

set-default-interface-prefix-suffix function 21

setf function 22 , 27

set-graphics-state function 133

set-hint-table function 58

set-printer-metrics function 156

set-printer-options function 153

set-top-level-interface-geometry function 66

simple-print-port function 156

single selection

specifying 43

:single-selection interaction style 36 , 43 , 73

slot 5

slot-value function 5

streams

interactive 26

strings

prompting for 101

subclasses

finding 21

subclasses, finding 21

symbols

prompting for 107

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

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

:title initarg 21 , 87

title panes 20

titled-object class 20

titled-pane-title accessor 95

:title-font initarg 22

title-pane class 20 , 146

:title-position initarg 22 , 49

titles

changing 22 , 97

changing interactively 22

for elements 21

for interfaces 21 , 97

for windows 21 , 97

specifying 20 , 20 - 22

specifying directly 21

toolbar

customize 28

folding 28

toolbar buttons 28

toolbars 28

top-level-interface-display-state function 69

U

unconvert-color function 143

underlined letters 19

user input 99 - 113

using callback functions 17

using the CAPI 6

V

:value-function keyword argument 112

values

prompting for 101 - 107

:vertical-scroll initarg 18 , 49

visible constraints 55

:visible-max-height initarg 55

:visible-max-width initarg 55

:visible-min-height initarg 55

:visible-min-width initarg 55

W

window titles 21 , 97

window-modal dialogs 107

Windows themes 12

Windows XP themes 12

with-dialog-results macro 108

with-document-pages macro 155

with-external-metafile macro 131

with-graphics-state macro 133

with-page macro 155

with-page-transform macro 156

with-pixmap-graphics-port macro 131 , 132 , 143

with-print-job macro 131 , 153

Works menu

in CAPI objects 7

X

X resources

fallback resources 13

in delivered applications 13

X11

resources 12 , 13

:x-ratios initarg 50

Y

:y-ratios initarg 50


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

NextPrevTopContents