twisted.words.protocols.irc._FormattingState

class documentation

class _FormattingState(_textattributes._FormattingStateMixin): (source)

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 to​MIRCControl​Codes Emit a mIRC control sequence that will set up all the attributes this formatting state has set.
Class Variable compare​Attributes Undocumented
Instance Variable background Undocumented
Instance Variable bold Undocumented
Instance Variable foreground Undocumented
Instance Variable off Undocumented
Instance Variable reverse​Video Undocumented
Instance Variable underline Undocumented

Inherited from _FormattingStateMixin:

Method copy Make a copy of this formatting state.
Method _with​Attribute Add a character attribute to a copy of this formatting state.

Inherited from DefaultFormattingState (via _FormattingStateMixin):

Method to​VT102 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