File: classGFC_1_1Pango_1_1Coverage.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (414 lines) | stat: -rw-r--r-- 18,699 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="content-type">
  <title>GTK+ Foundation Classes</title>
  <link href="gfc.css" rel="stylesheet" type="text/css">
  <meta content="The GFC Development Team" name="author">
  <meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
 alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
 border="0" cellpadding="0" cellspacing="0">
  <tbody>
    <tr>
      <td
 style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
 alt="GFC Logo" src="../images/gfc.png"
 style="width: 207px; height: 92px;"></td>
      <td
 style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
 alt="GFC Title Logo" src="../images/gfc-title.png"
 style="width: 418px; height: 76px;"><br>
      </td>
    </tr>
    <tr>
      <td
 style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
 style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
      </td>
      <td
 style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
 style="font-family: helvetica,arial,sans-serif;"><a
 href="../html/index.html">Main Page</a>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <a
 href="../html/files.html">File List</a></small><br>
      </td>
    </tr>
  </tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Pango::Coverage Class Reference</h1>A PangoCoverage C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="coverage_8hh-source.html">gfc/pango/coverage.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Pango::Coverage:
<p><center><img src="classGFC_1_1Pango_1_1Coverage.png" usemap="#GFC::Pango::Coverage_map" border="0" alt=""></center>
<map name="GFC::Pango::Coverage_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,142,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,142,24">
</map>
<a href="classGFC_1_1Pango_1_1Coverage-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z1151_0" doxytag="GFC::Pango::Coverage::Coverage" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1151_0">Coverage</a> ()
<dl class="el"><dd class="mdescRight">Construct a new coverage object, initialized to COVERAGE_NONE. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1151_1">Coverage</a> (PangoCoverage *coverage)
<dl class="el"><dd class="mdescRight">Construct a new coverage from an existing PangoCoverage.  <a href="#z1151_1"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1151_2">Coverage</a> (const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;src)
<dl class="el"><dd class="mdescRight">Copy constructor.  <a href="#z1151_2"></a><br></dl><li><a class="anchor" name="z1151_3" doxytag="GFC::Pango::Coverage::~Coverage" ></a>
virtual <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1151_3">~Coverage</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp; <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1151_4">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;src)
<dl class="el"><dd class="mdescRight">Assignment operator.  <a href="#z1151_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1152_0" doxytag="GFC::Pango::Coverage::pango_coverage" ></a>
PangoCoverage * <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1152_0">pango_coverage</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoCoverage structure. <br></dl><li><a class="anchor" name="z1152_1" doxytag="GFC::Pango::Coverage::operator PangoCoverage *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1152_1">operator PangoCoverage *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> to a PangoCoverage pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Pango.html#a135">CoverageLevel</a> <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1152_2">get</a> (int index) const
<dl class="el"><dd class="mdescRight">Determine whether a particular index is covered by coverage.  <a href="#z1152_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1153_0">set</a> (int index, <a class="el" href="namespaceGFC_1_1Pango.html#a135">CoverageLevel</a> level)
<dl class="el"><dd class="mdescRight">Modify a particular index within the coverage.  <a href="#z1153_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1153_1">max</a> (const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;other)
<dl class="el"><dd class="mdescRight">Set the coverage for each index in <em>other</em> to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in <em>other</em>.  <a href="#z1153_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1153_2">to_bytes</a> (unsigned char **bytes, int *n_bytes)
<dl class="el"><dd class="mdescRight">Convert the coverage into a flat binary format.  <a href="#z1153_2"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &gt; <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#e0">from_bytes</a> (unsigned char *bytes, int n_bytes)
<dl class="el"><dd class="mdescRight">Convert data generated from <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1153_2">to_bytes()</a> back to a <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> object.  <a href="#e0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoCoverage C++ wrapper class. 
<p>
It is often necessary in <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> to determine if a particular font can represent a particular character, and also how well it can represent that character. The <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> object is used to represent that information. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z1151_1" doxytag="GFC::Pango::Coverage::Coverage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> GFC::Pango::Coverage::Coverage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PangoCoverage *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>coverage</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [explicit]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new coverage from an existing PangoCoverage. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>coverage</em>&nbsp;</td><td>A PangoCoverage.</td></tr>
  </table>
</dl>
<br>
<a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> references the PangoCoverage and releases the reference when it's no longer required.     </td>
  </tr>
</table>
<a class="anchor" name="z1151_2" doxytag="GFC::Pango::Coverage::Coverage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> GFC::Pango::Coverage::Coverage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Copy constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>The source coverage. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="GFC::Pango::Coverage::from_bytes" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a>&gt; GFC::Pango::Coverage::from_bytes           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>n_bytes</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Convert data generated from <a class="el" href="classGFC_1_1Pango_1_1Coverage.html#z1153_2">to_bytes()</a> back to a <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>bytes</em>&nbsp;</td><td>A binary data representing a <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> object. </td></tr>
    <tr><td></td><td valign=top><em>n_bytes</em>&nbsp;</td><td>The size of <em>bytes</em> in bytes. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a newly allocated coverage, or null if the data was invalid. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1152_2" doxytag="GFC::Pango::Coverage::get" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Pango.html#a135">CoverageLevel</a> GFC::Pango::Coverage::get           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine whether a particular index is covered by coverage. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>index</em>&nbsp;</td><td>The index to check. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="namespaceGFC_1_1Pango.html#a135">Pango::CoverageLevel</a> for index. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1153_1" doxytag="GFC::Pango::Coverage::max" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void GFC::Pango::Coverage::max           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>other</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the coverage for each index in <em>other</em> to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in <em>other</em>. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>other</em>&nbsp;</td><td>Another coverage object. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1151_4" doxytag="GFC::Pango::Coverage::operator=" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a>&amp; GFC::Pango::Coverage::operator=           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Assignment operator. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>The source coverage. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1153_0" doxytag="GFC::Pango::Coverage::set" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void GFC::Pango::Coverage::set           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>index</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="namespaceGFC_1_1Pango.html#a135">CoverageLevel</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>level</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Modify a particular index within the coverage. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>index</em>&nbsp;</td><td>The index to modify. </td></tr>
    <tr><td></td><td valign=top><em>level</em>&nbsp;</td><td>The new level for <em>index</em>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1153_2" doxytag="GFC::Pango::Coverage::to_bytes" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void GFC::Pango::Coverage::to_bytes           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char **&nbsp;</td>
          <td class="mdname" nowrap> <em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int *&nbsp;</td>
          <td class="mdname" nowrap> <em>n_bytes</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Convert the coverage into a flat binary format. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>bytes</em>&nbsp;</td><td>The location to store result (must be freed with g_free()). </td></tr>
    <tr><td></td><td valign=top><em>n_bytes</em>&nbsp;</td><td>The location to store size of <em>bytes</em>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="coverage_8hh-source.html">coverage.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:45 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>