.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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::Resource::Font::CoreFont 3pm"
.TH PDF::Builder::Resource::Font::CoreFont 3pm "2023-12-15" "perl v5.36.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"
PDF::Builder::Resource::Font::CoreFont \- Module for using the 14 standard PDF built\-in Fonts (plus 15 Windows Fonts).
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 12
\&    #
\&    use PDF::Builder;
\&    #
\&    my $pdf = PDF::Builder\->new();
\&    my $cft = $pdf\->font(\*(AqTimes\-Roman\*(Aq);
\&   #my $cft = $pdf\->corefont(\*(AqTimes\-Roman\*(Aq);
\&    #
\&    my $page = $pdf\->page();
\&    my $text = $page\->text();
\&    $text\->font($cft, 20);
\&    $text\->translate(200, 700);
\&    $text\->text("Hello, World!");
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&    $font = PDF::Builder::Resource::Font::CoreFont\->new($pdf, $fontname, %options)
.Ve
.Sp
.RS 4
Returns a corefont object.
.Sp
Valid \f(CW%options\fR are:
.IP "encode" 4
.IX Item "encode"
Changes the encoding of the font from its default.
See \fIperl's Encode\fR for the supported values. \fBWarning:\fR only single byte 
encodings are permitted. Multibyte encodings such as 'utf8' are forbidden.
.IP "pdfname" 4
.IX Item "pdfname"
Changes the reference-name of the font from its default.
The reference-name is normally generated automatically and can be
retrieved via \f(CW\*(C`$pdfname=$font\-\*(C'\fR\fBname()\fR>.
.RE
.RS 4
.RE
.SS "Supported typefaces"
.IX Subsection "Supported typefaces"
\&\fBstandard \s-1PDF\s0 types\fR
.IP "\(bu" 4
helvetica, helveticaoblique, helveticabold, helvetiaboldoblique
.Sp
May have Arial substituted on some systems (e.g., Windows)
.IP "\(bu" 4
courier, courieroblique, courierbold, courierboldoblique
.Sp
Fixed pitch, may have Courier New substituted on some systems (e.g., Windows)
.IP "\(bu" 4
timesroman, timesitalic, timesbold, timesbolditalic
.Sp
May have Times New Roman substituted on some systems (e.g., Windows)
.IP "\(bu" 4
symbol, zapfdingbats
.PP
\&\fBPrimarily Windows typefaces\fR
.IP "\(bu" 4
georgia, georgiaitalic, georgiabold, georgiabolditalic
.IP "\(bu" 4
verdana, verdanaitalic, verdanabold, verdanabolditalic
.IP "\(bu" 4
trebuchet, trebuchetitalic, trebuchetbold, trebuchetbolditalic
.IP "\(bu" 4
bankgothic, bankgothicitalic, bankgothicbold, bankgothicitalic
.Sp
Free versions of Bank Gothic are often only medium weight Roman (bankgothic).
.IP "\(bu" 4
webdings, wingdings
.PP
Keep in mind that only font metrics (widths) are provided with PDF::Builder;
the fonts themselves are provided by the reader's machine (often packaged
with the operating system, or obtained separately by the user). To use a
specific font may require you to obtain one or more files from some source.
.PP
If a font (typeface and variant) is not available on a given reader's
machine, a substitution \fImay\fR be automatically made. For example, Helvetica is
usually not shipped with Windows machines, and Arial might be substituted.
For most characters, the glyph widths will be the same, but this can not be 
guaranteed!
.PP
PDF::Builder currently uses the [typeface].pm files to map glyph names to
code points (single byte encodings only) and to look up the glyph widths for
character positioning. There is no guarantee that a given font file includes
all the desired glyphs, nor that the widths will be absolutely the same, even
in different releases of the same font.
.SS "is_standard"
.IX Subsection "is_standard"
.Vb 1
\&    $bool = $class\->is_standard($name)
.Ve
.Sp
.RS 4
Returns true if \f(CW$name\fR is an exact, case-sensitive match for one of the
standard font names shown above.
.RE
.SS "loadallfonts"
.IX Subsection "loadallfonts"
.Vb 1
\&    PDF::Builder::Resource::Font::CoreFont\->loadallfonts()
.Ve
.Sp
.RS 4
\&\*(L"Requires in\*(R" all fonts available as corefonts.
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Alfred Reibenschuh