class documentation

class twisted.conch.insults.helper._FormattingState(_textattributes._FormattingStateMixin): (source)

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.

Class Variable compareAttributes Undocumented
Method __init__ Undocumented
Instance Variable charset Undocumented
Instance Variable bold Undocumented
Instance Variable underline Undocumented
Instance Variable blink Undocumented
Instance Variable reverseVideo Undocumented
Instance Variable foreground Undocumented
Instance Variable background 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.
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

charset = (source)

Undocumented

bold = (source)

Undocumented

underline = (source)

Undocumented

blink = (source)

Undocumented

reverseVideo = (source)

Undocumented

foreground = (source)

Undocumented

background = (source)

Undocumented

_subtracting = (source)

Undocumented

def wantOne(self, **kw): (source)

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

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

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 20.12.1 at 2021-02-28 19:53:36.