1PDF::Builder::Resource:U:sBearseCFoonnttr(i3b)uted PerlPDDoFc:u:mBeunitladteiro:n:Resource::BaseFont(3)
2
6 PDF::Builder::Resource::BaseFont - Base class for font resources
7
9 $font = PDF::Builder::Resource::BaseFont->new($pdf, $name)
10 Return a font resource object.
11 $descriptor = $font->descrByData()
13 Return the font's FontDescriptor key structure based on the font's
14 data.
15
17 $name = $font->fontname()
18 Return the font's name (a.k.a. display name).
19 $name = $font->altname()
21 Return the font's alternative name (a.k.a. Windows name for a
22 PostScript font).
23 $name = $font->subname()
25 Return the font's subname (a.k.a. font variant).
26 $name = $font->apiname()
28 Return the font's name to be used internally (should be equal to
29 $font->name()).
30 $issymbol = $font->issymbol()
32 Return the font's symbol flag (i.e., is this a symbol font).
33 $iscff = $font->iscff()
35 Return the font's Compact Font Format flag.
36
38 ($llx,$lly, $urx,$ury) = $font->fontbbox()
39 Return the font's bounding box.
40 $capheight = $font->capheight()
42 Return the font's capheight value.
43 $xheight = $font->xheight()
45 Return the font's xheight value.
46 $missingwidth = $font->missingwidth()
48 Return the font's missingwidth value.
49 $maxwidth = $font->maxwidth()
51 Return the font's maxwidth value.
52 $avgwidth = $font->avgwidth()
54 Return the font's avgwidth (average width) value.
55 $flags = $font->flags()
57 Return the font's flags value.
58 $stemv = $font->stemv()
60 Return the font's stemv value.
61 $stemh = $font->stemh()
63 Return the font's stemh value.
64 $italicangle = $font->italicangle()
66 Return the font's italicangle value.
67 $isfixedpitch = $font->isfixedpitch()
69 Return the font's isfixedpitch flag.
70 $underlineposition = $font->underlineposition()
72 Return the font's underlineposition value.
73 $underlinethickness = $font->underlinethickness()
75 Return the font's underlinethickness value.
76 $ascender = $font->ascender()
78 Return the font's ascender value.
79 $descender = $font->descender()
81 Return the font's descender value.
82
84 @names = $font->glyphNames()
85 Return the defined glyph names of the font.
86 $glNum = $font->glyphNum()
88 Return the number of defined glyph names of the font.
89 $uni = $font->uniByGlyph($char)
91 Return the unicode by glyph name.
92 $uni = $font->uniByEnc($char)
94 Return the Unicode by the font's encoding map.
95 $uni = $font->uniByMap($char)
97 Return the Unicode by the font's default map.
98 $char = $font->encByGlyph($glyph)
100 Return the character by the given glyph name of the font's encoding
101 map.
102 $char = $font->encByUni($uni)
104 Return the character by the given Unicode of the font's encoding
105 map.
106 $char = $font->mapByGlyph($glyph)
108 Return the character by the given glyph name of the font's default
109 map.
110 $char = $font->mapByUni($uni)
112 Return the character by the given Unicode of the font's default
113 map.
114 $name = $font->glyphByUni($unicode)
116 Return the glyph's name by the font's Unicode map. CAUTION: non-
117 standard glyph-names are mapped onto the ms-symbol area (0xF000).
118 $name = $font->glyphByEnc($char)
120 Return the glyph's name by the font's encoding map.
121 $name = $font->glyphByMap($char)
123 Return the glyph's name by the font's default map.
124 $width = $font->wxByGlyph($glyph)
126 Return the glyph's width. This is a value, that when divided by
127 1000 and multiplied by the font size (height in points), gives the
128 advance width to the next character's start. Typically, the width
129 will be under 1000.
130 $width = $font->wxByUni($uni)
132 Return the Unicode character's width. This is a value, that when
133 divided by 1000 and multiplied by the font size (height in points),
134 gives the advance width to the next character's start. Typically,
135 the width will be under 1000.
136 $width = $font->wxByEnc($char)
138 Return the character's width based on the current encoding. This
139 is a value, that when divided by 1000 and multiplied by the font
140 size (height in points), gives the advance width to the next
141 character's start. Typically, the width will be under 1000.
142 $flag = $font->wxMissingByEnc($char)
144 Return true if the character's width (based on the current
145 encoding) is supplied by "missing width" of font.
146 $width = $font->wxByMap($char)
148 Return the character's width based on the font's default encoding.
149 This is a value, that when divided by 1000 and multiplied by the
150 font size (height in points), gives the advance width to the next
151 character's start. Typically, the width will be under 1000.
152 $wd = $font->width($text)
154 Return the width of $text as if it were at size 1. CAUTION: works
155 correctly only if a proper Perl string is used, either in native or
156 UTF-8 format (check utf8-flag).
157 @widths = $font->width_array($text)
159 Return (as an array) the widths of the words in $text as if they
160 were at size 1.
161
163 $utf8string = $font->utfByStr($string)
164 Return the utf8-string from string based on the font's encoding
165 map.
166 $string = $font->strByUtf($utf8_string)
168 Return the encoded string from utf8-string based on the font's
169 encoding map.
170 $pdf_string = $font->textByStr($string)
172 Return a properly formatted representation of $string for use in
173 the PDF.
174 $pdf_string = $font->textByStrKern($string)
176 Return a properly formatted representation of $string, with
177 kerning, for use in the PDF.
178perl v5.36.0 2023-01-23PDF::Builder::Resource::BaseFont(3)