class documentation

class BuilderTextBuffer(Builder): (source)

Known subclasses: zim.templates.parser.TemplateBuilderTextBuffer

View In Hierarchy

Wrapper that buffers text going to a Builder object such that the last piece of text remains accessible for inspection and can be modified.
Method __init__ Undocumented
Method append No summary
Method clear_text Undocumented
Method end No summary
Method flush Undocumented
Method get_text Undocumented
Method set_text Undocumented
Method start No summary
Method text Append text @param text: text to be appended as string @implementation: must be implemented by sub-classes
Instance Variable buffer Undocumented
Instance Variable builder Undocumented
def __init__(self, builder): (source)
def append(self, tag, attrib=None, text=None): (source)
Convenience function to open a tag, append text and close it immediatly. Only used for formatted text that has no sub-processing done.
Parameters
tagthe tag name
attriboptional dict with attributes
textformatted text
Unknown Field: implementation
optional for subclasses, default implementation calls start(), text(), and end()
def clear_text(self): (source)

Undocumented

def end(self, tag): (source)
End formatted region
Parameters
tagthe tag name
Raises
XXXwhen tag does not match current state
Unknown Field: implementation
must be implemented by sub-classes
def flush(self): (source)
def get_text(self): (source)

Undocumented

def set_text(self, text): (source)

Undocumented

def start(self, tag, attrib=None): (source)
Start formatted region
Parameters
tagthe tag name
attriboptional dict with attributes
Unknown Field: implementation
must be implemented by sub-classes
def text(self, text): (source)
Append text
Parameters
texttext to be appended as string
Unknown Field: implementation
must be implemented by sub-classes
builder = (source)

Undocumented