C.10 LaTeXML::Box

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 Tokens 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.

The following methods are specific to LaTeXML::Box and LaTeXML::MathBox.

$string = $box->getString;

Returns the string part of the $box.

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.