The cl-tui Reference Manual

This is the cl-tui Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:46:35 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-tui

High-level library for making Text User Interfaces

Author

Alexander Sukhoverkhov

License

MIT

Dependencies
  • cl-charms (system).
  • trivial-types (system).
  • alexandria (system).
  • anaphora (system).
  • split-sequence (system).
  • cl-containers (system).
  • osicat (system).
Source

cl-tui.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-tui/cl-tui.asd

Source

cl-tui.asd.

Parent Component

cl-tui (system).

ASDF Systems

cl-tui.


3.1.2 cl-tui/packages.lisp

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Packages

3.1.3 cl-tui/vedit.lisp

Dependency

packages.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface
Internals

3.1.4 cl-tui/macro.lisp

Dependency

vedit.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Internals

3.1.5 cl-tui/frame-base.lisp

Dependency

macro.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface
Internals

3.1.6 cl-tui/frames.lisp

Dependency

frame-base.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface
Internals

3.1.7 cl-tui/layouts.lisp

Dependency

frames.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Internals

3.1.8 cl-tui/drawers.lisp

Dependency

layouts.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface
Internals

defun/frame (macro).


3.1.9 cl-tui/cl-tui.lisp

Dependency

drawers.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface
Internals

3.1.10 cl-tui/input.lisp

Dependency

cl-tui.lisp (file).

Source

cl-tui.asd.

Parent Component

cl-tui (system).

Public Interface

read-key (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 vedit

Source

packages.lisp.

Use List
  • common-lisp.
  • metabang.cl-containers.
Public Interface
Internals

4.2 cl-tui

Source

packages.lisp.

Use List
  • alexandria.
  • anaphora.
  • common-lisp.
  • split-sequence.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: define-children (name () &body children)
Package

cl-tui.

Source

frame-base.lisp.

Macro: define-frame (name (type &rest frame-args) &rest placement &key on &allow-other-keys)
Package

cl-tui.

Source

frame-base.lisp.

Macro: with-attributes ((&body attributes) frame &body body)

Enables given attributes, executes body and then ensures they’re disabled.

Package

cl-tui.

Source

frame-base.lisp.

Macro: with-screen ((&body arguments) &body body)

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).

Package

cl-tui.

Source

cl-tui.lisp.


5.1.2 Ordinary functions

Function: append-line (frame obj &rest init-args)
Package

cl-tui.

Source

drawers.lisp.

Function: clear (vedit)
Package

vedit.

Source

vedit.lisp.

Function: clear (frame)
Package

cl-tui.

Source

drawers.lisp.

Function: clear-colors ()
Package

cl-tui.

Source

frame-base.lisp.

Function: clear-text (frame)
Package

cl-tui.

Source

drawers.lisp.

Function: color (r g b)
Package

cl-tui.

Source

frame-base.lisp.

Function: color-pair (fg bg)
Package

cl-tui.

Source

frame-base.lisp.

Function: destroy-frame (name)
Package

cl-tui.

Source

frame-base.lisp.

Function: destroy-screen ()

Return terminal to default mode

Package

cl-tui.

Source

cl-tui.lisp.

Function: display (&optional frame)

Set the root frame. Only it and its children will be displayed. Default is :ROOT frame.

Package

cl-tui.

Source

cl-tui.lisp.

Function: draw-box (frame)
Package

cl-tui.

Source

drawers.lisp.

Function: draw-tab-bar (frame &key left-padding right-padding top-padding tab-padding)
Package

cl-tui.

Source

drawers.lisp.

Function: frame-size (&optional frame)

Returns the frame (Y X) size in characters. Or NIL if it’s unknown yet. Default FRAME is the whole screen.

Package

cl-tui.

Source

frame-base.lisp.

Function: get-text (frame)
Package

cl-tui.

Source

drawers.lisp.

Function: handle-key (vedit char)
Package

vedit.

Source

vedit.lisp.

Function: handle-key (frame key)
Package

cl-tui.

Source

drawers.lisp.

Function: init-screen (&rest arguments)

Initializes the ncurses environment

Package

cl-tui.

Source

cl-tui.lisp.

Function: make-vedit (&key point text completion-func handlers)
Package

vedit.

Source

vedit.lisp.

Function: point (vedit)
Package

vedit.

Source

vedit.lisp.

Function: put-char (frame y x c)
Package

cl-tui.

Source

drawers.lisp.

Function: put-text (frame y x str &rest format-args)
Package

cl-tui.

Source

drawers.lisp.

Function: read-key ()

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.

Package

cl-tui.

Source

input.lisp.

Function: refresh (&optional frame)
Package

cl-tui.

Source

frame-base.lisp.

Function: scroll-log (frame offset)
Package

cl-tui.

Source

drawers.lisp.

Function: set-split-type (frame split-type)
Package

cl-tui.

Source

drawers.lisp.

Function: tab-backwards (frame &optional n)
Package

cl-tui.

Source

drawers.lisp.

Function: tab-forward (frame &optional n)
Package

cl-tui.

Source

drawers.lisp.

Function: tabs-list (frame)
Package

cl-tui.

Source

drawers.lisp.

Function: text (vedit)
Package

vedit.

Source

vedit.lisp.

Function: (setf text) (vedit)
Package

vedit.

Source

vedit.lisp.


5.1.3 Generic functions

Generic Writer: set-prompt (new-value object)
Package

cl-tui.

Methods
Writer Method: set-prompt ((new-value edit-frame) edit-frame)

automatically generated writer method

Source

frames.lisp.

Target Slot

prompt.


5.1.4 Standalone methods

Method: initialize-instance ((frame simple-frame) &key name render &allow-other-keys)
Source

frames.lisp.

Method: initialize-instance ((frame frame) &key &allow-other-keys)
Source

frame-base.lisp.

Method: print-object ((obj vedit) out)
Source

vedit.lisp.


5.1.5 Classes

Class: color
Package

cl-tui.

Source

frame-base.lisp.

Direct slots
Slot: r
Type

(integer 0 1000)

Initargs

:r

Slot: g
Type

(integer 0 1000)

Initargs

:g

Slot: b
Type

(integer 0 1000)

Initargs

:b

Slot: id
Type

(or null fixnum)

Class: color-pair
Package

cl-tui.

Source

frame-base.lisp.

Direct slots
Slot: fg
Type

fixnum

Initargs

:fg

Slot: bg
Type

fixnum

Initargs

:bg

Slot: id
Type

(or null fixnum)

Class: container-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

frame.

Direct subclasses
Direct methods
Direct slots
Slot: children

Alist of frame names and any placement arguments.

Slot: split-type
Type

(member :none :vertical :horizontal)

Initform

:vertical

Initargs

:split-type

Class: edit-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

frame.

Direct methods
Direct slots
Slot: prompt
Type

(or string trivial-types:function-designator null)

Initform

""

Initargs

:prompt

Writers

set-prompt.

Slot: vedit
Initform

(vedit:make-vedit)

Class: log-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

frame.

Direct methods
Direct slots
Slot: lines
Type

list

Slot: offset
Type

fixnum

Initform

0

Slot: deduplicate-lines
Type

boolean

Initargs

:deduplicate-lines

Class: simple-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

canvas-frame.

Direct methods
Direct slots
Slot: render
Type

(or function null)

Class: tabbed-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

container-frame.

Direct methods
Direct slots
Slot: current-frame-position

Position of currently drawn children.

Initform

0

Initargs

:initial-tab

Slot: current-frame

Stores reference to currently displayed frame.


5.2 Internals


5.2.1 Special variables

Special Variable: *color-pairs*
Package

cl-tui.

Source

frame-base.lisp.

Special Variable: *colors*
Package

cl-tui.

Source

frame-base.lisp.

Special Variable: *current-attributes*
Package

cl-tui.

Source

frame-base.lisp.

Special Variable: *default-handlers*
Package

vedit.

Source

vedit.lisp.

Special Variable: *delayed-init*
Package

cl-tui.

Source

macro.lisp.

Special Variable: *delimit-chars*
Package

vedit.

Source

vedit.lisp.

Special Variable: *display*
Package

cl-tui.

Source

cl-tui.lisp.

Special Variable: *in-getch*

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.

Package

cl-tui.

Source

input.lisp.

Special Variable: *non-blocking-window*
Package

cl-tui.

Source

input.lisp.

Special Variable: *running*

T when screen is initialized

Package

cl-tui.

Source

cl-tui.lisp.

Special Variable: *used-color-pairs*

ID of the last used color-pair 0 if none

Package

cl-tui.

Source

frame-base.lisp.

