.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Text::PDF::Name 3pm"
.TH Text::PDF::Name 3pm "2021-01-02" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::PDF::Name \- Inherits from Text::PDF::String and stores PDF names (things
beginning with /)
.SH "METHODS"
.IX Header "METHODS"
.SS "Text::PDF::Name\->from_pdf($string)"
.IX Subsection "Text::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.
.ie n .SS "$n\->convert ($str, $pdf)"
.el .SS "\f(CW$n\fP\->convert ($str, \f(CW$pdf\fP)"
.IX Subsection "$n->convert ($str, $pdf)"
Converts a name into a string by removing the / and converting any hex
munging unless \f(CW$pdf\fR is supplied and its version is less than 1.2.
.ie n .SS "$s\->as_pdf ($pdf)"
.el .SS "\f(CW$s\fP\->as_pdf ($pdf)"
.IX Subsection "$s->as_pdf ($pdf)"
Returns a name formatted as \s-1PDF.\s0  \f(CW$pdf\fR is optional but should be the
\&\s-1PDF\s0 File object for which the name is intended if supplied.
.ie n .SS "Text::PDF::Name\->string_to_name ($str, $pdf)"
.el .SS "Text::PDF::Name\->string_to_name ($str, \f(CW$pdf\fP)"
.IX Subsection "Text::PDF::Name->string_to_name ($str, $pdf)"
Suitably encode the string \f(CW$str\fR for output in the File object \f(CW$pdf\fR
(the exact format may depend on the version of \f(CW$pdf\fR).  Prinicipally,
encode certain characters in hex if the version is greater than 1.1.
.ie n .SS "Text::PDF::Name\->name_to_string ($str, $pdf)"
.el .SS "Text::PDF::Name\->name_to_string ($str, \f(CW$pdf\fP)"
.IX Subsection "Text::PDF::Name->name_to_string ($str, $pdf)"
Suitably decode the string \f(CW$str\fR as read from the File object \f(CW$pdf\fR (the
exact decoding may depend on the version of \f(CW$pdf\fR).  Principally, undo
the hex encoding for \s-1PDF\s0 versions > 1.1.