twisted.conch.insults.helper._FormattingState(_textattributes._FormattingStateMixin) class documentation

Part of twisted.conch.insults.helper (View In Hierarchy)

Represents the formatting state/attributes of a single character.

Character set, intensity, underlinedness, blinkitude, video reversal, as well as foreground and background colors made up a character's attributes.

Method __init__ Undocumented
Method wantOne Add a character attribute to a copy of this formatting state.
Method toVT102 Emit a VT102 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 FancyEqMixin (via _FormattingStateMixin, DefaultFormattingState):

Method __eq__ Undocumented
Method __ne__ Undocumented
def __init__(self, charset=insults.G0, bold=False, underline=False, blink=False, reverseVideo=False, foreground=WHITE, background=BLACK, _subtracting=False):
Undocumented
def wantOne(self, **kw):

Add a character attribute to a copy of this formatting state.

Parameters**kwAn optional attribute name and value can be provided with a keyword argument.
ReturnsA formatting state instance with the new attribute.
See AlsoDefaultFormattingState._withAttribute.
def toVT102(self):
overrides twisted.python._textattributes.DefaultFormattingState.toVT102

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

ReturnsA string containing VT102 control sequences that mimic this formatting state.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.