D.2 LaTeXML::Util::KeyVal
Support for keyvals
D.2.1 Description
Provides a parser and representation of keyval pairs LaTeXML::KeyVal represents parameters handled by LaTeX’s keyval package.
Declarations
- DefKeyVal($keyset,$key,$type);
-
Defines the type of value expected for the key $key when parsed in part of a KeyVal using $keyset. $type would be something like ’any’ or ’Number’, but I’m still working on this.
Accessors
- KeyVal($arg,$key)
-
This is useful within constructors to access the value associated with $key in the argument $arg.
- KeyVals($arg)
-
This is useful within constructors to extract all keyvalue pairs to assign all attributes.
KeyVal Methods
- $value = $keyval->getValue($key);
-
Return the value associated with $key in the $keyval.
- @keyvals = $keyval->getKeyVals;
-
Return the hash reference containing the keys and values bound in the $keyval. Note that will only contain the last value for a given key, if they were repeated.
- @keyvals = $keyval->getPairs;
-
Return the alternating keys and values bound in the $keyval. Note that this may contain multiple entries for a given key, if they were repeated.
- $keyval->digestValues;
-
Return a new LaTeXML::KeyVals object with all values digested as appropriate.