dcell v0.0.2 (2022-10-19T01:33:35Z)

Termcap

dcell termcap

Represents the actual capabilities - this is an entry in a terminfo database.

struct Termcap {
string name;
immutable(string)[] aliases;
int columns;
int lines;
int colors;
string bell;
string clear;
string enterCA;
string exitCA;
string showCursor;
string hideCursor;
string attrOff;
string underline;
string bold;
string blink;
string reverse;
string dim;
string italic;
string enterKeypad;
string exitKeypad;
string setFg;
string setBg;
string resetColors;
string setCursor;
string cursorBack1;
string cursorUp1;
string padChar;
string insertChar;
string keyBackspace;
string keyF1;
string keyF2;
string keyF3;
string keyF4;
string keyF5;
string keyF6;
string keyF7;
string keyF8;
string keyF9;
string keyF10;
string keyF11;
string keyF12;
string keyF13;
string keyF14;
string keyF15;
string keyF16;
string keyF17;
string keyF18;
string keyF19;
string keyF20;
string keyF21;
string keyF22;
string keyF23;
string keyF24;
string keyF25;
string keyF26;
string keyF27;
string keyF28;
string keyF29;
string keyF30;
string keyF31;
string keyF32;
string keyF33;
string keyF34;
string keyF35;
string keyF36;
string keyF37;
string keyF38;
string keyF39;
string keyF40;
string keyF41;
string keyF42;
string keyF43;
string keyF44;
string keyF45;
string keyF46;
string keyF47;
string keyF48;
string keyF49;
string keyF50;
string keyF51;
string keyF52;
string keyF53;
string keyF54;
string keyF55;
string keyF56;
string keyF57;
string keyF58;
string keyF59;
string keyF60;
string keyF61;
string keyF62;
string keyF63;
string keyF64;
string keyInsert;
string keyDelete;
string keyHome;
string keyEnd;
string keyHelp;
string keyPgUp;
string keyPgDn;
string keyUp;
string keyDown;
string keyLeft;
string keyRight;
string keyBacktab;
string keyExit;
string keyClear;
string keyPrint;
string keyCancel;
string mouse;
string altChars;
string enterACS;
string exitACS;
string enableACS;
string keyShfRight;
string keyShfLeft;
string keyShfHome;
string keyShfEnd;
string keyShfInsert;
string keyShfDelete;
bool automargin;
string strikethrough;
string setFgBg;
string setFgBgRGB;
string setFgRGB;
string setBgRGB;
string keyShfUp;
string keyShfDown;
string keyShfPgUp;
string keyShfPgDn;
string keyCtrlUp;
string keyCtrlDown;
string keyCtrlRight;
string keyCtrlLeft;
string keyMetaUp;
string keyMetaDown;
string keyMetaRight;
string keyMetaLeft;
string keyAltUp;
string keyAltDown;
string keyAltRight;
string keyAltLeft;
string keyCtrlHome;
string keyCtrlEnd;
string keyMetaHome;
string keyMetaEnd;
string keyAltHome;
string keyAltEnd;
string keyAltShfUp;
string keyAltShfDown;
string keyAltShfLeft;
string keyAltShfRight;
string keyMetaShfUp;
string keyMetaShfDown;
string keyMetaShfLeft;
string keyMetaShfRight;
string keyCtrlShfUp;
string keyCtrlShfDown;
string keyCtrlShfLeft;
string keyCtrlShfRight;
string keyCtrlShfHome;
string keyCtrlShfEnd;
string keyAltShfHome;
string keyAltShfEnd;
string keyMetaShfHome;
string keyMetaShfEnd;
string enablePaste;
string disablePaste;
string pasteStart;
string pasteEnd;
string cursorReset;
string cursorBlock;
string cursorUnderline;
string cursorBar;
string cursorBlinkingBlock;
string cursorBlinkingUnderline;
string cursorBlinkingBar;
string enterURL;
string exitURL;
string setWindowSize;
void opAssign(const(Termcap)* other);
static void puts(R output, string s, void delegate() flush);
static string param(string s, int[] args);
static string param(string s, string[] args);
static string param(string s);
}

Members

Functions

