twisted.words.protocols.irc._FormattingState(_textattributes._FormattingStateMixin) class documentation

Part of twisted.words.protocols.irc View Source (View In Hierarchy)

Formatting state/attributes of a single character.

Attributes include:

  • Formatting nullifier
  • Bold
  • Underline
  • Reverse video
  • Foreground color
  • Background color
Present Since13.1
Class Variable compareAttributes Undocumented
Method __init__ Undocumented
Instance Variable off Undocumented
Instance Variable bold Undocumented
Instance Variable underline Undocumented
Instance Variable reverseVideo Undocumented
Instance Variable foreground Undocumented
Instance Variable background Undocumented
Method toMIRCControlCodes Emit a mIRC control sequence that will set up all the attributes this formatting state has set.

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
compareAttributes =
Undocumented
(type: Tuple[str, ...])
def __init__(self, off=False, bold=False, underline=False, reverseVideo=False, foreground=None, background=None): (source)
Undocumented
off =
Undocumented
bold =
Undocumented
underline =
Undocumented
reverseVideo =
Undocumented
foreground =
Undocumented
background =
Undocumented
def toMIRCControlCodes(self): (source)

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

ReturnsA string containing mIRC control sequences that mimic this formatting state.
API Documentation for Twisted, generated by pydoctor at 2020-03-20 23:54:06.