The croatoan Reference Manual

Table of Contents

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

The croatoan Reference Manual

This is the croatoan Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:54:11 2020 GMT+0.


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

1 Introduction

croatoan is a set of bindings to the ncurses terminal library for
Common Lisp.

It is inspired by, but not derived from, cl-ncurses and cl-charms.

Its main goal is to provide a higher-level, lispy/CLOSy interface,
whereas the existing bindings clone the cryptic C API.

As of now, the library is in an early, but hopefully usable stage. 
Ncurses is old and huge and it will take a while to cover completely.

The API is not yet stable.

It is developed and tested on Ubuntu 16.04 x86_64 and SBCL 2.0.0

The only supported ncurses version is 6.x --with-abi-version=6.
Version 5.9 mostly works, but I will focus new efforts on 6.x.

Since many popular distributions ship ncurses --with-abi-version=5,
for full compatibility (wide characters, 256 colors and extended
mouse support), you will have to manually build ncurses 6.x.

The documentation is currently provided by the commented examples.

You are welcome to contribute and any form of help would be greatly
appreciated.

--

Since ncurses is not thread-safe, all IO has to occur in the main
thread of the REPL running in a terminal.

This makes it difficult to interact with ncurses from the Emacs SLIME
REPL which runs in its own thread.

A workaround is to pass all ncurses IO to the main thread via a
thread-safe queue. Basic support for this has been implemented.

A tutorial on interacting with ncurses from swank/slime is available
in docs/slime.md


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 croatoan

Author

Anton Vidovic <anton.vidovic@gmx.de>

License

MIT

Description

High-level Lisp CLOS bindings for the ncurses terminal library.

Version

0.0.1

Dependencies
Source

croatoan.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 croatoan.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/croatoan-20200325-git/croatoan.asd

Systems

croatoan (system)


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

3.1.2 croatoan/package.lisp

Parent

croatoan (system)

Location

package.lisp

Packages

de.anvi.croatoan


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

3.1.3 croatoan/classes.lisp

Parent

croatoan (system)

Location

classes.lisp

Exported Definitions
Internal Definitions

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

3.1.4 croatoan/queue.lisp

Parent

croatoan (system)

Location

queue.lisp

Exported Definitions
Internal Definitions

*job-queue* (special variable)


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

3.1.5 croatoan/croatoan.lisp

Parent

croatoan (system)

Location

croatoan.lisp

Exported Definitions
Internal Definitions

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

3.1.6 croatoan/gray_streams.lisp

Parent

croatoan (system)

Location

gray_streams.lisp


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

3.1.7 croatoan/utf8.lisp

Parent

croatoan (system)

Location

utf8.lisp

Internal Definitions

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

3.1.8 croatoan/util.lisp

Parent

croatoan (system)

Location

util.lisp

Exported Definitions

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

3.1.9 croatoan/addch.lisp

Parent

croatoan (system)

Location

addch.lisp

Exported Definitions
Internal Definitions

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

3.1.10 croatoan/add_wch.lisp

Parent

croatoan (system)

Location

add_wch.lisp

Exported Definitions
Internal Definitions

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

3.1.11 croatoan/addstr.lisp

Parent

croatoan (system)

Location

addstr.lisp

Exported Definitions

add-string (function)


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

3.1.12 croatoan/attr.lisp

Parent

croatoan (system)

Location

attr.lisp

Exported Definitions
Internal Definitions

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

3.1.13 croatoan/beep.lisp

Parent

croatoan (system)

Location

beep.lisp

Exported Definitions

alert (function)


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

3.1.14 croatoan/bkgd.lisp

Parent

croatoan (system)

Location

bkgd.lisp

Internal Definitions

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

3.1.15 croatoan/bkgrnd.lisp

Parent

croatoan (system)

Location

bkgrnd.lisp

Internal Definitions

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

3.1.16 croatoan/border.lisp

Parent

croatoan (system)

Location

border.lisp

Exported Definitions

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

3.1.17 croatoan/border_set.lisp

Parent

croatoan (system)

Location

border_set.lisp

Exported Definitions

draw-wide-border (function)


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

3.1.18 croatoan/clear.lisp

Parent

croatoan (system)

Location

clear.lisp

Exported Definitions

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

3.1.19 croatoan/color.lisp

Parent

croatoan (system)

Location

color.lisp

Internal Definitions

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

3.1.20 croatoan/delch.lisp

Parent

croatoan (system)

Location

delch.lisp

Exported Definitions

delete-char (function)


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

3.1.21 croatoan/deleteln.lisp

Parent

croatoan (system)

Location

deleteln.lisp

Exported Definitions

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

3.1.22 croatoan/getch.lisp

Parent

croatoan (system)

Location

getch.lisp

Exported Definitions
Internal Definitions

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

3.1.23 croatoan/define_key.lisp

Parent

croatoan (system)

Location

define_key.lisp

Exported Definitions

define-function-key (function)


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

3.1.24 croatoan/get_wch.lisp

Parent

croatoan (system)

Location

get_wch.lisp

Exported Definitions

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

3.1.25 croatoan/getstr.lisp

Parent

croatoan (system)

Location

getstr.lisp

Exported Definitions

get-string (function)


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

3.1.26 croatoan/initscr.lisp

Parent

croatoan (system)

Location

initscr.lisp

Exported Definitions
Internal Definitions

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

3.1.27 croatoan/inopts.lisp

Parent

croatoan (system)

Location

inopts.lisp

Internal Definitions

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

3.1.28 croatoan/inch.lisp

Parent

croatoan (system)

Location

inch.lisp

Exported Definitions

extract-char (function)


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

3.1.29 croatoan/in_wch.lisp

Parent

croatoan (system)

Location

in_wch.lisp

Exported Definitions

extract-wide-char (function)


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

3.1.30 croatoan/inwstr.lisp

Parent

croatoan (system)

Location

inwstr.lisp

Exported Definitions

extract-wide-string (function)


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

3.1.31 croatoan/inchstr.lisp

Parent

croatoan (system)

Location

inchstr.lisp

Exported Definitions

extract-complex-string (function)


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

3.1.32 croatoan/insch.lisp

Parent

croatoan (system)

Location

insch.lisp

Exported Definitions

insert-char (function)


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

3.1.33 croatoan/ins_wch.lisp

Parent

croatoan (system)

Location

ins_wch.lisp

Exported Definitions

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

3.1.34 croatoan/insstr.lisp

Parent

croatoan (system)

Location

insstr.lisp

Exported Definitions

insert-string (function)


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

3.1.35 croatoan/instr.lisp

Parent

croatoan (system)

Location

instr.lisp

Exported Definitions

extract-string (function)


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

3.1.36 croatoan/kernel.lisp

Parent

croatoan (system)

Location

kernel.lisp

Internal Definitions

set-cursor-visibility (function)


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

3.1.37 croatoan/mouse.lisp

Parent

croatoan (system)

Location

mouse.lisp

Exported Definitions
Internal Definitions

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

3.1.38 croatoan/move.lisp

Parent

croatoan (system)

Location

move.lisp

Exported Definitions

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

3.1.39 croatoan/panel.lisp

Parent

croatoan (system)

Location

panel.lisp

Exported Definitions
Internal Definitions

rotate (function)


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

3.1.40 croatoan/refresh.lisp

Parent

croatoan (system)

Location

refresh.lisp

Exported Definitions

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

3.1.41 croatoan/touch.lisp

Parent

croatoan (system)

Location

touch.lisp

Exported Definitions

touch (function)


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

3.1.42 croatoan/wresize.lisp

Parent

croatoan (system)

Location

wresize.lisp

Exported Definitions

resize (function)


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

3.1.43 croatoan/form.lisp

Parent

croatoan (system)

Location

form.lisp

Exported Definitions
Internal Definitions

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

3.1.44 croatoan/menu.lisp

Parent

croatoan (system)

Location

menu.lisp

Exported Definitions
Internal Definitions

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

3.1.45 croatoan/shape.lisp

Parent

croatoan (system)

Location

shape.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 de.anvi.croatoan

High-level Lisp interface to the basic CFFI Ncurses API.

Source

package.lisp (file)

Nicknames
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 Special variables

Special Variable: *ansi-color-list*
Package

de.anvi.croatoan

Source

attr.lisp (file)


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

5.1.2 Macros

Macro: event-case (WINDOW EVENT &optional MOUSE-Y MOUSE-X) &body BODY

Window event loop, events are handled by an implicit case form.

For now, it is limited to events generated in a single window. So events from multiple windows have to be handled separately.

In order for event handling to work, input-buffering has to be nil. Several control character events can only be handled when process-control-chars is also nil.

If input-blocking is nil, we can handle the (nil) event, i.e. what happens between key presses.

If input-blocking is t, the (nil) event is never returned.

The main window event loop name is hard coded to event-case to be used with return-from.

Instead of ((nil) nil), which eats 100% CPU, use input-blocking t.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: save-excursion WINDOW &body BODY

After executing body, return the cursor in window to its initial position.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: submit &body BODY

Submit BODY from a producer thread to a job queue to be processed by the main thread.

The main thread should be the only one interfacing ncurses directly,
and should be running in a terminal.

SUBMIT uses a thread-safe FIFO queue to queue up jobs which should be
evaluated inside the terminal thread.

For this to work PROCESS has to be called from inside the terminal
thread to pop requests from the FIFO queue and evaluate them.

When a condition is signaled while the body of SUBMIT is evaluated, it
is handled by PROCESS and put inside a JOB-ERROR which also contains
the failed form.

The condition is then signaled again from within a restart which
allows skipping the failed form and continue evaluating requests.

In practice, this allows for calls to ncurses forms from SLIME to be
performed without IO glitches that tend to occur when ncurses code is
called from the SLIME repl thread directly.

Package

de.anvi.croatoan

Source

queue.lisp (file)

Macro: with-screen (SCREEN &key BIND-DEBUGGER-HOOK INPUT-BUFFERING PROCESS-CONTROL-CHARS ENABLE-NEWLINE-TRANSLATION INPUT-BLOCKING INPUT-ECHOING ENABLE-FUNCTION-KEYS ENABLE-SCROLLING INSERT-MODE ENABLE-COLORS USE-TERMINAL-COLORS CURSOR-VISIBLE STACKED FGCOLOR BGCOLOR COLOR-PAIR BACKGROUND) &body BODY

Create a screen, evaluate the forms in the body, then cleanly close the screen.

Pass any arguments besides BIND-DEBUGGER-HOOK to the initialisation of the
screen object. The screen is cleared immediately after initialisation.

This macro will bind *DEBUGGER-HOOK* so that END-SCREEN gets called before the condition is printed. This will interfere with SWANK as it also binds *DEBUGGER-HOOK*. To prevent WITH-SCREEN from binding *DEBUGGER-HOOK*, set BIND-DEBUGGER-HOOK to NIL.

This macro is the main entry point for writing ncurses programs with the croatoan library. Do not run more than one screen at the same time.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: with-window (WIN &rest OPTIONS) &body BODY

Create a window, evaluate the forms in the body, then cleanly close the window.

Pass any arguments to the initialisation of the window object.

Example:

