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`.`words`.`protocols`.`irc`.`_FormattingState``

class documentation

`class _FormattingState(_textattributes._FormattingStateMixin): (source)`

Constructor: `_FormattingState(off, bold, underline, reverseVideo, ...)`

View In Hierarchy

Formatting state/attributes of a single character.

Attributes include:

- Formatting nullifier
- Bold
- Underline
- Reverse video
- Foreground color
- Background color

Present Since
13.1

Method | `__init__` | Undocumented
Method | `toMIRCControlCodes` | Emit a mIRC control sequence that will set up all the attributes this formatting state has set.
Class Variable | `compareAttributes` | Undocumented
Instance Variable | `background` | Undocumented
Instance Variable | `bold` | Undocumented
Instance Variable | `foreground` | Undocumented
Instance Variable | `off` | Undocumented
Instance Variable | `reverseVideo` | Undocumented
Instance Variable | `underline` | Undocumented

Inherited from `_FormattingStateMixin`:

Method | `copy` | Make a copy of this formatting state.
Method | `_withAttribute` | Add a character attribute to a copy of this formatting state.

Inherited from `DefaultFormattingState` (via `_FormattingStateMixin`):

Method | `toVT102` | Emit a VT102 control sequence that will set up all the attributes this formatting state has set.
Class Variable | `_dummy` | Undocumented

Inherited from `FancyEqMixin` (via `_FormattingStateMixin`, `DefaultFormattingState`):

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

def __init__(self, off=False, bold=False, underline=False, reverseVideo=False, foreground=None, background=None): (source)

Undocumented

def toMIRCControlCodes(self): (source)

Emit a mIRC control sequence that will set up all the attributes this formatting state has set.

Returns
A string containing mIRC control sequences that mimic this formatting state.

compareAttributes: `tuple[str, ...]` = (source)
overrides `twisted.python._textattributes.DefaultFormattingState.compareAttributes`

Undocumented

background = (source)

Undocumented

bold = (source)

Undocumented

foreground = (source)

Undocumented

off = (source)

Undocumented

reverseVideo = (source)

Undocumented

underline = (source)

Undocumented