.\" 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 "PDF::Builder::Basic::PDF::String 3pm"
.TH PDF::Builder::Basic::PDF::String 3pm "2021-03-28" "perl v5.32.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::String \- PDF String type objects and superclass
for simple objects that are basically stringlike (Number, Name, etc.)
.SH "METHODS"
.IX Header "METHODS"
.SS "PDF::Builder::Basic::PDF::String\->from_pdf($string)"
.IX Subsection "PDF::Builder::Basic::PDF::String->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.
.SS "PDF::Builder::Basic::PDF::String\->new($string)"
.IX Subsection "PDF::Builder::Basic::PDF::String->new($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.
.ie n .SS "$s\->convert($str)"
.el .SS "\f(CW$s\fP\->convert($str)"
.IX Subsection "$s->convert($str)"
Returns \f(CW$str\fR converted as per criteria for input from \s-1PDF\s0 file
.ie n .SS "$s\->\fBval()\fP"
.el .SS "\f(CW$s\fP\->\fBval()\fP"
.IX Subsection "$s->val()"
Returns the value of this string (the string itself).
.ie n .SS "$s\->\fBas_pdf()\fP"
.el .SS "\f(CW$s\fP\->\fBas_pdf()\fP"
.IX Subsection "$s->as_pdf()"
Returns the string formatted for output as \s-1PDF\s0 for \s-1PDF\s0 File object \f(CW$pdf\fR.
.ie n .SS "$s\->outobjdeep($fh, $pdf)"
.el .SS "\f(CW$s\fP\->outobjdeep($fh, \f(CW$pdf\fP)"
.IX Subsection "$s->outobjdeep($fh, $pdf)"
Outputs the string in \s-1PDF\s0 format, complete with necessary conversions.