opAssign
void opAssign(const(Termcap)* other)

Permits a constant value to be assigned to a mutable value.

Static functions

param
string param(string s)
Undocumented in source. Be warned that the author may not have intended to support it.
param
string param(string s, string[] args)
Undocumented in source. Be warned that the author may not have intended to support it.
param
string param(string s, int[] args)

Evaluates a terminal capability string and expands it, using the supplied integer parameters.

puts
void puts(R output, string s, void delegate() flush)

Put a string to an out range, which is normally a file to an interactive terminal like /dev/tty or stdin, while interpretreting embedded delay sequences of the form $<DELAY> (where DELAY is given in milliseconds, and must be a postive rational number of millseconds). When these are encountered, the flush delegate is called (if not null), and the function sleeps for the indicated amount of time.

Variables

aliases
immutable(string)[] aliases;

alternate names for terminal

altChars
string altChars;

acsc, alternate characters, used for non-ASCII characters with certain legacy terminals

attrOff
string attrOff;

sgr0, turn off all text attributes and colors

automargin
bool automargin;

am, if true cursor wraps and advances to next row after last column

bell
string bell;

bell, the sequence to ring a bell

blink
string blink;

blink, starts blinking text

bold
string bold;

bold, starts bold (maybe intense or double-strike)

clear
string clear;

clear, the sequence to clear the screen

colors
int colors;
Undocumented in source.
columns
int columns;

cols, the number of columns present

cursorBack1
string cursorBack1;

cub1, move cursor backwards one

cursorBar
string cursorBar;

sequence to change the cursor to a steady vertical bar

cursorBlinkingBar
string cursorBlinkingBar;

sequence to change the cursor to a blinking vertical bar

cursorBlinkingBlock
string cursorBlinkingBlock;

sequence to change the cursor to a blinking block

cursorBlinkingUnderline
string cursorBlinkingUnderline;

sequence to change the cursor to a blinking underscore

cursorBlock
string cursorBlock;

sequence to change the cursor to a solid block

cursorReset
string cursorReset;

sequence to reset the cursor shape to default

cursorUnderline
string cursorUnderline;

sequence to change the cursor to a steady underscore

cursorUp1
string cursorUp1;

cuu1, mover cursor up one line

dim
string dim;

dim, reduces the intensity of text

disablePaste
string disablePaste;

sequence to disable delimited paste mode

enableACS
string enableACS;

enacs, sequence to enable alternate character set support

enablePaste
string enablePaste;

sequence to enable delimited paste mode

enterACS
string enterACS;

smacs, sequence to switch to alternate character set

enterCA
string enterCA;

smcup, sequence to enter cursor addressing mode

enterKeypad
string enterKeypad;

smkx, enables keypad mode

enterURL
string enterURL;

sequence to start making text a clickable link

exitACS
string exitACS;

rmacs, sequence to return to normal character set

exitCA
string exitCA;

rmcup, sequence to exit cursor addressing mode

exitKeypad
string exitKeypad;

rmkx, leaves keypad mode

exitURL
string exitURL;

sequence to stop making text clickable link

hideCursor
string hideCursor;

civis, mark the cursor invisible

insertChar
string insertChar;

ich1, insert a character, used for inserting at bottom right for automargin terminals

italic
string italic;

sitm, starts italics mode (not widely supported)

keyAltDown
string keyAltDown;
Undocumented in source.
keyAltEnd
string keyAltEnd;
Undocumented in source.
keyAltHome
string keyAltHome;
Undocumented in source.
keyAltLeft
string keyAltLeft;
Undocumented in source.
keyAltRight
string keyAltRight;
Undocumented in source.
keyAltShfDown
string keyAltShfDown;
Undocumented in source.
keyAltShfEnd
string keyAltShfEnd;
Undocumented in source.
keyAltShfHome
string keyAltShfHome;
Undocumented in source.
keyAltShfLeft
string keyAltShfLeft;
Undocumented in source.
keyAltShfRight
string keyAltShfRight;
Undocumented in source.
keyAltShfUp
string keyAltShfUp;
Undocumented in source.
keyAltUp
string keyAltUp;
Undocumented in source.
keyBackspace
string keyBackspace;

