Steve Simms > PDF-API2-2.019 > PDF::API2::Basic::PDF::Name



Annotate this POD


New  23
Open  7
View/Report Bugs
Module Version: 2.019   Source   Latest Release: PDF-API2-2.023


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



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.

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

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

$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.

PDF::API2::Basic::PDF::Name->string_to_name ($str, $pdf)

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

Note: This function only encodes names properly for PDF version 1.2 and higher.

PDF::API2::Basic::PDF::Name->name_to_string ($str, $pdf)

Suitably decode the string $str 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.

syntax highlighting: