class documentation

class MacroFunction(CommandBit): (source)

View In Hierarchy

A function that was defined using a macro.
Method addfilter Add a filter for the given parameter number and parameter value.
Method completemacro Complete the macro with the parameters read.
Method parsebit Parse a number of input parameters.
Method parsemacroparameter Parse a macro parameter. Could be a bracket or a single letter.
Method parsemandatory Parse a number of mandatory parameters.
Method parsenumbers Parse the remaining parameters as a running number.
Method parseoptional Parse optional parameters.
Method parseparameters Parse as many parameters as are needed.
Instance Variable contents Undocumented
Instance Variable output Undocumented
Instance Variable values Undocumented

Inherited from CommandBit:

Method parseliteral Parse a literal bracket.
Method parseparameter Parse a parameter at the current position
Method parsesquare Parse a square bracket
Method parsesquareliteral Parse a square bracket literally.
Method parsetext Parse a text parameter.
Method setcommand Set the command in the bit
Instance Variable command Undocumented
Instance Variable translated Undocumented

Inherited from FormulaCommand (via CommandBit):

Method detect Find the current command.
Method emptycommand Check for an empty command: look for command disguised as ending. Special case against '{ { } }' situation.
Method extractcommand Extract the command from elyxer.the current position.
Method parsecommandtype Parse a given command type.
Method parseupgreek Parse the Greek up command..
Method parsewithcommand Parse the command type once we have the command.
Class Variable commandmap Undocumented
Class Variable start Undocumented
Class Variable types Undocumented

Inherited from FormulaBit (via CommandBit, FormulaCommand):

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 factory Undocumented
Instance Variable size Undocumented

Inherited from Container (via CommandBit, FormulaCommand, FormulaBit):

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 addfilter(self, index, value): (source)
Add a filter for the given parameter number and parameter value.
def completemacro(self, macro): (source)
Complete the macro with the parameters read.
def parsebit(self, pos): (source)
Parse a number of input parameters.
def parsemacroparameter(self, pos, remaining): (source)
Parse a macro parameter. Could be a bracket or a single letter.
def parsemandatory(self, pos, number): (source)
Parse a number of mandatory parameters.
def parsenumbers(self, pos, remaining): (source)
Parse the remaining parameters as a running number.
def parseoptional(self, pos, defaults): (source)
Parse optional parameters.
def parseparameters(self, pos, macro): (source)
Parse as many parameters as are needed.
values: list = (source)

Undocumented