kbs, backspace key

keyBacktab
string keyBacktab;
Undocumented in source.
keyCancel
string keyCancel;
Undocumented in source.
keyClear
string keyClear;
Undocumented in source.
keyCtrlDown
string keyCtrlDown;
Undocumented in source.
keyCtrlEnd
string keyCtrlEnd;
Undocumented in source.
keyCtrlHome
string keyCtrlHome;
Undocumented in source.
keyCtrlLeft
string keyCtrlLeft;
Undocumented in source.
keyCtrlRight
string keyCtrlRight;
Undocumented in source.
keyCtrlShfDown
string keyCtrlShfDown;
Undocumented in source.
keyCtrlShfEnd
string keyCtrlShfEnd;
Undocumented in source.
keyCtrlShfHome
string keyCtrlShfHome;
Undocumented in source.
keyCtrlShfLeft
string keyCtrlShfLeft;
Undocumented in source.
keyCtrlShfRight
string keyCtrlShfRight;
Undocumented in source.
keyCtrlShfUp
string keyCtrlShfUp;
Undocumented in source.
keyCtrlUp
string keyCtrlUp;
Undocumented in source.
keyDelete
string keyDelete;
Undocumented in source.
keyDown
string keyDown;
Undocumented in source.
keyEnd
string keyEnd;
Undocumented in source.
keyExit
string keyExit;
Undocumented in source.
keyF1
string keyF1;
Undocumented in source.
keyF10
string keyF10;
Undocumented in source.
keyF11
string keyF11;
Undocumented in source.
keyF12
string keyF12;
Undocumented in source.
keyF13
string keyF13;
Undocumented in source.
keyF14
string keyF14;
Undocumented in source.
keyF15
string keyF15;
Undocumented in source.
keyF16
string keyF16;
Undocumented in source.
keyF17
string keyF17;
Undocumented in source.
keyF18
string keyF18;
Undocumented in source.
keyF19
string keyF19;
Undocumented in source.
keyF2
string keyF2;
Undocumented in source.
keyF20
string keyF20;
Undocumented in source.
keyF21
string keyF21;
Undocumented in source.
keyF22
string keyF22;
Undocumented in source.
keyF23
string keyF23;
Undocumented in source.
keyF24
string keyF24;
Undocumented in source.
keyF25
string keyF25;
Undocumented in source.
keyF26
string keyF26;
Undocumented in source.
keyF27
string keyF27;
Undocumented in source.
keyF28
string keyF28;
Undocumented in source.
keyF29
string keyF29;
Undocumented in source.
keyF3
string keyF3;
Undocumented in source.
keyF30
string keyF30;
Undocumented in source.
keyF31
string keyF31;
Undocumented in source.
keyF32
string keyF32;
Undocumented in source.
keyF33
string keyF33;
Undocumented in source.
keyF34
string keyF34;
Undocumented in source.
keyF35
string keyF35;
Undocumented in source.
keyF36
string keyF36;
Undocumented in source.
keyF37
string keyF37;
Undocumented in source.
keyF38
string keyF38;
Undocumented in source.
keyF39
string keyF39;
Undocumented in source.
keyF4
string keyF4;
Undocumented in source.
keyF40
string keyF40;
Undocumented in source.
keyF41
string keyF41;
Undocumented in source.
keyF42
string keyF42;
Undocumented in source.
keyF43
string keyF43;
Undocumented in source.
keyF44
string keyF44;
Undocumented in source.
keyF45
string keyF45;
Undocumented in source.
keyF46
string keyF46;
Undocumented in source.
keyF47
string keyF47;
Undocumented in source.
keyF48
string keyF48;
Undocumented in source.
keyF49
string keyF49;
Undocumented in source.
keyF5
string keyF5;
Undocumented in source.
keyF50
string keyF50;
Undocumented in source.
keyF51
string keyF51;
Undocumented in source.
keyF52
string keyF52;
Undocumented in source.
keyF53
string keyF53;
Undocumented in source.
keyF54
string keyF54;
Undocumented in source.
keyF55
string keyF55;
Undocumented in source.
keyF56
string keyF56;
Undocumented in source.
keyF57
string keyF57;
Undocumented in source.
keyF58
string keyF58;
Undocumented in source.
keyF59
string keyF59;
Undocumented in source.
keyF6
string keyF6;
Undocumented in source.
keyF60
string keyF60;
Undocumented in source.
keyF61
string keyF61;
Undocumented in source.
keyF62
string keyF62;
Undocumented in source.
keyF63
string keyF63;
Undocumented in source.
keyF64
string keyF64;
Undocumented in source.
keyF7
string keyF7;
Undocumented in source.
keyF8
string keyF8;
Undocumented in source.
keyF9
string keyF9;
Undocumented in source.
keyHelp
string keyHelp;
Undocumented in source.
keyHome
string keyHome;
Undocumented in source.
keyInsert
string keyInsert;
Undocumented in source.
keyLeft
string keyLeft;
Undocumented in source.
keyMetaDown
string keyMetaDown;
Undocumented in source.
keyMetaEnd
string keyMetaEnd;
Undocumented in source.
keyMetaHome
string keyMetaHome;
Undocumented in source.
keyMetaLeft
string keyMetaLeft;
Undocumented in source.
keyMetaRight
string keyMetaRight;
Undocumented in source.
keyMetaShfDown
string keyMetaShfDown;
Undocumented in source.
keyMetaShfEnd
string keyMetaShfEnd;
Undocumented in source.
keyMetaShfHome
string keyMetaShfHome;
Undocumented in source.
keyMetaShfLeft
string keyMetaShfLeft;
Undocumented in source.
keyMetaShfRight
string keyMetaShfRight;
Undocumented in source.
keyMetaShfUp
string keyMetaShfUp;
Undocumented in source.
keyMetaUp
string keyMetaUp;
Undocumented in source.
keyPgDn
string keyPgDn;
Undocumented in source.
keyPgUp
string keyPgUp;
Undocumented in source.
keyPrint
string keyPrint;
Undocumented in source.
keyRight
string keyRight;
Undocumented in source.
keyShfDelete
string keyShfDelete;
Undocumented in source.
keyShfDown
string keyShfDown;
Undocumented in source.
keyShfEnd
string keyShfEnd;
Undocumented in source.
keyShfHome
string keyShfHome;
Undocumented in source.
keyShfInsert
string keyShfInsert;
Undocumented in source.
keyShfLeft
string keyShfLeft;
Undocumented in source.
keyShfPgDn
string keyShfPgDn;
Undocumented in source.
keyShfPgUp
string keyShfPgUp;
Undocumented in source.
keyShfRight
string keyShfRight;
Undocumented in source.
keyShfUp
string keyShfUp;
Undocumented in source.
keyUp
string keyUp;
Undocumented in source.
lines
int lines;

