blob: ecd7fd69091ffbfc4e45039510168074ff39b944 [file] [log] [blame]
<html>
<head>
<title>Struct FontMetrics</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a>
<table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="FontMetrics-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#Elements" class="navisub">Elements' Summary</a></td>
<td class="navisub"><a href="#ElementDetails" class="navisub">Elements' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">struct FontMetrics</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Metrics global to the font, i.e. not specific to single
glyphs. The font height is defined as
ascent+descent+internalLeading, and therefore not explicitely
included here. </dd>
<dd><p>
Please note that when querying FontMetrics from an XCanvasFont
interface, all values here are given relative to the font cell
size. That means, the referenceCharWidth and/or
ascent+descent+internalLeading will approximately (rounded to
integer device resolution, or exactly, if fractional font
rendering is enabled) match the referenceAdvancement/cellSize
members of the FontRequest for which the XCanvasFont was
queried. Please be aware that the values returned in this
structure only map one-to-one to device pixel, if the combined
rendering transformation for text output equals the identity
transformation. Otherwise, the text output (and thus the resulting
metrics) will be subject to that transformation. Depending on the
underlying font technology, actual device output might be off by
up to one device pixel from the transformed metrics.
</dd>
<dt><b>Since </b></dt>
<dd>OOo 2.0.0 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Elements' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Ascent">Ascent</a></td>
<td class="imsum_right">Ascent (above the baseline) part of the font. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Descent">Descent</a></td>
<td class="imsum_right">Descent (below the baseline) part of the font. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#InternalLeading">InternalLeading</a></td>
<td class="imsum_right">Extra space above ascent &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ExternalLeading">ExternalLeading</a></td>
<td class="imsum_right">Extra space outside the font cells. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ReferenceCharSize">ReferenceCharSize</a></td>
<td class="imsum_right">This value specifies the reference character width of the
font. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#UnderlineOffset">UnderlineOffset</a></td>
<td class="imsum_right">Specifies the offset to be added to the baseline when drawing
underlined text.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#StrikeThroughOffset">StrikeThroughOffset</a></td>
<td class="imsum_right">Specifies the offset to be added to the baseline when striking
through the text.
&nbsp;</td>
</tr>
</table>
<a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Elements' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="Ascent" class="membertitle">Ascent</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>Ascent</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Ascent (above the baseline) part of the font. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Descent" class="membertitle">Descent</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>Descent</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Descent (below the baseline) part of the font. </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="InternalLeading" class="membertitle">InternalLeading</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>InternalLeading</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Extra space above ascent </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ExternalLeading" class="membertitle">ExternalLeading</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>ExternalLeading</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Extra space outside the font cells. </dd>
<dd><p>
It should not contain ink marks and is typically used
by the font designer to modify the line distance. <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ReferenceCharSize" class="membertitle">ReferenceCharSize</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>ReferenceCharSize</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This value specifies the reference character width of the
font. </dd>
<dd><p>
It's roughly equivalent to the average width of all
characters, and if one needs a font with double character
width, the referenceCharSize should be doubled. <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="UnderlineOffset" class="membertitle">UnderlineOffset</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>UnderlineOffset</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies the offset to be added to the baseline when drawing
underlined text.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="StrikeThroughOffset" class="membertitle">StrikeThroughOffset</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>StrikeThroughOffset</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies the offset to be added to the baseline when striking
through the text.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>