.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "PDF::Builder::Basic::PDF::Name 3"
.TH PDF::Builder::Basic::PDF::Name 3 2023-12-21 "perl v5.38.1" "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
PDF::Builder::Basic::PDF::Name \- Inherits from PDF::Builder::Basic::PDF::String
and stores PDF names (things beginning with /)
.SH METHODS
.IX Header "METHODS"
.SS from_pdf
.IX Subsection "from_pdf"
.Vb 1
\&    $n = PDF::Builder::Basic::PDF::Name\->from_pdf($string)
.Ve
.Sp
.RS 4
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.
.RE
.SS convert
.IX Subsection "convert"
.Vb 1
\&    $n\->convert($string, $pdf)
.Ve
.Sp
.RS 4
Converts a name into a string by removing the / and converting any hex
munging.
.RE
.SS as_pdf
.IX Subsection "as_pdf"
.Vb 1
\&    $s\->as_pdf($pdf)
.Ve
.Sp
.RS 4
Returns a name formatted as PDF. \f(CW$pdf\fR is optional but should be the
PDF File object for which the name is intended if supplied.
.RE
.SS string_to_name
.IX Subsection "string_to_name"
.Vb 1
\&    PDF::Builder::Basic::PDF::Name\->string_to_name($string, $pdf)
.Ve
.Sp
.RS 4
Suitably encode the string \f(CW$string\fR for output in the File object \f(CW$pdf\fR
(the exact format may depend on the version of \f(CW$pdf\fR).
.RE
.SS name_to_string
.IX Subsection "name_to_string"
.Vb 1
\&    PDF::Builder::Basic::PDF::Name\->name_to_string($string, $pdf)
.Ve
.Sp
.RS 4
Suitably decode the string \f(CW$string\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 PDF versions > 1.1.
.RE