twisted.conch.insults.window.TopWindow : API documentation

class documentation

class twisted.conch.insults.window.TopWindow(ContainerWidget): (source)

A top-level container object which provides focus wrap-around and paint scheduling.

Instance Variable	painter	A no-argument callable which will be invoked when this widget needs to be redrawn.
Instance Variable	scheduler	A one-argument callable which will be invoked with a no-argument callable and should arrange for it to invoked at some point in the near future. The no-argument callable will cause this widget and all its children to be redrawn. It is typically beneficial for the no-argument callable to be invoked at the end of handling for whatever event is currently active; for example, it might make sense to call it at the end of `twisted.conch.insults.insults.ITerminalProtocol.keystrokeReceived`. Note, however, that since calls to this may also be made in response to no apparent event, arrangements should be made for the function to be called even if an event handler such as `keystrokeReceived` is not on the call stack (eg, using `reactor.callLater` with a short timeout).
Class Variable	focused	Undocumented
Method	__init__	Undocumented
Method	repaint	Undocumented
Method	changeFocus	Undocumented
Method	keystrokeReceived	Undocumented
Instance Variable	_paintCall	Undocumented
Method	_paint	Undocumented

Inherited from ContainerWidget:

Instance Variable	focusedChild	The contained widget which currently has focus, or None.
Instance Variable	children	Undocumented
Method	addChild	Undocumented
Method	remChild	Undocumented
Method	filthy	Undocumented
Method	render	Undocumented
Method	focusReceived	Called when focus is being given to this widget.

Inherited from Widget (via ContainerWidget):

Class Variable	parent	Undocumented
Instance Variable	dirty	Undocumented
Instance Variable	width	Undocumented
Instance Variable	height	Undocumented
Method	redraw	Undocumented
Method	draw	Undocumented
Method	sizeHint	Undocumented
Method	tabReceived	Undocumented
Method	focusLost	Undocumented
Method	backspaceReceived	Undocumented
Method	functionKeyReceived	Undocumented
Method	characterReceived	Undocumented

painter = (source)

A no-argument callable which will be invoked when this widget needs to be redrawn.

scheduler = (source)

A one-argument callable which will be invoked with a no-argument callable and should arrange for it to invoked at some point in the near future. The no-argument callable will cause this widget and all its children to be redrawn. It is typically beneficial for the no-argument callable to be invoked at the end of handling for whatever event is currently active; for example, it might make sense to call it at the end of twisted.conch.insults.insults.ITerminalProtocol.keystrokeReceived. Note, however, that since calls to this may also be made in response to no apparent event, arrangements should be made for the function to be called even if an event handler such as keystrokeReceived is not on the call stack (eg, using reactor.callLater with a short timeout).

focused = (source)

overrides twisted.conch.insults.window.ContainerWidget.focused

Undocumented

(type: bool)

def __init__(self, painter, scheduler): (source)

overrides twisted.conch.insults.window.ContainerWidget.__init__

Undocumented

_paintCall = (source)

Undocumented

def repaint(self): (source)

overrides twisted.conch.insults.window.Widget.repaint

Undocumented