twisted.conch.insults.insults.ITerminalTransport

interface documentation

class ITerminalTransport(iinternet.ITransport): (source)

Known implementations: twisted.conch.insults.helper.TerminalBuffer, twisted.conch.insults.insults.ServerProtocol, twisted.conch.recvline.TransportSequence

View In Hierarchy

Undocumented

Method	`applicationKeypadMode`	Cause keypad to generate control functions.
Method	`cursorBackward`	Move the cursor left n columns.
Method	`cursorDown`	Move the cursor down n lines.
Method	`cursorForward`	Move the cursor right n columns.
Method	`cursorHome`	Move the cursor home.
Method	`cursorPosition`	Move the cursor to the given line and column.
Method	`cursorUp`	Move the cursor up n lines.
Method	`deleteCharacter`	Delete n characters starting at the cursor position.
Method	`deleteLine`	Delete n lines starting at the cursor position.
Method	`doubleHeightLine`	Make the current line the top or bottom half of a double-height, double-width line.
Method	`doubleWidthLine`	Make the current line a double-width line.
Method	`eraseDisplay`	Erase the entire display.
Method	`eraseLine`	Erase the entire cursor line.
Method	`eraseToDisplayBeginning`	Erase from the cursor to the beginning of the display, including the cursor position.
Method	`eraseToDisplayEnd`	Erase from the cursor to the end of the display, including the cursor position.
Method	`eraseToLineBeginning`	Erase from the cursor to the beginning of the line, including the cursor position.
Method	`eraseToLineEnd`	Erase from the cursor to the end of line, including cursor position.
Method	`horizontalTabulationSet`	Set a tab stop at the current cursor position.
Method	`index`	Move the cursor down one line, performing scrolling if necessary.
Method	`insertLine`	Insert n lines at the cursor position.
Method	`nextLine`	Move the cursor to the first position on the next line, performing scrolling if necessary.
Method	`numericKeypadMode`	Cause keypad to generate normal characters.
Method	`reportCursorPosition`	Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.
Method	`reset`	Reset the terminal to its initial state.
Method	`resetModes`	Reset the given modes on the terminal.
Method	`resetPrivateModes`	Reset the given DEC private modes on the terminal.
Method	`restoreCursor`	Restore the previously saved cursor position, character attribute, character set, and origin mode selection.
Method	`reverseIndex`	Move the cursor up one line, performing scrolling if necessary.
Method	`saveCursor`	Save the cursor position, character attribute, character set, and origin mode selection.
Method	`selectCharacterSet`	Select a character set.
Method	`selectGraphicRendition`	Enabled one or more character attributes.
Method	`setModes`	Set the given modes on the terminal.
Method	`setPrivateModes`	Set the given DEC private modes on the terminal.
Method	`shiftIn`	Activate the G0 character set.
Method	`shiftOut`	Activate the G1 character set.
Method	`singleShift2`	Shift to the G2 character set for a single character.
Method	`singleShift3`	Shift to the G3 character set for a single character.
Method	`singleWidthLine`	Make the current line a single-width, single-height line.
Method	`tabulationClear`	Clear the tab stop at the current cursor position.
Method	`tabulationClearAll`	Clear all tab stops.
Method	`unhandledControlSequence`	Called when an unsupported control sequence is received.

Inherited from ITransport:

Method	`getHost`	Similar to getPeer, but returns an address describing this side of the connection.
Method	`getPeer`	Get the remote address of this connection.
Method	`loseConnection`	Close my connection, after writing all pending data.
Method	`write`	Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method	`writeSequence`	Write an iterable of byte strings to the physical connection.

def applicationKeypadMode(): (source)

Cause keypad to generate control functions.

Cursor key mode selects the type of characters generated by cursor keys.

def cursorBackward(n=1): (source)

Move the cursor left n columns.

def cursorDown(n=1): (source)

Move the cursor down n lines.

def cursorForward(n=1): (source)

Move the cursor right n columns.

def cursorHome(): (source)

Move the cursor home.

def cursorPosition(column, line): (source)

Move the cursor to the given line and column.

def cursorUp(n=1): (source)

Move the cursor up n lines.

def deleteCharacter(n=1): (source)

Delete n characters starting at the cursor position.

Characters to the right of deleted characters are shifted to the left.

def deleteLine(n=1): (source)

Delete n lines starting at the cursor position.

Lines below the cursor are shifted up. This command is ignored when the cursor is outside the scroll region.

def doubleHeightLine(top=True): (source)

Make the current line the top or bottom half of a double-height, double-width line.

If top is True, the current line is the top half. Otherwise, it is the bottom half.

def doubleWidthLine(): (source)

Make the current line a double-width line.

def eraseDisplay(): (source)

Erase the entire display.

def eraseLine(): (source)

Erase the entire cursor line.

def eraseToDisplayBeginning(): (source)

Erase from the cursor to the beginning of the display, including the cursor position.

def eraseToDisplayEnd(): (source)

Erase from the cursor to the end of the display, including the cursor position.

def eraseToLineBeginning(): (source)

Erase from the cursor to the beginning of the line, including the cursor position.

def eraseToLineEnd(): (source)

Erase from the cursor to the end of line, including cursor position.

def horizontalTabulationSet(): (source)

Set a tab stop at the current cursor position.

def index(): (source)

Move the cursor down one line, performing scrolling if necessary.

def insertLine(n=1): (source)

Insert n lines at the cursor position.

Lines below the cursor are shifted down. Lines moved past the bottom margin are lost. This command is ignored when the cursor is outside the scroll region.

def nextLine(): (source)

Move the cursor to the first position on the next line, performing scrolling if necessary.

def numericKeypadMode(): (source)

Cause keypad to generate normal characters.

def reportCursorPosition(): (source)

Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.

def reset(): (source)

Reset the terminal to its initial state.

def resetModes(mode): (source)

Reset the given modes on the terminal.

def resetPrivateModes(modes): (source)

Reset the given DEC private modes on the terminal.

def restoreCursor(): (source)

Restore the previously saved cursor position, character attribute, character set, and origin mode selection.

If no cursor state was previously saved, move the cursor to the home position.

def reverseIndex(): (source)

Move the cursor up one line, performing scrolling if necessary.

def saveCursor(): (source)

Save the cursor position, character attribute, character set, and origin mode selection.

def selectCharacterSet(charSet, which): (source)

Select a character set.

charSet should be one of CS_US, CS_UK, CS_DRAWING, CS_ALTERNATE, or CS_ALTERNATE_SPECIAL.

which should be one of G0 or G1.

def selectGraphicRendition(*attributes): (source)

Enabled one or more character attributes.

Arguments should be one or more of UNDERLINE, REVERSE_VIDEO, BLINK, or BOLD. NORMAL may also be specified to disable all character attributes.

def setModes(modes): (source)

Set the given modes on the terminal.

def setPrivateModes(modes): (source)

Set the given DEC private modes on the terminal.

def shiftIn(): (source)

Activate the G0 character set.

def shiftOut(): (source)

Activate the G1 character set.

def singleShift2(): (source)

Shift to the G2 character set for a single character.

def singleShift3(): (source)

Shift to the G3 character set for a single character.

def singleWidthLine(): (source)

Make the current line a single-width, single-height line.

def tabulationClear(): (source)

Clear the tab stop at the current cursor position.

def tabulationClearAll(): (source)

Clear all tab stops.

def unhandledControlSequence(seq): (source)

Called when an unsupported control sequence is received.

Parameters
seq:`str`	The whole control sequence which could not be interpreted.