Sixty Second API Summary

T-60: The Terminal class represents a console window or remote terminal.  This is a base (abstract) class that provides a variety of rich functions (e.g. for executing menus, reading formatted text, etc).  However, the Terminal class does not know how any given terminal operates (e.g. it does not know how to set the color because there are thousands of different terminal types).  Specific implementations are classes that inherit from the Terminal class.

T-50: Two concrete implementations are provided by the library.  The SystemTerminal class represents the local Win32 console on Windows.  It behaves like the .NET Console except (of course) you have access to a richer API.  The SerialTerminal class represents a remote terminal that can be controlled via embedded escape codes.  An example is a VT100 terminal or a person connecting to a system via Telnet.

T-40: A protocol is a class that implements a specific type of protocol for a serial terminal.  Protocols are provided for ANSI-BBS (an X3.64 subset) and AVATAR terminals.  Future releases will add support for other terminal types (e.g. DEC VT monitors) as well as the generic Unix term-info system.

T-30: A translator is a module that expands embedded control codes in any text intended for display.  For example, you can embed variables in a text file.  The terminal library will expand those variables before the text is shown to the user.  Many different translators are provided; for example, the AnsiTranslator expands the subset of X3.64 escape sequences commonly found on BBS and DOS systems.  You can enable as many different translators (at the same time) as you want.  A variety of collections and overloads are provided for manipulating the set of active translators.

T-20: A TextStyle describes all of the colors and other attributes of some text to display.  Most of the attributes described in the ECMA-48 and X3.64 standards are supported (e.g. foreground color, background color, underlining, etc).  Note that not all terminal devices support every attribute.  The DOS window, for example, does not support underlining or overstrikes but does have quirky support for blinking.

T-10:  The Terminal.ReadChar function is the core input function.  The overloaded Terminal.Write function is core output function.  Everything else, including the rich prompting system, is based on these functions.  All of the functions with the prefix Prompt (e.g. PromptText, PromptPassword, etc) are rich functions; all of the functions with the prefix Translate (e.g. TranslateFile) are translation functions that write text while expanding any embedded codes.

T-00: Look through the provided samples in the Samples folder.  Have fun and help fix bugs and add new features.

Return to the main page.