1LaTeXML::Core::Box(3) User Contributed Perl DocumentationLaTeXML::Core::Box(3)
2
3
4

NAME

6       "LaTeXML::Core::Box" - Representations of digested objects; extends
7       LaTeXML::Common::Object.
8
9   Exported Functions
10       "$box = Box($string,$font,$locator,$tokens);"
11           Creates a Box representing the $string in the given $font.  The
12           $locator records the document source position.  The $tokens is a
13           Tokens list containing the TeX that created (or could have) the
14           Box.  If $font or $locator are undef, they are obtained from the
15           currently active LaTeXML::Core::State.  Note that $string can be
16           undef which contributes nothing to the generated document, but does
17           record the TeX code (in $tokens).
18
19   METHODS
20       "$font = $digested->getFont;"
21           Returns the font used by $digested.
22
23       "$boole = $digested->isMath;"
24           Returns whether $digested was created in math mode.
25
26       "@boxes = $digested->unlist;"
27           Returns a list of the boxes contained in $digested.  It is also
28           defined for the Boxes and Whatsit (which just return themselves) so
29           they can stand-in for a List.
30
31       "$string = $digested->toString;"
32           Returns a string representing this $digested.
33
34       "$string = $digested->revert;"
35           Reverts the box to the list of "Token"s that created (or could have
36           created) it.
37
38       "$string = $digested->getLocator;"
39           Get an object describing the location in the original source that
40           gave rise to $digested.
41
42       "$digested->beAbsorbed($document);"
43           $digested should get itself absorbed into the $document in whatever
44           way is apppropriate.
45
46       "$string = $box->getString;"
47           Returns the string part of the $box.
48

AUTHOR

50       Bruce Miller <bruce.miller@nist.gov>
51

53       Public domain software, produced as part of work done by the United
54       States Government & not subject to copyright in the US.
55
56
57
58perl v5.36.0                      2022-07-20             LaTeXML::Core::Box(3)
Impressum