docutils.utils.math.math2html.FormulaBit

class documentation

class FormulaBit(Container): (source)

Known subclasses: docutils.utils.math.math2html.Bracket, docutils.utils.math.math2html.Comment, docutils.utils.math.math2html.FormulaCommand, docutils.utils.math.math2html.FormulaNumber, docutils.utils.math.math2html.FormulaSymbol, docutils.utils.math.math2html.MacroParameter, docutils.utils.math.math2html.RawText, docutils.utils.math.math2html.TaggedBit, docutils.utils.math.math2html.WhiteSpace, docutils.utils.math.math2html.WholeFormula

Constructor: FormulaBit()

View In Hierarchy

A bit of a formula

Method __init__ The formula bit type can be 'alpha', 'number', 'font'.
Method __unicode__ Get a string representation
Method add Add any kind of formula bit already processed
Method clone Return a copy of itself.
Method computesize Compute the size of the bit as the max of the sizes of all contents.
Method setfactory Set the internal formula factory.
Method skiporiginal Skip a string and add it to the original formula
Class Variable original Undocumented
Class Variable type Undocumented
Instance Variable contents Undocumented
Instance Variable factory Undocumented
Instance Variable output Undocumented
Instance Variable size Undocumented

Inherited from Container:

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
def __init__(self): (source)
overrides docutils.utils.math.math2html.Container.__init__
overridden in docutils.utils.math.math2html.Bracket

The formula bit type can be 'alpha', 'number', 'font'.

def __unicode__(self): (source)
overrides docutils.utils.math.math2html.Container.__unicode__
overridden in docutils.utils.math.math2html.LimitPreviousCommand, docutils.utils.math.math2html.WhiteSpace

Get a string representation

def add(self, bit): (source)

Add any kind of formula bit already processed

def clone(self): (source)
overridden in docutils.utils.math.math2html.SquareBracket

Return a copy of itself.

def computesize(self): (source)

Compute the size of the bit as the max of the sizes of all contents.

def setfactory(self, factory): (source)

Set the internal formula factory.

def skiporiginal(self, string, pos): (source)

Skip a string and add it to the original formula

original: str = (source)
overridden in docutils.utils.math.math2html.BracketCommand, docutils.utils.math.math2html.MacroParameter

Undocumented

type = (source)
overridden in docutils.utils.math.math2html.AlphaCommand, docutils.utils.math.math2html.CombiningFunction, docutils.utils.math.math2html.DecoratingFunction, docutils.utils.math.math2html.FontFunction, docutils.utils.math.math2html.FormulaNumber, docutils.utils.math.math2html.LabelFunction, docutils.utils.math.math2html.RawText, docutils.utils.math.math2html.TextFunction

Undocumented

contents: list = (source)
overrides docutils.utils.math.math2html.Container.contents
overridden in docutils.utils.math.math2html.BracketCommand, docutils.utils.math.math2html.EmptyCommand, docutils.utils.math.math2html.FormulaCases, docutils.utils.math.math2html.HybridFunction, docutils.utils.math.math2html.LabelFunction, docutils.utils.math.math2html.MacroFunction, docutils.utils.math.math2html.MacroParameter, docutils.utils.math.math2html.SpacedCommand, docutils.utils.math.math2html.TaggedBit

Undocumented

factory = (source)

Undocumented

output = (source)
overridden in docutils.utils.math.math2html.FormulaCommand, docutils.utils.math.math2html.TaggedBit

Undocumented

size = (source)
overridden in docutils.utils.math.math2html.BeginCommand, docutils.utils.math.math2html.HybridFunction, docutils.utils.math.math2html.MultiRowFormula

Undocumented