Provided by: libpdf-builder-perl_3.023-2_all bug

NAME

       PDF::Builder::Basic::PDF::Utils - Utility functions for PDF library

DESCRIPTION

       A set of utility functions to save the fingers of the PDF library users!

FUNCTIONS

   PDFBool()
       Creates a Bool via PDF::Builder::Basic::PDF::Bool->new()

   PDFArray()
       Creates an array via PDF::Builder::Basic::PDF::Array->new()

   PDFDict()
       Creates a dict via PDF::Builder::Basic::PDF::Dict->new()

   PDFName()
       Creates a name via PDF::Builder::Basic::PDF::Name->new()

   PDFNull()
       Creates a null via PDF::Builder::Basic::PDF::Null->new()

   PDFNum()
       Creates a number via PDF::Builder::Basic::PDF::Number->new()

   PDFString($text, $usage)
       Returns either PDFStr($text) or PDFUtf($text), depending on whether $text is already in
       UTF-8 and whether the $usage permits UTF-8. If UTF-8 is not permitted, "downgrade" will be
       called on a UTF-8 formatted $text.

       $usage is a single character string indicating the use for which $text is to be applied.
       Some uses permit UTF-8, while others (currently) forbid it:

       's' An ordinary string, where UTF-8 text is permitted.

       'n' A named destination, where UTF-8 text is permitted.

       'o' An outline title, where UTF-8 text is permitted.

       'p' A popup title, where UTF-8 text is permitted.

       'm' metadata, where UTF-8 text is permitted.

       'f' A file path and/or name, where UTF-8 text is currently not permitted.

       'u' A URL, where UTF-8 text is currently not permitted.

       'x' Any other usage where UTF-8 text is not permitted.

   PDFStr()
       Creates a string via PDF::Builder::Basic::PDF::String->new()

       DEPRECATED. It is preferable that you use "PDFString" instead.

   PDFStrHex()
       Creates a hex-string via PDF::Builder::Basic::PDF::String->new()

   PDFUtf()
       Creates a utf8-string via PDF::Builder::Basic::PDF::String->new()

       DEPRECATED. It is preferable that you use "PDFString" instead.