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

class documentation

`class Widget: (source)`

Known subclasses: `twisted.conch.insults.window.Border`, `twisted.conch.insults.window.Button`, `twisted.conch.insults.window.Canvas`, `twisted.conch.insults.window.ContainerWidget`, `twisted.conch.insults.window.ScrolledArea`, `twisted.conch.insults.window.Selection`, `twisted.conch.insults.window.TextInput`, `twisted.conch.insults.window.TextOutput`, `twisted.conch.insults.window.Viewport`, `twisted.conch.insults.window._Scrollbar`

View In Hierarchy

Undocumented

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 | `render` | 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 backspaceReceived(self): (source)
overridden in `twisted.conch.insults.window.TextInput`

Undocumented

def characterReceived(self, keyID, modifier): (source)
overridden in `twisted.conch.insults.window.Button`, `twisted.conch.insults.window.Selection`, `twisted.conch.insults.window.TextInput`

Undocumented

def draw(self, width, height, terminal): (source)

Undocumented

def filthy(self): (source)
overridden in `twisted.conch.insults.window.Border`, `twisted.conch.insults.window.ContainerWidget`, `twisted.conch.insults.window.ScrolledArea`, `twisted.conch.insults.window.Viewport`

Undocumented

def focusLost(self): (source)
overridden in `twisted.conch.insults.window.Border`

Undocumented

def focusReceived(self): (source)
overridden in `twisted.conch.insults.window.Border`, `twisted.conch.insults.window.ContainerWidget`, `twisted.conch.insults.window.TextOutput`

Called when focus is being given to this widget.

May raise YieldFocus is this widget does not want focus.

def functionKeyReceived(self, keyID, modifier): (source)

Undocumented

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

Undocumented

def redraw(self, width, height, terminal): (source)

Undocumented

def render(self, width, height, terminal): (source)
overridden in `twisted.conch.insults.window.Border`, `twisted.conch.insults.window.Button`, `twisted.conch.insults.window.Canvas`, `twisted.conch.insults.window.ContainerWidget`, `twisted.conch.insults.window.HorizontalScrollbar`, `twisted.conch.insults.window.ScrolledArea`, `twisted.conch.insults.window.Selection`, `twisted.conch.insults.window.TextInput`, `twisted.conch.insults.window.TextOutput`, `twisted.conch.insults.window.VerticalScrollbar`, `twisted.conch.insults.window.Viewport`

Undocumented

def repaint(self): (source)
overridden in `twisted.conch.insults.window.TopWindow`

Undocumented

def sizeHint(self): (source)
overridden in `twisted.conch.insults.window.Border`, `twisted.conch.insults.window.Button`, `twisted.conch.insults.window.HorizontalScrollbar`, `twisted.conch.insults.window.Selection`, `twisted.conch.insults.window.TextInput`, `twisted.conch.insults.window.TextOutput`, `twisted.conch.insults.window.VerticalScrollbar`, `twisted.conch.insults.window._Box`

Undocumented

def tabReceived(self, modifier): (source)

Undocumented

parent = (source)

Undocumented

dirty: `bool` = (source)

Undocumented

focused: `bool` = (source)
overridden in `twisted.conch.insults.window.Canvas`, `twisted.conch.insults.window.ContainerWidget`

Undocumented

height = (source)
overridden in `twisted.conch.insults.window.Selection`

Undocumented

width = (source)

Undocumented