Special Variable: *used-colors*

ID of the last used color 0 if none

Package

cl-tui.

Source

frame-base.lisp.


5.2.2 Macros

Macro: defun/frame (name type (&rest args) &body body)
Package

cl-tui.

Source

drawers.lisp.

Macro: ensure-ok (form)
Package

cl-tui.

Source

macro.lisp.

Macro: make-handlers ((vedit-var) &body handlers)
Package

vedit.

Source

vedit.lisp.

Macro: when-running (&body body)
Package

cl-tui.

Source

macro.lisp.

Macro: with-processed-attributes (processed-attributes frame &body body)
Package

cl-tui.

Source

frame-base.lisp.


5.2.3 Ordinary functions

Function: attributes-to-code (attributes)
Package

cl-tui.

Source

frame-base.lisp.

Function: backspace (vedit)
Package

vedit.

Source

vedit.lisp.

Function: calculate-split (children type max)
Package

cl-tui.

Source

layouts.lisp.

Function: complete (vedit)
Package

vedit.

Source

vedit.lisp.

Function: complete-option (vedit text)
Package

vedit.

Source

vedit.lisp.

Function: copy-log-line (instance)
Package

cl-tui.

Source

frames.lisp.

Function: copy-vedit (instance)
Package

vedit.

Source

vedit.lisp.

Function: current-char (vedit)
Package

vedit.

Source

vedit.lisp.

Function: del-word-back (vedit)
Package

vedit.

Source

vedit.lisp.

Function: detect-alt-sequence (key)

Returns T if it’s an ALT-sequence for the next key and NIL if it’s a standalone ESC

Package

cl-tui.

Source

input.lisp.

Function: do-delayed-init ()
Package

cl-tui.

Source

macro.lisp.

Function: edit-frame-prompt-string (edit)
Package

cl-tui.

Source

frames.lisp.

Function: ensure-color (color)
Package

cl-tui.

Source

frame-base.lisp.

Function: ensure-color-pair (pair)
Package

cl-tui.

Source

frame-base.lisp.

Function: frame (name)
Setf Expander: (setf frame) (name)
Package

cl-tui.

Source

frame-base.lisp.

Function: frame-free-p (placement)
Package

cl-tui.

Source

layouts.lisp.

Function: get-attribute-name-from-keyword (attribute)

Converts keyword to ncurses attribute.

Package

cl-tui.

Source

frame-base.lisp.

Function: get-screen-size ()

Returns size of terminal screen.

Package

cl-tui.

Source

frame-base.lisp.

Function: hide-window (frame)
Package

cl-tui.

Source

frame-base.lisp.

Function: init-color ()
Package

cl-tui.

Source

cl-tui.lisp.

Function: is-frame-displayed (frame)
Package

cl-tui.

Source

frame-base.lisp.

Function: key-esc-p (key)
Package

cl-tui.

Source

input.lisp.

Function: key-function-p (key)
Package

cl-tui.

Source

input.lisp.

Function: key-keyword (key)
Package

cl-tui.

Source

input.lisp.

Function: keyname (key)
Package

cl-tui.

Source

input.lisp.

Reader: log-line-count (instance)
Writer: (setf log-line-count) (instance)
Package

cl-tui.

Source

frames.lisp.

Target Slot

count.

Reader: log-line-line (instance)
Writer: (setf log-line-line) (instance)
Package

cl-tui.

Source

frames.lisp.

Target Slot

line.

Function: log-line-p (object)
Package

cl-tui.

Source

frames.lisp.

Reader: log-line-ts (instance)
Writer: (setf log-line-ts) (instance)
Package

cl-tui.

Source

frames.lisp.

Target Slot

ts.

Function: make-log-line (&key line ts count)
Package

cl-tui.

Source

frames.lisp.

Function: make-vedit% (&key point text completion-func handlers command)
Package

vedit.

Source

vedit.lisp.

Function: move-char (vedit amount)
Package

vedit.

Source

vedit.lisp.

Function: move-full (vedit amount)
Package

vedit.

Source

vedit.lisp.

Function: move-word (vedit amount)
Package

vedit.

Source

vedit.lisp.

Function: ncurses-resize ()
Package

cl-tui.

Source

input.lisp.

Function: perform-container-layout (children ys xs hs ws)
Package

cl-tui.

Source

layouts.lisp.

Function: placement-height (placement)
Package

