oracular (3) PDF::Builder::Basic::PDF::Name.3pm.gz

NAME

       PDF::Builder::Basic::PDF::Name - Inherits from PDF::Builder::Basic::PDF::String and stores PDF names
       (things beginning with /)

METHODS

   from_pdf
           $n = PDF::Builder::Basic::PDF::Name->from_pdf($string)

           Creates a new string object (not a full object yet) from a given string. The string is parsed
           according to input criteria with escaping working, particular to Names.

   convert
           $n->convert($string, $pdf)

           Converts a name into a string by removing the / and converting any hex munging.

   as_pdf
           $s->as_pdf($pdf)

           Returns a name formatted as PDF. $pdf is optional but should be the PDF File object for which the
           name is intended if supplied.

   string_to_name
           PDF::Builder::Basic::PDF::Name->string_to_name($string, $pdf)

           Suitably encode the string $string for output in the File object $pdf (the exact format may depend on
           the version of $pdf).

   name_to_string
           PDF::Builder::Basic::PDF::Name->name_to_string($string, $pdf)

           Suitably decode the string $string as read from the File object $pdf (the exact decoding may depend
           on the version of $pdf).  Principally, undo the hex encoding for PDF versions > 1.1.