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
|
<!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> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <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::FontMetrics Class Reference</h1>A PangoFontMetrics C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="font_8hh-source.html">gfc/pango/font.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Pango::FontMetrics:
<p><center><img src="classGFC_1_1Pango_1_1FontMetrics.png" usemap="#GFC::Pango::FontMetrics_map" border="0" alt=""></center>
<map name="GFC::Pango::FontMetrics_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html" alt="GFC::G::Boxed" shape="rect" coords="0,112,153,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,153,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,153,24">
</map>
<a href="classGFC_1_1Pango_1_1FontMetrics-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="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1157_0">FontMetrics</a> (PangoFontMetrics *metrics)
<dl class="el"><dd class="mdescRight">Construct a new font metrics from an existing PangoFontMetrics. <a href="#z1157_0"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1157_1">FontMetrics</a> (PangoFontMetrics *metrics, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z5_0">copy</a>)
<dl class="el"><dd class="mdescRight">Construct a new font metrics from an existing PangoFontMetrics. <a href="#z1157_1"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1157_2">FontMetrics</a> (const <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#z1157_2"></a><br></dl><li><a class="anchor" name="z1157_3" doxytag="GFC::Pango::FontMetrics::~FontMetrics" ></a>
virtual <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1157_3">~FontMetrics</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> & <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1157_4">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#z1157_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1158_0" doxytag="GFC::Pango::FontMetrics::pango_font_metrics" ></a>
PangoFontMetrics * <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_0">pango_font_metrics</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoFontMetrics structure. <br></dl><li><a class="anchor" name="z1158_1" doxytag="GFC::Pango::FontMetrics::operator PangoFontMetrics *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_1">operator PangoFontMetrics *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> to a PangoFontMetrics pointer. <br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_2">get_ascent</a> () const
<dl class="el"><dd class="mdescRight">Returns the ascent from a font metrics structure. <a href="#z1158_2"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_3">get_descent</a> () const
<dl class="el"><dd class="mdescRight">Gets the descent from a font metrics structure. <a href="#z1158_3"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_4">get_approximate_char_width</a> () const
<dl class="el"><dd class="mdescRight">Gets the approximate character width for the font metrics structure. <a href="#z1158_4"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html#z1158_5">get_approximate_digit_width</a> () const
<dl class="el"><dd class="mdescRight">Gets the approximate digit width for the font metrics structure. <a href="#z1158_5"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoFontMetrics C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> structure holds the overall metric information for a font.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1157_0" doxytag="GFC::Pango::FontMetrics::FontMetrics" ></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::FontMetrics::FontMetrics </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoFontMetrics * </td>
<td class="mdname1" valign="top" nowrap> <em>metrics</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new font metrics from an existing PangoFontMetrics.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>metrics</em> </td><td>A pointer to a PangoFontMetrics.</td></tr>
</table>
</dl>
<br>
The <em>metrics</em> can be a newly created PangoFontMetrics or an existing PangoFontMetrics. The font metrics object created is a temporary object. It doesn't take over the ownership of PangoFontMetrics and PangoFontMetrics is not freed by the destructor. </td>
</tr>
</table>
<a class="anchor" name="z1157_1" doxytag="GFC::Pango::FontMetrics::FontMetrics" ></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::FontMetrics::FontMetrics </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoFontMetrics * </td>
<td class="mdname" nowrap> <em>metrics</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>copy</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new font metrics from an existing PangoFontMetrics.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>metrics</em> </td><td>A pointer to a PangoFontMetrics. </td></tr>
<tr><td></td><td valign=top><em>copy</em> </td><td>Whether the <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> object should make a copy of PangoFontMetrics or not.</td></tr>
</table>
</dl>
<br>
The <em>metrics</em> can be a newly created PangoFontMetrics or an existing PangoFontMetrics. If <em>copy</em> is true <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> will make a copy of PangoFontMetrics. If <em>copy</em> is false <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> wont make a copy but instead takes over the ownership of PangoFontMetrics. Either way, the destructor will free PangoFontMetrics when the <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> object is destroyed. This constructor is used by <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z6_0">G::Boxed::wrap()</a> to wrap PangoFontMetrics objects in a C++ wrapper. </td>
</tr>
</table>
<a class="anchor" name="z1157_2" doxytag="GFC::Pango::FontMetrics::FontMetrics" ></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::FontMetrics::FontMetrics </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>The source <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1158_4" doxytag="GFC::Pango::FontMetrics::get_approximate_char_width" ></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"> int GFC::Pango::FontMetrics::get_approximate_char_width </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the approximate character width for the font metrics structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The character width, in pango units. (1 point == PANGO_SCALE pango units.)</dd></dl>
<br>
This is merely a representative value useful, for example, for determining the initial size for a window. Actual characters in text will be wider and narrower than this. </td>
</tr>
</table>
<a class="anchor" name="z1158_5" doxytag="GFC::Pango::FontMetrics::get_approximate_digit_width" ></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"> int GFC::Pango::FontMetrics::get_approximate_digit_width </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the approximate digit width for the font metrics structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The digit width, in pango units. (1 point == PANGO_SCALE pango units.)</dd></dl>
<br>
This is merely a representative value useful, for example, for determining the initial size for a window. Actual digits in text can be wider and narrower than this. </td>
</tr>
</table>
<a class="anchor" name="z1158_2" doxytag="GFC::Pango::FontMetrics::get_ascent" ></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"> int GFC::Pango::FontMetrics::get_ascent </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the ascent from a font metrics structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The ascent, in pango units. (1 point == PANGO_SCALE pango units.)</dd></dl>
<br>
The ascent is the distance from the baseline to the logical top of a line of text. (The logical top may be above or below the top of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.) </td>
</tr>
</table>
<a class="anchor" name="z1158_3" doxytag="GFC::Pango::FontMetrics::get_descent" ></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"> int GFC::Pango::FontMetrics::get_descent </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the descent from a font metrics structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The descent, in pango units. (1 point == PANGO_SCALE pango units.)</dd></dl>
<br>
The descent is the distance from the baseline to the logical bottom of a line of text. (The logical bottom may be above or below the bottom of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.) </td>
</tr>
</table>
<a class="anchor" name="z1157_4" doxytag="GFC::Pango::FontMetrics::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_1FontMetrics.html">FontMetrics</a>& GFC::Pango::FontMetrics::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</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> </td><td>The source <a class="el" href="classGFC_1_1Pango_1_1FontMetrics.html">FontMetrics</a>. </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="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>
|