cl-tui.

Source

layouts.lisp.

Function: placement-width (placement)
Package

cl-tui.

Source

layouts.lisp.

Function: put-char (vedit char)
Package

vedit.

Source

vedit.lisp.

Function: put-log-line (frame text line)
Package

cl-tui.

Source

frames.lisp.

Function: rem-char (vedit)
Package

vedit.

Source

vedit.lisp.

Function: render-frame (frame)
Package

cl-tui.

Source

frame-base.lisp.

Function: resize ()

Makes sure *DISPLAY* frame and all its children have proper place on the screen

Package

cl-tui.

Source

frame-base.lisp.

Function: running-sum (list)
Package

cl-tui.

Source

layouts.lisp.

Function: seq-starts-with (seq1 seq2)
Package

vedit.

Source

vedit.lisp.

Function: show-window (frame nh nw ny nx)
Package

cl-tui.

Source

frame-base.lisp.

Function: sign (int)
Package

vedit.

Source

vedit.lisp.

Function: split-line (text width)
Package

cl-tui.

Source

frames.lisp.

Function: subtext (vedit start count)
Package

vedit.

Source

vedit.lisp.

Reader: vedit-command (instance)
Writer: (setf vedit-command) (instance)
Package

vedit.

Source

vedit.lisp.

Target Slot

command.

Reader: vedit-completion-func (instance)
Writer: (setf vedit-completion-func) (instance)
Package

vedit.

Source

vedit.lisp.

Target Slot

completion-func.

Reader: vedit-handlers (instance)
Writer: (setf vedit-handlers) (instance)
Package

vedit.

Source

vedit.lisp.

Target Slot

handlers.

Function: vedit-p (object)
Package

vedit.

Source

vedit.lisp.

Reader: vedit-point (instance)
Writer: (setf vedit-point) (instance)
Package

vedit.

Source

vedit.lisp.

Target Slot

point.

Reader: vedit-text (instance)
Writer: (setf vedit-text) (instance)
Package

vedit.

Source

vedit.lisp.

Target Slot

text.

Function: whitespacep (c)
Package

vedit.

Source

vedit.lisp.


5.2.4 Generic functions

Generic Function: add-child (parent child &rest placement)

Add a child to a container frame

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: add-child ((frame container-frame) child &rest placement)
Source

frames.lisp.

Method: add-child ((parent symbol) child &rest placement)
Generic Function: calculate-layout (frame)

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.

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: calculate-layout ((frame container-frame))
Source

layouts.lisp.

Method: calculate-layout ((frame tabbed-frame))
Source

frames.lisp.

Method: calculate-layout ((name symbol))
Method: calculate-layout ((frame frame))
Generic Function: frame-drawable-p (frame)

Returns whether instances of this frame can be drawed on. Otherwise no ncurses windows will be created

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: frame-drawable-p ((frame edit-frame))
Source

frames.lisp.

Method: frame-drawable-p ((frame log-frame))
Source

frames.lisp.

Method: frame-drawable-p ((frame canvas-frame))
Source

frames.lisp.

Method: frame-drawable-p ((frame frame))
Generic Function: remove-child (parent child)

Remove a child from a container frame

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: remove-child ((frame container-frame) child)
Source

frames.lisp.

Method: remove-child ((parent symbol) child)
Generic Function: render-children (frame)

Render children for containers

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: render-children ((frame tabbed-frame))
Source

frames.lisp.

Method: render-children ((frame container-frame))
Source

frames.lisp.

Method: render-children ((frame frame))
Method: render-children ((name symbol))
Generic Function: render-log-line (frame line y w &key ts count)

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

Package

cl-tui.

Source

frames.lisp.

Methods
Method: render-log-line (frame (text string) y w &key ts count)
Generic Function: render-self (frame)

Displays the frame on screen.

Package

cl-tui.

Source

frame-base.lisp.

Methods
Method: render-self ((frame edit-frame))
Source

frames.lisp.

Method: render-self ((frame log-frame))
Source

frames.lisp.

Method: render-self ((frame simple-frame))
Source

frames.lisp.

Method: render-self ((frame frame))
Method: render-self ((name symbol))

5.2.5 Structures

Structure: log-line
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: line
Type

(or string standard-object)

Initform

""

Readers

log-line-line.

Writers

(setf log-line-line).

Slot: ts
Type

