~ubuntu-branches/ubuntu/feisty/pango1.0/feisty

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Coverage Maps</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="Pango Reference Manual">
<link rel="up" href="lowlevel.html" title="Low Level Functionality">
<link rel="prev" href="pango-OpenType-Font-Handling.html" title="OpenType Font Handling">
<link rel="next" href="pango-Engines.html" title="Engines">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="pango.html" title="Basic Pango Interfaces">
<link rel="chapter" href="rendering.html" title="Rendering with Pango">
<link rel="chapter" href="lowlevel.html" title="Low Level Functionality">
<link rel="chapter" href="tools.html" title="Pango Tools">
<link rel="chapter" href="pango-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 1.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 1.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 1.10">
<link rel="index" href="ix08.html" title="Index of new symbols in 1.12">
<link rel="index" href="ix09.html" title="Index of new symbols in 1.14">
<link rel="index" href="ix10.html" title="Index of new symbols in 1.16">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="pango-OpenType-Font-Handling.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="lowlevel.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Pango Reference Manual</th>
<td><a accesskey="n" href="pango-Engines.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2759699" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2759993" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="pango-Coverage-Maps"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2759699"></a><span class="refentrytitle">Coverage Maps</span>
</h2>
<p>Coverage Maps &#8212; Unicode character range coverage storage</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



enum        <a href="pango-Coverage-Maps.html#PangoCoverageLevel">PangoCoverageLevel</a>;
#define     <a href="pango-Coverage-Maps.html#PANGO-TYPE-COVERAGE-LEVEL:CAPS">PANGO_TYPE_COVERAGE_LEVEL</a>
            <a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>;

<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* <a href="pango-Coverage-Maps.html#pango-coverage-new">pango_coverage_new</a>           (void);
<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* <a href="pango-Coverage-Maps.html#pango-coverage-ref">pango_coverage_ref</a>           (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);
void        <a href="pango-Coverage-Maps.html#pango-coverage-unref">pango_coverage_unref</a>            (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);
<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* <a href="pango-Coverage-Maps.html#pango-coverage-copy">pango_coverage_copy</a>          (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);
<a href="pango-Coverage-Maps.html#PangoCoverageLevel">PangoCoverageLevel</a> <a href="pango-Coverage-Maps.html#pango-coverage-get">pango_coverage_get</a>       (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             int index_);
void        <a href="pango-Coverage-Maps.html#pango-coverage-max">pango_coverage_max</a>              (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             <a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *other);
void        <a href="pango-Coverage-Maps.html#pango-coverage-set">pango_coverage_set</a>              (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             int index_,
                                             <a href="pango-Coverage-Maps.html#PangoCoverageLevel">PangoCoverageLevel</a> level);
void        <a href="pango-Coverage-Maps.html#pango-coverage-to-bytes">pango_coverage_to_bytes</a>         (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             <a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"
>guchar</a> **bytes,
                                             int *n_bytes);
<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* <a href="pango-Coverage-Maps.html#pango-coverage-from-bytes">pango_coverage_from_bytes</a>    (<a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"
>guchar</a> *bytes,
                                             int n_bytes);

</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2759993"></a><h2>Description</h2>
<p>
It is often necessary in Pango to determine if a particular font can
represent a particular character, and also how well it can represent
that character. The <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a> is a data structure that is used
to represent that information.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2760019"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2760030"></a><h3>
<a name="PangoCoverageLevel"></a>enum PangoCoverageLevel</h3>
<a class="indexterm" name="id2760043"></a><pre class="programlisting">typedef enum {
  PANGO_COVERAGE_NONE,
  PANGO_COVERAGE_FALLBACK,
  PANGO_COVERAGE_APPROXIMATE,
  PANGO_COVERAGE_EXACT
} PangoCoverageLevel;
</pre>
<p>
Used to indicate how well a font can represent a particular Unicode
character point for a particular script.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="PANGO-COVERAGE-NONE:CAPS"></a><code class="literal">PANGO_COVERAGE_NONE</code></span></td>
<td>The character is not representable with the font.
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-COVERAGE-FALLBACK:CAPS"></a><code class="literal">PANGO_COVERAGE_FALLBACK</code></span></td>
<td>The character is represented in a way that may be
                          comprehensible but is not the correct graphical form.
                          For instance, a Hangul character represented as a
                          a sequence of Jamos, or a Latin transliteration of
                          a Cyrillic word.
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-COVERAGE-APPROXIMATE:CAPS"></a><code class="literal">PANGO_COVERAGE_APPROXIMATE</code></span></td>
<td>The character is represented as basically the correct
                             graphical form, but with a stylistic variant inappropriate for
                             the current script.
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-COVERAGE-EXACT:CAPS"></a><code class="literal">PANGO_COVERAGE_EXACT</code></span></td>
<td>The character is represented as the correct graphical form.