(with-window (win :input-echoing t
body)

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Macro: with-windows BINDINGS &body BODY

Create one or more windows, evaluate the forms in the body, then cleanly close the windows.

Pass any arguments to the initialisation of the window objects.

Example:

(with-windows ((win1 :input-echoing t)
(win2 :input-echoing t))
body)

Package

de.anvi.croatoan

Source

croatoan.lisp (file)


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

5.1.3 Functions

Function: accept OBJECT EVENT &rest ARGS

Associate this function with an event (key binding or button) to exit the event loop of a form or form element.

The first return value is t, emphasizing that the user has accepted the form.

The second value is a list containing the object, the event that called the exit and the args passed.

This allows to specify by which button or event the form was accepted.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: accept-selection MENU EVENT

Return the value of the currently selected item or all checked items.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: acs CHAR-NAME

Take a symbol, return the integer representing the acs char.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add WINDOW OBJECT &rest KEYS &key &allow-other-keys

Add the text object to the window, then advance the cursor.

Currently supported text objects are characters (simple and complex), characters given by integer codes or keywords, and strings (simple and complex).

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the object.

The position can also be passed in form of a two-element list.

If n is given for a char, write n chars. If n is -1, add as many chars as will fit on the line.

If n is given for a string, add at most n chars from the string. If n is -1, add as many chars from the string as will fit on the line.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add-attributes WIN ATTRIBUTES

Takes a list of keywords and turns the appropriate attributes on.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: add-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Add the narrow (single-byte) char to the window, then advance the cursor.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given for a char, write n chars. If n is -1, add as many chars as will fit on the line.

Example: (add-char scr #a :attributes ’(:bold) :color-pair ’(:red :yellow))

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: add-function-key KEY-NAME KEY-CODE

Add a new function key given by the mapping of key name (keyword) <-> key code (integer).

If the alist already contains key-name or key-code this mapping will
be overwritten by the new values.

This operation modifies *key-alist*.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: add-string WINDOW STRING &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Add the unrendered string to the window.

If n is given, add at most n chars from the string. If n is -1, as many chars will be added that will fit on the line.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the object.

The position can also be passed in form of a two-element list.

Package

de.anvi.croatoan

Source

addstr.lisp (file)

Function: add-wide-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Add the wide (multi-byte) char to the window, then advance the cursor.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given for a char, write n chars. If n is -1, add as many chars as will fit on the line.

If char is a complex-char, its own style overrides any style parameters.

If a style is passed, it overrides attributes and color-pair.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: add-wide-char-utf-8 WINDOW CHAR &key ATTRIBUTES COLOR-PAIR Y X POSITION N

Add the wide (multi-byte) char to the window, then advance the cursor.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given, write n chars. If n is -1, as many chars will be added as will fit on the line.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: alert &optional TYPE
Package

de.anvi.croatoan

Source

beep.lisp (file)

Function: angle-line Y0 X0 THETA LENGTH &key CHAR

Draw a line of the given length in the bearing theta from the origin.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: bind OBJECT EVENT HANDLER

Bind the handler function to the event in the bindings alist of the object.

If event is a list of events, bind the handler to each event separately.

The handlers will be called by the run-event-loop when keyboard or mouse events occur.

The handler functions have two mandatory arguments, window and event.

For every event-loop, at least an event to exit the event loop should be assigned, by associating it with the predefined function exit-event-loop.

If a handler for the default event t is defined, it will handle all events for which no specific event handler has been defined.

If input-blocking of the window is set to nil, a handler for the nil event
can be defined, which will be called at a specified frame-rate between keypresses. Here the main application state can be updated.

Alternatively, to achieve the same effect, input-blocking can be set to a specific delay in miliseconds.

Example use: (bind scr #q (lambda (win event) (throw ’event-loop :quit)))

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: box WINDOW &optional HLINE-CHAR VLINE-CHAR

Draw a border around the window.

If any parameter is nil or zero, the default ACS char will be used.

Package

de.anvi.croatoan

Source

border.lisp (file)

Function: cancel OBJECT EVENT &rest ARGS

Associate this function with an event (key binding or button) to exit the event loop of a form or form element.

The return value is nil, emphasizing that the user has canceled the form.

The second value is a list containing the object, the event that called the exit and the args passed.

This allows to specify why the form was canceled.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: center-position WINDOW

Return the position (y x) of the center of the window.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Function: change-attributes WIN N ATTRIBUTES &key COLOR-PAIR Y X POSITION

Change the attributes of n chars starting at the current cursor position.

If n is -1, as many chars will be added as will fit on the line.

If the destination coordinates y and x are given, the attributes are changed from the given point without moving the cursor position.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: circle Y0 X0 RADIUS &key FILLED CHAR

Return a circle with a given radius, optionally filled.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: complex-char= A B

Return t if the simple-char, the color pair and the attribute list of a complex-char are equal.

The initial purpose of this function is to be used as the equality test for alexandria:define-constant.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Function: default-color-pair SCREEN
Package

de.anvi.croatoan

Source

attr.lisp (file)

Writer

(setf default-color-pair) (function)

Function: (setf default-color-pair) COLOR-PAIR SCREEN

Set the colors which will comprise the default color pair 0.

The default color pair is used when no other colors are specified.

The ncurses default color pair is white on black.

If the terminal can set its own colors, they are named :terminal.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Reader

default-color-pair (function)

Function: define-function-key KEY-NAME CHAR-LIST &key KEY-CODE

Add or replace a new function key defined by the given character sequence.

key-name is the symbol used to represent the key (e.g. :f1).

char-list is the raw sequence of characters returned by the terminal to identify an event (key pressed, mouse event, etc.).

If key-code is an integer a new mapping (name . code) is added
to the database overwriting any already existing mapping which contains either key-name or key-code.

If key-code is nil (default) the mapping is added with an unique, unused, generated keycode.

Package

de.anvi.croatoan

Source

define_key.lisp (file)

Function: define-keymap NAME PLIST

Register a keymap given by a name and a plist of keys and functions.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: delete-char WINDOW &key Y X

Delete the character under the cursor.

All characters to the right of the cursor on the same line are moved to the left one position and the last character on the line is filled with a blank. The cursor position does not change after moving
to (y,x), if specified.

Package

de.anvi.croatoan

Source

delch.lisp (file)

Function: delete-line WINDOW &key N

Delete n lines starting with the one under the cursor.

The remaining lines are moved up. The bottom n lines are cleared.

The current cursor position does not change.

Package

de.anvi.croatoan

Source

deleteln.lisp (file)

Function: dequeue QUEUE

Pop of the first element of queue and return it, returns NIL when queue is empty

Package

de.anvi.croatoan

Source

queue.lisp (file)

Function: draw-border WINDOW &key LEFT RIGHT TOP BOTTOM TOP-LEFT TOP-RIGHT BOTTOM-LEFT BOTTOM-RIGHT

Draw a border around the window using single-byte line-drawing characters.

If no border chars are given, the default ncurses ACS chars will be used.

Package

de.anvi.croatoan

Source

border.lisp (file)

Function: draw-menu WINDOW MENU

Draw the menu to the window.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: draw-shape WINDOW SHAPE &optional SQUARIFY

Draw a shape in the given window.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: draw-wide-border WINDOW &key LEFT RIGHT TOP BOTTOM TOP-LEFT TOP-RIGHT BOTTOM-LEFT BOTTOM-RIGHT

Draw a border around the window using (wide) unicode line-drawing characters.

If no border chars are given, the default ncurses WACS chars will be used.

Package

de.anvi.croatoan

Source

border_set.lisp (file)

Function: echo WINDOW CHAR &rest KEYS &key &allow-other-keys

Add one character to the window, then advance the cursor.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given for a char, write n chars. If n is -1, add as many chars as will fit on the line.

If char is a complex-char, its own style overrides any style parameters.

If a style is passed, it overrides attributes and color-pair.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: echo-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION

Add one narrow (single-byte) character to the window, then refresh the window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then echo the character.

The position can also be passed in form of a two-element list.

The only difference to add-char and a subsequent refresh is a
performance gain if we know that we only need to output a single character.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: echo-wide-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION

Add one wide (multi-byte) character to the window, then refresh the window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

The only difference to add-wide-char and a subsequent refresh is a performance gain if we know that we only need to output a single character.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: edit OBJECT &rest ARGS
Package

de.anvi.croatoan

Source

form.lisp (file)

Function: empty-stack ()

Remove all windows from the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: end-screen ()

Clean shutdown of the curses display.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: enqueue ITEM QUEUE

Push a new item onto the tail of the queue, return the new item.

Package

de.anvi.croatoan

Source

queue.lisp (file)

Function: exit-event-loop OBJECT EVENT &rest ARGS

Associate this function with an event to exit the event loop.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: exit-menu-event-loop MENU EVENT

Associate this function with an event to exit the menu event loop.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: extract-char WINDOW &key Y X POSITION

Extract and return the single-byte complex char from the window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

Package

de.anvi.croatoan

Source

inch.lisp (file)

Function: extract-complex-string WINDOW &key Y X POSITION N

Extract and return a complex string from the window.

Start at the current cursor position and end at the right margin of window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given, read at most n chars.

Package

de.anvi.croatoan

Source

inchstr.lisp (file)

Function: extract-string WINDOW &key Y X POSITION N

Extract and return a string from window.

Any attributes are stripped from the characters before the string is returned.

Start at the current cursor position and end at the right margin of window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given, read at most n chars.

Package

de.anvi.croatoan

Source

instr.lisp (file)

Function: extract-wide-char WINDOW &key Y X POSITION

Extract and return a single wide (complex) character from the window.

This includes wide characters (code > 255), and requires the ncursesw library.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

Package

de.anvi.croatoan

Source

in_wch.lisp (file)

Function: extract-wide-string WINDOW &key Y X POSITION N

Extract and return a string from window.

Any attributes are stripped from the characters before the string is returned.

Start at the current cursor position and end at the right margin of window.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the character.

The position can also be passed in form of a two-element list.

If n is given, read at most n chars.

Package

de.anvi.croatoan

Source

inwstr.lisp (file)

Function: fill-shape SHAPE

Take a shape that only shows the borders and ’color it out’.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: find-element FORM ELEMENT-NAME &key TEST KEY

Return from the given form the element given by its name.

The name should be a keyword, symbol or integer, the default test is eql.

If the name is a string, equal should be used as the test.

Instead of the name, another key can be provided to identify the element.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: find-keymap KEYMAP-NAME

Return a keymap given by its name from the global keymap alist.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: flush-input ()

Throw away any typeahead that has been input by the user and has not yet been read by the program.

This can be used to clear the input buffer after a key has been held down for a longer time to prevent that events are handled by the progrem even after the key is released. (That form of intertia can happen in games.)

This ncurses function has the same purpose as cl:clear-input.

Package

de.anvi.croatoan

Source

util.lisp (file)

Function: function-key-p NUMBER

Take a single-byte key code returned by get-char, return t if the number is a known function key, or nil if it is either a char or an unknown key.

Used in get-event to check the return value of get-char.

get-wide-char/event has a different way to check for function keys.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-char WINDOW &key Y X

Read in a C char (single byte) from the keyboard and return it.

If the destination coordinates y (row) and x (column) are given, move the cursor to the destination first and then read a single byte.

The window from which the char is read is automatically refreshed.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-event WINDOW
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-mouse-event ()
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: get-string WINDOW N &key Y X

Read a string from the keyboard and return it.

Reading is performed until a newline or carriage return is received. The terminating character is not included in the returned string.

If n is given, read at most n chars, to prevent a possible input buffer overflow.

If the destination coordinates y and x are given, move the cursor there first.

Package

de.anvi.croatoan

Source

getstr.lisp (file)

Function: get-wide-char WINDOW &key Y X POSITION

Read in a wide C wchar_t (multi-byte) from the keyboard and return it.

If the destination coordinates y (row) and x (column) are given, move
the cursor to the destination first and then read a multi-byte char.

The window from which the char is read is automatically refreshed.

If the second returned value is t, the char is a function key, nil otherwise.

Package

de.anvi.croatoan

Source

get_wch.lisp (file)

Function: get-wide-event WINDOW

Return a single user input event and its code as a second value.

An event can be a lisp character or a keyword representing a function or mouse key.

If input-blocking is nil for the window, return nil if no key was typed.

Package

de.anvi.croatoan

Source

get_wch.lisp (file)

Function: goto WIN &rest POSITIONS

Move the cursor to the position given as a two-element list (y x).

If more than one position is given, add the coordinates before moving the cursor.

This allows to address sub-coordinates or cursor movement to a
different position.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: insert WINDOW OBJECT &rest KEYS &key &allow-other-keys

Insert char or string into window before the char currently under the cursor.

Currently supported text objects are characters (simple and complex), characters given by integer codes or keywords, and strings
(simple and complex).

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then insert the object.

The position can also be passed in form of a two-element list.

If n is given for a char, insert n chars.

If n is given for a string, add at most n chars from the string.

Package

de.anvi.croatoan

Source

ins_wch.lisp (file)

Function: insert-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Insert char into window before the character currently under the cursor.

Chars right of the cursor are moved one position to the right.
The rightmost character on the line may be lost. The position of the cursor is not changed.

char can be a simple character or a complex-char with attributes and colors.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the object.

The position can also be passed in form of a two-element list.

If n is given, insert n chars.

Package

de.anvi.croatoan

Source

insch.lisp (file)

Function: insert-line WINDOW &key N

Insert n lines above the current line.

The current line and the lines below are moved down. The n bottom lines are lost.

The current cursor position does not change.

Package

de.anvi.croatoan

Source

deleteln.lisp (file)

Function: insert-nth N ELEMENT LIST

Insert element into list at nth place, increasing the length of the list.

Example: (insert-nth 3 ’x ’(a b c d e)) => (A B C X D E)

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: insert-string WINDOW STRING &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Insert string before the current position in window.

Chars right of the cursor are moved to the right. The rightmost chars on the line may be lost. The cursor position is not changed.

If n is given, insert at most n chars from the string.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the object.

The position can also be passed in form of a two-element list.

Package

de.anvi.croatoan

Source

insstr.lisp (file)

Function: insert-wide-char WINDOW CHAR &key ATTRIBUTES FGCOLOR BGCOLOR COLOR-PAIR STYLE Y X POSITION N

Insert char into window before the character currently under the cursor.

Chars right of the cursor are moved one position to the right.
The rightmost character on the line may be lost. The position of the cursor is not changed.

char can be a simple character or a complex-char with attributes and colors.

If the position coordinates y (row) and x (column) are given, move the cursor to the position first and then add the object.

The position can also be passed in form of a two-element list.

If n is given, insert n chars.

Package

de.anvi.croatoan

Source

ins_wch.lisp (file)

Function: key-code-to-name CODE &optional DEFAULT

Take an integer representing the function key code, return a keyword representing the function key name.

If a name to the given code is not in the key list, return the value of the optional parameter: ’default’.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: key-name-to-code KEY-NAME &optional DEFAULT

Return the code (an integer) from the given keyname (a keyword).

If the code does not exist, return the value of the optional parameter: ’default’.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: key-pressed-p WINDOW
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: key-supported-p KEY-CHAR
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: line Y0 X0 Y1 X1 &key CHAR

Return a straight line between two points

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: lower WIN

Lower window one position in the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: lower-to-bottom WIN

Lower window to the bottom of the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: mark-for-redraw WINDOW &key FIRST-LINE NO-OF-LINES

Mark a whole window or a number of lines to be completely redrawn on the next refresh.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: mark-for-refresh WIN &optional PAD-MIN-Y PAD-MIN-X SCREEN-MIN-Y SCREEN-MIN-X SCREEN-MAX-Y SCREEN-MAX-X

Mark a window for a later batch-refresh.

Copy a window to the virtual screen, but do not display it on the visible physical screen. Call batch-refresh to display all marked refreshes.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: merge-shapes &rest SHAPES

Create a new shape object by merging the coordinates of a given list of shapes.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: move WINDOW Y X &key RELATIVE

Move cursor to the position given by row y and column x.

If relative is t, move the cursor by y rows and x columns.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: move-direction WINDOW DIRECTION &optional N

Move cursor in the given direction by n cells.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: move-end-of-line FIELD EVENT &rest ARGS

Move the cursor to the last char in the field.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: move-start-of-line FIELD EVENT &rest ARGS

Move the cursor to the first char in the field.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: move-window WINDOW Y X &key RELATIVE

Move top left corner of the window to row y and column x.

If relative is t, move the window by y rows and x columns.

Package

de.anvi.croatoan

Source

move.lisp (file)

Function: new-line WINDOW &optional COUNT

Insert count newline characters into window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: polygon CORNERS &key FILLED CHAR

Return a polygon along a list of corners, optionally filled

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: process ()

Process the contents of the job queue in the current thread, then exit.

Process should be called from the main thread, which should be the only thread interfacing ncurses directly, and should be running in a terminal.

Package

de.anvi.croatoan

Source

queue.lisp (file)

Function: quadrilateral Y0 X0 Y1 X1 Y2 X2 Y3 X3 &key FILLED CHAR

Return a quadrilateral (utility wrapper around ‘polygon’).

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: raise WIN

Raise window one position in the stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: raise-to-top WIN

Raise window to the top of the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: rectangle Y0 X0 HEIGHT WIDTH &key FILLED CHAR

Return a rectangle (utility wrapper around ‘polygon’).

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: refresh WIN &optional PAD-MIN-Y PAD-MIN-X SCREEN-MIN-Y SCREEN-MIN-X SCREEN-MAX-Y SCREEN-MAX-X

Redisplay the window after changes have been made to it.

Copies a window to the virtual screen, then updates the visible physical screen by the contents of the virtual screen.

Only updates the changed parts of the window. In order to redraw the whole window, it has to be explicitely touched or marked for redraw.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: refresh-marked ()

Refresh windows marked for refresh.

Package

de.anvi.croatoan

Source

refresh.lisp (file)

Function: refresh-stack ()

Touch and refresh visible windows in the window stack.

Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: remove-attributes WIN ATTRIBUTES

Takes a list of keywords and turns the appropriate attributes off.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: remove-nth N LIST

Remove element at nth place from the list, decreasing the length of the list.

Example: (remove-nth 3 ’(a b c d e)) => (A B C E)

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: replace-nth N ELEMENT LIST

Replaces element of list at nth place, not increasing the length of the list.

Example: (replace-nth 3 ’x ’(a b c d e)) => (A B C X E)

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: reset-field FIELD EVENT &rest ARGS

Clear the field and reset its internal buffers and pointers.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: reset-form OBJECT EVENT &rest ARGS
Package

de.anvi.croatoan

Source

form.lisp (file)

Function: resize WINDOW HEIGHT WIDTH
Package

de.anvi.croatoan

Source

wresize.lisp (file)

Function: return-from-menu MENU RETURN-VALUE

Set menu window to invisible, refresh the window stack, return the value from select.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: run-event-loop OBJECT &rest ARGS

Read events from the window, then call predefined event handler functions on the events.

The handlers can be added by the bind function, or by directly setting a predefined keymap to the window’s bindings slot.

Args is one or more additional arguments passed to the handlers.

Provide a non-local exit point so we can exit the loop from an event handler.

One of the events must provide a way to exit the event loop by throwing ’event-loop.

The function exit-event-loop is pre-defined to perform this non-local exit.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: select MENU

Display the menu, let the user select an item, return the selected item.

If the item is a menu object, recursively display the sub menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: set-mouse-event KEYWORD-LIST

Take a list of mouse events, activate tracking of those events.

Returns an integer bitmask. An empty list turns off mouse tracking.

Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: shape-extent SHAPE

Return min-y, min-x, max-y, and max-x of a shape’s coordinates as multiple values.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: toggle-item-checkbox MENU EVENT

Toggle the checked state of the current item, used in checkbox menus.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: touch WINDOW

Make the next call to refresh rewrite whe whole window by marking the whole window as changed.

Makes it possible to raise unchanged overlapping windows by refreshing.

Package

de.anvi.croatoan

Source

touch.lisp (file)

Function: triangle Y0 X0 Y1 X1 Y2 X2 &key FILLED CHAR

Return a triangle (utility wrapper around ‘polygon’).

Package

de.anvi.croatoan

Source

shape.lisp (file)

Function: unbind OBJECT EVENT

Remove the event and the handler function from object’s bindings alist.

If event is a list of events, remove each event separately from the alist.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: unget-char CHTYPE
Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: update-menu MENU EVENT

Take a menu and an event, update in-place the current item of the menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: update-redraw-menu MENU EVENT

Update the menu after an event, the redraw the menu.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: use-terminal-colors-p SCREEN
Function: (setf use-terminal-colors-p) FLAG SCREEN
Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: wacs CHAR-NAME

Take a keyword symbol, return the wide unicode integer representing the ACS char.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: wait-for-event WIN

Wait till a valid event (keyboard, mouse or resize) occurs, then return.

If blocking is set to t, wait till any event is read.

If blocking is nil, ignore the nil events and only return when the first non-nil event is read.

The return value is not specified.

Package

de.anvi.croatoan

Source

get_wch.lisp (file)


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

5.1.4 Generic functions

Generic Function: attributes OBJECT
Generic Function: (setf attributes) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: attributes (WINDOW window)
Method: (setf attributes) ATTRIBUTES (WIN window)
Source

classes.lisp (file)

Method: attributes (COMPLEX-CHAR complex-char)
Method: (setf attributes) NEW-VALUE (COMPLEX-CHAR complex-char)

List of keywords denoting attributes.

Source

classes.lisp (file)

Generic Function: background WINDOW
Generic Function: (setf background) CHAR WINDOW &optional APPLY
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: background (WIN window)
Method: (setf background) CHAR (WINDOW window) &optional APPLY
Generic Function: bgcolor OBJECT
Generic Function: (setf bgcolor) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: bgcolor (WIN window)
Method: (setf bgcolor) BGCOLOR (WIN window)
Source

classes.lisp (file)

Method: bgcolor (COMPLEX-CHAR complex-char)
Method: (setf bgcolor) NEW-VALUE (COMPLEX-CHAR complex-char)

A keyword denoting the background color of the complex character.

Source

classes.lisp (file)

Generic Function: bindings OBJECT
Generic Function: (setf bindings) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: bindings (FORM form)
Method: (setf bindings) NEW-VALUE (FORM form)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (FIELD field)
Method: (setf bindings) NEW-VALUE (FIELD field)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (CHECKBOX checkbox)
Method: (setf bindings) NEW-VALUE (CHECKBOX checkbox)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (BUTTON button)
Method: (setf bindings) NEW-VALUE (BUTTON button)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (ELEMENT element)
Method: (setf bindings) NEW-VALUE (ELEMENT element)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (MENU menu)
Method: (setf bindings) NEW-VALUE (MENU menu)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (WINDOW window)
Method: (setf bindings) NEW-VALUE (WINDOW window)

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Source

classes.lisp (file)

Method: bindings (KEYMAP keymap)
Method: (setf bindings) NEW-VALUE (KEYMAP keymap)

Alist of events and handler functions.

Source

classes.lisp (file)

Generic Function: buffer OBJECT
Generic Function: (setf buffer) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: buffer (FIELD field)
Method: (setf buffer) NEW-VALUE (FIELD field)

List containing the characters in the field.

Source

classes.lisp (file)

Generic Function: callback OBJECT
Generic Function: (setf callback) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: callback (BUTTON button)
Method: (setf callback) NEW-VALUE (BUTTON button)

Callback function called when the button is activated.

Source

classes.lisp (file)

Generic Function: char-to-string CHAR

Return a string representing the char.

Package

de.anvi.croatoan

Source

util.lisp (file)

Methods
Method: char-to-string (CHAR integer)
Method: char-to-string (CHAR character)
Generic Function: checkedp OBJECT
Generic Function: (setf checkedp) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: checkedp (CHECKBOX checkbox)
Method: (setf checkedp) NEW-VALUE (CHECKBOX checkbox)

t if the checkbox has been checked, nil if it hasn’t.

Source

classes.lisp (file)

Method: checkedp (MENU-ITEM menu-item)
Method: (setf checkedp) NEW-VALUE (MENU-ITEM menu-item)

t if the item has been checked, nil if it hasn’t.

Source

classes.lisp (file)

Generic Function: clear OBJECT &key REDRAW TARGET
Package

de.anvi.croatoan

Source

clear.lisp (file)

Methods
Method: clear (FIELD field) &key

Clear the field by overwriting it with the background char.

The default background char is #space.

Source

form.lisp (file)

Method: clear (WINDOW window) &key REDRAW TARGET

Clear the window by overwriting it with blanks.

If the keyword redraw is t, first copy blanks to every position in the window, then set the clear-redraw-flag to have the window redrawn from scratch on the next refresh.

If target is :end-of-line, clear the window from the cursor to the end of the current line.

If target is :bottom, clear the window from the cursor to the end of the current line and all lines below.

Generic Function: closed-p S

Check whether the screen has been closed without a subsequent call to refresh to reactivate it.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Methods
Method: closed-p (S screen)
Generic Function: color-pair WIN
Generic Function: (setf color-pair) COLOR-PAIR WIN
Package

de.anvi.croatoan

Methods
Method: color-pair (XCH complex-char)
Method: (setf color-pair) COLOR-PAIR (XCH complex-char)
Source

classes.lisp (file)

Method: color-pair (WIN window)
Method: (setf color-pair) COLOR-PAIR (WIN window)
Source

classes.lisp (file)

Generic Function: complex-char-array OBJECT
Generic Function: (setf complex-char-array) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: complex-char-array (COMPLEX-STRING complex-string)
Method: (setf complex-char-array) NEW-VALUE (COMPLEX-STRING complex-string)

Lisp primitive string type.

Source

classes.lisp (file)

Generic Function: convert-char CHAR RESULT-TYPE

Take a char and convert it to a char of result-type.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Methods
Method: convert-char (CHAR integer) RESULT-TYPE
Method: convert-char (CHAR character) RESULT-TYPE
Method: convert-char (CHAR complex-char) RESULT-TYPE
Generic Function: coordinates OBJECT
Generic Function: (setf coordinates) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: coordinates (SHAPE shape)
Method: (setf coordinates) NEW-VALUE (SHAPE shape)

A list of coordinates relative to the origin that form this shape.

Source

shape.lisp (file)

Generic Function: current-item OBJECT
Generic Function: (setf current-item) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: current-item (MENU menu)
Method: (setf current-item) NEW-VALUE (MENU menu)

Pointer to the currently selected item object. The first item is initialized as the current item.

Source

classes.lisp (file)

Generic Function: current-item-mark OBJECT
Package

de.anvi.croatoan

Methods
Method: current-item-mark (MENU menu)

A string prefixed to the current item in the menu.

Source

classes.lisp (file)

Generic Function: current-item-number OBJECT
Generic Function: (setf current-item-number) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: current-item-number (MENU menu)
Method: (setf current-item-number) NEW-VALUE (MENU menu)

Number of the currently selected item.

Source

classes.lisp (file)

Generic Function: cursor-position WINDOW
Generic Function: (setf cursor-position) COORDINATES WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: cursor-position (WINDOW window)
Method: (setf cursor-position) COORDINATES (W window)
Generic Function: cursor-position-x WINDOW
Generic Function: (setf cursor-position-x) X WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: cursor-position-x (WIN window)
Method: (setf cursor-position-x) X (WIN window)
Generic Function: cursor-position-y WINDOW
Generic Function: (setf cursor-position-y) Y WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: cursor-position-y (WIN window)
Method: (setf cursor-position-y) Y (WIN window)
Generic Function: cursor-visible-p WINDOW
Generic Function: (setf cursor-visible-p) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: cursor-visible-p (SCREEN screen)
Method: (setf cursor-visible-p) STATUS (SCREEN screen)
Generic Function: cyclic-selection-p OBJECT
Generic Function: (setf cyclic-selection-p) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: cyclic-selection-p (MENU menu)
Method: (setf cyclic-selection-p) NEW-VALUE (MENU menu)

Wrap around when the end of a non-scrolled menu is reached.

Source

classes.lisp (file)

Generic Function: delete-function-key OBJECT

Delete a mapping croatoan keycode <-> curses integer, if exists

Package

de.anvi.croatoan

Source

getch.lisp (file)

Methods
Method: delete-function-key (KEY-CODE integer)

Take a key code, delete the mapping key name (keyword) <-> key code (number), if it exists.

This operation modifies *key-alist*.

Method: delete-function-key (KEY-NAME symbol)

Take a key name, delete the mapping key name (keyword) <-> key code (integer), if it exists.

This operation modifies *key-alist*.

Generic Function: draw OBJECT

Draw objects (form, field, menu) to their associated window.

Package

de.anvi.croatoan

Source

form.lisp (file)

Methods
Method: draw (MENU dialog-window)
Source

menu.lisp (file)

Method: draw (MENU menu-window)

Draw the menu-window.

Source

menu.lisp (file)

Method: draw (MENU menu)

Draw the menu to its associated window.

Source

menu.lisp (file)

Method: draw (FORM form-window)

Draw the form by drawing the elements, then moving the cursor to the current element.

Method: draw (FORM form)

Draw the form by drawing the elements, then moving the cursor to the current element.

Method: draw (FIELD field)

Clear and redraw the field and its contents and background.

Method: draw (CHECKBOX checkbox)
Method: draw (BUTTON button)
Method: draw (LABEL label)
Generic Function: draw-border-p OBJECT
Package

de.anvi.croatoan

Methods
Method: draw-border-p (WINDOW window)

Draw (t) or don’t draw (nil, default) an initial border around a window. Not redrawn automatically.

Source

classes.lisp (file)

Generic Function: element-position OBJECT
Generic Function: (setf element-position) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: element-position (ELEMENT element)
Method: (setf element-position) NEW-VALUE (ELEMENT element)

A two-element list (y=row x=column) containing the coordinate of the top left corner of the element within its associated window.

Source

classes.lisp (file)

Generic Function: elements OBJECT
Generic Function: (setf elements) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: elements (FORM form)
Method: (setf elements) NEW-VALUE (FORM form)

List of elements. The first element will be initialized as the current element.

Source

classes.lisp (file)

Generic Function: fgcolor OBJECT
Generic Function: (setf fgcolor) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: fgcolor (WIN window)
Method: (setf fgcolor) FGCOLOR (WIN window)
Source

classes.lisp (file)

Method: fgcolor (COMPLEX-CHAR complex-char)
Method: (setf fgcolor) NEW-VALUE (COMPLEX-CHAR complex-char)

A keyword denoting the foreground color of the complex character.

Source

classes.lisp (file)

Generic Function: frame-rate OBJECT
Generic Function: (setf frame-rate) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: frame-rate (WINDOW window)
Method: (setf frame-rate) NEW-VALUE (WINDOW window)

Set the frame rate in fps (frames per second). When input-blocking is nil, sleep for 1/frame-rate seconds between event loop cycles. Has the same effect as setting input-blocking duration, and should thus not be used simultaneously.

Source

classes.lisp (file)

Generic Function: function-keys-enabled-p WINDOW
Generic Function: (setf function-keys-enabled-p) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: function-keys-enabled-p (WINDOW window)
Method: (setf function-keys-enabled-p) STATUS (WINDOW window)
Generic Function: height WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: height (WINDOW window)
Generic Function: input-blocking WINDOW
Generic Function: (setf input-blocking) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: input-blocking (WINDOW window)
Method: (setf input-blocking) STATUS (WINDOW window)
Generic Function: input-buffering-p SCREEN
Generic Function: (setf input-buffering-p) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: input-buffering-p (SCREEN screen)
Method: (setf input-buffering-p) STATUS (SCREEN screen)
Generic Function: input-echoing-p SCREEN
Generic Function: (setf input-echoing-p) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: input-echoing-p (SCREEN screen)
Method: (setf input-echoing-p) STATUS (SCREEN screen)
Generic Function: insert-mode-p OBJECT
Generic Function: (setf insert-mode-p) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: insert-mode-p (WINDOW window)
Method: (setf insert-mode-p) NEW-VALUE (WINDOW window)

Printing a new char will insert (t) it before the character under the cursor instead of overwriting it (nil, default).

Source

classes.lisp (file)

Generic Function: items OBJECT
Generic Function: (setf items) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: items (MENU menu)
Method: (setf items) NEW-VALUE (MENU menu)

List of menu items. Item types can be strings, symbols, other menus or callback functions.

Source

classes.lisp (file)

Generic Function: key-to-string KEY

Return a string representing the key.

In particular:

- A printable character becomes a string cointaining that character (e.g. #a -> "a");

- A control character becomes a string with the (upcased) character prefixed with the caret character (#^). (e.g Control-j -> "^J")

- A keyword becomes a string.
Note that the key names returned by ncurses in general do not correspond to the key names used by croatoan.

KEY_LEFT vs LEFT
KEY_F(1) vs F1
kLFT5 vs CTRL-LEFT

See: https://en.wikipedia.org/wiki/Control_character#How_control_characters_map_to_keyboards

Package

de.anvi.croatoan

Source

util.lisp (file)

Methods
Method: key-to-string (KEY integer)
Method: key-to-string (KEY character)
Method: key-to-string (KEY-NAME symbol)

Function key name represented by a keyword.

Generic Function: keymap OBJECT
Generic Function: (setf keymap) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: keymap (FORM form)
Method: (setf keymap) NEW-VALUE (FORM form)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (FIELD field)
Method: (setf keymap) NEW-VALUE (FIELD field)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (CHECKBOX checkbox)
Method: (setf keymap) NEW-VALUE (CHECKBOX checkbox)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (BUTTON button)
Method: (setf keymap) NEW-VALUE (BUTTON button)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (ELEMENT element)
Method: (setf keymap) NEW-VALUE (ELEMENT element)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (MENU menu)
Method: (setf keymap) NEW-VALUE (MENU menu)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Method: keymap (WINDOW window)
Method: (setf keymap) NEW-VALUE (WINDOW window)

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Source

classes.lisp (file)

Generic Function: location WINDOW
Generic Function: (setf location) COORDINATES WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: location (WIN sub-window)
Method: location (WINDOW window)
Method: (setf location) COORDINATES (W window)
Generic Function: location-x WINDOW
Generic Function: (setf location-x) X WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: location-x (WIN sub-window)
Method: location-x (WIN window)
Method: (setf location-x) X (WIN window)
Generic Function: location-y WINDOW
Generic Function: (setf location-y) Y WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: location-y (WIN sub-window)
Method: location-y (WIN window)
Method: (setf location-y) Y (WIN window)
Generic Function: max-buffer-length OBJECT
Generic Function: (setf max-buffer-length) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: max-buffer-length (FIELD field)
Method: (setf max-buffer-length) NEW-VALUE (FIELD field)

Max length of the field buffer. If nil, it will be initialized to field width. Horizontal scrolling is then disabled.

Source

classes.lisp (file)

Generic Function: max-item-length OBJECT
Generic Function: (setf max-item-length) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: max-item-length (MENU menu)
Method: (setf max-item-length) NEW-VALUE (MENU menu)

Max number of characters displayed for a single item.

Source

classes.lisp (file)

Generic Function: menu-type OBJECT
Generic Function: (setf menu-type) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: menu-type (MENU menu)
Method: (setf menu-type) NEW-VALUE (MENU menu)

Types of menus: :selection (default, can contain strings, symbols, menus) or :checklist.

Source

classes.lisp (file)

Generic Function: message-height OBJECT
Package

de.anvi.croatoan

Methods
Method: message-height (DIALOG-WINDOW dialog-window)

Max number of lines reserved for the optional message text.

Source

classes.lisp (file)

Generic Function: message-pad OBJECT
Package

de.anvi.croatoan

Methods
Method: message-pad (DIALOG-WINDOW dialog-window)

Passive content window, for example for menu descriptions.

Source

classes.lisp (file)

Generic Function: message-pad-coordinates OBJECT
Package

de.anvi.croatoan

Methods
Method: message-pad-coordinates (DIALOG-WINDOW dialog-window)

List of four coordinates where to refresh/display the message pad: min-y min-x max-y max-x.

Source

classes.lisp (file)

Generic Function: message-text OBJECT
Generic Function: (setf message-text) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: message-text (DIALOG-WINDOW dialog-window)
Method: (setf message-text) NEW-VALUE (DIALOG-WINDOW dialog-window)

Optional message text to describe the choices in the menu below.

Source

classes.lisp (file)

Generic Function: move-next-char OBJECT EVENT &rest ARGS

Move the cursor to the next char.

Package

de.anvi.croatoan

Source

form.lisp (file)

Methods
Method: move-next-char (FIELD field) EVENT &rest ARGS

Move the cursor to the next char in the field.

Method: move-next-char OBJECT EVENT &rest ARGS

The default method does nothing.

Generic Function: move-previous-char OBJECT EVENT &rest ARGS

Move the cursor to the previous character.

Package

de.anvi.croatoan

Source

form.lisp (file)

Methods
Method: move-previous-char (FIELD field) EVENT &rest ARGS

Move the cursor to the previous char in the field.

Method: move-previous-char OBJECT EVENT &rest ARGS

The default method does nothing.

Generic Function: name OBJECT
Package

de.anvi.croatoan

Methods
Method: name (FORM form)

Name of the form.

Source

classes.lisp (file)

Method: name (ELEMENT element)

Optional unique name by which the element can be identified and accessed.

Source

classes.lisp (file)

Method: name (MENU menu)

Name of the menu. (For example for setting the menu-window title, if title is t.)

Source

classes.lisp (file)

Method: name (MENU-ITEM menu-item)

Short name of a menu item displayed in the menu.

Source

classes.lisp (file)

Generic Function: newline-translation-enabled-p SCREEN
Generic Function: (setf newline-translation-enabled-p) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: newline-translation-enabled-p (SCREEN screen)
Method: (setf newline-translation-enabled-p) STATUS (SCREEN screen)
Generic Function: origin-x OBJECT
Generic Function: (setf origin-x) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: origin-x (SHAPE shape)
Method: (setf origin-x) NEW-VALUE (SHAPE shape)

The x coordinate of this shape’s point of origin.

Source

shape.lisp (file)

Generic Function: origin-y OBJECT
Generic Function: (setf origin-y) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: origin-y (SHAPE shape)
Method: (setf origin-y) NEW-VALUE (SHAPE shape)

The y coordinate of this shape’s point of origin.

Source

shape.lisp (file)

Generic Function: plot-char OBJECT
Generic Function: (setf plot-char) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: plot-char (SHAPE shape)
Method: (setf plot-char) NEW-VALUE (SHAPE shape)

The character to use for plotting.

Source

shape.lisp (file)

Generic Function: process-control-chars-p SCREEN
Generic Function: (setf process-control-chars-p) STATUS SCREEN
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: process-control-chars-p (SCREEN screen)
Method: (setf process-control-chars-p) STATUS (SCREEN screen)
Generic Function: scrolling-enabled-p WINDOW
Generic Function: (setf scrolling-enabled-p) STATUS WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: scrolling-enabled-p (WINDOW window)
Method: (setf scrolling-enabled-p) STATUS (WINDOW window)
Generic Function: scrolling-region WINDOW
Generic Function: (setf scrolling-region) LIST WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: scrolling-region (WINDOW window)
Method: (setf scrolling-region) LIST (WINDOW window)
Generic Function: simple-char OBJECT
Generic Function: (setf simple-char) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: simple-char (COMPLEX-CHAR complex-char)
Method: (setf simple-char) NEW-VALUE (COMPLEX-CHAR complex-char)

Lisp primitive character type, like #a.

Source

classes.lisp (file)

Generic Function: (setf source-location) COORDINATES SUB-WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Methods
Method: (setf source-location) COORDINATES (W sub-window)
Generic Function: stackedp WIN
Generic Function: (setf stackedp) STACKEDP WIN
Package

de.anvi.croatoan

Methods
Method: stackedp (WIN window)
Method: (setf stackedp) STACKEDP (WIN window)
Source

classes.lisp (file)

Generic Function: style ELEMENT
Generic Function: (setf style) STYLE ELEMENT
Package

de.anvi.croatoan

Methods
Method: style (FORM form)
Method: (setf style) NEW-VALUE (FORM form)

A plist of default styles for each form element type.

Source

classes.lisp (file)

Method: style (ELEMENT element)

If the element’s style slot is empty, check whether a default style has been defined in the parent form.

Source

classes.lisp (file)

Method: (setf style) STYLE (ELEMENT element)
Source

classes.lisp (file)

Generic Function: sub-window OBJECT
Package

de.anvi.croatoan

Methods
Method: sub-window (DECORATED-WINDOW decorated-window)

Active content window, for example for menu items.

Source

classes.lisp (file)

Generic Function: title OBJECT
Generic Function: (setf title) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: title (ELEMENT element)
Method: (setf title) NEW-VALUE (ELEMENT element)

Title of the element to be displayed at an location depending on the element type.

Source

classes.lisp (file)

Method: title (DECORATED-WINDOW decorated-window)
Method: (setf title) NEW-VALUE (DECORATED-WINDOW decorated-window)

If t, a title of the window will be displayed over the top border.

Source

classes.lisp (file)

Generic Function: value OBJECT
Generic Function: (setf value) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: value (CHECKLIST checklist)

Return the list of values of the checked items.

Source

menu.lisp (file)

Method: value (MENU menu)

Return the value of the selected item.

Source

menu.lisp (file)

Method: value (FIELD field)

If the field buffer is empty, return nil, otherwise return the buffer as a string.

Source

classes.lisp (file)

Method: (setf value) NEW-VALUE (FIELD field)
Source

classes.lisp (file)

Method: value (ELEMENT element)
Method: (setf value) NEW-VALUE (ELEMENT element)

Value of the element, mostly the result of the form editing.

Source

classes.lisp (file)

Method: value (MENU-ITEM menu-item)

Object associated with and returned upon selection of the item.

Source

classes.lisp (file)

Generic Function: visiblep OBJECT
Generic Function: (setf visiblep) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: visiblep (WINDOW window)
Method: (setf visiblep) NEW-VALUE (WINDOW window)

If visible is nil, do not refresh the stacked window when refreshing the window stack.

Source

classes.lisp (file)

Generic Function: width WINDOW
Package

de.anvi.croatoan

Source

classes.lisp (file)

Writer

(setf width) (generic function)

Methods
Method: width (WINDOW window)
Method: width (FIELD field)

The width of the field. The default buffer length is equal the width.

Method: width (LABEL label)

The width of the label.

Generic Function: (setf width) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Reader

width (generic function)

Methods
Method: (setf width) NEW-VALUE (FIELD field)

The width of the field. The default buffer length is equal the width.

Source

classes.lisp (file)

Method: (setf width) NEW-VALUE (LABEL label)

The width of the label.

Source

classes.lisp (file)

Generic Function: window ELEMENT
Generic Function: (setf window) WINDOW ELEMENT
Package

de.anvi.croatoan

Methods
Method: window (FORM form)
Method: (setf window) NEW-VALUE (FORM form)

Window created separately and then associated with the form.

Source

classes.lisp (file)

Method: window (ELEMENT element)

Return the window associated with an element, which can optionally be part of a form.

If there is no window asociated with the element, return the window associated with the parent form.

Source

classes.lisp (file)

Method: (setf window) WINDOW (ELEMENT element)
Source

classes.lisp (file)

Generic Function: winptr OBJECT
Package

de.anvi.croatoan

Methods
Method: winptr (WINDOW window)

Pointer to a C/ncurses WINDOW structure after the window is created.

Source

classes.lisp (file)


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

5.1.5 Conditions

Condition: job-error ()
Package

de.anvi.croatoan

Source

queue.lisp (file)

Direct superclasses

error (condition)

Direct methods

print-object (method)

Direct slots
Slot: form

The form that failed to execute

Initargs

:form

Initform

(quote (error "form required"))

Slot: error

The error that was signaled when form was executed

Initargs

:error

Initform

(quote (error "error required"))


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

5.1.6 Classes

Class: button ()

An element that can call a function by pressing enter (or in future, with a mouse click).

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

element (class)

Direct methods
Direct slots
Slot: callback

Callback function called when the button is activated.

Type

(or null symbol function)

Initargs

:callback

Readers

callback (generic function)

Writers

(setf callback) (generic function)

Slot: style

A plist of two complex-chars (or nil): :foreground and :selected-foreground.

Type

(or null cons)

Initargs

:style

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Initform

(quote de.anvi.croatoan:button-map)

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Class: checkbox ()

A boolean element that can be checked (t) or unchecked (nil)

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

element (class)

Direct methods
Direct slots
Slot: style

A plist containing :foreground and :selected-foreground.

Type

(or null cons)

Initargs

:style

Slot: checkedp

t if the checkbox has been checked, nil if it hasn’t.

Type

boolean

Initargs

:checked

Readers

checkedp (generic function)

Writers

(setf checkedp) (generic function)

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Initform

(quote de.anvi.croatoan::checkbox-map)

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Class: checklist ()

A checklist is a multi-selection menu with checkable items.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

menu (class)

Direct methods
Direct slots
Slot: menu-type

The type of the menu is set to :checklist

Type

keyword

Initargs

:menu-type

Initform

:checklist

Class: complex-char ()

A complex char consists of a simple char, a list of attribute keywords and a pair of color keywords.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • convert-char (method)
  • stream-write-char (method)
  • print-object (method)
  • print-object (method)
  • color-pair (method)
  • color-pair (method)
  • make-load-form (method)
  • initialize-instance (method)
  • bgcolor (method)
  • bgcolor (method)
  • fgcolor (method)
  • fgcolor (method)
  • attributes (method)
  • attributes (method)
  • simple-char (method)
  • simple-char (method)
Direct slots
Slot: simple-char

Lisp primitive character type, like #a.

Type

(or null integer character keyword)

Initargs

:simple-char

Readers

simple-char (generic function)

Writers

(setf simple-char) (generic function)

Slot: attributes

List of keywords denoting attributes.

Type

(or null cons)

Initargs

:attributes

Initform

(quote nil)

Readers

attributes (generic function)

Writers

(setf attributes) (generic function)

Slot: fgcolor

A keyword denoting the foreground color of the complex character.

Type

(or null keyword integer list)

Initargs

:fgcolor

Readers

fgcolor (generic function)

Writers

(setf fgcolor) (generic function)

Slot: bgcolor

A keyword denoting the background color of the complex character.

Type

(or null keyword integer list)

Initargs

:bgcolor

Readers

bgcolor (generic function)

Writers

(setf bgcolor) (generic function)

Class: complex-string ()

A complex string consists of an array of complex characters.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • print-object (method)
  • initialize-instance (method)
  • complex-char-array (method)
  • complex-char-array (method)
Direct slots
Slot: complex-char-array

Lisp primitive string type.

Type

vector

Initargs

:complex-char-array

Initform

(make-array 0 :element-type (quote de.anvi.croatoan:complex-char) :fill-pointer 0 :adjustable t)

Readers

complex-char-array (generic function)

Writers

(setf complex-char-array) (generic function)

Class: decorated-window ()

A decorated-window is a window consisting of a background window for a border, a title and a content sub-window.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct subclasses
Direct methods
  • close (method)
  • initialize-instance (method)
  • title (method)
  • title (method)
  • sub-window (method)
Direct slots
Slot: sub-window

Active content window, for example for menu items.

Type

(or null de.anvi.croatoan:sub-window)

Initargs

:sub-window

Readers

sub-window (generic function)

Slot: title

If t, a title of the window will be displayed over the top border.

Type

(or boolean string)

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Class: dialog-window ()

A dialog is a decorated menu with a title, a message and items.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

menu-window (class)

Direct methods
Direct slots
Slot: message-pad

Passive content window, for example for menu descriptions.

Type

(or null de.anvi.croatoan:pad)

Readers

message-pad (generic function)

Slot: message-text

Optional message text to describe the choices in the menu below.

Type

(or null string)

Initargs

:message-text

Readers

message-text (generic function)

Writers

(setf message-text) (generic function)

Slot: message-height

Max number of lines reserved for the optional message text.

Type

integer

Initargs

:message-height

Initform

0

Readers

message-height (generic function)

Slot: message-pad-coordinates

List of four coordinates where to refresh/display the message pad: min-y min-x max-y max-x.

Type

(or null cons)

Readers

message-pad-coordinates (generic function)

Class: field ()

A field is an editable part of the screen for user input. Can be part of a form.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

element (class)

Direct methods
Direct slots
Slot: width

The width of the field. The default buffer length is equal the width.

Type

(or null integer)

Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: style

A plist of four complex-chars (or nil): :foreground, :background, :selected-foreground, :selected-background.

Type

(or null cons)

Initargs

:style

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Initform

(quote de.anvi.croatoan:field-map)

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Slot: buffer

List containing the characters in the field.

Type

(or null list)

Readers

buffer (generic function)

Writers

(setf buffer) (generic function)

Slot: max-buffer-length

Max length of the field buffer. If nil, it will be initialized to field width. Horizontal scrolling is then disabled.

Type

(or null integer)

Initargs

:max-buffer-length

Readers

max-buffer-length (generic function)

Writers

(setf max-buffer-length) (generic function)

Slot: display-pointer

Position in the input buffer from which n=width characters are displayed.
When max-buffer-length is greater than width, display-pointer can be greater than zero. Horizontal scrolling is then enabled.

Type

(or null integer)

Initform

0

Readers

display-pointer (generic function)

Writers

(setf display-pointer) (generic function)

Slot: input-pointer

The position in the input buffer to which the next character will be written.

Type

integer

Initform

0

Readers

input-pointer (generic function)

Writers

(setf input-pointer) (generic function)

Class: form ()

A form is a list of fields.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

form-window (class)

Direct methods
Direct slots
Slot: name

Name of the form.

Type

(or null symbol keyword string)

Initargs

:name

Readers

name (generic function)

Slot: elements

List of elements. The first element will be initialized as the current element.

Type

(or null cons)

Initargs

:elements

Readers

elements (generic function)

Writers

(setf elements) (generic function)

Slot: current-element-number

Number of the currently selected element.

Type

integer

Initform

0

Readers

current-element-number (generic function)

Writers

(setf current-element-number) (generic function)

Slot: current-element

Currently selected element object.

Type

(or null de.anvi.croatoan:field de.anvi.croatoan:button de.anvi.croatoan:label de.anvi.croatoan:checkbox de.anvi.croatoan:menu de.anvi.croatoan:checklist)

Readers

current-element (generic function)

Writers

(setf current-element) (generic function)

Slot: style

A plist of default styles for each form element type.

Type

(or null cons)

Initargs

:style

Readers

style (generic function)

Writers

(setf style) (generic function)

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Initform

(quote de.anvi.croatoan:form-map)

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Slot: window

Window created separately and then associated with the form.

Type

(or null de.anvi.croatoan:window)

Initargs

:window

Readers

window (generic function)

Writers

(setf window) (generic function)

Class: form-window ()
Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses
Direct methods
  • draw (method)
  • close (method)
  • initialize-instance (method)
Class: keymap ()

A keymap contains an alist of events as keys and event handlers or chained keymaps as values.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • initialize-instance (method)
  • bindings (method)
  • bindings (method)
Direct slots
Slot: bindings

Alist of events and handler functions.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Class: label ()

A string displayed at the specified location.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

element (class)

Direct methods
Direct slots
Slot: reference

If the name of a reference element is specified, the element’s title will be displayed instead of the label’s. If a title for the label is explicitely provided, it overrides the title of the reference element.

Type

(or null symbol keyword string)

Initargs

:reference

Readers

reference (generic function)

Writers

(setf reference) (generic function)

Slot: width

The width of the label.

Type

(or null integer)

Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: style
Type

(or null cons)

Initargs

:style

Slot: activep

Labels are by default not active and can not be selected when cycling through the elements.

Class: menu ()

A menu is a list of items that can be selected by the user.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

element (class)

Direct subclasses
Direct methods
Direct slots
Slot: name

Name of the menu. (For example for setting the menu-window title, if title is t.)

Type

(or null string symbol)

Initargs

:name

Readers

name (generic function)

Slot: items

List of menu items. Item types can be strings, symbols, other menus or callback functions.

Type

(or null cons)

Initargs

:items

Readers

items (generic function)

Writers

(setf items) (generic function)

Slot: menu-type

Types of menus: :selection (default, can contain strings, symbols, menus) or :checklist.

Type

keyword

Initargs

:menu-type

Initform

:selection

Readers

menu-type (generic function)

Writers

(setf menu-type) (generic function)

Slot: current-item-number

Number of the currently selected item.

Type

integer

Initform

0

Readers

current-item-number (generic function)

Writers

(setf current-item-number) (generic function)

Slot: current-item

Pointer to the currently selected item object. The first item is initialized as the current item.

Type

(or null string symbol de.anvi.croatoan:menu-item)

Readers

current-item (generic function)

Writers

(setf current-item) (generic function)

Slot: current-item-position

(y x) position of the current item in the window.
This information is useful for positioning the cursor on the current item after displaying the menu.

Type

(or null cons)

Initargs

:current-item-position

Readers

current-item-position (generic function)

Writers

(setf current-item-position) (generic function)

Slot: current-item-mark

A string prefixed to the current item in the menu.

Type

string

Initargs

:current-item-mark

Initform

""

Readers

current-item-mark (generic function)

Slot: cyclic-selection-p

Wrap around when the end of a non-scrolled menu is reached.

Type

boolean

Initargs

:cyclic-selection

Readers

cyclic-selection-p (generic function)

Writers

(setf cyclic-selection-p) (generic function)

Slot: max-item-length

Max number of characters displayed for a single item.

Type

integer

Initargs

:max-item-length

Initform

15

Readers

max-item-length (generic function)

Writers

(setf max-item-length) (generic function)

Slot: layout

Layout (no-of-rows no-of-columns) of the items in the menu. If nil, we have a vertical list.

Type

(or null cons)

Initargs

:layout

Readers

layout (generic function)

Writers

(setf layout) (generic function)

Slot: scrolled-layout

Layout (no-of-rows no-of-columns) of the menu items actually displayed on screen.

Type

(or null cons)

Initargs

:scrolled-layout

Readers

scrolled-layout (generic function)

Writers

(setf scrolled-layout) (generic function)

Slot: scrolled-region-start

A 2-element list tracking the starting row/y and column/x of the displayed menu region.

Type

(or null cons)

Initform

(list 0 0)

Readers

scrolled-region-start (generic function)

Writers

(setf scrolled-region-start) (generic function)

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Initform

(quote de.anvi.croatoan:menu-map)

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Slot: style

Style of menu items: :foreground, :background, :selected-foreground, :selected-background. The default style of the selected item is the attribute :reverse, and nil for other items.

Type

(or null cons)

Initargs

:style

Class: menu-item ()

A menu consists of a list of menu items.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name

Short name of a menu item displayed in the menu.

Type

(or null string symbol)

Initargs

:name

Readers

name (generic function)

Slot: checkedp

t if the item has been checked, nil if it hasn’t.

Type

boolean

Initargs

:checked

Readers

checkedp (generic function)

Writers

(setf checkedp) (generic function)

Slot: value

Object associated with and returned upon selection of the item.

Type

(or symbol string de.anvi.croatoan:menu de.anvi.croatoan:menu-window function)

Initargs

:value

Readers

value (generic function)

Class: menu-window ()

A menu-window is decorated-window providing a list of items to be selected by the user.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses
Direct subclasses

dialog-window (class)

Direct methods
  • draw (method)
  • close (method)
  • initialize-instance (method)
Class: pad ()

A pad is a window without a specified location on screen, which is specified dynamically during refresh.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct subclasses

sub-pad (class)

Direct methods

initialize-instance (method)

Class: queue ()

A thread-safe FIFO queue.

Package

de.anvi.croatoan

Source

queue.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • initialize-instance (method)
Direct slots
Slot: head

Pointer to the first cons of the elements list.

Slot: tail

Pointer to the last cons of the elements list.

Slot: lock

A mutex that ensures thread-safe access to the queue from multiple threads.

Class: screen ()

Represents the main window created upon screen initialisation.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct methods
Direct slots
Slot: colors-enabled-p

Enable (t) or disable (nil) display of colors, if the terminal supports it.

Type

boolean

Initargs

:enable-colors

Slot: use-terminal-colors-p

Use (t) colors set by the terminal (named :terminal) as the default instead of the ncurses default white on black.

Type

boolean

Initargs

:use-terminal-colors

Slot: cursor-visible-p

Enable (t) or disable (nil) the display of a visible cursor.

Type

boolean

Initargs

:cursor-visible

Initform

t

Slot: input-echoing-p

Enable (t) or disable (nil) echoing of chars during keyboard input.

Type

boolean

Initargs

:input-echoing

Initform

t

Slot: input-buffering-p

Set whether typed characters will be returned immediately when they are typed (nil, default) or buffered until Return is typed (t).

Type

boolean

Initargs

:input-buffering

Slot: process-control-chars-p

If input-buffering is nil, set whether some control characters like ^C, ^S, ^Q, ^D will be processed (t, default) or passed directly to the program (nil).
When input-buffering is t, control chars are always processed and this option has no effect.

Type

boolean

Initargs

:process-control-chars

Initform

t

Slot: newline-translation-enabled-p

If t (default), the #return character (CR ^M r) is automatically translated to newline (NL) on input, and NL is translated to CR LF on output.
NL is the standard, system independent, portable way to end a line.
It can be either #linefeed (LF ^J n) on Linux, carriage #return on MacOS, CRLF rn on Windows. Setting newline translation to nil is necessary to be able to detect the #return key.

Type

boolean

Initargs

:enable-newline-translation

Initform

t

Slot: closed-p

Check whether the screen has been closed, without a subsequent call to refresh to reactivate it.

Type

boolean

Class: shape ()

A shape is a list of coordinates, relative to an origin, that can be plotted in a window.

Package

de.anvi.croatoan

Source

shape.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: origin-x

The x coordinate of this shape’s point of origin.

Type

integer

Initargs

:x0

Initform

0

Readers

origin-x (generic function)

Writers

(setf origin-x) (generic function)

Slot: origin-y

The y coordinate of this shape’s point of origin.

Type

integer

Initargs

:y0

Initform

0

Readers

origin-y (generic function)

Writers

(setf origin-y) (generic function)

Slot: coordinates

A list of coordinates relative to the origin that form this shape.

Type

(or null cons)

Readers

coordinates (generic function)

Writers

(setf coordinates) (generic function)

Slot: plot-char

The character to use for plotting.

Type

(or null character keyword de.anvi.croatoan:complex-char)

Initargs

:char

Initform

(make-instance (quote de.anvi.croatoan:complex-char) :simple-char #\x :color-pair (quote (:white :black)) :attributes nil)

Readers

plot-char (generic function)

Writers

(setf plot-char) (generic function)

Class: sub-pad ()

A sub-pad shares the memory and the display with a parent pad and has to be contained within it.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

pad (class)

Direct methods

initialize-instance (method)

Direct slots
Slot: parent

The parent pad which will contain the sub-pad.

Type

(or null de.anvi.croatoan:pad)

Initargs

:parent

Class: sub-window ()

A sub-window shares the memory and the display with and has to be contained within a parent window.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

window (class)

Direct methods
Direct slots
Slot: parent

The parent window which will contain the sub-window.

Type

(or null de.anvi.croatoan:window)

Initargs

:parent

Slot: relativep

The location of the sub-window is relative to the parent window (t) or to the screen (nil, default).

Type

boolean

Initargs

:relative

Slot: source-location

Location (y x) of the area of the parent window, which is mapped to the subwindow. By default it is identical to the location of the subwindow.

Type

(or null cons)

Initargs

:source-location

Class: window ()

A curses window object as returned by newwin.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses
  • fundamental-character-output-stream (class)
  • fundamental-character-input-stream (class)
Direct subclasses
Direct methods
Direct slots
Slot: location

The (y=row x=column) coordinate of the top left corner of the window.

Type

(or null cons)

Initargs

:location

Initform

(quote (0 0))

Slot: width

The width (second, horizontal, x dimension) of the window.

Type

(or null integer)

Initargs

:width

Slot: height

The height (first, vertical, y dimension) of the window.

Type

(or null integer)

Initargs

:height

Slot: cursor-position

The current cursor position coordinates in the form (y x).

Type

cons

Slot: input-blocking

Input mode: blocking (t), non-blocking (nil) or blocking duration in (positive integer) miliseconds.

Type

(or boolean integer)

Initargs

:input-blocking

Initform

t

Slot: frame-rate

Set the frame rate in fps (frames per second). When input-blocking is nil, sleep for 1/frame-rate seconds between event loop cycles. Has the same effect as setting input-blocking duration, and should thus not be used simultaneously.

Type

(or null integer)

Initargs

:frame-rate

Readers

frame-rate (generic function)

Writers

(setf frame-rate) (generic function)

Slot: function-keys-enabled-p

Enable (t) or disable (nil) support for function keys.

Type

boolean

Initargs

:enable-function-keys

Slot: scrolling-enabled-p

Enable (t) or disable (nil) support for window scrolling.

Type

boolean

Initargs

:enable-scrolling

Slot: scrolling-region

When scrolling is enabled, only scroll the window region from line y1 to y2 given as the list (y1 y2).

Type

(or null cons)

Initargs

:scrolling-region

Slot: insert-mode-p

Printing a new char will insert (t) it before the character under the cursor instead of overwriting it (nil, default).

Type

boolean

Initargs

:insert-mode

Readers

insert-mode-p (generic function)

Writers

(setf insert-mode-p) (generic function)

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Slot: background

Sets a complex char with its attributes and colors as the default style of unrendered text and empty cells of the window. Complex chars with pre-existing attributes and colors are not changed.

Type

(or null de.anvi.croatoan:complex-char)

Initargs

:background

Slot: attributes

A list of keywords denoting attributes of new characters added to a window.

Type

(or null cons)

Initargs

:attributes

Slot: fgcolor

A keyword denoting the foreground color of new characters added to the window.

Type

(or null keyword integer list)

Initargs

:fgcolor

Slot: bgcolor

A keyword denoting the background color of new characters added to the window.

Type

(or null keyword integer list)

Initargs

:bgcolor

Slot: draw-border-p

Draw (t) or don’t draw (nil, default) an initial border around a window. Not redrawn automatically.

Type

boolean

Initargs

:draw-border

Readers

draw-border-p (generic function)

Slot: stackedp

If stacked is t, the window is added to the global window stack, so overlapping windows can be refreshed in the stacking order.

Type

boolean

Initargs

:stacked

Slot: visiblep

If visible is nil, do not refresh the stacked window when refreshing the window stack.

Type

boolean

Initargs

:visible

Initform

t

Readers

visiblep (generic function)

Writers

(setf visiblep) (generic function)

Slot: winptr

Pointer to a C/ncurses WINDOW structure after the window is created.

Readers

winptr (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *bitmask-alist*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *color-pair-alist*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *default-color-pair*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *job-queue*

A queue of functions (consed to their form for debugging purposes) to be processed by the main thread to interface with ncurses.

Package

de.anvi.croatoan

Source

queue.lisp (file)

Special Variable: *key-alist*
Package

de.anvi.croatoan

Source

getch.lisp (file)

Special Variable: *keymaps*

An alist of available keymaps.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Special Variable: *mouse-button-event-bitmask-alist*
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Special Variable: *mouse-event-bitmask-alist*
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Special Variable: *valid-attributes*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: *window-stack*
Package

de.anvi.croatoan

Source

classes.lisp (file)

Special Variable: *xterm-color-hex-list*
Package

de.anvi.croatoan

Source

color.lisp (file)

Special Variable: *xterm-color-name-list*
Package

de.anvi.croatoan

Source

attr.lisp (file)

Special Variable: acs-alist
Package

de.anvi.croatoan

Source

addch.lisp (file)

Special Variable: acs-map-array
Package

de.anvi.croatoan

Source

addch.lisp (file)

Special Variable: wide-acs-alist
Package

de.anvi.croatoan

Source

add_wch.lisp (file)


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

5.2.2 Macros

Macro: access-alist KEY FIND-FN TEST-FN GET-VALUE-FN DEFAULT

Helper macro for ’key-name-to-code’ and ’key-code-to-name’.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Macro: mouse-bitmask BUTTON EVENT
Package

de.anvi.croatoan

Source

mouse.lisp (file)


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

5.2.3 Functions

Function: ascii-byte-p OCTET

Return t if octet is a single-byte 7-bit ASCII char.

The most significant bit is 0, so the allowed pattern is 0xxx xxxx.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: attrs2chtype ATTRS

Take a list of attribute keywords, return a chtype with the attribute bits set.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: bitmask-to-keyword BITMASK
Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: call-button-function BUTTON EVENT &rest ARGS
Package

de.anvi.croatoan

Source

form.lisp (file)

Function: char2chtype CHAR

Take a character in different forms, return a chtype containing that character.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: checked-items MENU

Take a menu, return a list of checked menu items.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: chtype2attrs CH

Take a chtype, return a list of used attribute keywords.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: chtype2colors CH

Take a chtype or attr_t integer, return a list of two keywords denoting a color pair.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: chtype2xchar CH

Converts a ncurses chtype to croatoan complex-char.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: closest-gray RGB

Take an integer 0-255 denoting a gray color intensity, return the closest gray from the xterm palette.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-1k-to-8bit INTEGER

Convert the ncurses color intensity 0-1000 to the 8bit range 0-255.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-8bit-to-1k INTEGER

Convert the 8bit range 0-255 to the ncurses color intensity 0-1000.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: color-name-to-number COLOR-NAME

Take a keyword denoting a color name, return the color number.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: color-to-number COLOR

Takes a color in various notations, converts that notation to the exact or most appropriate color number.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: colors2chtype COLOR-PAIR

Take a list of a color pair, return a chtype with the color attribute set.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: complete-default-pair COLOR-PAIR

Take a color pair possibly containing nil, return a pair completed from the default color pair 0.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: complete-pair WINDOW PAIR

If either the foreground or background color is nil, complete the pair for the given window.

Return the completed pair.

Try to complete the missing colors in the following order:

1. window color pair.
2. window background character color pair.
3. ncurses default color pair 0 (white on black or the terminal default color pair).

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: debug-print-field-buffer OBJECT EVENT &rest ARGS
Package

de.anvi.croatoan

Source

form.lisp (file)

Function: delete-next-char FIELD EVENT &rest ARGS

Delete the next char (char under the cursor) in the field, not moving the cursor.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: delete-previous-char FIELD EVENT &rest ARGS

Delete the previous char in the field, moving the cursor to the left.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: distance-to-bottom WINDOW

Return the number of lines from the cursor position to the bottom of the window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: distance-to-eol WINDOW

Return the number of columns from the cursor position to the end of the line in the window.

Package

de.anvi.croatoan

Source

addch.lisp (file)

Function: draw-menu-item WIN MENU ITEM-NUMBER I J

Draw the item given by item-number at item position (i j) in the window.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: enable-8bit-char-input WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: escape-sequence-delay WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: field-add-char FIELD CHAR &rest ARGS

Add char to the current cursor position in the field.

The buffer can be longer than the displayed field width, horizontal scrolling is enabled.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: flush-on-interrupt WINDOW FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: format-menu-item MENU ITEM-NUMBER

Take a menu and return item item-number as a properly formatted string.

If the menu is a checklist, return [ ] or [X] at the first position.

If a mark is set for the current item, display the mark at the second position. Display the same number of spaces for other items.

At the third position, display the item given by item-number.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: funcall-get-cchar_t FN WINDOW

Call function fn to read a cchar_t from window and return it as a wide complex char.

Package

de.anvi.croatoan

Source

bkgrnd.lisp (file)

Function: funcall-make-cchar_t FN WINDOW CHAR ATTRIBUTES COLOR-PAIR N

Assemble a cchar_t out of a char, attributes and a color-pair.

Then apply the fn to window and the assembled cchar_t.

char can be a lisp character, an ACS keyword, an integer code point or a complex char.

attributes should be a list of valid attribute keywords.

color-pair should be a list of a foreground and background color keyword.

attributes and color-pair can be nil.

If char is a complex char, attributes and color-pair are ignored.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: funcall-make-cchar_t-ptr FN WINPTR CHAR ATTR_T COLOR-PAIR-NUMBER COUNT

Create a cchar_t and apply function fn count times to winptr and cchar_t.

cchar_t is a C struct representing a wide complex-char in ncurses.

This function is a wrapper around %setcchar and should not be used elsewhere.

Package

de.anvi.croatoan

Source

add_wch.lisp (file)

Function: funcall-make-chtype FN WINDOW CHAR ATTRIBUTES COLOR-PAIR N

Assemble a chtype out of a char, attributes and a color-pair.

Apply low-level ncurses function fn count times to window and chtype.

chtype is a 32-bit integer representing a non-wide complex-char in ncurses.

char can be a lisp character, an ACS keyword, an integer code point or a complex char.

attributes should be a list of valid attribute keywords.

color-pair should be a list of a foreground and background color keyword.

attributes and color-pair can be nil.

If char is a complex char, attributes and color-pair are ignored.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: gen-unused-key-code ()

Generate and return an unused key code.

Used by define-function-key when a new escape sequence is added.

To avoid conflicts with existing ncurses code numbers, new numbers start at 1024.

Package

de.anvi.croatoan

Source

getch.lisp (file)

Function: get-background-cchar_t WINDOW

Return the wide complex char that is the background character of the window.

Package

de.anvi.croatoan

Source

bkgrnd.lisp (file)

Function: get-background-char WINDOW

Return the complex char that is the background character of the window.

Package

de.anvi.croatoan

Source

bkgd.lisp (file)

Function: get-bitmask ATTRIBUTE

Returns an ncurses attr/chtype representing the attribute keyword.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: get-event-handler OBJECT EVENT

Take an object and an event, return the object’s handler for that event.

The key bindings alist is stored in the bindings slot of the object.

An external keymap can be defined so several objects can share the same set of bindings.

Object-local bindings override the external keymap. The local bindings
are checked first for a handler, then the external keymap.

If no handler is defined for the event, the default event handler t is tried. If not even a default handler is defined, the event is ignored.

If input-blocking is nil, we receive nil events in case no real events occur. In that case, the handler for the nil event is returned, if defined.

The event pairs are added by the bind function as conses: (event . #’handler).

An event should be bound to the pre-defined function exit-event-loop.

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: gray-to-rgb SGR

Take a sgr gray color number 232-255, return a list of three RGB integers 0-255.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: hex-to-rgb HEX

Take a 24bit integer (RGB hex triplet), return a list of three 8bit (0-255) RGB values.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: hex-to-sgr HEX

Takes a RGB hex triplet, returns the exact or most appropriate SGR color code 0-255.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: init-screen ()

Initializes the curses mode. Returns the main window.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: io-queue-flush FLAG
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: keyword-to-bitmask KEYS

Take a list of mouse event keywords, return a logiored bitmask.

Package

de.anvi.croatoan

Source

mouse.lisp (file)

Function: lead-byte-p OCTET

Return t if octet is one of the leading bytes of an UTF-8 sequence, nil otherwise.

Allowed leading byte patterns are 0xxx xxxx, 110x xxxx, 1110 xxxx and 1111 0xxx.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: list2array LIST DIMENSIONS

Example: (list2array ’(a b c d e f) ’(3 2)) => #2A((A B) (C D) (E F))

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: make-chtype CHAR ATTRIBUTES COLOR-PAIR

Assemble a chtype out of a char, attributes and a color-pair.

char can be a lisp character, an ACS keyword, or an integer code point.

attributes should be a list of valid attribute keywords.

color-pair should be a list of a foreground and background color keyword.

attributes and color-pair can be nil.

If char is a complex char, and the attributes and color-pair are passed, they override the attributes and the color-of the complex char.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: multi-byte-p OCTET

Return t if octet is a part of a multi-byte UTF-8 sequence.

The multibyte pattern is 1xxx xxxx.

A multi-byte can be either a lead byte or a trail byte.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: n-trail-bytes OCTET

Take a leading utf-8 byte, return the number of continuation bytes 1-3.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: new-terminal TYPE OUT-FD IN-FD

Use instead of init-screen when you want more than one terminal.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: number-to-pair NUMBER

Take a pair number, return a color pair in a 2 element list of keywords.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: pair-to-number PAIR

Take a two-element list of colors, return the ncurses pair number.

The colors can be keywords or numbers -1:255.

-1 is the :terminal default color when use-terminal-colors-p is t.

If it is a new color pair, add it to ncurses, then return the new pair number.

If the pair already exists, return its pair number.

If pair is nil, return the default color number, 0.

Example:

(pair-to-number ’(:white :black)) => 0

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: plist2alist PLIST

Take a plist in the form (k1 v1 k2 v2 ...), return an alist ((k1 . v1) (k2 . v2) ...)

Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Function: reset-menu MENU

After the menu is closed reset it to its initial state.

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: rgb-to-hex RGB-LIST

Take a list of three 8bit (0-255) RGB values, return a 24bit integer (RGB hex triplet).

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: rgb-to-rgb6 RGB-LIST

Take a list of three RGB integers 0-255, return a list of three RGB integers 0-5.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: rgb6-to-rgb RGB6-LIST

Take a list of three RGB integers 0-5, return a list of three RGB integers 0-255 of the xterm color palette.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: rgb6-to-sgr RGB6-LIST

Take a list of three RGB integers 0-5, return an 8bit SGR color code 16-231.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: rmi2sub LAYOUT RMI

Take array dimensions and an index in row-major order, return two subscripts.

Example: (rmi2sub ’(2 3) 5) => (1 2)

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: rotate LIST COUNT
Package

de.anvi.croatoan

Source

panel.lisp (file)

Function: select-next-element FORM EVENT &rest ARGS

Select the next element in a form’s element list.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: select-previous-element FORM EVENT &rest ARGS

Select the previous element in a form’s element list.

Package

de.anvi.croatoan

Source

form.lisp (file)

Function: set-attributes WINPTR ATTRIBUTES

Takes a list of keywords and sets the appropriate attributes.

Overwrites any previous attribute settings including the color.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: set-background-cchar_t WINDOW CHAR &optional APPLY

Set a wide complex character as the background of a window.

The attribute part of the background character is combined with simple characters added to the window.

If apply is t, the background setting is immediately applied to all cells in the window.

Otherwise, it is applied only to newly added simple characters.

Package

de.anvi.croatoan

Source

bkgrnd.lisp (file)

Function: set-background-char WINPTR XCHAR &optional APPLY

Set a complex single-byte character as the background of a window.

The attribute part of the background character is combined with simple characters in the window.

If apply is t, the background setting is immediately applied to all cells in the window.

Otherwise, it is applied only to newly added simple characters.

Package

de.anvi.croatoan

Source

bkgd.lisp (file)

Function: set-color-pair WINPTR COLOR-PAIR

Sets the color attribute of the window only.

Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: set-current-terminal NEW-SCREEN

Sets new-screen as the current terminal. Returns the old screen.

Package

de.anvi.croatoan

Source

initscr.lisp (file)

Function: set-cursor-visibility STATUS
Package

de.anvi.croatoan

Source

kernel.lisp (file)

Function: set-default-color-pair USE-TERMINAL-COLORS-P
Package

de.anvi.croatoan

Source

attr.lisp (file)

Function: set-enable-fkeys WINDOW FLAG

If flag is t, bind function keys to known codes when returned by get-char.

If flag is nil, F keys will be system-dependent multi-character escape codes.

Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: set-equal LIST-A LIST-B &key TEST KEY

Compare if every element of list-a is contained in list-b.

The order of elements in lists does not matter, so the lists are actually treated as sets.

The items of the set are extracted using function ’key’ and compared using predicate ’test’.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Function: set-input-blocking WINDOW STATUS

Set window input blocking behavior.

Possible values are t, nil and a blocking duration in (positive integer) miliseconds.

Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: set-input-echoing FLAG

Set whether chars will be echoed on input.

Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: set-input-mode INPUT-BUFFERING PROCESS-CONTROL-CHARS
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: sgr-to-hex SGR

Take a SGR color code 0-255, return a 24bit hex triplet.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: sgr-to-rgb6 SGR

Take a 8bit SGR color code 16-231, return a list of three RGB integers 0-5.

Package

de.anvi.croatoan

Source

color.lisp (file)

Function: sub2rmi LAYOUT SUBS

Take array dimensions and two subscripts, return an index in row-major order.

Example: (sub2rmi ’(2 3) ’(1 2)) => 5

Package

de.anvi.croatoan

Source

menu.lisp (file)

Function: test-utf-8 ()
Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: toggle-checkbox CHECKBOX EVENT &rest ARGS
Package

de.anvi.croatoan

Source

form.lisp (file)

Function: trail-byte-p OCTET

Return t if octet is the continuation byte of an UTF-8 sequence.

The allowed continuation byte pattern is 10xx xxxx.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: type-ahead-fd FD
Package

de.anvi.croatoan

Source

inopts.lisp (file)

Function: unicode-to-utf-8 INT

Take a unicode code point, return a list of one to four UTF-8 encoded bytes (octets).

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: utf-8-to-unicode BYTE-LIST

Take a list of one to four utf-8 encoded bytes (octets), return a code point.

Since this decoder will only used for reading keyboard input, the sequences are not checked for illegal bytes.

Since security is not considered, this decoder should not be used for anything else.

Package

de.anvi.croatoan

Source

utf8.lisp (file)

Function: xchar2chtype CH

Convert a croatoan complex char to an integral ncurses chtype.

Package

de.anvi.croatoan

Source

attr.lisp (file)


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

5.2.4 Generic functions

Generic Function: activep OBJECT
Generic Function: (setf activep) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: activep (ELEMENT element)
Method: (setf activep) NEW-VALUE (ELEMENT element)

If t (default), the element can be selected. Used to prevent labels from being selected.

Source

classes.lisp (file)

Generic Function: current-element OBJECT
Generic Function: (setf current-element) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: current-element (FORM form)
Method: (setf current-element) NEW-VALUE (FORM form)

Currently selected element object.

Source

classes.lisp (file)

Generic Function: current-element-number OBJECT
Generic Function: (setf current-element-number) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: current-element-number (FORM form)
Method: (setf current-element-number) NEW-VALUE (FORM form)

Number of the currently selected element.

Source

classes.lisp (file)

Generic Function: current-item-position OBJECT
Generic Function: (setf current-item-position) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: current-item-position (MENU menu)
Method: (setf current-item-position) NEW-VALUE (MENU menu)

(y x) position of the current item in the window.
This information is useful for positioning the cursor on the current item after displaying the menu.

Source

classes.lisp (file)

Generic Function: display-pointer OBJECT
Generic Function: (setf display-pointer) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: display-pointer (FIELD field)
Method: (setf display-pointer) NEW-VALUE (FIELD field)

Position in the input buffer from which n=width characters are displayed.
When max-buffer-length is greater than width, display-pointer can be greater than zero. Horizontal scrolling is then enabled.

Source

classes.lisp (file)

Generic Function: handle-event OBJECT EVENT ARGS
Package

de.anvi.croatoan

Source

croatoan.lisp (file)

Methods
Method: handle-event (FORM form) EVENT ARGS

If a form can’t handle an event, let the current form element try to handle it.

Method: handle-event OBJECT EVENT ARGS

Default method for all objects without a specialized method.

Generic Function: input-pointer OBJECT
Generic Function: (setf input-pointer) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: input-pointer (FIELD field)
Method: (setf input-pointer) NEW-VALUE (FIELD field)

The position in the input buffer to which the next character will be written.

Source

classes.lisp (file)

Generic Function: layout OBJECT
Generic Function: (setf layout) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: layout (MENU menu)
Method: (setf layout) NEW-VALUE (MENU menu)

Layout (no-of-rows no-of-columns) of the items in the menu. If nil, we have a vertical list.

Source

classes.lisp (file)

Generic Function: parent-form OBJECT
Generic Function: (setf parent-form) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: parent-form (ELEMENT element)
Method: (setf parent-form) NEW-VALUE (ELEMENT element)

Parent form of the element. Added to every element upon the initialization of the form.

Source

classes.lisp (file)

Generic Function: reference OBJECT
Generic Function: (setf reference) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: reference (LABEL label)
Method: (setf reference) NEW-VALUE (LABEL label)

If the name of a reference element is specified, the element’s title will be displayed instead of the label’s. If a title for the label is explicitely provided, it overrides the title of the reference element.

Source

classes.lisp (file)

Generic Function: scrolled-layout OBJECT
Generic Function: (setf scrolled-layout) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: scrolled-layout (MENU menu)
Method: (setf scrolled-layout) NEW-VALUE (MENU menu)

Layout (no-of-rows no-of-columns) of the menu items actually displayed on screen.

Source

classes.lisp (file)

Generic Function: scrolled-region-start OBJECT
Generic Function: (setf scrolled-region-start) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: scrolled-region-start (MENU menu)
Method: (setf scrolled-region-start) NEW-VALUE (MENU menu)

A 2-element list tracking the starting row/y and column/x of the displayed menu region.

Source

classes.lisp (file)

Generic Function: selectedp OBJECT
Generic Function: (setf selectedp) NEW-VALUE OBJECT
Package

de.anvi.croatoan

Methods
Method: selectedp (ELEMENT element)
Method: (setf selectedp) NEW-VALUE (ELEMENT element)

Flag denoting whether the element is currently selected in a form.

Source

classes.lisp (file)

Generic Function: update-cursor-position OBJECT

Update the cursor position of the element of a form.

Package

de.anvi.croatoan

Source

form.lisp (file)

Methods
Method: update-cursor-position (FORM form)

Move the cursor to the correct position in current element of the form.

Method: update-cursor-position (FIELD field)

Update the cursor position of a field.

Method: update-cursor-position (CHECKBOX checkbox)

Update the cursor position of a checkbox.

Method: update-cursor-position (OBJECT checklist)

Update the cursor position of a checklist after it is drawn.

Place the cursor between the brackets [_] of the current item.

Method: update-cursor-position (OBJECT menu)

Update the cursor position of a menu after it is drawn.

Place the cursor, when it is visible, on the first char of the current item.

Method: update-cursor-position OBJECT

The default method puts the cursor at the start position of the element.


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

5.2.5 Classes

Class: element ()

An element of a form, like a field or button.

Package

de.anvi.croatoan

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name

Optional unique name by which the element can be identified and accessed.

Type

(or null symbol keyword string)

Initargs

:name

Readers

name (generic function)

Slot: title

Title of the element to be displayed at an location depending on the element type.

Type

(or boolean string)

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: value

Value of the element, mostly the result of the form editing.

Type

(or symbol keyword string number)

Initargs

:value

Readers

value (generic function)

Writers

(setf value) (generic function)

Slot: element-position

A two-element list (y=row x=column) containing the coordinate of the top left corner of the element within its associated window.

Type

(or null cons)

Initargs

:position

Readers

element-position (generic function)

Writers

(setf element-position) (generic function)

Slot: bindings

Alist of events (characters, keywords or integers) as keys and handler functions as values. Used by the run-event-loop function.

Type

(or null cons)

Initargs

:bindings

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: keymap

Keymap containing the key bindings to be used by run-event-loop instead of the object’s own bindings.

Type

(or null symbol keyword de.anvi.croatoan:keymap)

Initargs

:keymap

Readers

keymap (generic function)

Writers

(setf keymap) (generic function)

Slot: selectedp

Flag denoting whether the element is currently selected in a form.

Type

boolean

Readers

selectedp (generic function)

Writers

(setf selectedp) (generic function)

Slot: activep

If t (default), the element can be selected. Used to prevent labels from being selected.

Type

boolean

Initform

t

Readers

activep (generic function)

Writers

(setf activep) (generic function)

Slot: parent-form

Parent form of the element. Added to every element upon the initialization of the form.

Type

(or null de.anvi.croatoan:form)

Readers

parent-form (generic function)

Writers

(setf parent-form) (generic function)

Slot: window

If the element is not part of a form, a window can also be associated with the stand-alone element.

Type

(or null de.anvi.croatoan:window)

Initargs

:window


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
croatoan.asd: The croatoan․asd file
croatoan/addch.lisp: The croatoan/addch․lisp file
croatoan/addstr.lisp: The croatoan/addstr․lisp file
croatoan/add_wch.lisp: The croatoan/add_wch․lisp file
croatoan/attr.lisp: The croatoan/attr․lisp file
croatoan/beep.lisp: The croatoan/beep․lisp file
croatoan/bkgd.lisp: The croatoan/bkgd․lisp file
croatoan/bkgrnd.lisp: The croatoan/bkgrnd․lisp file
croatoan/border.lisp: The croatoan/border․lisp file
croatoan/border_set.lisp: The croatoan/border_set․lisp file
croatoan/classes.lisp: The croatoan/classes․lisp file
croatoan/clear.lisp: The croatoan/clear․lisp file
croatoan/color.lisp: The croatoan/color․lisp file
croatoan/croatoan.lisp: The croatoan/croatoan․lisp file
croatoan/define_key.lisp: The croatoan/define_key․lisp file
croatoan/delch.lisp: The croatoan/delch․lisp file
croatoan/deleteln.lisp: The croatoan/deleteln․lisp file
croatoan/form.lisp: The croatoan/form․lisp file
croatoan/getch.lisp: The croatoan/getch․lisp file
croatoan/getstr.lisp: The croatoan/getstr․lisp file
croatoan/get_wch.lisp: The croatoan/get_wch․lisp file
croatoan/gray_streams.lisp: The croatoan/gray_streams․lisp file
croatoan/inch.lisp: The croatoan/inch․lisp file
croatoan/inchstr.lisp: The croatoan/inchstr․lisp file
croatoan/initscr.lisp: The croatoan/initscr․lisp file
croatoan/inopts.lisp: The croatoan/inopts․lisp file
croatoan/insch.lisp: The croatoan/insch․lisp file
croatoan/insstr.lisp: The croatoan/insstr․lisp file
croatoan/instr.lisp: The croatoan/instr․lisp file
croatoan/ins_wch.lisp: The croatoan/ins_wch․lisp file
croatoan/inwstr.lisp: The croatoan/inwstr․lisp file
croatoan/in_wch.lisp: The croatoan/in_wch․lisp file
croatoan/kernel.lisp: The croatoan/kernel․lisp file
croatoan/menu.lisp: The croatoan/menu․lisp file
croatoan/mouse.lisp: The croatoan/mouse․lisp file
croatoan/move.lisp: The croatoan/move․lisp file
croatoan/package.lisp: The croatoan/package․lisp file
croatoan/panel.lisp: The croatoan/panel․lisp file
croatoan/queue.lisp: The croatoan/queue․lisp file
croatoan/refresh.lisp: The croatoan/refresh․lisp file
croatoan/shape.lisp: The croatoan/shape․lisp file
croatoan/touch.lisp: The croatoan/touch․lisp file
croatoan/utf8.lisp: The croatoan/utf8․lisp file
croatoan/util.lisp: The croatoan/util․lisp file
croatoan/wresize.lisp: The croatoan/wresize․lisp file

F
File, Lisp, croatoan.asd: The croatoan․asd file
File, Lisp, croatoan/addch.lisp: The croatoan/addch․lisp file
File, Lisp, croatoan/addstr.lisp: The croatoan/addstr․lisp file
File, Lisp, croatoan/add_wch.lisp: The croatoan/add_wch․lisp file
File, Lisp, croatoan/attr.lisp: The croatoan/attr․lisp file
File, Lisp, croatoan/beep.lisp: The croatoan/beep․lisp file
File, Lisp, croatoan/bkgd.lisp: The croatoan/bkgd․lisp file
File, Lisp, croatoan/bkgrnd.lisp: The croatoan/bkgrnd․lisp file
File, Lisp, croatoan/border.lisp: The croatoan/border․lisp file
File, Lisp, croatoan/border_set.lisp: The croatoan/border_set․lisp file
File, Lisp, croatoan/classes.lisp: The croatoan/classes․lisp file
File, Lisp, croatoan/clear.lisp: The croatoan/clear․lisp file
File, Lisp, croatoan/color.lisp: The croatoan/color․lisp file
File, Lisp, croatoan/croatoan.lisp: The croatoan/croatoan․lisp file
File, Lisp, croatoan/define_key.lisp: The croatoan/define_key․lisp file
File, Lisp, croatoan/delch.lisp: The croatoan/delch․lisp file
File, Lisp, croatoan/deleteln.lisp: The croatoan/deleteln․lisp file
File, Lisp, croatoan/form.lisp: The croatoan/form․lisp file
File, Lisp, croatoan/getch.lisp: The croatoan/getch․lisp file
File, Lisp, croatoan/getstr.lisp: The croatoan/getstr․lisp file
File, Lisp, croatoan/get_wch.lisp: The croatoan/get_wch․lisp file
File, Lisp, croatoan/gray_streams.lisp: The croatoan/gray_streams․lisp file
File, Lisp, croatoan/inch.lisp: The croatoan/inch․lisp file
File, Lisp, croatoan/inchstr.lisp: The croatoan/inchstr․lisp file
File, Lisp, croatoan/initscr.lisp: The croatoan/initscr․lisp file
File, Lisp, croatoan/inopts.lisp: The croatoan/inopts․lisp file
File, Lisp, croatoan/insch.lisp: The croatoan/insch․lisp file
File, Lisp, croatoan/insstr.lisp: The croatoan/insstr․lisp file
File, Lisp, croatoan/instr.lisp: The croatoan/instr․lisp file
File, Lisp, croatoan/ins_wch.lisp: The croatoan/ins_wch․lisp file
File, Lisp, croatoan/inwstr.lisp: The croatoan/inwstr․lisp file
File, Lisp, croatoan/in_wch.lisp: The croatoan/in_wch․lisp file
File, Lisp, croatoan/kernel.lisp: The croatoan/kernel․lisp file
File, Lisp, croatoan/menu.lisp: The croatoan/menu․lisp file
File, Lisp, croatoan/mouse.lisp: The croatoan/mouse․lisp file
File, Lisp, croatoan/move.lisp: The croatoan/move․lisp file
File, Lisp, croatoan/package.lisp: The croatoan/package․lisp file
File, Lisp, croatoan/panel.lisp: The croatoan/panel․lisp file
File, Lisp, croatoan/queue.lisp: The croatoan/queue․lisp file
File, Lisp, croatoan/refresh.lisp: The croatoan/refresh․lisp file
File, Lisp, croatoan/shape.lisp: The croatoan/shape․lisp file
File, Lisp, croatoan/touch.lisp: The croatoan/touch․lisp file
File, Lisp, croatoan/utf8.lisp: The croatoan/utf8․lisp file
File, Lisp, croatoan/util.lisp: The croatoan/util․lisp file
File, Lisp, croatoan/wresize.lisp: The croatoan/wresize․lisp file

L
Lisp File, croatoan.asd: The croatoan․asd file
Lisp File, croatoan/addch.lisp: The croatoan/addch․lisp file
Lisp File, croatoan/addstr.lisp: The croatoan/addstr․lisp file
Lisp File, croatoan/add_wch.lisp: The croatoan/add_wch․lisp file
Lisp File, croatoan/attr.lisp: The croatoan/attr․lisp file
Lisp File, croatoan/beep.lisp: The croatoan/beep․lisp file
Lisp File, croatoan/bkgd.lisp: The croatoan/bkgd․lisp file
Lisp File, croatoan/bkgrnd.lisp: The croatoan/bkgrnd․lisp file
Lisp File, croatoan/border.lisp: The croatoan/border․lisp file
Lisp File, croatoan/border_set.lisp: The croatoan/border_set․lisp file
Lisp File, croatoan/classes.lisp: The croatoan/classes․lisp file
Lisp File, croatoan/clear.lisp: The croatoan/clear․lisp file
Lisp File, croatoan/color.lisp: The croatoan/color․lisp file
Lisp File, croatoan/croatoan.lisp: The croatoan/croatoan․lisp file
Lisp File, croatoan/define_key.lisp: The croatoan/define_key․lisp file
Lisp File, croatoan/delch.lisp: The croatoan/delch․lisp file
Lisp File, croatoan/deleteln.lisp: The croatoan/deleteln․lisp file
Lisp File, croatoan/form.lisp: The croatoan/form․lisp file
Lisp File, croatoan/getch.lisp: The croatoan/getch․lisp file
Lisp File, croatoan/getstr.lisp: The croatoan/getstr․lisp file
Lisp File, croatoan/get_wch.lisp: The croatoan/get_wch․lisp file
Lisp File, croatoan/gray_streams.lisp: The croatoan/gray_streams․lisp file
Lisp File, croatoan/inch.lisp: The croatoan/inch․lisp file
Lisp File, croatoan/inchstr.lisp: The croatoan/inchstr․lisp file
Lisp File, croatoan/initscr.lisp: The croatoan/initscr․lisp file
Lisp File, croatoan/inopts.lisp: The croatoan/inopts․lisp file
Lisp File, croatoan/insch.lisp: The croatoan/insch․lisp file
Lisp File, croatoan/insstr.lisp: The croatoan/insstr․lisp file
Lisp File, croatoan/instr.lisp: The croatoan/instr․lisp file
Lisp File, croatoan/ins_wch.lisp: The croatoan/ins_wch․lisp file
Lisp File, croatoan/inwstr.lisp: The croatoan/inwstr․lisp file
Lisp File, croatoan/in_wch.lisp: The croatoan/in_wch․lisp file
Lisp File, croatoan/kernel.lisp: The croatoan/kernel․lisp file
Lisp File, croatoan/menu.lisp: The croatoan/menu․lisp file
Lisp File, croatoan/mouse.lisp: The croatoan/mouse․lisp file
Lisp File, croatoan/move.lisp: The croatoan/move․lisp file
Lisp File, croatoan/package.lisp: The croatoan/package․lisp file
Lisp File, croatoan/panel.lisp: The croatoan/panel․lisp file
Lisp File, croatoan/queue.lisp: The croatoan/queue․lisp file
Lisp File, croatoan/refresh.lisp: The croatoan/refresh․lisp file
Lisp File, croatoan/shape.lisp: The croatoan/shape․lisp file
Lisp File, croatoan/touch.lisp: The croatoan/touch․lisp file
Lisp File, croatoan/utf8.lisp: The croatoan/utf8․lisp file
Lisp File, croatoan/util.lisp: The croatoan/util․lisp file
Lisp File, croatoan/wresize.lisp: The croatoan/wresize․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   O   P   Q   R   S   T   U   V   W   X  
Index Entry  Section

(
(setf activep): Internal generic functions
(setf activep): Internal generic functions
(setf attributes): Exported generic functions
(setf attributes): Exported generic functions
(setf attributes): Exported generic functions
(setf background): Exported generic functions
(setf background): Exported generic functions
(setf bgcolor): Exported generic functions
(setf bgcolor): Exported generic functions
(setf bgcolor): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf buffer): Exported generic functions
(setf buffer): Exported generic functions
(setf callback): Exported generic functions
(setf callback): Exported generic functions
(setf checkedp): Exported generic functions
(setf checkedp): Exported generic functions
(setf checkedp): Exported generic functions
(setf color-pair): Exported generic functions
(setf color-pair): Exported generic functions
(setf color-pair): Exported generic functions
(setf complex-char-array): Exported generic functions
(setf complex-char-array): Exported generic functions
(setf coordinates): Exported generic functions
(setf coordinates): Exported generic functions
(setf current-element): Internal generic functions
(setf current-element): Internal generic functions
(setf current-element-number): Internal generic functions
(setf current-element-number): Internal generic functions
(setf current-item): Exported generic functions
(setf current-item): Exported generic functions
(setf current-item-number): Exported generic functions
(setf current-item-number): Exported generic functions
(setf current-item-position): Internal generic functions
(setf current-item-position): Internal generic functions
(setf cursor-position): Exported generic functions
(setf cursor-position): Exported generic functions
(setf cursor-position-x): Exported generic functions
(setf cursor-position-x): Exported generic functions
(setf cursor-position-y): Exported generic functions
(setf cursor-position-y): Exported generic functions
(setf cursor-visible-p): Exported generic functions
(setf cursor-visible-p): Exported generic functions
(setf cyclic-selection-p): Exported generic functions
(setf cyclic-selection-p): Exported generic functions
(setf default-color-pair): Exported functions
(setf display-pointer): Internal generic functions
(setf display-pointer): Internal generic functions
(setf element-position): Exported generic functions
(setf element-position): Exported generic functions
(setf elements): Exported generic functions
(setf elements): Exported generic functions
(setf fgcolor): Exported generic functions
(setf fgcolor): Exported generic functions
(setf fgcolor): Exported generic functions
(setf frame-rate): Exported generic functions
(setf frame-rate): Exported generic functions
(setf function-keys-enabled-p): Exported generic functions
(setf function-keys-enabled-p): Exported generic functions
(setf input-blocking): Exported generic functions
(setf input-blocking): Exported generic functions
(setf input-buffering-p): Exported generic functions
(setf input-buffering-p): Exported generic functions
(setf input-echoing-p): Exported generic functions
(setf input-echoing-p): Exported generic functions
(setf input-pointer): Internal generic functions
(setf input-pointer): Internal generic functions
(setf insert-mode-p): Exported generic functions
(setf insert-mode-p): Exported generic functions
(setf items): Exported generic functions
(setf items): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf keymap): Exported generic functions
(setf layout): Internal generic functions
(setf layout): Internal generic functions
(setf location): Exported generic functions
(setf location): Exported generic functions
(setf location-x): Exported generic functions
(setf location-x): Exported generic functions
(setf location-y): Exported generic functions
(setf location-y): Exported generic functions
(setf max-buffer-length): Exported generic functions
(setf max-buffer-length): Exported generic functions
(setf max-item-length): Exported generic functions
(setf max-item-length): Exported generic functions
(setf menu-type): Exported generic functions
(setf menu-type): Exported generic functions
(setf message-text): Exported generic functions
(setf message-text): Exported generic functions
(setf newline-translation-enabled-p): Exported generic functions
(setf newline-translation-enabled-p): Exported generic functions
(setf origin-x): Exported generic functions
(setf origin-x): Exported generic functions
(setf origin-y): Exported generic functions
(setf origin-y): Exported generic functions
(setf parent-form): Internal generic functions
(setf parent-form): Internal generic functions
(setf plot-char): Exported generic functions
(setf plot-char): Exported generic functions
(setf process-control-chars-p): Exported generic functions
(setf process-control-chars-p): Exported generic functions
(setf reference): Internal generic functions
(setf reference): Internal generic functions
(setf scrolled-layout): Internal generic functions
(setf scrolled-layout): Internal generic functions
(setf scrolled-region-start): Internal generic functions
(setf scrolled-region-start): Internal generic functions
(setf scrolling-enabled-p): Exported generic functions
(setf scrolling-enabled-p): Exported generic functions
(setf scrolling-region): Exported generic functions
(setf scrolling-region): Exported generic functions
(setf selectedp): Internal generic functions
(setf selectedp): Internal generic functions
(setf simple-char): Exported generic functions
(setf simple-char): Exported generic functions
(setf source-location): Exported generic functions
(setf source-location): Exported generic functions
(setf stackedp): Exported generic functions
(setf stackedp): Exported generic functions
(setf style): Exported generic functions
(setf style): Exported generic functions
(setf style): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf use-terminal-colors-p): Exported functions
(setf value): Exported generic functions
(setf value): Exported generic functions
(setf value): Exported generic functions
(setf visiblep): Exported generic functions
(setf visiblep): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions
(setf width): Exported generic functions
(setf window): Exported generic functions
(setf window): Exported generic functions
(setf window): Exported generic functions

A
accept: Exported functions
accept-selection: Exported functions
access-alist: Internal macros
acs: Exported functions
activep: Internal generic functions
activep: Internal generic functions
add: Exported functions
add-attributes: Exported functions
add-char: Exported functions
add-function-key: Exported functions
add-string: Exported functions
add-wide-char: Exported functions
add-wide-char-utf-8: Exported functions
alert: Exported functions
angle-line: Exported functions
ascii-byte-p: Internal functions
attributes: Exported generic functions
attributes: Exported generic functions
attributes: Exported generic functions
attrs2chtype: Internal functions

B
background: Exported generic functions
background: Exported generic functions
bgcolor: Exported generic functions
bgcolor: Exported generic functions
bgcolor: Exported generic functions
bind: Exported functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bindings: Exported generic functions
bitmask-to-keyword: Internal functions
box: Exported functions
buffer: Exported generic functions
buffer: Exported generic functions

C
call-button-function: Internal functions
callback: Exported generic functions
callback: Exported generic functions
cancel: Exported functions
center-position: Exported functions
change-attributes: Exported functions
char-to-string: Exported generic functions
char-to-string: Exported generic functions
char-to-string: Exported generic functions
char2chtype: Internal functions
checked-items: Internal functions
checkedp: Exported generic functions
checkedp: Exported generic functions
checkedp: Exported generic functions
chtype2attrs: Internal functions
chtype2colors: Internal functions
chtype2xchar: Internal functions
circle: Exported functions
clear: Exported generic functions
clear: Exported generic functions
clear: Exported generic functions
closed-p: Exported generic functions
closed-p: Exported generic functions
closest-gray: Internal functions
color-1k-to-8bit: Internal functions
color-8bit-to-1k: Internal functions
color-name-to-number: Internal functions
color-pair: Exported generic functions
color-pair: Exported generic functions
color-pair: Exported generic functions
color-to-number: Internal functions
colors2chtype: Internal functions
complete-default-pair: Internal functions
complete-pair: Internal functions
complex-char-array: Exported generic functions
complex-char-array: Exported generic functions
complex-char=: Exported functions
convert-char: Exported generic functions
convert-char: Exported generic functions
convert-char: Exported generic functions
convert-char: Exported generic functions
coordinates: Exported generic functions
coordinates: Exported generic functions
current-element: Internal generic functions
current-element: Internal generic functions
current-element-number: Internal generic functions
current-element-number: Internal generic functions
current-item: Exported generic functions
current-item: Exported generic functions
current-item-mark: Exported generic functions
current-item-mark: Exported generic functions
current-item-number: Exported generic functions
current-item-number: Exported generic functions
current-item-position: Internal generic functions
current-item-position: Internal generic functions
cursor-position: Exported generic functions
cursor-position: Exported generic functions
cursor-position-x: Exported generic functions
cursor-position-x: Exported generic functions
cursor-position-y: Exported generic functions
cursor-position-y: Exported generic functions
cursor-visible-p: Exported generic functions
cursor-visible-p: Exported generic functions
cyclic-selection-p: Exported generic functions
cyclic-selection-p: Exported generic functions

D
debug-print-field-buffer: Internal functions
default-color-pair: Exported functions
define-function-key: Exported functions
define-keymap: Exported functions
delete-char: Exported functions
delete-function-key: Exported generic functions
delete-function-key: Exported generic functions
delete-function-key: Exported generic functions
delete-line: Exported functions
delete-next-char: Internal functions
delete-previous-char: Internal functions
dequeue: Exported functions
display-pointer: Internal generic functions
display-pointer: Internal generic functions
distance-to-bottom: Internal functions
distance-to-eol: Internal functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw: Exported generic functions
draw-border: Exported functions
draw-border-p: Exported generic functions
draw-border-p: Exported generic functions
draw-menu: Exported functions
draw-menu-item: Internal functions
draw-shape: Exported functions
draw-wide-border: Exported functions

E
echo: Exported functions
echo-char: Exported functions
echo-wide-char: Exported functions
edit: Exported functions
element-position: Exported generic functions
element-position: Exported generic functions
elements: Exported generic functions
elements: Exported generic functions
empty-stack: Exported functions
enable-8bit-char-input: Internal functions
end-screen: Exported functions
enqueue: Exported functions
escape-sequence-delay: Internal functions
event-case: Exported macros
exit-event-loop: Exported functions
exit-menu-event-loop: Exported functions
extract-char: Exported functions
extract-complex-string: Exported functions
extract-string: Exported functions
extract-wide-char: Exported functions
extract-wide-string: Exported functions

F
fgcolor: Exported generic functions
fgcolor: Exported generic functions
fgcolor: Exported generic functions
field-add-char: Internal functions
fill-shape: Exported functions
find-element: Exported functions
find-keymap: Exported functions
flush-input: Exported functions
flush-on-interrupt: Internal functions
format-menu-item: Internal functions
frame-rate: Exported generic functions
frame-rate: Exported generic functions
funcall-get-cchar_t: Internal functions
funcall-make-cchar_t: Internal functions
funcall-make-cchar_t-ptr: Internal functions
funcall-make-chtype: Internal functions
Function, (setf default-color-pair): Exported functions
Function, (setf use-terminal-colors-p): Exported functions
Function, accept: Exported functions
Function, accept-selection: Exported functions
Function, acs: Exported functions
Function, add: Exported functions
Function, add-attributes: Exported functions
Function, add-char: Exported functions
Function, add-function-key: Exported functions
Function, add-string: Exported functions
Function, add-wide-char: Exported functions
Function, add-wide-char-utf-8: Exported functions
Function, alert: Exported functions
Function, angle-line: Exported functions
Function, ascii-byte-p: Internal functions
Function, attrs2chtype: Internal functions
Function, bind: Exported functions
Function, bitmask-to-keyword: Internal functions
Function, box: Exported functions
Function, call-button-function: Internal functions
Function, cancel: Exported functions
Function, center-position: Exported functions
Function, change-attributes: Exported functions
Function, char2chtype: Internal functions
Function, checked-items: Internal functions
Function, chtype2attrs: Internal functions
Function, chtype2colors: Internal functions
Function, chtype2xchar: Internal functions
Function, circle: Exported functions
Function, closest-gray: Internal functions
Function, color-1k-to-8bit: Internal functions
Function, color-8bit-to-1k: Internal functions
Function, color-name-to-number: Internal functions
Function, color-to-number: Internal functions
Function, colors2chtype: Internal functions
Function, complete-default-pair: Internal functions
Function, complete-pair: Internal functions
Function, complex-char=: Exported functions
Function, debug-print-field-buffer: Internal functions
Function, default-color-pair: Exported functions
Function, define-function-key: Exported functions
Function, define-keymap: Exported functions
Function, delete-char: Exported functions
Function, delete-line: Exported functions
Function, delete-next-char: Internal functions
Function, delete-previous-char: Internal functions
Function, dequeue: Exported functions
Function, distance-to-bottom: Internal functions
Function, distance-to-eol: Internal functions
Function, draw-border: Exported functions
Function, draw-menu: Exported functions
Function, draw-menu-item: Internal functions
Function, draw-shape: Exported functions
Function, draw-wide-border: Exported functions
Function, echo: Exported functions
Function, echo-char: Exported functions
Function, echo-wide-char: Exported functions
Function, edit: Exported functions
Function, empty-stack: Exported functions
Function, enable-8bit-char-input: Internal functions
Function, end-screen: Exported functions
Function, enqueue: Exported functions
Function, escape-sequence-delay: Internal functions
Function, exit-event-loop: Exported functions
Function, exit-menu-event-loop: Exported functions
Function, extract-char: Exported functions
Function, extract-complex-string: Exported functions
Function, extract-string: Exported functions
Function, extract-wide-char: Exported functions
Function, extract-wide-string: Exported functions
Function, field-add-char: Internal functions
Function, fill-shape: Exported functions
Function, find-element: Exported functions
Function, find-keymap: Exported functions
Function, flush-input: Exported functions
Function, flush-on-interrupt: Internal functions
Function, format-menu-item: Internal functions
Function, funcall-get-cchar_t: Internal functions
Function, funcall-make-cchar_t: Internal functions
Function, funcall-make-cchar_t-ptr: Internal functions
Function, funcall-make-chtype: Internal functions
Function, function-key-p: Exported functions
Function, gen-unused-key-code: Internal functions
Function, get-background-cchar_t: Internal functions
Function, get-background-char: Internal functions
Function, get-bitmask: Internal functions
Function, get-char: Exported functions
Function, get-event: Exported functions
Function, get-event-handler: Internal functions
Function, get-mouse-event: Exported functions
Function, get-string: Exported functions
Function, get-wide-char: Exported functions
Function, get-wide-event: Exported functions
Function, goto: Exported functions
Function, gray-to-rgb: Internal functions
Function, hex-to-rgb: Internal functions
Function, hex-to-sgr: Internal functions
Function, init-screen: Internal functions
Function, insert: Exported functions
Function, insert-char: Exported functions
Function, insert-line: Exported functions
Function, insert-nth: Exported functions
Function, insert-string: Exported functions
Function, insert-wide-char: Exported functions
Function, io-queue-flush: Internal functions
Function, key-code-to-name: Exported functions
Function, key-name-to-code: Exported functions
Function, key-pressed-p: Exported functions
Function, key-supported-p: Exported functions
Function, keyword-to-bitmask: Internal functions
Function, lead-byte-p: Internal functions
Function, line: Exported functions
Function, list2array: Internal functions
Function, lower: Exported functions
Function, lower-to-bottom: Exported functions
Function, make-chtype: Internal functions
Function, mark-for-redraw: Exported functions
Function, mark-for-refresh: Exported functions
Function, merge-shapes: Exported functions
Function, move: Exported functions
Function, move-direction: Exported functions
Function, move-end-of-line: Exported functions
Function, move-start-of-line: Exported functions
Function, move-window: Exported functions
Function, multi-byte-p: Internal functions
Function, n-trail-bytes: Internal functions
Function, new-line: Exported functions
Function, new-terminal: Internal functions
Function, number-to-pair: Internal functions
Function, pair-to-number: Internal functions
Function, plist2alist: Internal functions
Function, polygon: Exported functions
Function, process: Exported functions
Function, quadrilateral: Exported functions
Function, raise: Exported functions
Function, raise-to-top: Exported functions
Function, rectangle: Exported functions
Function, refresh: Exported functions
Function, refresh-marked: Exported functions
Function, refresh-stack: Exported functions
Function, remove-attributes: Exported functions
Function, remove-nth: Exported functions
Function, replace-nth: Exported functions
Function, reset-field: Exported functions
Function, reset-form: Exported functions
Function, reset-menu: Internal functions
Function, resize: Exported functions
Function, return-from-menu: Exported functions
Function, rgb-to-hex: Internal functions
Function, rgb-to-rgb6: Internal functions
Function, rgb6-to-rgb: Internal functions
Function, rgb6-to-sgr: Internal functions
Function, rmi2sub: Internal functions
Function, rotate: Internal functions
Function, run-event-loop: Exported functions
Function, select: Exported functions
Function, select-next-element: Internal functions
Function, select-previous-element: Internal functions
Function, set-attributes: Internal functions
Function, set-background-cchar_t: Internal functions
Function, set-background-char: Internal functions
Function, set-color-pair: Internal functions
Function, set-current-terminal: Internal functions
Function, set-cursor-visibility: Internal functions
Function, set-default-color-pair: Internal functions
Function, set-enable-fkeys: Internal functions
Function, set-equal: Internal functions
Function, set-input-blocking: Internal functions
Function, set-input-echoing: Internal functions
Function, set-input-mode: Internal functions
Function, set-mouse-event: Exported functions
Function, sgr-to-hex: Internal functions
Function, sgr-to-rgb6: Internal functions
Function, shape-extent: Exported functions
Function, sub2rmi: Internal functions
Function, test-utf-8: Internal functions
Function, toggle-checkbox: Internal functions
Function, toggle-item-checkbox: Exported functions
Function, touch: Exported functions
Function, trail-byte-p: Internal functions
Function, triangle: Exported functions
Function, type-ahead-fd: Internal functions
Function, unbind: Exported functions
Function, unget-char: Exported functions
Function, unicode-to-utf-8: Internal functions
Function, update-menu: Exported functions
Function, update-redraw-menu: Exported functions
Function, use-terminal-colors-p: Exported functions
Function, utf-8-to-unicode: Internal functions
Function, wacs: Exported functions
Function, wait-for-event: Exported functions
Function, xchar2chtype: Internal functions
function-key-p: Exported functions
function-keys-enabled-p: Exported generic functions
function-keys-enabled-p: Exported generic functions

G
gen-unused-key-code: Internal functions
Generic Function, (setf activep): Internal generic functions
Generic Function, (setf attributes): Exported generic functions
Generic Function, (setf background): Exported generic functions
Generic Function, (setf bgcolor): Exported generic functions
Generic Function, (setf bindings): Exported generic functions
Generic Function, (setf buffer): Exported generic functions
Generic Function, (setf callback): Exported generic functions
Generic Function, (setf checkedp): Exported generic functions
Generic Function, (setf color-pair): Exported generic functions
Generic Function, (setf complex-char-array): Exported generic functions
Generic Function, (setf coordinates): Exported generic functions
Generic Function, (setf current-element): Internal generic functions
Generic Function, (setf current-element-number): Internal generic functions
Generic Function, (setf current-item): Exported generic functions
Generic Function, (setf current-item-number): Exported generic functions
Generic Function, (setf current-item-position): Internal generic functions
Generic Function, (setf cursor-position): Exported generic functions
Generic Function, (setf cursor-position-x): Exported generic functions
Generic Function, (setf cursor-position-y): Exported generic functions
Generic Function, (setf cursor-visible-p): Exported generic functions
Generic Function, (setf cyclic-selection-p): Exported generic functions
Generic Function, (setf display-pointer): Internal generic functions
Generic Function, (setf element-position): Exported generic functions
Generic Function, (setf elements): Exported generic functions
Generic Function, (setf fgcolor): Exported generic functions
Generic Function, (setf frame-rate): Exported generic functions
Generic Function, (setf function-keys-enabled-p): Exported generic functions
Generic Function, (setf input-blocking): Exported generic functions
Generic Function, (setf input-buffering-p): Exported generic functions
Generic Function, (setf input-echoing-p): Exported generic functions
Generic Function, (setf input-pointer): Internal generic functions
Generic Function, (setf insert-mode-p): Exported generic functions
Generic Function, (setf items): Exported generic functions
Generic Function, (setf keymap): Exported generic functions
Generic Function, (setf layout): Internal generic functions
Generic Function, (setf location): Exported generic functions
Generic Function, (setf location-x): Exported generic functions
Generic Function, (setf location-y): Exported generic functions
Generic Function, (setf max-buffer-length): Exported generic functions
Generic Function, (setf max-item-length): Exported generic functions
Generic Function, (setf menu-type): Exported generic functions
Generic Function, (setf message-text): Exported generic functions
Generic Function, (setf newline-translation-enabled-p): Exported generic functions
Generic Function, (setf origin-x): Exported generic functions
Generic Function, (setf origin-y): Exported generic functions
Generic Function, (setf parent-form): Internal generic functions
Generic Function, (setf plot-char): Exported generic functions
Generic Function, (setf process-control-chars-p): Exported generic functions
Generic Function, (setf reference): Internal generic functions
Generic Function, (setf scrolled-layout): Internal generic functions
Generic Function, (setf scrolled-region-start): Internal generic functions
Generic Function, (setf scrolling-enabled-p): Exported generic functions
Generic Function, (setf scrolling-region): Exported generic functions
Generic Function, (setf selectedp): Internal generic functions
Generic Function, (setf simple-char): Exported generic functions
Generic Function, (setf source-location): Exported generic functions
Generic Function, (setf stackedp): Exported generic functions
Generic Function, (setf style): Exported generic functions
Generic Function, (setf title): Exported generic functions
Generic Function, (setf value): Exported generic functions
Generic Function, (setf visiblep): Exported generic functions
Generic Function, (setf width): Exported generic functions
Generic Function, (setf window): Exported generic functions
Generic Function, activep: Internal generic functions
Generic Function, attributes: Exported generic functions
Generic Function, background: Exported generic functions
Generic Function, bgcolor: Exported generic functions
Generic Function, bindings: Exported generic functions
Generic Function, buffer: Exported generic functions
Generic Function, callback: Exported generic functions
Generic Function, char-to-string: Exported generic functions
Generic Function, checkedp: Exported generic functions
Generic Function, clear: Exported generic functions
Generic Function, closed-p: Exported generic functions
Generic Function, color-pair: Exported generic functions
Generic Function, complex-char-array: Exported generic functions
Generic Function, convert-char: Exported generic functions
Generic Function, coordinates: Exported generic functions
Generic Function, current-element: Internal generic functions
Generic Function, current-element-number: Internal generic functions
Generic Function, current-item: Exported generic functions
Generic Function, current-item-mark: Exported generic functions
Generic Function, current-item-number: Exported generic functions
Generic Function, current-item-position: Internal generic functions
Generic Function, cursor-position: Exported generic functions
Generic Function, cursor-position-x: Exported generic functions
Generic Function, cursor-position-y: Exported generic functions
Generic Function, cursor-visible-p: Exported generic functions
Generic Function, cyclic-selection-p: Exported generic functions
Generic Function, delete-function-key: Exported generic functions
Generic Function, display-pointer: Internal generic functions
Generic Function, draw: Exported generic functions
Generic Function, draw-border-p: Exported generic functions
Generic Function, element-position: Exported generic functions
Generic Function, elements: Exported generic functions
Generic Function, fgcolor: Exported generic functions
Generic Function, frame-rate: Exported generic functions
Generic Function, function-keys-enabled-p: Exported generic functions
Generic Function, handle-event: Internal generic functions
Generic Function, height: Exported generic functions
Generic Function, input-blocking: Exported generic functions
Generic Function, input-buffering-p: Exported generic functions
Generic Function, input-echoing-p: Exported generic functions
Generic Function, input-pointer: Internal generic functions
Generic Function, insert-mode-p: Exported generic functions
Generic Function, items: Exported generic functions
Generic Function, key-to-string: Exported generic functions
Generic Function, keymap: Exported generic functions
Generic Function, layout: Internal generic functions
Generic Function, location: Exported generic functions
Generic Function, location-x: Exported generic functions
Generic Function, location-y: Exported generic functions
Generic Function, max-buffer-length: Exported generic functions
Generic Function, max-item-length: Exported generic functions
Generic Function, menu-type: Exported generic functions
Generic Function, message-height: Exported generic functions
Generic Function, message-pad: Exported generic functions
Generic Function, message-pad-coordinates: Exported generic functions
Generic Function, message-text: Exported generic functions
Generic Function, move-next-char: Exported generic functions
Generic Function, move-previous-char: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, newline-translation-enabled-p: Exported generic functions
Generic Function, origin-x: Exported generic functions
Generic Function, origin-y: Exported generic functions
Generic Function, parent-form: Internal generic functions
Generic Function, plot-char: Exported generic functions
Generic Function, process-control-chars-p: Exported generic functions
Generic Function, reference: Internal generic functions
Generic Function, scrolled-layout: Internal generic functions
Generic Function, scrolled-region-start: Internal generic functions
Generic Function, scrolling-enabled-p: Exported generic functions
Generic Function, scrolling-region: Exported generic functions
Generic Function, selectedp: Internal generic functions
Generic Function, simple-char: Exported generic functions
Generic Function, stackedp: Exported generic functions
Generic Function, style: Exported generic functions
Generic Function, sub-window: Exported generic functions
Generic Function, title: Exported generic functions
Generic Function, update-cursor-position: Internal generic functions
Generic Function, value: Exported generic functions
Generic Function, visiblep: Exported generic functions
Generic Function, width: Exported generic functions
Generic Function, window: Exported generic functions
Generic Function, winptr: Exported generic functions
get-background-cchar_t: Internal functions
get-background-char: Internal functions
get-bitmask: Internal functions
get-char: Exported functions
get-event: Exported functions
get-event-handler: Internal functions
get-mouse-event: Exported functions
get-string: Exported functions
get-wide-char: Exported functions
get-wide-event: Exported functions
goto: Exported functions
gray-to-rgb: Internal functions

H
handle-event: Internal generic functions
handle-event: Internal generic functions
handle-event: Internal generic functions
height: Exported generic functions
height: Exported generic functions
hex-to-rgb: Internal functions
hex-to-sgr: Internal functions

I
init-screen: Internal functions
input-blocking: Exported generic functions
input-blocking: Exported generic functions
input-buffering-p: Exported generic functions
input-buffering-p: Exported generic functions
input-echoing-p: Exported generic functions
input-echoing-p: Exported generic functions
input-pointer: Internal generic functions
input-pointer: Internal generic functions
insert: Exported functions
insert-char: Exported functions
insert-line: Exported functions
insert-mode-p: Exported generic functions
insert-mode-p: Exported generic functions
insert-nth: Exported functions
insert-string: Exported functions
insert-wide-char: Exported functions
io-queue-flush: Internal functions
items: Exported generic functions
items: Exported generic functions

K
key-code-to-name: Exported functions
key-name-to-code: Exported functions
key-pressed-p: Exported functions
key-supported-p: Exported functions
key-to-string: Exported generic functions
key-to-string: Exported generic functions
key-to-string: Exported generic functions
key-to-string: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keymap: Exported generic functions
keyword-to-bitmask: Internal functions

L
layout: Internal generic functions
layout: Internal generic functions
lead-byte-p: Internal functions
line: Exported functions
list2array: Internal functions
location: Exported generic functions
location: Exported generic functions
location: Exported generic functions
location-x: Exported generic functions
location-x: Exported generic functions
location-x: Exported generic functions
location-y: Exported generic functions
location-y: Exported generic functions
location-y: Exported generic functions
lower: Exported functions
lower-to-bottom: Exported functions

M
Macro, access-alist: Internal macros
Macro, event-case: Exported macros
Macro, mouse-bitmask: Internal macros
Macro, save-excursion: Exported macros
Macro, submit: Exported macros
Macro, with-screen: Exported macros
Macro, with-window: Exported macros
Macro, with-windows: Exported macros
make-chtype: Internal functions
mark-for-redraw: Exported functions
mark-for-refresh: Exported functions
max-buffer-length: Exported generic functions
max-buffer-length: Exported generic functions
max-item-length: Exported generic functions
max-item-length: Exported generic functions
menu-type: Exported generic functions
menu-type: Exported generic functions
merge-shapes: Exported functions
message-height: Exported generic functions
message-height: Exported generic functions
message-pad: Exported generic functions
message-pad: Exported generic functions
message-pad-coordinates: Exported generic functions
message-pad-coordinates: Exported generic functions
message-text: Exported generic functions
message-text: Exported generic functions
Method, (setf activep): Internal generic functions
Method, (setf attributes): Exported generic functions
Method, (setf attributes): Exported generic functions
Method, (setf background): Exported generic functions
Method, (setf bgcolor): Exported generic functions
Method, (setf bgcolor): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf buffer): Exported generic functions
Method, (setf callback): Exported generic functions
Method, (setf checkedp): Exported generic functions
Method, (setf checkedp): Exported generic functions
Method, (setf color-pair): Exported generic functions
Method, (setf color-pair): Exported generic functions
Method, (setf complex-char-array): Exported generic functions
Method, (setf coordinates): Exported generic functions
Method, (setf current-element): Internal generic functions
Method, (setf current-element-number): Internal generic functions
Method, (setf current-item): Exported generic functions
Method, (setf current-item-number): Exported generic functions
Method, (setf current-item-position): Internal generic functions
Method, (setf cursor-position): Exported generic functions
Method, (setf cursor-position-x): Exported generic functions
Method, (setf cursor-position-y): Exported generic functions
Method, (setf cursor-visible-p): Exported generic functions
Method, (setf cyclic-selection-p): Exported generic functions
Method, (setf display-pointer): Internal generic functions
Method, (setf element-position): Exported generic functions
Method, (setf elements): Exported generic functions
Method, (setf fgcolor): Exported generic functions
Method, (setf fgcolor): Exported generic functions
Method, (setf frame-rate): Exported generic functions
Method, (setf function-keys-enabled-p): Exported generic functions
Method, (setf input-blocking): Exported generic functions
Method, (setf input-buffering-p): Exported generic functions
Method, (setf input-echoing-p): Exported generic functions
Method, (setf input-pointer): Internal generic functions
Method, (setf insert-mode-p): Exported generic functions
Method, (setf items): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf keymap): Exported generic functions
Method, (setf layout): Internal generic functions
Method, (setf location): Exported generic functions
Method, (setf location-x): Exported generic functions
Method, (setf location-y): Exported generic functions
Method, (setf max-buffer-length): Exported generic functions
Method, (setf max-item-length): Exported generic functions
Method, (setf menu-type): Exported generic functions
Method, (setf message-text): Exported generic functions
Method, (setf newline-translation-enabled-p): Exported generic functions
Method, (setf origin-x): Exported generic functions
Method, (setf origin-y): Exported generic functions
Method, (setf parent-form): Internal generic functions
Method, (setf plot-char): Exported generic functions
Method, (setf process-control-chars-p): Exported generic functions
Method, (setf reference): Internal generic functions
Method, (setf scrolled-layout): Internal generic functions
Method, (setf scrolled-region-start): Internal generic functions
Method, (setf scrolling-enabled-p): Exported generic functions
Method, (setf scrolling-region): Exported generic functions
Method, (setf selectedp): Internal generic functions
Method, (setf simple-char): Exported generic functions
Method, (setf source-location): Exported generic functions
Method, (setf stackedp): Exported generic functions
Method, (setf style): Exported generic functions
Method, (setf style): Exported generic functions
Method, (setf title): Exported generic functions
Method, (setf title): Exported generic functions
Method, (setf value): Exported generic functions
Method, (setf value): Exported generic functions
Method, (setf visiblep): Exported generic functions
Method, (setf width): Exported generic functions
Method, (setf width): Exported generic functions
Method, (setf window): Exported generic functions
Method, (setf window): Exported generic functions
Method, activep: Internal generic functions
Method, attributes: Exported generic functions
Method, attributes: Exported generic functions
Method, background: Exported generic functions
Method, bgcolor: Exported generic functions
Method, bgcolor: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, bindings: Exported generic functions
Method, buffer: Exported generic functions
Method, callback: Exported generic functions
Method, char-to-string: Exported generic functions
Method, char-to-string: Exported generic functions
Method, checkedp: Exported generic functions
Method, checkedp: Exported generic functions
Method, clear: Exported generic functions
Method, clear: Exported generic functions
Method, closed-p: Exported generic functions
Method, color-pair: Exported generic functions
Method, color-pair: Exported generic functions
Method, complex-char-array: Exported generic functions
Method, convert-char: Exported generic functions
Method, convert-char: Exported generic functions
Method, convert-char: Exported generic functions
Method, coordinates: Exported generic functions
Method, current-element: Internal generic functions
Method, current-element-number: Internal generic functions
Method, current-item: Exported generic functions
Method, current-item-mark: Exported generic functions
Method, current-item-number: Exported generic functions
Method, current-item-position: Internal generic functions
Method, cursor-position: Exported generic functions
Method, cursor-position-x: Exported generic functions
Method, cursor-position-y: Exported generic functions
Method, cursor-visible-p: Exported generic functions
Method, cyclic-selection-p: Exported generic functions
Method, delete-function-key: Exported generic functions
Method, delete-function-key: Exported generic functions
Method, display-pointer: Internal generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw: Exported generic functions
Method, draw-border-p: Exported generic functions
Method, element-position: Exported generic functions
Method, elements: Exported generic functions
Method, fgcolor: Exported generic functions
Method, fgcolor: Exported generic functions
Method, frame-rate: Exported generic functions
Method, function-keys-enabled-p: Exported generic functions
Method, handle-event: Internal generic functions
Method, handle-event: Internal generic functions
Method, height: Exported generic functions
Method, input-blocking: Exported generic functions
Method, input-buffering-p: Exported generic functions
Method, input-echoing-p: Exported generic functions
Method, input-pointer: Internal generic functions
Method, insert-mode-p: Exported generic functions
Method, items: Exported generic functions
Method, key-to-string: Exported generic functions
Method, key-to-string: Exported generic functions
Method, key-to-string: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, keymap: Exported generic functions
Method, layout: Internal generic functions
Method, location: Exported generic functions
Method, location: Exported generic functions
Method, location-x: Exported generic functions
Method, location-x: Exported generic functions
Method, location-y: Exported generic functions
Method, location-y: Exported generic functions
Method, max-buffer-length: Exported generic functions
Method, max-item-length: Exported generic functions
Method, menu-type: Exported generic functions
Method, message-height: Exported generic functions
Method, message-pad: Exported generic functions
Method, message-pad-coordinates: Exported generic functions
Method, message-text: Exported generic functions
Method, move-next-char: Exported generic functions
Method, move-next-char: Exported generic functions
Method, move-previous-char: Exported generic functions
Method, move-previous-char: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, newline-translation-enabled-p: Exported generic functions
Method, origin-x: Exported generic functions
Method, origin-y: Exported generic functions
Method, parent-form: Internal generic functions
Method, plot-char: Exported generic functions
Method, process-control-chars-p: Exported generic functions
Method, reference: Internal generic functions
Method, scrolled-layout: Internal generic functions
Method, scrolled-region-start: Internal generic functions
Method, scrolling-enabled-p: Exported generic functions
Method, scrolling-region: Exported generic functions
Method, selectedp: Internal generic functions
Method, simple-char: Exported generic functions
Method, stackedp: Exported generic functions
Method, style: Exported generic functions
Method, style: Exported generic functions
Method, sub-window: Exported generic functions
Method, title: Exported generic functions
Method, title: Exported generic functions
Method, update-cursor-position: Internal generic functions
Method, update-cursor-position: Internal generic functions
Method, update-cursor-position: Internal generic functions
Method, update-cursor-position: Internal generic functions
Method, update-cursor-position: Internal generic functions
Method, update-cursor-position: Internal generic functions
Method, value: Exported generic functions
Method, value: Exported generic functions
Method, value: Exported generic functions
Method, value: Exported generic functions
Method, value: Exported generic functions
Method, visiblep: Exported generic functions
Method, width: Exported generic functions
Method, width: Exported generic functions
Method, width: Exported generic functions
Method, window: Exported generic functions
Method, window: Exported generic functions
Method, winptr: Exported generic functions
mouse-bitmask: Internal macros
move: Exported functions
move-direction: Exported functions
move-end-of-line: Exported functions
move-next-char: Exported generic functions
move-next-char: Exported generic functions
move-next-char: Exported generic functions
move-previous-char: Exported generic functions
move-previous-char: Exported generic functions
move-previous-char: Exported generic functions
move-start-of-line: Exported functions
move-window: Exported functions
multi-byte-p: Internal functions

N
n-trail-bytes: Internal functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
new-line: Exported functions
new-terminal: Internal functions
newline-translation-enabled-p: Exported generic functions
newline-translation-enabled-p: Exported generic functions
number-to-pair: Internal functions

O
origin-x: Exported generic functions
origin-x: Exported generic functions
origin-y: Exported generic functions
origin-y: Exported generic functions

P
pair-to-number: Internal functions
parent-form: Internal generic functions
parent-form: Internal generic functions
plist2alist: Internal functions
plot-char: Exported generic functions
plot-char: Exported generic functions
polygon: Exported functions
process: Exported functions
process-control-chars-p: Exported generic functions
process-control-chars-p: Exported generic functions

Q
quadrilateral: Exported functions

R
raise: Exported functions
raise-to-top: Exported functions
rectangle: Exported functions
reference: Internal generic functions
reference: Internal generic functions
refresh: Exported functions
refresh-marked: Exported functions
refresh-stack: Exported functions
remove-attributes: Exported functions
remove-nth: Exported functions
replace-nth: Exported functions
reset-field: Exported functions
reset-form: Exported functions
reset-menu: Internal functions
resize: Exported functions
return-from-menu: Exported functions
rgb-to-hex: Internal functions
rgb-to-rgb6: Internal functions
rgb6-to-rgb: Internal functions
rgb6-to-sgr: Internal functions
rmi2sub: Internal functions
rotate: Internal functions
run-event-loop: Exported functions

S
save-excursion: Exported macros
scrolled-layout: Internal generic functions
scrolled-layout: Internal generic functions
scrolled-region-start: Internal generic functions
scrolled-region-start: Internal generic functions
scrolling-enabled-p: Exported generic functions
scrolling-enabled-p: Exported generic functions
scrolling-region: Exported generic functions
scrolling-region: Exported generic functions
select: Exported functions
select-next-element: Internal functions
select-previous-element: Internal functions
selectedp: Internal generic functions
selectedp: Internal generic functions
set-attributes: Internal functions
set-background-cchar_t: Internal functions
set-background-char: Internal functions
set-color-pair: Internal functions
set-current-terminal: Internal functions
set-cursor-visibility: Internal functions
set-default-color-pair: Internal functions
set-enable-fkeys: Internal functions
set-equal: Internal functions
set-input-blocking: Internal functions
set-input-echoing: Internal functions
set-input-mode: Internal functions
set-mouse-event: Exported functions
sgr-to-hex: Internal functions
sgr-to-rgb6: Internal functions
shape-extent: Exported functions
simple-char: Exported generic functions
simple-char: Exported generic functions
stackedp: Exported generic functions
stackedp: Exported generic functions
style: Exported generic functions
style: Exported generic functions
style: Exported generic functions
sub-window: Exported generic functions
sub-window: Exported generic functions
sub2rmi: Internal functions
submit: Exported macros

T
test-utf-8: Internal functions
title: Exported generic functions
title: Exported generic functions
title: Exported generic functions
toggle-checkbox: Internal functions
toggle-item-checkbox: Exported functions
touch: Exported functions
trail-byte-p: Internal functions
triangle: Exported functions
type-ahead-fd: Internal functions

U
unbind: Exported functions
unget-char: Exported functions
unicode-to-utf-8: Internal functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-cursor-position: Internal generic functions
update-menu: Exported functions
update-redraw-menu: Exported functions
use-terminal-colors-p: Exported functions
utf-8-to-unicode: Internal functions

V
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
value: Exported generic functions
visiblep: Exported generic functions
visiblep: Exported generic functions

W
wacs: Exported functions
wait-for-event: Exported functions
width: Exported generic functions
width: Exported generic functions
width: Exported generic functions
width: Exported generic functions
window: Exported generic functions
window: Exported generic functions
window: Exported generic functions
winptr: Exported generic functions
winptr: Exported generic functions
with-screen: Exported macros
with-window: Exported macros
with-windows: Exported macros

X
xchar2chtype: Internal functions

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

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

A.3 Variables

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

*
*ansi-color-list*: Exported special variables
*bitmask-alist*: Internal special variables
*color-pair-alist*: Internal special variables
*default-color-pair*: Internal special variables
*job-queue*: Internal special variables
*key-alist*: Internal special variables
*keymaps*: Internal special variables
*mouse-button-event-bitmask-alist*: Internal special variables
*mouse-event-bitmask-alist*: Internal special variables
*valid-attributes*: Internal special variables
*window-stack*: Internal special variables
*xterm-color-hex-list*: Internal special variables
*xterm-color-name-list*: Internal special variables

A
acs-alist: Internal special variables
acs-map-array: Internal special variables
activep: Exported classes
activep: Internal classes
attributes: Exported classes
attributes: Exported classes

B
background: Exported classes
bgcolor: Exported classes
bgcolor: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Exported classes
bindings: Internal classes
buffer: Exported classes

C
callback: Exported classes
checkedp: Exported classes
checkedp: Exported classes
closed-p: Exported classes
colors-enabled-p: Exported classes
complex-char-array: Exported classes
coordinates: Exported classes
current-element: Exported classes
current-element-number: Exported classes
current-item: Exported classes
current-item-mark: Exported classes
current-item-number: Exported classes
current-item-position: Exported classes
cursor-position: