docutils.utils.math.math2html.Container

class documentation

class Container: (source)

Known subclasses: docutils.utils.math.math2html.BlackBox, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit, docutils.utils.math.math2html.StringContainer

View In Hierarchy

A container for text and objects in a lyx file

Method __init__ Undocumented
Method __str__ Get a description
Method escape Escape a line with replacements from a map
Method escapeentities Escape all Unicode characters to HTML entities.
Method extracttext Extract all text from allowed containers.
Method gethtml Get the resulting HTML
Method getparameter Get the value of a parameter, if present.
Method getparameterlist Get the value of a comma-separated parameter as a list.
Method group Group some adjoining elements into a group
Method hasemptyoutput Check if the parent's output is empty.
Method locateprocess Search for all embedded containers and process them
Method process Process contents
Method recursivesearch Perform a recursive search in the container.
Method remove Remove a container but leave its contents
Method searchall Search for all embedded containers of a given type
Method searchprocess Search for elements of a given type and process them
Method searchremove Search for all containers of a type and remove them
Method tree Show in a tree
Class Variable begin Undocumented
Class Variable parent Undocumented
Class Variable partkey Undocumented
Instance Variable contents Undocumented
def __init__(self): (source)
overridden in docutils.utils.math.math2html.BlackBox, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit, docutils.utils.math.math2html.StringContainer

Undocumented

def __str__(self): (source)
overridden in docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit, docutils.utils.math.math2html.StringContainer

Get a description

def escape(self, line, replacements=EscapeConfig.entities): (source)

Escape a line with replacements from a map

def escapeentities(self, line): (source)

Escape all Unicode characters to HTML entities.

def extracttext(self): (source)
overridden in docutils.utils.math.math2html.StringContainer

Extract all text from allowed containers.

def gethtml(self): (source)

Get the resulting HTML

def getparameter(self, name): (source)

Get the value of a parameter, if present.

def getparameterlist(self, name): (source)

Get the value of a comma-separated parameter as a list.

def group(self, index, group, isingroup): (source)

Group some adjoining elements into a group

def hasemptyoutput(self): (source)

Check if the parent's output is empty.

def locateprocess(self, locate, process): (source)

Search for all embedded containers and process them

def process(self): (source)
overridden in docutils.utils.math.math2html.FontFunction, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.StringContainer, docutils.utils.math.math2html.TextFunction

Process contents

def recursivesearch(self, locate, recursive, process): (source)

Perform a recursive search in the container.

def remove(self, index): (source)

Remove a container but leave its contents

def searchall(self, type): (source)

Search for all embedded containers of a given type

def searchprocess(self, type, process): (source)

Search for elements of a given type and process them

def searchremove(self, type): (source)

Search for all containers of a type and remove them

def tree(self, level=0): (source)

Show in a tree

begin = (source)

Undocumented

parent = (source)

Undocumented

partkey = (source)

Undocumented

contents = (source)
overridden in docutils.utils.math.math2html.BlackBox, docutils.utils.math.math2html.Constant, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit

Undocumented