The cl-tk Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-tk Reference Manual

This is the cl-tk Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:35:18 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

1.1 cl-tk

Author

Marijn Haverbeke <marijnh@gmail.com>

License

BSD

Description

Minimal bridge to Tcl/Tk

Dependency

cffi

Source

cl-tk.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-tk.asd

Location

cl-tk.asd

Systems

cl-tk (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-tk/package.lisp

Parent

cl-tk (system)

Location

package.lisp

Packages

cl-tk


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 cl-tk/base.lisp

Dependency

package.lisp (file)

Parent

cl-tk (system)

Location

base.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 cl-tk/wish.lisp

Dependency

base.lisp (file)

Parent

cl-tk (system)

Location

wish.lisp

Exported Definitions

wish-tk (class)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.5 cl-tk/cffi.lisp

Dependency

base.lisp (file)

Parent

cl-tk (system)

Location

cffi.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.6 cl-tk/ffi.lisp

Dependency

cffi.lisp (file)

Parent

cl-tk (system)

Location

ffi.lisp

Exported Definitions

ffi-tk (class)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 cl-tk

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *tk*
Package

cl-tk

Source

base.lisp (file)

Special Variable: *wname*
Package

cl-tk

Source

base.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Macros

Macro: bind-event TAG EVENT (&rest FIELDS) &body BODY

For example (bind-event "." "<1>" ((x #x) (y #y)) (format t "clicked ~a,~a" x y))

Package

cl-tk

Source

base.lisp (file)

Macro: event-handler* &body BODY
Package

cl-tk

Source

base.lisp (file)

Macro: with-local-events &body BODY
Package

cl-tk

Source

base.lisp (file)

Macro: with-tk (&optional BACK-END) &body BODY
Package

cl-tk

Source

base.lisp (file)

Macro: with-wname NAME &body BODY
Package

cl-tk

Source

base.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Functions

Function: alive-p ()
Package

cl-tk

Source

base.lisp (file)

Function: clear-events SNAPSHOT
Package

cl-tk

Source

base.lisp (file)

Function: destroy ()
Package

cl-tk

Source

base.lisp (file)

Function: doevent &optional BLOCK
Package

cl-tk

Source

base.lisp (file)

Function: doevents ()
Package

cl-tk

Source

base.lisp (file)

Function: event-handler FUNC &optional FIELDS
Package

cl-tk

Source

base.lisp (file)

Function: event-snapshot ()
Package

cl-tk

Source

base.lisp (file)

Function: lit VAL
Package

cl-tk

Source

base.lisp (file)

Function: mainloop ()
Package

cl-tk

Source

base.lisp (file)

Function: tcl COMMAND &rest ARGS
Package

cl-tk

Source

base.lisp (file)

Function: tcl-error CONTROL &rest ARGS
Package

cl-tk

Source

base.lisp (file)

Function: tcl-escape STR
Package

cl-tk

Source

base.lisp (file)

Function: tcl[ COMMAND &rest ARGS
Package

cl-tk

Source

base.lisp (file)

Function: tcl{ COMMAND &rest ARGS
Package

cl-tk

Source

base.lisp (file)

Function: toplevel-tk &optional BACK-END
Package

cl-tk

Source

base.lisp (file)

Function: unregister-event ID
Package

cl-tk

Source

base.lisp (file)

Function: wname NAME &optional ID
Package

cl-tk

Source

base.lisp (file)

Function: wname-car NAME
Package

cl-tk

Source

base.lisp (file)

Function: wname-cdr NAME
Package

cl-tk

Source

base.lisp (file)

Function: wname-cons NAME BASE
Package

cl-tk

Source

base.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.4 Conditions

Condition: tcl-error ()
Package

cl-tk

Source

base.lisp (file)

Direct superclasses

simple-error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.5 Classes

Class: ffi-tk ()
Package

cl-tk

Source

ffi.lisp (file)

Direct superclasses

tk (class)

Direct methods
Direct slots
Slot: interp
Readers

@interp (generic function)

Slot: alive
Initform

t

Readers

@alive (generic function)

Writers

(setf @alive) (generic function)

Class: wish-tk ()
Package

cl-tk

Source

wish.lisp (file)

Direct superclasses

tk (class)

Direct methods
Direct slots
Slot: stream
Readers

@stream (generic function)

Slot: binary
Initargs

:binary

Initform

(quote ("wish8.5" "wish85" "wish"))

Readers

@binary (generic function)

Slot: queue
Readers

@queue (generic function)

Writers

(setf @queue) (generic function)

Slot: alive
Initform

t

Readers

@alive (generic function)

Writers

(setf @alive) (generic function)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Constants

Constant: +tcl-dont-wait+
Package

cl-tk

Source

ffi.lisp (file)

Constant: +tcl-error+
Package

cl-tk

Source

ffi.lisp (file)

Constant: +tcl-ok+
Package

cl-tk

Source

ffi.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Functions

Function: copy-literal-string INSTANCE
Package

cl-tk

Source

base.lisp (file)

Function: create-interp ()
Package

cl-tk

Source

cffi.lisp (file)

Function: delete-interp INTERP
Package

cl-tk

Source

cffi.lisp (file)

Function: do-one-event FLAGS
Package

cl-tk

Source

cffi.lisp (file)

Function: get-string-result INTERP
Package

cl-tk

Source

cffi.lisp (file)

Function: handle-event TK ID ARGS
Package

cl-tk

Source

base.lisp (file)

Function: input-pending-p STREAM
Package

cl-tk

Source

wish.lisp (file)

Function: literal-string-p OBJECT
Package

cl-tk

Source

base.lisp (file)

Function: literal-string-val INSTANCE
Function: (setf literal-string-val) VALUE INSTANCE
Package

cl-tk

Source

base.lisp (file)

Function: load-libs ()
Package

cl-tk

Source

cffi.lisp (file)

Function: null-pointer-p PTR
Package

cl-tk

Source

cffi.lisp (file)

Function: read-wish-message STREAM &optional TYPE
Package

cl-tk

Source

wish.lisp (file)

Function: register-event HANDLER
Package

cl-tk

Source

base.lisp (file)

Function: start-tk &optional BACK-END
Package

cl-tk

Source

base.lisp (file)

Function: tcl-eval INTERP SCRIPT
Package

cl-tk

Source

cffi.lisp (file)

Function: tcl-form VAL
Package

cl-tk

Source

base.lisp (file)

Function: tcl-init INTERP
Package

cl-tk

Source

cffi.lisp (file)

Function: tk-init INTERP
Package

cl-tk

Source

cffi.lisp (file)

Function: try-wish-binaries BINARIES
Package

cl-tk

Source

wish.lisp (file)

Function: wish-stream BINARY-NAME
Package

cl-tk

Source

wish.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Generic functions

Generic Function: @alive OBJECT
Generic Function: (setf @alive) NEW-VALUE OBJECT
Package

cl-tk

Methods
Method: @alive (FFI-TK ffi-tk)

automatically generated reader method

Source

ffi.lisp (file)

Method: (setf @alive) NEW-VALUE (FFI-TK ffi-tk)

automatically generated writer method

Source

ffi.lisp (file)

Method: @alive (WISH-TK wish-tk)

automatically generated reader method

Source

wish.lisp (file)

Method: (setf @alive) NEW-VALUE (WISH-TK wish-tk)

automatically generated writer method

Source

wish.lisp (file)

Generic Function: @binary OBJECT
Package

cl-tk

Methods
Method: @binary (WISH-TK wish-tk)

automatically generated reader method

Source

wish.lisp (file)

Generic Function: @interp OBJECT
Package

cl-tk

Methods
Method: @interp (FFI-TK ffi-tk)

automatically generated reader method

Source

ffi.lisp (file)

Generic Function: @next-id OBJECT
Generic Function: (setf @next-id) NEW-VALUE OBJECT
Package

cl-tk

Methods
Method: @next-id (TK tk)

automatically generated reader method

Source

base.lisp (file)

Method: (setf @next-id) NEW-VALUE (TK tk)

automatically generated writer method

Source

base.lisp (file)

Generic Function: @queue OBJECT
Generic Function: (setf @queue) NEW-VALUE OBJECT
Package

cl-tk

Methods
Method: @queue (WISH-TK wish-tk)

automatically generated reader method

Source

wish.lisp (file)

Method: (setf @queue) NEW-VALUE (WISH-TK wish-tk)

automatically generated writer method

Source

wish.lisp (file)

Generic Function: @stream OBJECT
Package

cl-tk

Methods
Method: @stream (WISH-TK wish-tk)

automatically generated reader method

Source

wish.lisp (file)

Generic Function: @table OBJECT
Package

cl-tk

Methods
Method: @table (TK tk)

automatically generated reader method

Source

base.lisp (file)

Generic Function: tcl-send TK COMMAND &optional GET-RESULT
Package

cl-tk

Source

base.lisp (file)

Methods
Method: tcl-send (TK ffi-tk) COMMAND &optional GET-RESULT
Source

ffi.lisp (file)

Method: tcl-send (TK wish-tk) COMMAND &optional GET-RESULT
Source

wish.lisp (file)

Generic Function: tk-alive-p TK
Package

cl-tk

Source

base.lisp (file)

Methods
Method: tk-alive-p (TK ffi-tk)
Source

ffi.lisp (file)

Method: tk-alive-p (TK wish-tk)
Source

wish.lisp (file)

Generic Function: tk-destroy TK
Package

cl-tk

Source

base.lisp (file)

Methods
Method: tk-destroy (TK ffi-tk)
Source

ffi.lisp (file)

Method: tk-destroy (TK wish-tk)
Source

wish.lisp (file)

Generic Function: tk-doevent TK &optional BLOCK
Package

cl-tk

Source

base.lisp (file)

Methods
Method: tk-doevent (TK ffi-tk) &optional BLOCK
Source

ffi.lisp (file)

Method: tk-doevent (TK wish-tk) &optional BLOCK
Source

wish.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Structures

Structure: literal-string ()
Package

cl-tk

Source

base.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: val
Readers

literal-string-val (function)

Writers

(setf literal-string-val) (function)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Classes

Class: tk ()
Package

cl-tk

Source

base.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: event-table
Initform

(make-hash-table :test (quote eql))

Readers

@table (generic function)

Slot: next-id
Initform

0

Readers

@next-id (generic function)

Writers

(setf @next-id) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-tk.asd: The cl-tk<dot>asd file
cl-tk/base.lisp: The cl-tk/base<dot>lisp file
cl-tk/cffi.lisp: The cl-tk/cffi<dot>lisp file
cl-tk/ffi.lisp: The cl-tk/ffi<dot>lisp file
cl-tk/package.lisp: The cl-tk/package<dot>lisp file
cl-tk/wish.lisp: The cl-tk/wish<dot>lisp file

F
File, Lisp, cl-tk.asd: The cl-tk<dot>asd file
File, Lisp, cl-tk/base.lisp: The cl-tk/base<dot>lisp file
File, Lisp, cl-tk/cffi.lisp: The cl-tk/cffi<dot>lisp file
File, Lisp, cl-tk/ffi.lisp: The cl-tk/ffi<dot>lisp file
File, Lisp, cl-tk/package.lisp: The cl-tk/package<dot>lisp file
File, Lisp, cl-tk/wish.lisp: The cl-tk/wish<dot>lisp file

L
Lisp File, cl-tk.asd: The cl-tk<dot>asd file
Lisp File, cl-tk/base.lisp: The cl-tk/base<dot>lisp file
Lisp File, cl-tk/cffi.lisp: The cl-tk/cffi<dot>lisp file
Lisp File, cl-tk/ffi.lisp: The cl-tk/ffi<dot>lisp file
Lisp File, cl-tk/package.lisp: The cl-tk/package<dot>lisp file
Lisp File, cl-tk/wish.lisp: The cl-tk/wish<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (   @  
A   B   C   D   E   F   G   H   I   L   M   N   R   S   T   U   W  
Index Entry  Section

(
(setf @alive): Internal generic functions
(setf @alive): Internal generic functions
(setf @alive): Internal generic functions
(setf @next-id): Internal generic functions
(setf @next-id): Internal generic functions
(setf @queue): Internal generic functions
(setf @queue): Internal generic functions
(setf literal-string-val): Internal functions

@
@alive: Internal generic functions
@alive: Internal generic functions
@alive: Internal generic functions
@binary: Internal generic functions
@binary: Internal generic functions
@interp: Internal generic functions
@interp: Internal generic functions
@next-id: Internal generic functions
@next-id: Internal generic functions
@queue: Internal generic functions
@queue: Internal generic functions
@stream: Internal generic functions
@stream: Internal generic functions
@table: Internal generic functions
@table: Internal generic functions

A
alive-p: Exported functions

B
bind-event: Exported macros

C
clear-events: Exported functions
copy-literal-string: Internal functions
create-interp: Internal functions

D
delete-interp: Internal functions
destroy: Exported functions
do-one-event: Internal functions
doevent: Exported functions
doevents: Exported functions

E
event-handler: Exported functions
event-handler*: Exported macros
event-snapshot: Exported functions

F
Function, (setf literal-string-val): Internal functions
Function, alive-p: Exported functions
Function, clear-events: Exported functions
Function, copy-literal-string: Internal functions
Function, create-interp: Internal functions
Function, delete-interp: Internal functions
Function, destroy: Exported functions
Function, do-one-event: Internal functions
Function, doevent: Exported functions
Function, doevents: Exported functions
Function, event-handler: Exported functions
Function, event-snapshot: Exported functions
Function, get-string-result: Internal functions
Function, handle-event: Internal functions
Function, input-pending-p: Internal functions
Function, lit: Exported functions
Function, literal-string-p: Internal functions
Function, literal-string-val: Internal functions
Function, load-libs: Internal functions
Function, mainloop: Exported functions
Function, null-pointer-p: Internal functions
Function, read-wish-message: Internal functions
Function, register-event: Internal functions
Function, start-tk: Internal functions
Function, tcl: Exported functions
Function, tcl-error: Exported functions
Function, tcl-escape: Exported functions
Function, tcl-eval: Internal functions
Function, tcl-form: Internal functions
Function, tcl-init: Internal functions
Function, tcl[: Exported functions
Function, tcl{: Exported functions
Function, tk-init: Internal functions
Function, toplevel-tk: Exported functions
Function, try-wish-binaries: Internal functions
Function, unregister-event: Exported functions
Function, wish-stream: Internal functions
Function, wname: Exported functions
Function, wname-car: Exported functions
Function, wname-cdr: Exported functions
Function, wname-cons: Exported functions

G
Generic Function, (setf @alive): Internal generic functions
Generic Function, (setf @next-id): Internal generic functions
Generic Function, (setf @queue): Internal generic functions
Generic Function, @alive: Internal generic functions
Generic Function, @binary: Internal generic functions
Generic Function, @interp: Internal generic functions
Generic Function, @next-id: Internal generic functions
Generic Function, @queue: Internal generic functions
Generic Function, @stream: Internal generic functions
Generic Function, @table: Internal generic functions
Generic Function, tcl-send: Internal generic functions
Generic Function, tk-alive-p: Internal generic functions
Generic Function, tk-destroy: Internal generic functions
Generic Function, tk-doevent: Internal generic functions
get-string-result: Internal functions

H
handle-event: Internal functions

I
input-pending-p: Internal functions

L
lit: Exported functions
literal-string-p: Internal functions
literal-string-val: Internal functions
load-libs: Internal functions

M
Macro, bind-event: Exported macros
Macro, event-handler*: Exported macros
Macro, with-local-events: Exported macros
Macro, with-tk: Exported macros
Macro, with-wname: Exported macros
mainloop: Exported functions
Method, (setf @alive): Internal generic functions
Method, (setf @alive): Internal generic functions
Method, (setf @next-id): Internal generic functions
Method, (setf @queue): Internal generic functions
Method, @alive: Internal generic functions
Method, @alive: Internal generic functions
Method, @binary: Internal generic functions
Method, @interp: Internal generic functions
Method, @next-id: Internal generic functions
Method, @queue: Internal generic functions
Method, @stream: Internal generic functions
Method, @table: Internal generic functions
Method, tcl-send: Internal generic functions
Method, tcl-send: Internal generic functions
Method, tk-alive-p: Internal generic functions
Method, tk-alive-p: Internal generic functions
Method, tk-destroy: Internal generic functions
Method, tk-destroy: Internal generic functions
Method, tk-doevent: Internal generic functions
Method, tk-doevent: Internal generic functions

N
null-pointer-p: Internal functions

R
read-wish-message: Internal functions
register-event: Internal functions

S
start-tk: Internal functions

T
tcl: Exported functions
tcl-error: Exported functions
tcl-escape: Exported functions
tcl-eval: Internal functions
tcl-form: Internal functions
tcl-init: Internal functions
tcl-send: Internal generic functions
tcl-send: Internal generic functions
tcl-send: Internal generic functions
tcl[: Exported functions
tcl{: Exported functions
tk-alive-p: Internal generic functions
tk-alive-p: Internal generic functions
tk-alive-p: Internal generic functions
tk-destroy: Internal generic functions
tk-destroy: Internal generic functions
tk-destroy: Internal generic functions
tk-doevent: Internal generic functions
tk-doevent: Internal generic functions
tk-doevent: Internal generic functions
tk-init: Internal functions
toplevel-tk: Exported functions
try-wish-binaries: Internal functions

U
unregister-event: Exported functions

W
wish-stream: Internal functions
with-local-events: Exported macros
with-tk: Exported macros
with-wname: Exported macros
wname: Exported functions
wname-car: Exported functions
wname-cdr: Exported functions
wname-cons: Exported functions

Jump to:   (   @  
A   B   C   D   E   F   G   H   I   L   M   N   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
A   B   C   E   I   N   Q   S   V  
Index Entry  Section

*
*tk*: Exported special variables
*wname*: Exported special variables

+
+tcl-dont-wait+: Internal constants
+tcl-error+: Internal constants
+tcl-ok+: Internal constants

A
alive: Exported classes
alive: Exported classes

B
binary: Exported classes

C
Constant, +tcl-dont-wait+: Internal constants
Constant, +tcl-error+: Internal constants
Constant, +tcl-ok+: Internal constants

E
event-table: Internal classes

I
interp: Exported classes

N
next-id: Internal classes

Q
queue: Exported classes

S
Slot, alive: Exported classes
Slot, alive: Exported classes
Slot, binary: Exported classes
Slot, event-table: Internal classes
Slot, interp: Exported classes
Slot, next-id: Internal classes
Slot, queue: Exported classes
Slot, stream: Exported classes
Slot, val: Internal structures
Special Variable, *tk*: Exported special variables
Special Variable, *wname*: Exported special variables
stream: Exported classes

V
val: Internal structures

Jump to:   *   +  
A   B   C   E   I   N   Q   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   L   P   S   T   W  
Index Entry  Section

C
cl-tk: The cl-tk system
cl-tk: The cl-tk package
Class, ffi-tk: Exported classes
Class, tk: Internal classes
Class, wish-tk: Exported classes
Condition, tcl-error: Exported conditions

F
ffi-tk: Exported classes

L
literal-string: Internal structures

P
Package, cl-tk: The cl-tk package

S
Structure, literal-string: Internal structures
System, cl-tk: The cl-tk system

T
tcl-error: Exported conditions
tk: Internal classes

W
wish-tk: Exported classes

Jump to:   C   F   L   P   S   T   W