This is the cl-tui Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:48:29 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-tuiHigh-level library for making Text User Interfaces
Alexander Sukhoverkhov
MIT
cl-charms (system).
trivial-types (system).
alexandria (system).
anaphora (system).
split-sequence (system).
cl-containers (system).
osicat (system).
packages.lisp (file).
vedit.lisp (file).
macro.lisp (file).
frame-base.lisp (file).
frames.lisp (file).
layouts.lisp (file).
drawers.lisp (file).
cl-tui.lisp (file).
input.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-tui/cl-tui.asdcl-tui/packages.lispcl-tui/vedit.lispcl-tui/macro.lispcl-tui/frame-base.lispcl-tui/frames.lispcl-tui/layouts.lispcl-tui/drawers.lispcl-tui/cl-tui.lispcl-tui/input.lispcl-tui/vedit.lisppackages.lisp (file).
cl-tui (system).
clear (function).
handle-key (function).
make-vedit (function).
point (function).
print-object (method).
text (function).
(setf text) (function).
*default-handlers* (special variable).
*delimit-chars* (special variable).
backspace (function).
complete (function).
complete-option (function).
copy-vedit (function).
current-char (function).
del-word-back (function).
make-handlers (macro).
make-vedit% (function).
move-char (function).
move-full (function).
move-word (function).
put-char (function).
rem-char (function).
seq-starts-with (function).
sign (function).
subtext (function).
vedit (structure).
vedit-command (reader).
(setf vedit-command) (writer).
vedit-completion-func (reader).
(setf vedit-completion-func) (writer).
vedit-handlers (reader).
(setf vedit-handlers) (writer).
vedit-p (function).
vedit-point (reader).
(setf vedit-point) (writer).
vedit-text (reader).
(setf vedit-text) (writer).
whitespacep (function).
cl-tui/macro.lispvedit.lisp (file).
cl-tui (system).
*delayed-init* (special variable).
do-delayed-init (function).
ensure-ok (macro).
when-running (macro).
cl-tui/frame-base.lispmacro.lisp (file).
cl-tui (system).
clear-colors (function).
color (function).
color (class).
color-pair (function).
color-pair (class).
define-children (macro).
define-frame (macro).
destroy-frame (function).
frame-size (function).
initialize-instance (method).
refresh (function).
with-attributes (macro).
*color-pairs* (special variable).
*colors* (special variable).
*current-attributes* (special variable).
*used-color-pairs* (special variable).
*used-colors* (special variable).
add-child (generic function).
attributes-to-code (function).
calculate-layout (generic function).
ensure-color (function).
ensure-color-pair (function).
(setf frame) (setf expander).
frame (function).
frame (class).
frame-drawable-p (generic function).
get-attribute-name-from-keyword (function).
get-screen-size (function).
hide-window (function).
is-frame-displayed (function).
remove-child (generic function).
render-children (generic function).
render-frame (function).
render-self (generic function).
resize (function).
show-window (function).
with-processed-attributes (macro).
cl-tui/frames.lispframe-base.lisp (file).
cl-tui (system).
container-frame (class).
edit-frame (class).
initialize-instance (method).
log-frame (class).
set-prompt (writer method).
simple-frame (class).
tabbed-frame (class).
add-child (method).
calculate-layout (method).
canvas-frame (class).
copy-log-line (function).
edit-frame-prompt-string (function).
frame-drawable-p (method).
frame-drawable-p (method).
frame-drawable-p (method).
log-line (structure).
log-line-count (reader).
(setf log-line-count) (writer).
log-line-line (reader).
(setf log-line-line) (writer).
log-line-p (function).
log-line-ts (reader).
(setf log-line-ts) (writer).
make-log-line (function).
put-log-line (function).
remove-child (method).
render-children (method).
render-children (method).
render-log-line (generic function).
render-self (method).
render-self (method).
render-self (method).
split-line (function).
cl-tui/layouts.lispframes.lisp (file).
cl-tui (system).
calculate-layout (method).
calculate-split (function).
frame-free-p (function).
perform-container-layout (function).
placement-height (function).
placement-width (function).
running-sum (function).
cl-tui/drawers.lisplayouts.lisp (file).
cl-tui (system).
append-line (function).
clear (function).
clear-text (function).
draw-box (function).
draw-tab-bar (function).
get-text (function).
handle-key (function).
put-char (function).
put-text (function).
scroll-log (function).
set-split-type (function).
tab-backwards (function).
tab-forward (function).
tabs-list (function).
defun/frame (macro).
cl-tui/cl-tui.lispdrawers.lisp (file).
cl-tui (system).
destroy-screen (function).
display (function).
init-screen (function).
with-screen (macro).
*display* (special variable).
*running* (special variable).
init-color (function).
root-frame (class).
cl-tui/input.lispcl-tui.lisp (file).
cl-tui (system).
read-key (function).
*in-getch* (special variable).
*non-blocking-window* (special variable).
detect-alt-sequence (function).
key-esc-p (function).
key-function-p (function).
key-keyword (function).
keyname (function).
ncurses-resize (function).
Packages are listed by definition order.
veditcommon-lisp.
metabang.cl-containers.
clear (function).
handle-key (function).
make-vedit (function).
point (function).
text (function).
(setf text) (function).
*default-handlers* (special variable).
*delimit-chars* (special variable).
backspace (function).
complete (function).
complete-option (function).
copy-vedit (function).
current-char (function).
del-word-back (function).
make-handlers (macro).
make-vedit% (function).
move-char (function).
move-full (function).
move-word (function).
put-char (function).
rem-char (function).
seq-starts-with (function).
sign (function).
subtext (function).
vedit (structure).
vedit-command (reader).
(setf vedit-command) (writer).
vedit-completion-func (reader).
(setf vedit-completion-func) (writer).
vedit-handlers (reader).
(setf vedit-handlers) (writer).
vedit-p (function).
vedit-point (reader).
(setf vedit-point) (writer).
vedit-text (reader).
(setf vedit-text) (writer).
whitespacep (function).
cl-tuialexandria.
anaphora.
common-lisp.
split-sequence.
append-line (function).
clear (function).
clear-colors (function).
clear-text (function).
color (function).
color (class).
color-pair (function).
color-pair (class).
container-frame (class).
define-children (macro).
define-frame (macro).
destroy-frame (function).
destroy-screen (function).
display (function).
draw-box (function).
draw-tab-bar (function).
edit-frame (class).
frame-size (function).
get-text (function).
handle-key (function).
init-screen (function).
log-frame (class).
put-char (function).
put-text (function).
read-key (function).
refresh (function).
scroll-log (function).
set-prompt (generic writer).
set-split-type (function).
simple-frame (class).
tab-backwards (function).
tab-forward (function).
tabbed-frame (class).
tabs-list (function).
with-attributes (macro).
with-screen (macro).
*color-pairs* (special variable).
*colors* (special variable).
*current-attributes* (special variable).
*delayed-init* (special variable).
*display* (special variable).
*in-getch* (special variable).
*non-blocking-window* (special variable).
*running* (special variable).
*used-color-pairs* (special variable).
*used-colors* (special variable).
add-child (generic function).
attributes-to-code (function).
calculate-layout (generic function).
calculate-split (function).
canvas-frame (class).
copy-log-line (function).
defun/frame (macro).
detect-alt-sequence (function).
do-delayed-init (function).
edit-frame-prompt-string (function).
ensure-color (function).
ensure-color-pair (function).
ensure-ok (macro).
(setf frame) (setf expander).
frame (function).
frame (class).
frame-drawable-p (generic function).
frame-free-p (function).
get-attribute-name-from-keyword (function).
get-screen-size (function).
hide-window (function).
init-color (function).
is-frame-displayed (function).
key-esc-p (function).
key-function-p (function).
key-keyword (function).
keyname (function).
log-line (structure).
log-line-count (reader).
(setf log-line-count) (writer).
log-line-line (reader).
(setf log-line-line) (writer).
log-line-p (function).
log-line-ts (reader).
(setf log-line-ts) (writer).
make-log-line (function).
ncurses-resize (function).
perform-container-layout (function).
placement-height (function).
placement-width (function).
put-log-line (function).
remove-child (generic function).
render-children (generic function).
render-frame (function).
render-log-line (generic function).
render-self (generic function).
resize (function).
root-frame (class).
running-sum (function).
show-window (function).
split-line (function).
when-running (macro).
with-processed-attributes (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Enables given attributes, executes body and then ensures they’re disabled.
Ensures that wrapped code will be executed after successful initialization of screen and that screen will be properly deinitialized after ‘body’ is executed (or raised error).
Return terminal to default mode
Set the root frame. Only it and its children will be displayed. Default is :ROOT frame.
Returns the frame (Y X) size in characters. Or NIL if it’s unknown yet. Default FRAME is the whole screen.
Initializes the ncurses environment
Returns two values indicating the pressed keys.
Primary is the pressed key as a CL character or a keyword if it’s a special key.
Secondary value is the state of alt key. CL-TUI tries its best to portably guess when ESC
and when alt+smth keys were pressed but seems like ncurses still returns garbage for
alt+function (i.e. all non-printable) keys.
Ctrl and Shift keys modify the primary value.
Ctrl+anything generates a non-printable character.
Shift key is reported by making the primary value uppercase. Ctrl+Shift can’t be detected
at all.
edit-frame) edit-frame) ¶automatically generated writer method
simple-frame) &key name render &allow-other-keys) ¶(or function null)
Used to resize screen immediately instead of postponing it to the next input because characters put into queue by UNGETCH are not immediately read by GETCH. GETCH can receive them only on the next call.
T when screen is initialized
ID of the last used color-pair 0 if none
ID of the last used color 0 if none
Returns T if it’s an ALT-sequence for the next key and NIL if it’s a standalone ESC
Converts keyword to ncurses attribute.
Returns size of terminal screen.
line.
ts.
Makes sure *DISPLAY* frame and all its children have proper place on the screen
text.
Add a child to a container frame
container-frame) child &rest placement) ¶symbol) child &rest placement) ¶The frame should have actual X Y H and W when this generic is called.
It sets the frame’s children’s coordinates and sizes to actual values and recursively
calls itself on them.
The default method does nothing and should be overloaded in container frames.
container-frame)) ¶tabbed-frame)) ¶symbol)) ¶Returns whether instances of this frame can be drawed on. Otherwise no ncurses windows will be created
edit-frame)) ¶canvas-frame)) ¶Remove a child from a container frame
container-frame) child) ¶symbol) child) ¶Render children for containers
tabbed-frame)) ¶container-frame)) ¶symbol)) ¶Renders the log line to an ncurses window.
FRAME - frame to render to
LINE - object to render
Y - LAST line to be occupied by the line
W - frame width
TS - timestamp when the line was added
COUNT - count of repeating lines when deduplication is enabled
string) y w &key ts count) ¶Displays the frame on screen.
edit-frame)) ¶simple-frame)) ¶symbol)) ¶| Jump to: | (
A B C D E F G H I K L M N P R S T V W |
|---|
| Jump to: | (
A B C D E F G H I K L M N P R S T V W |
|---|
| Jump to: | *
B C D F G H I L O P R S T V W X Y |
|---|
| Jump to: | *
B C D F G H I L O P R S T V W X Y |
|---|
| Jump to: | C D E F I L M P R S T V |
|---|
| Jump to: | C D E F I L M P R S T V |
|---|