twisted.conch.insults.helper._FormattingState : API documentation

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): (source)

Undocumented

@deprecated(Version('Twisted', 13, 1, 0))
def wantOne(self, **kw): (source)

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

Parameters	**kw	An optional attribute name and value can be provided with a keyword argument.
Returns	A formatting state instance with the new attribute.
See Also	`DefaultFormattingState._withAttribute`.

def toVT102(self): (source)

overrides twisted.python._textattributes.DefaultFormattingState.toVT102

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

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

t.c.i.h._FormattingState(_textattributes._FormattingStateMixin) : class documentation