ListBuilder Class

Inheritance diagram of ListBuilder

class ListBuilder

Methods:

begin(decoder, style) Begin a list.
get_mark([value]) Get the mark text for the next list item.
item(decoder, style[, value]) Begin a list item.

Methods

ListBuilder.begin(decoder, style)

Begin a list.

Parameters:
  • decoder (StructuredTextDecoder) – Decoder.
  • style (dict) – Style dictionary that applies over the entire list.
ListBuilder.get_mark(value=None)

Get the mark text for the next list item.

Parameters:value (str) – Optional value of the list item. The meaning is list-type dependent.
Return type:str
ListBuilder.item(decoder, style, value=None)

Begin a list item.

Parameters:
  • decoder (StructuredTextDecoder) – Decoder.
  • style (dict) – Style dictionary that applies over the list item.
  • value (str) – Optional value of the list item. The meaning is list-type dependent.

Table Of Contents

Previous topic

ImageElement Class

Next topic

OrderedListBuilder Class