integer

Initform

(get-universal-time)

Readers

log-line-ts.

Writers

(setf log-line-ts).

Slot: count
Package

common-lisp.

Type

fixnum

Initform

1

Readers

log-line-count.

Writers

(setf log-line-count).

Structure: vedit
Package

vedit.

Source

vedit.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: point
Readers

vedit-point.

Writers

(setf vedit-point).

Slot: text
Readers

vedit-text.

Writers

(setf vedit-text).

Slot: completion-func
Readers

vedit-completion-func.

Writers

(setf vedit-completion-func).

Slot: handlers
Readers

vedit-handlers.

Writers

(setf vedit-handlers).

Slot: command
Readers

vedit-command.

Writers

(setf vedit-command).


5.2.6 Classes

Class: canvas-frame
Package

cl-tui.

Source

frames.lisp.

Direct superclasses

frame.

Direct subclasses
Direct methods

frame-drawable-p.

Class: frame
Package

cl-tui.

Source

frame-base.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: parent
Type

(or symbol null)

Initargs

:parent

Slot: h
Slot: w
Slot: y
Slot: x
Slot: window

Ncurses window object. Created on demand.

Class: root-frame
Package

cl-tui.

Source

cl-tui.lisp.

Direct superclasses

Appendix A Indexes


A.1 Concepts


A.2 Functions

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

