The cl-tui Reference Manual

Table of Contents

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

The cl-tui Reference Manual

This is the cl-tui Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:39:13 2020 GMT+0.


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

1 Introduction

Build Status

cl-tui - Text User Interface for Common Lisp

cl-tui is a library for text user interfaces like that of ncmpcpp or Dungeon Crawl

It's intended to be available on Linux and Windows but the latter is rarely tested. Please, report bugs either on github's or SourceForge's issue tracker.

Supported implementations are SBCL, CCL. I want to also support ECL and CLISP but ECL currently can't build osicat (investigated by osicat developers) and CLISP had a lot of issues with ncurses. Any help with CLISP is appreciated.

cl-tui is supposed to be a complete abstraction so if you have to use cl-charms directly for some reason please submit an issue describing your use-case.

Documentation

Follow the very well-commented examples in the examples directory. Each new feature gets an example and all of them are checked to be in working order on every commit.


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

2 Systems

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


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

2.1 cl-tui

Author

Alexander Sukhoverkhov

License

MIT

Description

High-level library for making Text User Interfaces

Dependencies
Source

cl-tui.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-tui.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-tui-20200427-git/cl-tui.asd

Systems

cl-tui (system)


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

3.1.2 cl-tui/packages.lisp

Parent

cl-tui (system)

Location

packages.lisp

Packages

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

3.1.3 cl-tui/vedit.lisp

Dependency

packages.lisp (file)

Parent

cl-tui (system)

Location

vedit.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cl-tui/macro.lisp

Dependency

vedit.lisp (file)

Parent

cl-tui (system)

Location

macro.lisp

Internal Definitions

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

3.1.5 cl-tui/frame-base.lisp

Dependency

macro.lisp (file)

Parent

cl-tui (system)

Location

frame-base.lisp

Exported Definitions
Internal Definitions

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

3.1.6 cl-tui/frames.lisp

Dependency

frame-base.lisp (file)

Parent

cl-tui (system)

Location

frames.lisp

Exported Definitions
Internal Definitions

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

3.1.7 cl-tui/layouts.lisp

Dependency

frames.lisp (file)

Parent

cl-tui (system)

Location

layouts.lisp

Internal Definitions

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

3.1.8 cl-tui/drawers.lisp

Dependency

layouts.lisp (file)

Parent

cl-tui (system)

Location

drawers.lisp

Exported Definitions
Internal Definitions

defun/frame (macro)


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

3.1.9 cl-tui/cl-tui.lisp

Dependency

drawers.lisp (file)

Parent

cl-tui (system)

Location

cl-tui.lisp

Exported Definitions
Internal Definitions

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

3.1.10 cl-tui/input.lisp

Dependency

cl-tui.lisp (file)

Parent

cl-tui (system)

Location

input.lisp

Exported Definitions

