← Back to branch summary

~ubuntu-branches/ubuntu/wily/qtbase-opensource-src/wily

« back to all changes in this revision

Viewing changes to src/3rdparty/freetype/docs/reference/ft2-bdf_fonts.html

  • Committer: Package Import Robot
  • Author(s): Timo Jyrinki
  • Date: 2013-02-05 12:46:17 UTC
  • Revision ID: package-import@ubuntu.com-20130205124617-c8jouts182j002fx
Tags: upstream-5.0.1+dfsg
Import upstream version 5.0.1+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/3rdparty/freetype/docs/reference/ft2-bdf_fonts.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
 
2
"http://www.w3.org/TR/html4/loose.dtd">
 
3
<html>
 
4
<head>
 
5
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 
6
<title>FreeType-2.3.9 API Reference</title>
 
7
<style type="text/css">
 
8
  body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
 
9
         color: #000000;
 
10
         background: #FFFFFF; }
 
11
 
 
12
  p { text-align: justify; }
 
13
  h1 { text-align: center; }
 
14
  li { text-align: justify; }
 
15
  td { padding: 0 0.5em 0 0.5em; }
 
16
  td.left { padding: 0 0.5em 0 0.5em;
 
17
            text-align: left; }
 
18
 
 
19
  a:link { color: #0000EF; }
 
20
  a:visited { color: #51188E; }
 
21
  a:hover { color: #FF0000; }
 
22
 
 
23
  span.keyword { font-family: monospace;
 
24
                 text-align: left;
 
25
                 white-space: pre;
 
26
                 color: darkblue; }
 
27
 
 
28
  pre.colored { color: blue; }
 
29
 
 
30
  ul.empty { list-style-type: none; }
 
31
</style>
 
32
</head>
 
33
<body>
 
34
 
 
35
<table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td>
 
36
<td width="100%"></td>
 
37
<td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
38
<center><h1>FreeType-2.3.9 API Reference</h1></center>
 
39
 
 
40
<center><h1>
 
41
BDF and PCF Files
 
42
</h1></center>
 
43
<h2>Synopsis</h2>
 
44
<table align=center cellspacing=5 cellpadding=0 border=0>
 
45
<tr><td></td><td><a href="#FT_PropertyType">FT_PropertyType</a></td><td></td><td><a href="#BDF_PropertyRec">BDF_PropertyRec</a></td><td></td><td><a href="#FT_Get_BDF_Property">FT_Get_BDF_Property</a></td></tr>
 
46
<tr><td></td><td><a href="#BDF_Property">BDF_Property</a></td><td></td><td><a href="#FT_Get_BDF_Charset_ID">FT_Get_BDF_Charset_ID</a></td><td></td><td></td></tr>
 
47
</table><br><br>
 
48
 
 
49
<table align=center width="87%"><tr><td>
 
50
<p>This section contains the declaration of functions specific to BDF and PCF fonts.</p>
 
51
</td></tr></table><br>
 
52
<table align=center width="75%"><tr><td>
 
53
<h4><a name="FT_PropertyType">FT_PropertyType</a></h4>
 
54
<table align=center width="87%"><tr><td>
 
55
Defined in FT_BDF_H (freetype/ftbdf.h).
 
56
</td></tr></table><br>
 
57
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 
58
 
 
59
  <span class="keyword">typedef</span> <span class="keyword">enum</span>  BDF_PropertyType_
 
60
  {
 
61
    <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_NONE</a>     = 0,
 
62
    <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_ATOM</a>     = 1,
 
63
    <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_INTEGER</a>  = 2,
 
64
    <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_CARDINAL</a> = 3
 
65
 
 
66
  } BDF_PropertyType;
 
67
 
 
68
</pre></table><br>
 
69
<table align=center width="87%"><tr><td>
 
70
<p>A list of BDF property types.</p>
 
71
</td></tr></table><br>
 
72
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>values</b></em></td></tr><tr><td>
 
73
<p></p>
 
74
<table cellpadding=3 border=0>
 
75
<tr valign=top><td><b>BDF_PROPERTY_TYPE_NONE</b></td><td>
 
76
<p>Value&nbsp;0 is used to indicate a missing property.</p>
 
77
</td></tr>
 
78
<tr valign=top><td><b>BDF_PROPERTY_TYPE_ATOM</b></td><td>
 
79
<p>Property is a string atom.</p>
 
80
</td></tr>
 
81
<tr valign=top><td colspan=0><b>BDF_PROPERTY_TYPE_INTEGER</b></td></tr>
 
82
<tr valign=top><td></td><td>
 
83
<p>Property is a 32-bit signed integer.</p>
 
84
</td></tr>
 
85
<tr valign=top><td colspan=0><b>BDF_PROPERTY_TYPE_CARDINAL</b></td></tr>
 
86
<tr valign=top><td></td><td>
 
87
<p>Property is a 32-bit unsigned integer.</p>
 
88
</td></tr>
 
89
</table>
 
90
</td></tr></table>
 
91
</td></tr></table>
 
92
<hr width="75%">
 
93
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 
94
<td width="100%"></td>
 
95
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
96
 
 
97
<table align=center width="75%"><tr><td>
 
98
<h4><a name="BDF_Property">BDF_Property</a></h4>
 
99
<table align=center width="87%"><tr><td>
 
100
<p>A handle to a <a href="ft2-bdf_fonts.html#BDF_PropertyRec">BDF_PropertyRec</a> structure to model a given BDF/PCF property.</p>
 
101
</td></tr></table><br>
 
102
</td></tr></table>
 
103
<hr width="75%">
 
104
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 
105
<td width="100%"></td>
 
106
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
107
 
 
108
<table align=center width="75%"><tr><td>
 
109
<h4><a name="BDF_PropertyRec">BDF_PropertyRec</a></h4>
 
110
<table align=center width="87%"><tr><td>
 
111
Defined in FT_BDF_H (freetype/ftbdf.h).
 
112
</td></tr></table><br>
 
113
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 
114
 
 
115
  <span class="keyword">typedef</span> <span class="keyword">struct</span>  BDF_PropertyRec_
 
116
  {
 
117
    BDF_PropertyType  type;
 
118
    <span class="keyword">union</span> {
 
119
      <span class="keyword">const</span> <span class="keyword">char</span>*     atom;
 
120
      <a href="ft2-basic_types.html#FT_Int32">FT_Int32</a>        integer;
 
121
      <a href="ft2-basic_types.html#FT_UInt32">FT_UInt32</a>       cardinal;
 
122
 
 
123
    } u;
 
124
 
 
125
  } <b>BDF_PropertyRec</b>;
 
126
 
 
127
</pre></table><br>
 
128
<table align=center width="87%"><tr><td>
 
129
<p>This structure models a given BDF/PCF property.</p>
 
130
</td></tr></table><br>
 
131
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>fields</b></em></td></tr><tr><td>
 
132
<p></p>
 
133
<table cellpadding=3 border=0>
 
134
<tr valign=top><td><b>type</b></td><td>
 
135
<p>The property type.</p>
 
136
</td></tr>
 
137
<tr valign=top><td><b>u.atom</b></td><td>
 
138
<p>The atom string, if type is <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_ATOM</a>.</p>
 
139
</td></tr>
 
140
<tr valign=top><td><b>u.integer</b></td><td>
 
141
<p>A signed integer, if type is <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_INTEGER</a>.</p>
 
142
</td></tr>
 
143
<tr valign=top><td><b>u.cardinal</b></td><td>
 
144
<p>An unsigned integer, if type is <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_CARDINAL</a>.</p>
 
145
</td></tr>
 
146
</table>
 
147
</td></tr></table>
 
148
</td></tr></table>
 
149
<hr width="75%">
 
150
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 
151
<td width="100%"></td>
 
152
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
153
 
 
154
<table align=center width="75%"><tr><td>
 
155
<h4><a name="FT_Get_BDF_Charset_ID">FT_Get_BDF_Charset_ID</a></h4>
 
156
<table align=center width="87%"><tr><td>
 
157
Defined in FT_BDF_H (freetype/ftbdf.h).
 
158
</td></tr></table><br>
 
159
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 
160
 
 
161
  FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
 
162
  <b>FT_Get_BDF_Charset_ID</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>       face,
 
163
                         <span class="keyword">const</span> <span class="keyword">char</span>*  *acharset_encoding,
 
164
                         <span class="keyword">const</span> <span class="keyword">char</span>*  *acharset_registry );
 
165
 
 
166
</pre></table><br>
 
167
<table align=center width="87%"><tr><td>
 
168
<p>Retrieve a BDF font character set identity, according to the BDF specification.</p>
 
169
</td></tr></table><br>
 
170
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 
171
<p></p>
 
172
<table cellpadding=3 border=0>
 
173
<tr valign=top><td><b>face</b></td><td>
 
174
<p>A handle to the input face.</p>
 
175
</td></tr>
 
176
</table>
 
177
</td></tr></table>
 
178
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 
179
<p></p>
 
180
<table cellpadding=3 border=0>
 
181
<tr valign=top><td><b>acharset_encoding</b></td><td>
 
182
<p>Charset encoding, as a C&nbsp;string, owned by the face.</p>
 
183
</td></tr>
 
184
<tr valign=top><td><b>acharset_registry</b></td><td>
 
185
<p>Charset registry, as a C&nbsp;string, owned by the face.</p>
 
186
</td></tr>
 
187
</table>
 
188
</td></tr></table>
 
189
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 
190
<p>FreeType error code. 0&nbsp;means success.</p>
 
191
</td></tr></table>
 
192
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 
193
<p>This function only works with BDF faces, returning an error otherwise.</p>
 
194
</td></tr></table>
 
195
</td></tr></table>
 
196
<hr width="75%">
 
197
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 
198
<td width="100%"></td>
 
199
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
200
 
 
201
<table align=center width="75%"><tr><td>
 
202
<h4><a name="FT_Get_BDF_Property">FT_Get_BDF_Property</a></h4>
 
203
<table align=center width="87%"><tr><td>
 
204
Defined in FT_BDF_H (freetype/ftbdf.h).
 
205
</td></tr></table><br>
 
206
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 
207
 
 
208
  FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
 
209
  <b>FT_Get_BDF_Property</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>           face,
 
210
                       <span class="keyword">const</span> <span class="keyword">char</span>*       prop_name,
 
211
                       <a href="ft2-bdf_fonts.html#BDF_PropertyRec">BDF_PropertyRec</a>  *aproperty );
 
212
 
 
213
</pre></table><br>
 
214
<table align=center width="87%"><tr><td>
 
215
<p>Retrieve a BDF property from a BDF or PCF font file.</p>
 
216
</td></tr></table><br>
 
217
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 
218
<p></p>
 
219
<table cellpadding=3 border=0>
 
220
<tr valign=top><td><b>face</b></td><td>
 
221
<p>A handle to the input face.</p>
 
222
</td></tr>
 
223
<tr valign=top><td><b>name</b></td><td>
 
224
<p>The property name.</p>
 
225
</td></tr>
 
226
</table>
 
227
</td></tr></table>
 
228
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 
229
<p></p>
 
230
<table cellpadding=3 border=0>
 
231
<tr valign=top><td><b>aproperty</b></td><td>
 
232
<p>The property.</p>
 
233
</td></tr>
 
234
</table>
 
235
</td></tr></table>
 
236
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 
237
<p>FreeType error code. 0&nbsp;means success.</p>
 
238
</td></tr></table>
 
239
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 
240
<p>This function works with BDF <i>and</i> PCF fonts. It returns an error otherwise. It also returns an error if the property is not in the font.</p>
 
241
<p>A &lsquo;property&rsquo; is a either key-value pair within the STARTPROPERTIES ... ENDPROPERTIES block of a BDF font or a key-value pair from the &lsquo;info-&gt;props&rsquo; array within a &lsquo;FontRec&rsquo; structure of a PCF font.</p>
 
242
<p>Integer properties are always stored as &lsquo;signed&rsquo; within PCF fonts; consequently, <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_CARDINAL</a> is a possible return value for BDF fonts only.</p>
 
243
<p>In case of error, &lsquo;aproperty-&gt;type&rsquo; is always set to <a href="ft2-bdf_fonts.html#FT_PropertyType">BDF_PROPERTY_TYPE_NONE</a>.</p>
 
244
</td></tr></table>
 
245
</td></tr></table>
 
246
<hr width="75%">
 
247
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 
248
<td width="100%"></td>
 
249
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 
250
 
 
251
</body>
 
252
</html>