Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`insults`.`window`.`TopWindow``

class documentation

`class TopWindow(ContainerWidget): (source)`

View In Hierarchy

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

Method | `__init__` | Undocumented
Method | `changeFocus` | Undocumented
Method | `keystrokeReceived` | Undocumented
Method | `repaint` | Undocumented
Class Variable | `focused` | Undocumented
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...
Method | `_paint` | Undocumented
Instance Variable | `_paintCall` | Undocumented

Inherited from `ContainerWidget`:

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

Inherited from `Widget` (via `ContainerWidget`):

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

def __init__(self, painter, scheduler): (source)
overrides `twisted.conch.insults.window.ContainerWidget.__init__`

Undocumented

def changeFocus(self): (source)
overrides `twisted.conch.insults.window.ContainerWidget.changeFocus`

Undocumented

def keystrokeReceived(self, keyID, modifier): (source)
overrides `twisted.conch.insults.window.ContainerWidget.keystrokeReceived`

Undocumented

def repaint(self): (source)
overrides `twisted.conch.insults.window.Widget.repaint`

Undocumented

focused: `bool` = (source)
overrides `twisted.conch.insults.window.ContainerWidget.focused`

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

def _paint(self): (source)

Undocumented

_paintCall = (source)

Undocumented