(
(setf frame): Private ordinary functions
(setf log-line-count): Private ordinary functions
(setf log-line-line): Private ordinary functions
(setf log-line-ts): Private ordinary functions
(setf text): Public ordinary functions
(setf vedit-command): Private ordinary functions
(setf vedit-completion-func): Private ordinary functions
(setf vedit-handlers): Private ordinary functions
(setf vedit-point): Private ordinary functions
(setf vedit-text): Private ordinary functions

A
add-child: Private generic functions
add-child: Private generic functions
add-child: Private generic functions
append-line: Public ordinary functions
attributes-to-code: Private ordinary functions

B
backspace: Private ordinary functions

C
calculate-layout: Private generic functions
calculate-layout: Private generic functions
calculate-layout: Private generic functions
calculate-layout: Private generic functions
calculate-layout: Private generic functions
calculate-split: Private ordinary functions
clear: Public ordinary functions
clear: Public ordinary functions
clear-colors: Public ordinary functions
clear-text: Public ordinary functions
color: Public ordinary functions
color-pair: Public ordinary functions
complete: Private ordinary functions
complete-option: Private ordinary functions
copy-log-line: Private ordinary functions
copy-vedit: Private ordinary functions
current-char: Private ordinary functions

D
define-children: Public macros
define-frame: Public macros
defun/frame: Private macros
del-word-back: Private ordinary functions
destroy-frame: Public ordinary functions
destroy-screen: Public ordinary functions
detect-alt-sequence: Private ordinary functions
display: Public ordinary functions
do-delayed-init: Private ordinary functions
draw-box: Public ordinary functions
draw-tab-bar: Public ordinary functions

E
edit-frame-prompt-string: Private ordinary functions
ensure-color: Private ordinary functions
ensure-color-pair: Private ordinary functions
ensure-ok: Private macros

F
frame: Private ordinary functions
frame-drawable-p: Private generic functions
frame-drawable-p: Private generic functions
frame-drawable-p: Private generic functions
frame-drawable-p: Private generic functions
frame-drawable-p: Private generic functions
frame-free-p: Private ordinary functions
frame-size: Public ordinary functions
Function, (setf log-line-count): Private ordinary functions
Function, (setf log-line-line): Private ordinary functions
Function, (setf log-line-ts): Private ordinary functions
Function, (setf text): Public ordinary functions
Function, (setf vedit-command): Private ordinary functions
Function, (setf vedit-completion-func): Private ordinary functions
Function, (setf vedit-handlers): Private ordinary functions
Function, (setf vedit-point): Private ordinary functions
Function, (setf vedit-text): Private ordinary functions
Function, append-line: Public ordinary functions
Function, attributes-to-code: Private ordinary functions
Function, backspace: Private ordinary functions
Function, calculate-split: Private ordinary functions
Function, clear: Public ordinary functions
Function, clear: Public ordinary functions
Function, clear-colors: Public ordinary functions
Function, clear-text: Public ordinary functions
Function, color: Public ordinary functions
Function, color-pair: Public ordinary functions
Function, complete: Private ordinary functions
Function, complete-option: Private ordinary functions
Function, copy-log-line: Private ordinary functions
Function, copy-vedit: Private ordinary functions
Function, current-char: Private ordinary functions
Function, del-word-back: Private ordinary functions
Function, destroy-frame: Public ordinary functions
Function, destroy-screen: Public ordinary functions
Function, detect-alt-sequence: Private ordinary functions
Function, display: Public ordinary functions
Function, do-delayed-init: Private ordinary functions
Function, draw-box: Public ordinary functions
Function, draw-tab-bar: Public ordinary functions
Function, edit-frame-prompt-string: Private ordinary functions
Function, ensure-color: Private ordinary functions
Function, ensure-color-pair: Private ordinary functions
Function, frame: Private ordinary functions
Function, frame-free-p: Private ordinary functions
Function, frame-size: Public ordinary functions
Function, get-attribute-name-from-keyword: Private ordinary functions
Function, get-screen-size: Private ordinary functions
Function, get-text: Public ordinary functions
Function, handle-key: Public ordinary functions
Function, handle-key: Public ordinary functions
Function, hide-window: Private ordinary functions
Function, init-color: Private ordinary functions
Function, init-screen: Public ordinary functions
Function, is-frame-displayed: Private ordinary functions
Function, key-esc-p: Private ordinary functions
Function, key-function-p: Private ordinary functions
Function, key-keyword: Private ordinary functions
Function, keyname: Private ordinary functions
Function, log-line-count: Private ordinary functions
Function, log-line-line: Private ordinary functions
Function, log-line-p: Private ordinary functions
Function, log-line-ts: Private ordinary functions
Function, make-log-line: Private ordinary functions
Function, make-vedit: Public ordinary functions
Function, make-vedit%: Private ordinary functions
Function, move-char: Private ordinary functions
Function, move-full: Private ordinary functions
Function, move-word: Private ordinary functions
Function, ncurses-resize: Private ordinary functions
Function, perform-container-layout: Private ordinary functions
Function, placement-height: Private ordinary functions
Function, placement-width: Private ordinary functions
Function, point: Public ordinary functions
Function, put-char: Public ordinary functions
Function, put-char: Private ordinary functions
Function, put-log-line: Private ordinary functions
Function, put-text: Public ordinary functions
Function, read-key: Public ordinary functions
Function, refresh: Public ordinary functions
Function, rem-char: Private ordinary functions
Function, render-frame: Private ordinary functions
Function, resize: Private ordinary functions
Function, running-sum: Private ordinary functions
Function, scroll-log: Public ordinary functions
Function, seq-starts-with: Private ordinary functions
Function, set-split-type: Public ordinary functions
Function, show-window: Private ordinary functions
Function, sign: Private ordinary functions
Function, split-line: Private ordinary functions
Function, subtext: Private ordinary functions
Function, tab-backwards: Public ordinary functions
Function, tab-forward: Public ordinary functions
Function, tabs-list: Public ordinary functions
Function, text: Public ordinary functions
Function, vedit-command: Private ordinary functions
Function, vedit-completion-func: Private ordinary functions
Function, vedit-handlers: Private ordinary functions
Function, vedit-p: Private ordinary functions
Function, vedit-point: Private ordinary functions
Function, vedit-text: Private ordinary functions
Function, whitespacep: Private ordinary functions

G
Generic Function, add-child: Private generic functions
Generic Function, calculate-layout: Private generic functions
Generic Function, frame-drawable-p: Private generic functions
Generic Function, remove-child: Private generic functions
Generic Function, render-children: Private generic functions
Generic Function, render-log-line: Private generic functions
Generic Function, render-self: Private generic functions
Generic Function, set-prompt: Public generic functions
get-attribute-name-from-keyword: Private ordinary functions
get-screen-size: Private ordinary functions
get-text: Public ordinary functions

H
handle-key: Public ordinary functions
handle-key: Public ordinary functions
hide-window: Private ordinary functions

I
init-color: Private ordinary functions
init-screen: Public ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
is-frame-displayed: Private ordinary functions

K
key-esc-p: Private ordinary functions
key-function-p: Private ordinary functions
key-keyword: Private ordinary functions
keyname: Private ordinary functions

L
log-line-count: Private ordinary functions
log-line-line: Private ordinary functions
log-line-p: Private ordinary functions
log-line-ts: Private ordinary functions

M
Macro, define-children: Public macros
Macro, define-frame: Public macros
Macro, defun/frame: Private macros
Macro, ensure-ok: Private macros
Macro, make-handlers: Private macros
Macro, when-running: Private macros
Macro, with-attributes: Public macros
Macro, with-processed-attributes: Private macros
Macro, with-screen: Public macros
make-handlers: Private macros
make-log-line: Private ordinary functions
make-vedit: Public ordinary functions
make-vedit%: Private ordinary functions
Method, add-child: Private generic functions
Method, add-child: Private generic functions
Method, calculate-layout: Private generic functions
Method, calculate-layout: Private generic functions
Method, calculate-layout: Private generic functions
Method, calculate-layout: Private generic functions
Method, frame-drawable-p: Private generic functions
Method, frame-drawable-p: Private generic functions
Method, frame-drawable-p: Private generic functions
Method, frame-drawable-p: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, print-object: Public standalone methods
Method, remove-child: Private generic functions
Method, remove-child: Private generic functions
Method, render-children: Private generic functions
Method, render-children: Private generic functions
Method, render-children: Private generic functions
Method, render-children: Private generic functions
Method, render-log-line: Private generic functions
Method, render-self: Private generic functions
Method, render-self: Private generic functions
Method, render-self: Private generic functions
Method, render-self: Private generic functions
Method, render-self: Private generic functions
Method, set-prompt: Public generic functions
move-char: Private ordinary functions
move-full: Private ordinary functions
move-word: Private ordinary functions

N
ncurses-resize: Private ordinary functions

P
perform-container-layout: Private ordinary functions
placement-height: Private ordinary functions
placement-width: Private ordinary functions
point: Public ordinary functions
print-object: Public standalone methods
put-char: Public ordinary functions
put-char: Private ordinary functions
put-log-line: Private ordinary functions
put-text: Public ordinary functions

R
read-key: Public ordinary functions
refresh: Public ordinary functions
rem-char: Private ordinary functions
remove-child: Private generic functions
remove-child: Private generic functions
remove-child: Private generic functions
render-children: Private generic functions
render-children: Private generic functions
render-children: Private generic functions
render-children: Private generic functions
render-children: Private generic functions
render-frame: Private ordinary functions
render-log-line: Private generic functions
render-log-line: Private generic functions
render-self: Private generic functions
render-self: Private generic functions
render-self: Private generic functions
render-self: Private generic functions
render-self: Private generic functions
render-self: Private generic functions
resize: Private ordinary functions
running-sum: Private ordinary functions

S
scroll-log: Public ordinary functions
seq-starts-with: Private ordinary functions
set-prompt: Public generic functions
set-prompt: Public generic functions
set-split-type: Public ordinary functions
Setf Expander, (setf frame): Private ordinary functions
show-window: Private ordinary functions
sign: Private ordinary functions
split-line: Private ordinary functions
subtext: Private ordinary functions

T
tab-backwards: Public ordinary functions
tab-forward: Public ordinary functions
tabs-list: Public ordinary functions
text: Public ordinary functions

V
vedit-command: Private ordinary functions
vedit-completion-func: Private ordinary functions
vedit-handlers: Private ordinary functions
vedit-p: Private ordinary functions
vedit-point: Private ordinary functions
vedit-text: Private ordinary functions

W
when-running: Private macros
whitespacep: Private ordinary functions
with-attributes: Public macros
with-processed-attributes: Private macros
with-screen: Public macros


A.3 Variables

Jump to:   *  
B   C   D   F   G   H   I   L   O   P   R   S   T   V   W   X   Y  
Index Entry  Section

*
*color-pairs*: Private special variables
*colors*: Private special variables
*current-attributes*: Private special variables
*default-handlers*: Private special variables
*delayed-init*: Private special variables
*delimit-chars*: Private special variables
*display*: Private special variables
*in-getch*: Private special variables
*non-blocking-window*: Private special variables
*running*: Private special variables
*used-color-pairs*: Private special variables
*used-colors*: Private special variables

B
b: Public classes
bg: Public classes

C
children: Public classes
command: Private structures
completion-func: Private structures
count: Private structures
current-frame: Public classes
current-frame-position: Public classes

D
deduplicate-lines: Public classes

F
fg: Public classes

G
g: Public classes

H
h: Private classes
handlers: Private structures

I
id: Public classes
id: Public classes

L
line: Private structures
lines: Public classes

O
offset: Public classes

P
parent: Private classes
point: Private structures
prompt: Public classes

R
r: Public classes
render: Public classes

S
Slot, b: Public classes
Slot, bg: Public classes
Slot, children: Public classes
Slot, command: Private structures
Slot, completion-func: Private structures
Slot, count: Private structures
Slot, current-frame: Public classes
Slot, current-frame-position: Public classes
Slot, deduplicate-lines: Public classes
Slot, fg: Public classes
Slot, g: Public classes
Slot, h: Private classes
Slot, handlers: Private structures
Slot, id: Public classes
Slot, id: Public classes
Slot, line: Private structures
Slot, lines: Public classes
Slot, offset: Public classes
Slot, parent: Private classes
Slot, point: Private structures
Slot, prompt: Public classes
Slot, r: Public classes
Slot, render: Public classes
Slot, split-type: Public classes
Slot, text: Private structures
Slot, ts: Private structures
Slot, vedit: Public classes
Slot, w: Private classes
Slot, window: Private classes
Slot, x: Private classes
Slot, y: Private classes
Special Variable, *color-pairs*: Private special variables
Special Variable, *colors*: Private special variables
Special Variable, *current-attributes*: Private special variables
Special Variable, *default-handlers*: Private special variables
Special Variable, *delayed-init*: Private special variables
Special Variable, *delimit-chars*: Private special variables
Special Variable, *display*: Private special variables
Special Variable, *in-getch*: Private special variables
Special Variable, *non-blocking-window*: Private special variables
Special Variable, *running*: Private special variables
Special Variable, *used-color-pairs*: Private special variables
Special Variable, *used-colors*: Private special variables
split-type: Public classes

T
text: Private structures
ts: Private structures

V
vedit: Public classes

W
w: Private classes
window: Private classes

X
x: Private classes

Y
y: Private classes


A.4 Data types

Jump to:   C   D   E   F   I   L   M   P   R   S   T   V  
Index Entry  Section

C
canvas-frame: Private classes
cl-tui: The cl-tui system
cl-tui: The cl-tui package
cl-tui.asd: The cl-tui/cl-tui․asd file
cl-tui.lisp: The cl-tui/cl-tui․lisp file
Class, canvas-frame: Private classes
Class, color: Public classes
Class, color-pair: Public classes
Class, container-frame: Public classes
Class, edit-frame: Public classes
Class, frame: Private classes
Class, log-frame: Public classes
Class, root-frame: Private classes
Class, simple-frame: Public classes
Class, tabbed-frame: Public classes
color: Public classes
color-pair: Public classes
container-frame: Public classes

D
drawers.lisp: The cl-tui/drawers․lisp file

E
edit-frame: Public classes

F
File, cl-tui.asd: The cl-tui/cl-tui․asd file
File, cl-tui.lisp: The cl-tui/cl-tui․lisp file
File, drawers.lisp: The cl-tui/drawers․lisp file
File, frame-base.lisp: The cl-tui/frame-base․lisp file
File, frames.lisp: The cl-tui/frames․lisp file
File, input.lisp: The cl-tui/input․lisp file
File, layouts.lisp: The cl-tui/layouts․lisp file
File, macro.lisp: The cl-tui/macro․lisp file
File, packages.lisp: The cl-tui/packages․lisp file
File, vedit.lisp: The cl-tui/vedit․lisp file
frame: Private classes
frame-base.lisp: The cl-tui/frame-base․lisp file
frames.lisp: The cl-tui/frames․lisp file

I
input.lisp: The cl-tui/input․lisp file

L
layouts.lisp: The cl-tui/layouts․lisp file
log-frame: Public classes
log-line: Private structures

M
macro.lisp: The cl-tui/macro․lisp file

P
Package, cl-tui: The cl-tui package
Package, vedit: The vedit package
packages.lisp: The cl-tui/packages․lisp file

R
root-frame: Private classes

S
simple-frame: Public classes
Structure, log-line: Private structures
Structure, vedit: Private structures
System, cl-tui: The cl-tui system

T
tabbed-frame: Public classes

V
vedit: The vedit package
vedit: Private structures
vedit.lisp: The cl-tui/vedit․lisp file