LaTeXML::Box(3pm) User Contributed Perl Documentation LaTeXML::Box(3pm)
NAME
"LaTeXML::Box" - Representations of digested objects.
DESCRIPTION
These represent various kinds of digested objects
"LaTeXML::Box"
represents text in a particular font;
"LaTeXML::MathBox"
represents a math token in a particular font;
"LaTeXML::List"
represents a sequence of digested things in text;
"LaTeXML::MathList"
represents a sequence of digested things in math;
"LaTeXML::Whatsit"
represents a digested object that can generate arbitrary elements in the XML Document.
Common Methods
All these classes extend LaTeXML::Object and so implement the "stringify" and "equals" operations.
"$font = $digested->getFont;"
Returns the font used by $digested.
"$boole = $digested->isMath;"
Returns whether $digested was created in math mode.
"@boxes = $digested->unlist;"
Returns a list of the boxes contained in $digested. It is also defined for the Boxes and Whatsit (which just return themselves) so
they can stand-in for a List.
"$string = $digested->toString;"
Returns a string representing this $digested.
"$string = $digested->revert;"
Reverts the box to the list of "Token"s that created (or could have created) it.
"$string = $digested->getLocator;"
Get a string describing the location in the original source that gave rise to $digested.
"$digested->beAbsorbed($document);"
$digested should get itself absorbed into the $document in whatever way is apppropriate.
Box Methods
The following methods are specific to "LaTeXML::Box" and "LaTeXML::MathBox".
"$string = $box->getString;"
Returns the string part of the $box.
Whatsit Methods
Note that the font is stored in the data properties under 'font'.
"$defn = $whatsit->getDefinition;"
Returns the LaTeXML::Definition responsible for creating $whatsit.
"$value = $whatsit->getProperty($key);"
Returns the value associated with $key in the $whatsit's property list.
"$whatsit->setProperty($key,$value);"
Sets the $value associated with the $key in the $whatsit's property list.
"$props = $whatsit->getProperties();"
Returns the hash of properties stored on this Whatsit. (Note that this hash is modifiable).
"$props = $whatsit->setProperties(%keysvalues);"
Sets several properties, like setProperty.
"$list = $whatsit->getArg($n);"
Returns the $n-th argument (starting from 1) for this $whatsit.
"@args = $whatsit->getArgs;"
Returns the list of arguments for this $whatsit.
"$whatsit->setArgs(@args);"
Sets the list of arguments for this $whatsit to @args (each arg should be a "LaTeXML::List" or "LaTeXML::MathList").
"$list = $whatsit->getBody;"
Return the body for this $whatsit. This is only defined for environments or top-level math formula. The body is stored in the
properties under 'body'.
"$whatsit->setBody(@body);"
Sets the body of the $whatsit to the boxes in @body. The last $box in @body is assumed to represent the `trailer', that is the result
of the invocation that closed the environment or math. It is stored separately in the properties under 'trailer'.
"$list = $whatsit->getTrailer;"
Return the trailer for this $whatsit. See "setBody".
AUTHOR
Bruce Miller <bruce.miller@nist.gov>
COPYRIGHT
Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.
perl v5.10.1 2009-06-11 LaTeXML::Box(3pm)