class documentation

class twisted.conch.recvline.RecvLine(insults.TerminalProtocol): (source)

Known subclasses: twisted.conch.recvline.HistoricRecvLine

View In Hierarchy

TerminalProtocol which adds line editing features.

Clients will be prompted for lines of input with all the usual features: character echoing, left and right arrow support for moving the cursor to different areas of the line buffer, backspace and delete for removing characters, and insert for toggling between typeover and insert mode. Tabs will be expanded to enough spaces to move the cursor to the next tabstop (every four characters by default). Enter causes the line buffer to be cleared and the line to be passed to the lineReceived() method which, by default, does nothing. Subclasses are responsible for redrawing the input prompt (this will probably change).

Instance Variable width Undocumented
Instance Variable height Undocumented
Class Variable TABSTOP Undocumented
Class Variable ps Undocumented
Class Variable pn Undocumented
Method connectionMade Called after a connection has been established.
Instance Variable lineBuffer Undocumented
Instance Variable lineBufferIndex Undocumented
Instance Variable keyHandlers Undocumented
Method initializeScreen Undocumented
Method currentLineBuffer Undocumented
Method setInsertMode Undocumented
Instance Variable mode Undocumented
Method setTypeoverMode Undocumented
Method drawInputLine Write a line containing the current input prompt and the current line buffer at the current cursor position.
Method terminalSize Called to indicate the size of the terminal.
Method unhandledControlSequence Called when an unsupported control sequence is received.
Method keystrokeReceived A keystroke was received.
Method characterReceived Undocumented
Method handle_TAB Undocumented
Method handle_LEFT Undocumented
Method handle_RIGHT Undocumented
Method handle_HOME Undocumented
Method handle_END Undocumented
Method handle_BACKSPACE Undocumented
Method handle_DELETE Undocumented
Method handle_RETURN Undocumented
Method handle_INSERT Undocumented
Method lineReceived Undocumented
Class Variable _printableChars Undocumented
Class Variable _log Undocumented

Inherited from TerminalProtocol:

Method makeConnection Called with an ITerminalTransport when a connection is established.
Instance Variable terminal Undocumented
Method connectionLost Called when the connection has been lost.
width = (source)

Undocumented

height = (source)

Undocumented

TABSTOP = (source)

Undocumented

(type: int)

Undocumented

(type: tuple[bytes, ...])

Undocumented

(type: int)
_printableChars = (source)

Undocumented

_log = (source)

Undocumented

def connectionMade(self): (source)

Called after a connection has been established.

lineBuffer = (source)

Undocumented

(type: list)
lineBufferIndex = (source)

Undocumented

(type: int)
keyHandlers = (source)

Undocumented

def initializeScreen(self): (source)

Undocumented

def currentLineBuffer(self): (source)

Undocumented

def setInsertMode(self): (source)

Undocumented

mode = (source)

Undocumented

(type: str)
def setTypeoverMode(self): (source)

Undocumented

def drawInputLine(self): (source)

Write a line containing the current input prompt and the current line buffer at the current cursor position.

def terminalSize(self, width, height): (source)

Called to indicate the size of the terminal.

A terminal of 80x24 should be assumed if this method is not called. This method might not be called for real terminals.

def unhandledControlSequence(self, seq): (source)

Called when an unsupported control sequence is received.

ParametersseqThe whole control sequence which could not be interpreted. (type: str)
def keystrokeReceived(self, keyID, modifier): (source)

A keystroke was received.

Each keystroke corresponds to one invocation of this method. keyID is a string identifier for that key. Printable characters are represented by themselves. Control keys, such as arrows and function keys, are represented with symbolic constants on ServerProtocol.

def characterReceived(self, ch, moreCharactersComing): (source)

Undocumented

def handle_TAB(self): (source)

Undocumented

def handle_LEFT(self): (source)

Undocumented

def handle_RIGHT(self): (source)

Undocumented

def handle_HOME(self): (source)

Undocumented

def handle_END(self): (source)

Undocumented

def handle_BACKSPACE(self): (source)

Undocumented

def handle_DELETE(self): (source)

Undocumented

def handle_RETURN(self): (source)

Undocumented

def handle_INSERT(self): (source)

Undocumented

def lineReceived(self, line): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.