</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760167"></a><h3>
<a name="PANGO-TYPE-COVERAGE-LEVEL:CAPS"></a>PANGO_TYPE_COVERAGE_LEVEL</h3>
<a class="indexterm" name="id2760181"></a><pre class="programlisting">#define PANGO_TYPE_COVERAGE_LEVEL (pango_coverage_level_get_type())
</pre>
<p>
The <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> type for <a href="pango-Coverage-Maps.html#PangoCoverageLevel"><span class="type">PangoCoverageLevel</span></a>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760213"></a><h3>
<a name="PangoCoverage"></a>PangoCoverage</h3>
<a class="indexterm" name="id2760226"></a><pre class="programlisting">typedef struct _PangoCoverage PangoCoverage;</pre>
<p>
The <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a> structure represents a map from Unicode characters
to <a href="pango-Coverage-Maps.html#PangoCoverageLevel"><span class="type">PangoCoverageLevel</span></a>. It is an opaque structure with no public fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760260"></a><h3>
<a name="pango-coverage-new"></a>pango_coverage_new ()</h3>
<a class="indexterm" name="id2760274"></a><pre class="programlisting"><a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* pango_coverage_new           (void);</pre>
<p>
Create a new <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the newly allocated <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>,
              initialized to <a href="pango-Coverage-Maps.html#PANGO-COVERAGE-NONE:CAPS"><code class="literal">PANGO_COVERAGE_NONE</code></a>
              with a reference count of one, which
              should be freed with <a href="pango-Coverage-Maps.html#pango-coverage-unref"><code class="function">pango_coverage_unref()</code></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760353"></a><h3>
<a name="pango-coverage-ref"></a>pango_coverage_ref ()</h3>
<a class="indexterm" name="id2760366"></a><pre class="programlisting"><a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* pango_coverage_ref           (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);</pre>
<p>
Increase the reference count on the <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a> by one</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <em class="parameter"><code>coverage</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760449"></a><h3>
<a name="pango-coverage-unref"></a>pango_coverage_unref ()</h3>
<a class="indexterm" name="id2760462"></a><pre class="programlisting">void        pango_coverage_unref            (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);</pre>
<p>
Increase the reference count on the <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a> by one.
if the result is zero, free the coverage and all associated memory.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760531"></a><h3>
<a name="pango-coverage-copy"></a>pango_coverage_copy ()</h3>
<a class="indexterm" name="id2760544"></a><pre class="programlisting"><a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* pango_coverage_copy          (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage);</pre>
<p>
Copy an existing <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>. (This function may now be unnecessary
since we refcount the structure. File a bug if you use it.)</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the newly allocated <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>,
              with a reference count of one, which
              should be freed with <a href="pango-Coverage-Maps.html#pango-coverage-unref"><code class="function">pango_coverage_unref()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760643"></a><h3>
<a name="pango-coverage-get"></a>pango_coverage_get ()</h3>
<a class="indexterm" name="id2760657"></a><pre class="programlisting"><a href="pango-Coverage-Maps.html#PangoCoverageLevel">PangoCoverageLevel</a> pango_coverage_get       (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             int index_);</pre>
<p>
Determine whether a particular index is covered by <em class="parameter"><code>coverage</code></em></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>index_</code></em>&#160;:</span></td>
<td> the index to check
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the coverage level of <em class="parameter"><code>coverage</code></em> for character <em class="parameter"><code>index_</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760764"></a><h3>
<a name="pango-coverage-max"></a>pango_coverage_max ()</h3>
<a class="indexterm" name="id2760777"></a><pre class="programlisting">void        pango_coverage_max              (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             <a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *other);</pre>
<p>
Set the coverage for each index in <em class="parameter"><code>coverage</code></em> to be the max (better)
value of the current coverage for the index and the coverage for
the corresponding index in <em class="parameter"><code>other</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>other</code></em>&#160;:</span></td>
<td> another <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2760879"></a><h3>
<a name="pango-coverage-set"></a>pango_coverage_set ()</h3>
<a class="indexterm" name="id2760892"></a><pre class="programlisting">void        pango_coverage_set              (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             int index_,
                                             <a href="pango-Coverage-Maps.html#PangoCoverageLevel">PangoCoverageLevel</a> level);</pre>
<p>
Modify a particular index within <em class="parameter"><code>coverage</code></em></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>index_</code></em>&#160;:</span></td>
<td> the index to modify
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>level</code></em>&#160;:</span></td>
<td> the new level for <em class="parameter"><code>index_</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761004"></a><h3>
<a name="pango-coverage-to-bytes"></a>pango_coverage_to_bytes ()</h3>
<a class="indexterm" name="id2761017"></a><pre class="programlisting">void        pango_coverage_to_bytes         (<a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a> *coverage,
                                             <a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"
>guchar</a> **bytes,
                                             int *n_bytes);</pre>
<p>
Convert a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a> structure into a flat binary format</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>coverage</code></em>&#160;:</span></td>
<td> a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>bytes</code></em>&#160;:</span></td>
<td> location to store result (must be freed with <a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>n_bytes</code></em>&#160;:</span></td>
<td> location to store size of result
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2761137"></a><h3>
<a name="pango-coverage-from-bytes"></a>pango_coverage_from_bytes ()</h3>
<a class="indexterm" name="id2761151"></a><pre class="programlisting"><a href="pango-Coverage-Maps.html#PangoCoverage">PangoCoverage</a>* pango_coverage_from_bytes    (<a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Basic-Types.html#guchar"
>guchar</a> *bytes,
                                             int n_bytes);</pre>
<p>
Convert data generated from <code class="function">pango_converage_to_bytes()</code> back
to a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a></p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>bytes</code></em>&#160;:</span></td>
<td> binary data representing a <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>n_bytes</code></em>&#160;:</span></td>
<td> the size of <em class="parameter"><code>bytes</code></em> in bytes
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly allocated <a href="pango-Coverage-Maps.html#PangoCoverage"><span class="type">PangoCoverage</span></a>, or <a
href="/home/behdad/.local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if
              the data was invalid.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>