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`.`Viewport``

class documentation

`class Viewport(Widget): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `filthy` | Undocumented
Method | `render` | Undocumented
Method | `xOffset.setter` | Undocumented
Method | `yOffset.setter` | Undocumented
Instance Variable | `containee` | Undocumented
Property | `xOffset` | Undocumented
Property | `yOffset` | Undocumented
Class Variable | `_height` | Undocumented
Class Variable | `_width` | Undocumented
Instance Variable | `_buf` | Undocumented
Instance Variable | `_xOffset` | Undocumented
Instance Variable | `_yOffset` | Undocumented

Inherited from `Widget`:

Method | `backspaceReceived` | Undocumented
Method | `characterReceived` | Undocumented
Method | `draw` | Undocumented
Method | `focusLost` | Undocumented
Method | `focusReceived` | Called when focus is being given to this widget.
Method | `functionKeyReceived` | Undocumented
Method | `keystrokeReceived` | Undocumented
Method | `redraw` | Undocumented
Method | `repaint` | Undocumented
Method | `sizeHint` | Undocumented
Method | `tabReceived` | Undocumented
Class Variable | `parent` | Undocumented
Instance Variable | `dirty` | Undocumented
Instance Variable | `focused` | Undocumented
Instance Variable | `height` | Undocumented
Instance Variable | `width` | Undocumented

def __init__(self, containee): (source)

Undocumented

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

Undocumented

def render(self, width, height, terminal): (source)
overrides `twisted.conch.insults.window.Widget.render`

Undocumented

@xOffset.setter
def xOffset(self, value): (source)

Undocumented

@yOffset.setter
def yOffset(self, value): (source)

Undocumented

containee = (source)

Undocumented

@property
xOffset = (source)

Undocumented

@property
yOffset = (source)

Undocumented

_height: `int` = (source)

Undocumented

_width: `int` = (source)

Undocumented

_buf = (source)

Undocumented

_xOffset = (source)

Undocumented

_yOffset = (source)

Undocumented