docutils.utils.math.math2html.Container

class documentation

class Container(object): (source)

Known subclasses: docutils.utils.math.math2html.Align, docutils.utils.math.math2html.BlackBox, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit, docutils.utils.math.math2html.Link, docutils.utils.math.math2html.LyXLine, docutils.utils.math.math2html.Newline, docutils.utils.math.math2html.QuoteContainer, docutils.utils.math.math2html.Separator, docutils.utils.math.math2html.Space, docutils.utils.math.math2html.StringContainer, docutils.utils.math.math2html.TaggedText, docutils.utils.math.math2html.VerticalSpace

View In Hierarchy

A container for text and objects in a lyx file

Method __init__ Undocumented
Method __unicode__ Get a description
Method escape Escape a line with replacements from elyxer.a map
Method escapeall Escape all lines in an array according to the output options.
Method escapeentities Escape all Unicode characters to HTML entities.
Method extracttext Extract all text from elyxer.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.Align, docutils.utils.math.math2html.BlackBox, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.FormulaBit, docutils.utils.math.math2html.Link, docutils.utils.math.math2html.LyXLine, docutils.utils.math.math2html.Newline, docutils.utils.math.math2html.QuoteContainer, docutils.utils.math.math2html.Separator, docutils.utils.math.math2html.Space, docutils.utils.math.math2html.StringContainer, docutils.utils.math.math2html.TaggedText, docutils.utils.math.math2html.VerticalSpace

Undocumented

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

Get a description

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

Escape a line with replacements from elyxer.a map

def escapeall(self, lines): (source)

Escape all lines in an array according to the output options.

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 elyxer.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.Align, docutils.utils.math.math2html.BarredText, docutils.utils.math.math2html.BoldText, docutils.utils.math.math2html.ColorText, docutils.utils.math.math2html.EmphaticText, docutils.utils.math.math2html.FontFunction, docutils.utils.math.math2html.Formula, docutils.utils.math.math2html.Hfill, docutils.utils.math.math2html.InsetLength, docutils.utils.math.math2html.Label, docutils.utils.math.math2html.LabelFunction, docutils.utils.math.math2html.LangLine, docutils.utils.math.math2html.LyXFormat, docutils.utils.math.math2html.LyXLine, docutils.utils.math.math2html.Newline, docutils.utils.math.math2html.QuoteContainer, docutils.utils.math.math2html.Reference, docutils.utils.math.math2html.ShapedText, docutils.utils.math.math2html.SizeText, docutils.utils.math.math2html.Space, docutils.utils.math.math2html.StartAppendix, docutils.utils.math.math2html.StrikeOut, docutils.utils.math.math2html.StringContainer, docutils.utils.math.math2html.TextFamily, docutils.utils.math.math2html.TextFunction, docutils.utils.math.math2html.URL, docutils.utils.math.math2html.VersalitasText, docutils.utils.math.math2html.VerticalSpace

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, docutils.utils.math.math2html.Link, docutils.utils.math.math2html.Separator, docutils.utils.math.math2html.TaggedText

Undocumented