twisted.conch.insults.helper._FormattingState

class documentation

class _FormattingState(_textattributes._FormattingStateMixin): (source)

Constructor: _FormattingState(charset, bold, underline, blink, ...)

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 toVT102 Emit a VT102 control sequence that will set up all the attributes this formatting state has set.
Method wantOne Add a character attribute to a copy of this formatting state.
Class Variable compareAttributes Undocumented
Instance Variable background Undocumented
Instance Variable blink Undocumented
Instance Variable bold Undocumented
Instance Variable charset Undocumented
Instance Variable foreground Undocumented
Instance Variable reverseVideo Undocumented
Instance Variable underline Undocumented
Instance Variable _subtracting 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):

Class Variable _dummy Undocumented

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

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.
def wantOne(self, **kw): (source)

Deprecated since version 13.1.0: wantOne was deprecated in Twisted 13.1.0.

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.
Returns
A formatting state instance with the new attribute.
See Also
DefaultFormattingState._withAttribute.
compareAttributes: tuple[str, ...] = (source)
overrides twisted.python._textattributes.DefaultFormattingState.compareAttributes

Undocumented

background = (source)

Undocumented

blink = (source)

Undocumented

bold = (source)

Undocumented

charset = (source)

Undocumented

foreground = (source)

Undocumented

reverseVideo = (source)

Undocumented

underline = (source)

Undocumented

_subtracting = (source)

Undocumented