File: classGFC_1_1Pango_1_1Font.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 (347 lines) | stat: -rw-r--r-- 17,157 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
<!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::Font Class Reference</h1>A PangoFont C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="font_8hh-source.html">gfc/pango/font.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Pango::Font:
<p><center><img src="classGFC_1_1Pango_1_1Font.png" usemap="#GFC::Pango::Font_map" border="0" alt=""></center>
<map name="GFC::Pango::Font_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Pango_1_1Font-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="z1168_0" doxytag="GFC::Pango::Font::~Font" ></a>
virtual <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1168_0">~Font</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1169_0" doxytag="GFC::Pango::Font::pango_font" ></a>
PangoFont * <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_0">pango_font</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoFont structure. <br></dl><li><a class="anchor" name="z1169_1" doxytag="GFC::Pango::Font::operator PangoFont *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_1">operator PangoFont *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> to a PangoFont pointer. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> &gt; <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_2">describe</a> () const
<dl class="el"><dd class="mdescRight">Returns a description of the font.  <a href="#z1169_2"></a><br></dl><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_1Font.html#z1169_3">get_coverage</a> (PangoLanguage *language) const
<dl class="el"><dd class="mdescRight">Computes the coverage map for a given font and language tag.  <a href="#z1169_3"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> &gt; <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_4">get_metrics</a> (PangoLanguage *language=0) const
<dl class="el"><dd class="mdescRight">Gets overall metric information for a font.  <a href="#z1169_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_5">get_glyph_extents</a> (<a class="el" href="namespaceGFC_1_1Pango.html#a116">Glyph</a> glyph, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *ink_rect, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *logical_rect) const
<dl class="el"><dd class="mdescRight">Gets the logical and ink extents of a glyph within a font.  <a href="#z1169_5"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>PangoEngineShape * <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1170_0">find_shaper</a> (unsigned int character_code, PangoLanguage *language)
<dl class="el"><dd class="mdescRight">Finds the best matching shaper for a font for a particular language tag and character point.  <a href="#z1170_0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Pango_1_1Font.html#z1167_0">Font</a> (PangoFont *font, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> from an existing PangoFont.  <a href="#z1167_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoFont C++ wrapper class. 
<p>
<a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> is used to represent a font in a rendering-system-independent matter. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z1167_0" doxytag="GFC::Pango::Font::Font" ></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::Font::Font           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PangoFont *&nbsp;</td>
          <td class="mdname" nowrap> <em>font</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [explicit, protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> from an existing PangoFont. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>font</em>&nbsp;</td><td>A pointer to a PangoFont. </td></tr>
    <tr><td></td><td valign=top><em>owns_reference</em>&nbsp;</td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
  </table>
</dl>
<br>
The <em>font</em> can be a newly created PangoFont or an existing PangoFont. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>).     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1169_2" doxytag="GFC::Pango::Font::describe" ></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_1FontDescription.html">FontDescription</a>&gt; GFC::Pango::Font::describe           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </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>
Returns a description of the font. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a newly-allocated <a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> object. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1170_0" doxytag="GFC::Pango::Font::find_shaper" ></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"> PangoEngineShape* GFC::Pango::Font::find_shaper           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>character_code</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>PangoLanguage *&nbsp;</td>
          <td class="mdname" nowrap> <em>language</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>
Finds the best matching shaper for a font for a particular language tag and character point. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>character_code</em>&nbsp;</td><td>The ISO-10646 character code. </td></tr>
    <tr><td></td><td valign=top><em>language</em>&nbsp;</td><td>The language tag. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The best matching shaper. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1169_3" doxytag="GFC::Pango::Font::get_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"> <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::Font::get_coverage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PangoLanguage *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>language</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>
Computes the coverage map for a given font and language tag. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>language</em>&nbsp;</td><td>The language tag. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a newly-allocated <a class="el" href="classGFC_1_1Pango_1_1Coverage.html">Coverage</a> object. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1169_5" doxytag="GFC::Pango::Font::get_glyph_extents" ></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::Font::get_glyph_extents           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Pango.html#a116">Glyph</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>glyph</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>ink_rect</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>logical_rect</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the logical and ink extents of a glyph within a font. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>glyph</em>&nbsp;</td><td>The glyph index. </td></tr>
    <tr><td></td><td valign=top><em>ink_rect</em>&nbsp;</td><td>The rectangle used to store the extents of the glyph as drawn, or null to indicate that the result is not needed. </td></tr>
    <tr><td></td><td valign=top><em>logical_rect</em>&nbsp;</td><td>The rectangle used to store the logical extents of the glyph, or null to indicate that the result is not needed.</td></tr>
  </table>
</dl>
<br>
The coordinate system for each rectangle has its origin at the base line and horizontal origin of the character with increasing coordinates extending to the right and down. The macros PANGO_ASCENT(), PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING can be used to convert from the extents rectangle to more traditional font metrics. The units of the rectangles are in 1/PANGO_SCALE of a device unit.     </td>
  </tr>
</table>
<a class="anchor" name="z1169_4" doxytag="GFC::Pango::Font::get_metrics" ></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_1FontMetrics.html">FontMetrics</a>&gt; GFC::Pango::Font::get_metrics           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PangoLanguage *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>language</em> = <code>0</code>          </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>
Gets overall metric information for a font. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>language</em>&nbsp;</td><td>The language tag used to determine which script to get the metrics for, or null to indicate to get the metrics for the entire font. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> object.</dd></dl>
<br>
Since the metrics may be substantially different for different scripts, a language tag can be provided to indicate that the metrics should be retrieved that correspond to the script(s) used by that language.     </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="font_8hh-source.html">font.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>