lines, the number lines (rows) present

mouse
string mouse;

kmouse, indicates support for mouse mode - XTerm style sequences are assumed

name
string name;

primary name for terminal, e.g. "xterm"

padChar
string padChar;

pad, padding character, if non-empty enables padding delays

pasteEnd
string pasteEnd;

sequence sent by terminal to indicated end of a paste buffer

pasteStart
string pasteStart;

sequence sent by terminal to indicate start of a paste buffer

resetColors
string resetColors;

op, sets foreground and background to default

reverse
string reverse;

rev, inverts the foreground and background colors

setBg
string setBg;

setab, sets background text color (indexed)

setBgRGB
string setBgRGB;

sequence to set background color RGB value

setCursor
string setCursor;

cup, sets cursor location to row and column

setFg
string setFg;

setaf, sets foreground text color (indexed)

setFgBg
string setFgBg;

sequence to set both foreground and background together, using indexed colors

setFgBgRGB
string setFgBgRGB;

sequence to set both foreground and background together, using RGB colors

setFgRGB
string setFgRGB;

sequence to set foreground color to RGB value

setWindowSize
string setWindowSize;

sequence to resize the window (rarely supported)

showCursor
string showCursor;

cnorm, should display the normal cursor

strikethrough
string strikethrough;
Undocumented in source.
underline
string underline;

smul, starts underlining

Meta

Source

See Implementation

dcell termcap structs

Page generated by adrdox