t.c.r.RecvLine(insults.TerminalProtocol) : class documentation

Part of twisted.conch.recvline View Source View In Hierarchy

Known subclasses: twisted.conch.recvline.HistoricRecvLine

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).

Method connectionMade Called after a connection has been established.
Method initializeScreen Undocumented
Method currentLineBuffer Undocumented
Method setInsertMode 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 Undocumented
Method unhandledControlSequence Undocumented
Method keystrokeReceived Undocumented
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

Inherited from TerminalProtocol:

Method makeConnection Undocumented
Method connectionLost Undocumented
def connectionMade(self): (source)
overrides twisted.conch.insults.insults.TerminalProtocol.connectionMade
overridden in twisted.conch.recvline.HistoricRecvLine
Called after a connection has been established.
def initializeScreen(self): (source)
Undocumented
def currentLineBuffer(self): (source)
Undocumented
def setInsertMode(self): (source)
Undocumented
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)
overrides twisted.conch.insults.insults.TerminalProtocol.terminalSize
Undocumented
def unhandledControlSequence(self, seq): (source)
overrides twisted.conch.insults.insults.TerminalProtocol.unhandledControlSequence
Undocumented
def keystrokeReceived(self, keyID, modifier): (source)
overrides twisted.conch.insults.insults.TerminalProtocol.keystrokeReceived
Undocumented
def characterReceived(self, ch, moreCharactersComing): (source)
overridden in twisted.conch.manhole.ColoredManhole
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)
overridden in twisted.conch.recvline.HistoricRecvLine
Undocumented
def handle_INSERT(self): (source)
Undocumented
def lineReceived(self, line): (source)
overridden in twisted.conch.manhole.Manhole
Undocumented
API Documentation for Twisted, generated by pydoctor at 2015-01-30 14:14:53.