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

class documentation

`class Canvas(Widget): (source)`

View In Hierarchy

Undocumented

Method | `__getitem__` | Undocumented
Method | `__init__` | Undocumented
Method | `__setitem__` | Undocumented
Method | `clear` | Undocumented
Method | `render` | Undocumented
Method | `resize` | Undocumented
Class Variable | `focused` | Undocumented
Instance Variable | `contents` | Undocumented
Instance Variable | `x` | Undocumented
Instance Variable | `y` | Undocumented
Instance Variable | `_height` | Undocumented
Instance Variable | `_width` | Undocumented

Inherited from `Widget`:

Method | `backspaceReceived` | Undocumented
Method | `characterReceived` | Undocumented
Method | `draw` | Undocumented
Method | `filthy` | 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 | `height` | Undocumented
Instance Variable | `width` | Undocumented

def __getitem__(self, index): (source)

Undocumented

def __init__(self): (source)

Undocumented

def __setitem__(self, index, value): (source)

Undocumented

def clear(self): (source)

Undocumented

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

Undocumented

def resize(self, width, height): (source)

Undocumented

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

Undocumented

contents = (source)

Undocumented

x = (source)

Undocumented

y = (source)

Undocumented

_height = (source)

Undocumented

_width = (source)

Undocumented