twisted.conch.insults.window.TopWindow(ContainerWidget) class documentation

Part of twisted.conch.insults.window (View In Hierarchy)

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).
Method __init__ Undocumented
Method repaint Undocumented
Method changeFocus Undocumented
Method keystrokeReceived Undocumented
Method _paint Undocumented

Inherited from ContainerWidget:

Instance Variable focusedChild The contained widget which currently has focus, or None.
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):

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 =
A no-argument callable which will be invoked when this widget needs to be redrawn.
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).
def __init__(self, painter, scheduler):
overrides twisted.conch.insults.window.ContainerWidget.__init__
Undocumented
def repaint(self):
overrides twisted.conch.insults.window.Widget.repaint
Undocumented
def _paint(self):
Undocumented
def changeFocus(self):
overrides twisted.conch.insults.window.ContainerWidget.changeFocus
Undocumented
def keystrokeReceived(self, keyID, modifier):
overrides twisted.conch.insults.window.ContainerWidget.keystrokeReceived
Undocumented
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.