twisted.conch.recvline.RecvLine : API documentation

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

Inherited from TerminalProtocol:

Method	makeConnection	Called with an `ITerminalTransport` when a connection is established.
Method	connectionLost	Called when the connection has been lost.

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)

from twisted.conch.insults.insults.ITerminalProtocol

overrides twisted.conch.insults.insults.TerminalProtocol.terminalSize

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)

from twisted.conch.insults.insults.ITerminalProtocol

overrides twisted.conch.insults.insults.TerminalProtocol.unhandledControlSequence

Called when an unsupported control sequence is received.

Parameters seq The whole control sequence which could not be interpreted. (type: str)

def keystrokeReceived(self, keyID, modifier): (source)

from twisted.conch.insults.insults.ITerminalProtocol

overrides twisted.conch.insults.insults.TerminalProtocol.keystrokeReceived

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)

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

twisted.conch.recvline.RecvLine(insults.TerminalProtocol) class documentation

`twisted.conch.recvline.RecvLine(insults.TerminalProtocol)` class documentation