latexml::util::keyval(3pm) [debian man page]

LaTeXML::Util::KeyVal(3pm)				User Contributed Perl Documentation				LaTeXML::Util::KeyVal(3pm)

NAME

       "LaTeXML::Util::KeyVal" - support for keyvals

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.

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-16						LaTeXML::Util::KeyVal(3pm)

LaTeXML::Object(3pm)					User Contributed Perl Documentation				      LaTeXML::Object(3pm)

NAME

       "LaTeXML::Object" - abstract base class for most LaTeXML objects.

DESCRIPTION

       "LaTeXML::Object" serves as an abstract base class for all other objects (both the data objects and control objects).  It provides for
       common methods for stringification and comparison operations to simplify coding and to beautify error reporting.

   Methods
       "$string = $object->stringify;"
	   Returns a readable representation of $object, useful for debugging.

       "$string = $object->toString;"
	   Returns the string content of $object; most useful for extracting a usable string from tokens or boxes that might representing a
	   filename or such.

       "$boole = $object->equals($other);"
	   Returns whether $object and $other are equal.  Should perform a deep comparision, but the default implementation just compares for
	   object identity.

       "$boole = $object->isaToken;"
	   Returns whether $object is an LaTeXML::Token.

       "$boole = $object->isaBox;"
	   Returns whether $object is an LaTeXML::Box.

       "$boole = $object->isaDefinition;"
	   Returns whether $object is an LaTeXML::Definition.

       "$digested = $object->beDigested;"
	   Does whatever is needed to digest the object, and return the digested representation.  Tokens would be digested into boxes; Some
	   objects, such as numbers can just return themselves.

       "$object->beAbsorbed($document);"
	   Do whatever is needed to absorb the $object into the $document, typically by invoking appropriate methods on the $document.

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::Object(3pm)