read-key (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-tui

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

4.2 vedit

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: define-children NAME () &body CHILDREN
Package

cl-tui

Source

frame-base.lisp (file)

Macro: define-frame NAME (TYPE &rest FRAME-ARGS) &rest PLACEMENT &key (ON PARENT) &allow-other-keys
Package

cl-tui

Source

frame-base.lisp (file)

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 (file)

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 (file)


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

5.1.2 Functions

Function: append-line FRAME OBJ &rest INIT-ARGS
Package

cl-tui

Source

drawers.lisp (file)

Function: clear FRAME
Package

cl-tui

Source

drawers.lisp (file)

Function: clear VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: clear-colors ()
Package

cl-tui

Source

frame-base.lisp (file)

Function: clear-text FRAME
Package

cl-tui

Source

drawers.lisp (file)

Function: color R G B
Package

cl-tui

Source

frame-base.lisp (file)

Function: color-pair FG BG
Package

cl-tui

Source

frame-base.lisp (file)

Function: destroy-frame NAME
Package

cl-tui

Source

frame-base.lisp (file)

Function: destroy-screen ()

Return terminal to default mode

Package

cl-tui

Source

cl-tui.lisp (file)

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 (file)

Function: draw-box FRAME
Package

cl-tui

Source

drawers.lisp (file)

Function: draw-tab-bar FRAME &key LEFT-PADDING RIGHT-PADDING TOP-PADDING TAB-PADDING
Package

cl-tui

Source

drawers.lisp (file)

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 (file)

Function: get-text FRAME
Package

cl-tui

Source

drawers.lisp (file)

Function: handle-key FRAME KEY
Package

cl-tui

Source

drawers.lisp (file)

Function: handle-key VEDIT CHAR
Package

vedit

Source

vedit.lisp (file)

Function: init-screen &rest ARGUMENTS

Initializes the ncurses environment

Package

cl-tui

Source

cl-tui.lisp (file)

Function: make-vedit &key POINT TEXT COMPLETION-FUNC HANDLERS
Package

vedit

Source

vedit.lisp (file)

Function: point VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: put-char FRAME Y X C
Package

cl-tui

Source

drawers.lisp (file)

Function: put-text FRAME Y X STR &rest FORMAT-ARGS
Package

cl-tui

Source

drawers.lisp (file)

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 (file)

Function: refresh &optional FRAME
Package

cl-tui

Source

frame-base.lisp (file)

Function: scroll-log FRAME OFFSET
Package

cl-tui

Source

drawers.lisp (file)

Function: set-split-type FRAME SPLIT-TYPE
Package

cl-tui

Source

drawers.lisp (file)

Function: tab-backwards FRAME &optional N
Package

cl-tui

Source

drawers.lisp (file)

Function: tab-forward FRAME &optional N
Package

cl-tui

Source

drawers.lisp (file)

Function: tabs-list FRAME
Package

cl-tui

Source

drawers.lisp (file)

Function: text VEDIT
Function: (setf text) NEW-TEXT VEDIT
Package

vedit

Source

vedit.lisp (file)


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

5.1.3 Generic functions

Generic Function: set-prompt NEW-VALUE OBJECT
Package

cl-tui

Methods
Method: set-prompt NEW-VALUE (EDIT-FRAME edit-frame)

automatically generated writer method

Source

frames.lisp (file)


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

5.1.4 Classes

Class: color ()
Package

cl-tui

Source

frame-base.lisp (file)

Direct superclasses

standard-object (class)

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 (file)

Direct superclasses

standard-object (class)

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 (file)

Direct superclasses

frame (class)

Direct subclasses
Direct methods
Direct slots
Slot: children

Alist of frame names and any placement arguments.

Slot: split-type
Type

(member :none :vertical :horizontal)

Initargs

:split-type

Initform

:vertical

Class: edit-frame ()
Package

cl-tui

Source

frames.lisp (file)

Direct superclasses

frame (class)

Direct methods
Direct slots
Slot: prompt
Type

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

Initargs

:prompt

Initform

""

Writers

set-prompt (generic function)

Slot: vedit
Initform

(vedit:make-vedit)

Class: log-frame ()
Package

cl-tui

Source

frames.lisp (file)

Direct superclasses

frame (class)

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 (file)

Direct superclasses

canvas-frame (class)

Direct methods
Direct slots
Slot: render
Type

(or function null)

Class: tabbed-frame ()
Package

cl-tui

Source

frames.lisp (file)

Direct superclasses

container-frame (class)

Direct methods
Direct slots
Slot: current-frame-position

Position of currently drawn children.

Initargs

:initial-tab

Initform

0

Slot: current-frame

Stores reference to currently displayed frame.


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *color-pairs*
Package

cl-tui

Source

frame-base.lisp (file)

Special Variable: *colors*
Package

cl-tui

Source

frame-base.lisp (file)

Special Variable: *current-attributes*
Package

cl-tui

Source

frame-base.lisp (file)

Special Variable: *default-handlers*
Package

vedit

Source

vedit.lisp (file)

Special Variable: *delayed-init*
Package

cl-tui

Source

macro.lisp (file)

Special Variable: *delimit-chars*
Package

vedit

Source

vedit.lisp (file)

Special Variable: *display*
Package

cl-tui

Source

cl-tui.lisp (file)

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 (file)

Special Variable: *non-blocking-window*
Package

cl-tui

Source

input.lisp (file)

Special Variable: *running*

T when screen is initialized

Package

cl-tui

Source

cl-tui.lisp (file)

Special Variable: *used-color-pairs*

ID of the last used color-pair 0 if none

Package

cl-tui

Source

frame-base.lisp (file)

Special Variable: *used-colors*

ID of the last used color 0 if none

Package

cl-tui

Source

frame-base.lisp (file)


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

5.2.2 Macros

Macro: defun/frame NAME TYPE (&rest ARGS) &body BODY
Package

cl-tui

Source

drawers.lisp (file)

Macro: ensure-ok FORM
Package

cl-tui

Source

macro.lisp (file)

Macro: make-handlers (VEDIT-VAR) &body HANDLERS
Package

vedit

Source

vedit.lisp (file)

Macro: when-running &body BODY
Package

cl-tui

Source

macro.lisp (file)

Macro: with-processed-attributes PROCESSED-ATTRIBUTES FRAME &body BODY
Package

cl-tui

Source

frame-base.lisp (file)


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

5.2.3 Functions

Function: attributes-to-code ATTRIBUTES
Package

cl-tui

Source

frame-base.lisp (file)

Function: backspace VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: calculate-split CHILDREN TYPE MAX
Package

cl-tui

Source

layouts.lisp (file)

Function: complete VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: complete-option VEDIT TEXT
Package

vedit

Source

vedit.lisp (file)

Function: copy-log-line INSTANCE
Package

cl-tui

Source

frames.lisp (file)

Function: copy-vedit INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: current-char VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: del-word-back VEDIT
Package

vedit

Source

vedit.lisp (file)

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 (file)

Function: do-delayed-init ()
Package

cl-tui

Source

macro.lisp (file)

Function: edit-frame-prompt-string EDIT
Package

cl-tui

Source

frames.lisp (file)

Function: ensure-color COLOR
Package

cl-tui

Source

frame-base.lisp (file)

Function: ensure-color-pair PAIR
Package

cl-tui

Source

frame-base.lisp (file)

Function: frame NAME
Package

cl-tui

Source

frame-base.lisp (file)

Setf Expander

(setf frame) (setf expander)

Setf Expander: (setf frame) NAME
Package

cl-tui

Source

frame-base.lisp (file)

Reader

frame (function)

Function: frame-free-p PLACEMENT
Package

cl-tui

Source

layouts.lisp (file)

Function: get-attribute-name-from-keyword ATTRIBUTE

Converts keyword to ncurses attribute.

Package

cl-tui

Source

frame-base.lisp (file)

Function: get-screen-size ()

Returns size of terminal screen.

Package

cl-tui

Source

frame-base.lisp (file)

Function: hide-window FRAME
Package

cl-tui

Source

frame-base.lisp (file)

Function: init-color ()
Package

cl-tui

Source

cl-tui.lisp (file)

Function: is-frame-displayed FRAME
Package

cl-tui

Source

frame-base.lisp (file)

Function: key-esc-p KEY
Package

cl-tui

Source

input.lisp (file)

Function: key-function-p KEY
Package

cl-tui

Source

input.lisp (file)

Function: key-keyword KEY
Package

cl-tui

Source

input.lisp (file)

Function: keyname KEY
Package

cl-tui

Source

input.lisp (file)

Function: log-line-count INSTANCE
Function: (setf log-line-count) VALUE INSTANCE
Package

cl-tui

Source

frames.lisp (file)

Function: log-line-line INSTANCE
Function: (setf log-line-line) VALUE INSTANCE
Package

cl-tui

Source

frames.lisp (file)

Function: log-line-p OBJECT
Package

cl-tui

Source

frames.lisp (file)

Function: log-line-ts INSTANCE
Function: (setf log-line-ts) VALUE INSTANCE
Package

cl-tui

Source

frames.lisp (file)

Function: make-log-line &key (LINE LINE) (TS TS) (COUNT COUNT)
Package

cl-tui

Source

frames.lisp (file)

Function: make-vedit% &key (POINT POINT) (TEXT TEXT) (COMPLETION-FUNC COMPLETION-FUNC) (HANDLERS HANDLERS) (COMMAND COMMAND)
Package

vedit

Source

vedit.lisp (file)

Function: move-char VEDIT AMOUNT
Package

vedit

Source

vedit.lisp (file)

Function: move-full VEDIT AMOUNT
Package

vedit

Source

vedit.lisp (file)

Function: move-word VEDIT AMOUNT
Package

vedit

Source

vedit.lisp (file)

Function: ncurses-resize ()
Package

cl-tui

Source

input.lisp (file)

Function: perform-container-layout CHILDREN YS XS HS WS
Package

cl-tui

Source

layouts.lisp (file)

Function: placement-height PLACEMENT
Package

cl-tui

Source

layouts.lisp (file)

Function: placement-width PLACEMENT
Package

cl-tui

Source

layouts.lisp (file)

Function: put-char VEDIT CHAR
Package

vedit

Source

vedit.lisp (file)

Function: put-log-line FRAME TEXT LINE
Package

cl-tui

Source

frames.lisp (file)

Function: rem-char VEDIT
Package

vedit

Source

vedit.lisp (file)

Function: render-frame FRAME
Package

cl-tui

Source

frame-base.lisp (file)

Function: resize ()

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

Package

cl-tui

Source

frame-base.lisp (file)

Function: running-sum LIST
Package

cl-tui

Source

layouts.lisp (file)

Function: seq-starts-with SEQ1 SEQ2
Package

vedit

Source

vedit.lisp (file)

Function: show-window FRAME NH NW NY NX
Package

cl-tui

Source

frame-base.lisp (file)

Function: sign INT
Package

vedit

Source

vedit.lisp (file)

Function: split-line TEXT WIDTH
Package

cl-tui

Source

frames.lisp (file)

Function: subtext VEDIT START COUNT
Package

vedit

Source

vedit.lisp (file)

Function: vedit-command INSTANCE
Function: (setf vedit-command) VALUE INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: vedit-completion-func INSTANCE
Function: (setf vedit-completion-func) VALUE INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: vedit-handlers INSTANCE
Function: (setf vedit-handlers) VALUE INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: vedit-p OBJECT
Package

vedit

Source

vedit.lisp (file)

Function: vedit-point INSTANCE
Function: (setf vedit-point) VALUE INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: vedit-text INSTANCE
Function: (setf vedit-text) VALUE INSTANCE
Package

vedit

Source

vedit.lisp (file)

Function: whitespacep C
Package

vedit

Source

vedit.lisp (file)


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

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 (file)

Methods
Method: add-child (FRAME container-frame) CHILD &rest PLACEMENT
Source

frames.lisp (file)

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 (file)

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

layouts.lisp (file)

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

frames.lisp (file)

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 (file)

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

frames.lisp (file)

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

frames.lisp (file)

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

frames.lisp (file)

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 (file)

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

frames.lisp (file)

Method: remove-child (PARENT symbol) CHILD
Generic Function: render-children FRAME

Render children for containers

Package

cl-tui

Source

frame-base.lisp (file)

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

frames.lisp (file)

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

frames.lisp (file)

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 (file)

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 (file)

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

frames.lisp (file)

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

frames.lisp (file)

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

frames.lisp (file)

Method: render-self (FRAME frame)
Method: render-self (NAME symbol)

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

5.2.5 Structures

Structure: log-line ()
Package

cl-tui

Source

frames.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: line
Type

(or string standard-object)

Initform

""

Readers

log-line-line (function)

Writers

(setf log-line-line) (function)

Slot: ts
Type

integer

Initform

(get-universal-time)

Readers

log-line-ts (function)

Writers

(setf log-line-ts) (function)

Slot: count
Type

fixnum

Initform

1

Readers

log-line-count (function)

Writers

(setf log-line-count) (function)

Structure: vedit ()
Package

vedit

Source

vedit.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: point
Readers

vedit-point (function)

Writers

(setf vedit-point) (function)

Slot: text
Readers

vedit-text (function)

Writers

(setf vedit-text) (function)

Slot: completion-func
Readers

vedit-completion-func (function)

Writers

(setf vedit-completion-func) (function)

Slot: handlers
Readers

vedit-handlers (function)

Writers

(setf vedit-handlers) (function)

Slot: command
Readers

vedit-command (function)

Writers

(setf vedit-command) (function)


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

5.2.6 Classes

Class: canvas-frame ()
Package

cl-tui

Source

frames.lisp (file)

Direct superclasses

frame (class)

Direct subclasses
Direct methods

frame-drawable-p (method)

Class: frame ()
Package

cl-tui

Source

frame-base.lisp (file)

Direct superclasses

standard-object (class)

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 (file)

Direct superclasses

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-tui.asd: The cl-tui․asd file
cl-tui/cl-tui.lisp: The cl-tui/cl-tui․lisp file
cl-tui/drawers.lisp: The cl-tui/drawers․lisp file
cl-tui/frame-base.lisp: The cl-tui/frame-base․lisp file
cl-tui/frames.lisp: The cl-tui/frames․lisp file
cl-tui/input.lisp: The cl-tui/input․lisp file
cl-tui/layouts.lisp: The cl-tui/layouts․lisp file
cl-tui/macro.lisp: The cl-tui/macro․lisp file
cl-tui/packages.lisp: The cl-tui/packages․lisp file
cl-tui/vedit.lisp: The cl-tui/vedit․lisp file

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

L
Lisp File, cl-tui.asd: The cl-tui․asd file
Lisp File, cl-tui/cl-tui.lisp: The cl-tui/cl-tui․lisp file
Lisp File, cl-tui/drawers.lisp: The cl-tui/drawers․lisp file
Lisp File, cl-tui/frame-base.lisp: The cl-tui/frame-base․lisp file
Lisp File, cl-tui/frames.lisp: The cl-tui/frames․lisp file
Lisp File, cl-tui/input.lisp: The cl-tui/input․lisp file
Lisp File, cl-tui/layouts.lisp: The cl-tui/layouts․lisp file
Lisp File, cl-tui/macro.lisp: The cl-tui/macro․lisp file
Lisp File, cl-tui/packages.lisp: The cl-tui/packages․lisp file
Lisp File, cl-tui/vedit.lisp: The cl-tui/vedit․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   K   L   M   N   P   R   S   T   V   W  
Index Entry  Section

(
(setf frame): Internal functions
(setf log-line-count): Internal functions
(setf log-line-line): Internal functions
(setf log-line-ts): Internal functions
(setf text): Exported functions
(setf vedit-command): Internal functions
(setf vedit-completion-func): Internal functions
(setf vedit-handlers): Internal functions
(setf vedit-point): Internal functions
(setf vedit-text): Internal functions

A
add-child: Internal generic functions
add-child: Internal generic functions
add-child: Internal generic functions
append-line: Exported functions
attributes-to-code: Internal functions

B
backspace: Internal functions

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

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

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

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

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

H
handle-key: Exported functions
handle-key: Exported functions
hide-window: Internal functions

I
init-color: Internal functions
init-screen: Exported functions
is-frame-displayed: Internal functions

K
key-esc-p: Internal functions
key-function-p: Internal functions
key-keyword: Internal functions
keyname: Internal functions

L
log-line-count: Internal functions
log-line-line: Internal functions
log-line-p: Internal functions
log-line-ts: Internal functions

M
Macro, define-children: Exported macros
Macro, define-frame: Exported macros
Macro, defun/frame: Internal macros
Macro, ensure-ok: Internal macros
Macro, make-handlers: Internal macros
Macro, when-running: Internal macros
Macro, with-attributes: Exported macros
Macro, with-processed-attributes: Internal macros
Macro, with-screen: Exported macros
make-handlers: Internal macros
make-log-line: Internal functions
make-vedit: Exported functions
make-vedit%: Internal functions
Method, add-child: Internal generic functions
Method, add-child: Internal generic functions
Method, calculate-layout: Internal generic functions
Method, calculate-layout: Internal generic functions
Method, calculate-layout: Internal generic functions
Method, calculate-layout: Internal generic functions
Method, frame-drawable-p: Internal generic functions
Method, frame-drawable-p: Internal generic functions
Method, frame-drawable-p: Internal generic functions
Method, frame-drawable-p: Internal generic functions
Method, remove-child: Internal generic functions
Method, remove-child: Internal generic functions
Method, render-children: Internal generic functions
Method, render-children: Internal generic functions
Method, render-children: Internal generic functions
Method, render-children: Internal generic functions
Method, render-log-line: Internal generic functions
Method, render-self: Internal generic functions
Method, render-self: Internal generic functions
Method, render-self: Internal generic functions
Method, render-self: Internal generic functions
Method, render-self: Internal generic functions
Method, set-prompt: Exported generic functions
move-char: Internal functions
move-full: Internal functions
move-word: Internal functions

N
ncurses-resize: Internal functions

P
perform-container-layout: Internal functions
placement-height: Internal functions
placement-width: Internal functions
point: Exported functions
put-char: Exported functions
put-char: Internal functions
put-log-line: Internal functions
put-text: Exported functions

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

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

T
tab-backwards: Exported functions
tab-forward: Exported functions
tabs-list: Exported functions
text: Exported functions

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

W
when-running: Internal macros
whitespacep: Internal functions
with-attributes: Exported macros
with-processed-attributes: Internal macros
with-screen: Exported macros

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

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

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*: Internal special variables
*colors*: Internal special variables
*current-attributes*: Internal special variables
*default-handlers*: Internal special variables
*delayed-init*: Internal special variables
*delimit-chars*: Internal special variables
*display*: Internal special variables
*in-getch*: Internal special variables
*non-blocking-window*: Internal special variables
*running*: Internal special variables
*used-color-pairs*: Internal special variables
*used-colors*: Internal special variables

B
b: Exported classes
bg: Exported classes

C
children: Exported classes
command: Internal structures
completion-func: Internal structures
count: Internal structures
current-frame: Exported classes
current-frame-position: Exported classes

D
deduplicate-lines: Exported classes

F
fg: Exported classes

G
g: Exported classes

H
h: Internal classes
handlers: Internal structures

I
id: Exported classes
id: Exported classes

L
line: Internal structures
lines: Exported classes

O
offset: Exported classes

P
parent: Internal classes
point: Internal structures
prompt: Exported classes

R
r: Exported classes
render: Exported classes

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

T
text: Internal structures
ts: Internal structures

V
vedit: Exported classes

W
w: Internal classes
window: Internal classes

X
x: Internal classes

Y
y: Internal classes

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

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

A.4 Data types

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

C
canvas-frame: Internal classes
cl-tui: The cl-tui system
cl-tui: The cl-tui package
Class, canvas-frame: Internal classes
Class, color: Exported classes
Class, color-pair: Exported classes
Class, container-frame: Exported classes
Class, edit-frame: Exported classes
Class, frame: Internal classes
Class, log-frame: Exported classes
Class, root-frame: Internal classes
Class, simple-frame: Exported classes
Class, tabbed-frame: Exported classes
color: Exported classes
color-pair: Exported classes
container-frame: Exported classes

E
edit-frame: Exported classes

F
frame: Internal classes

L
log-frame: Exported classes
log-line: Internal structures

P
Package, cl-tui: The cl-tui package
Package, vedit: The vedit package

R
root-frame: Internal classes

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

T
tabbed-frame: Exported classes

V
vedit: The vedit package
vedit: Internal structures

Jump to:   C   E   F   L   P   R   S   T   V