blob: 3d1fe3e7bce9f45b933cdcb6285f832b59e1a348 [file] [log] [blame]
<html>
<head>
<title>Struct FontRequest</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="FontRequest-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 FontRequest</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This structure contains all information necessary to describe a
font to be queried from XCanvas. </dd>
<dd><p>
Note: Outline fonts are to be requested as a special family, set
<a href="../rendering/FontInfo.html">FontInfo</a>::<a href="../rendering/FontInfo.html#FamilyName">FamilyName</a> appropriately. Emboss/relief
must be emulated by upper layers. <p>
Leave the <a href="../rendering/FontInfo.html">FontInfo</a>::<a href="../rendering/FontInfo.html#FamilyName">FamilyName</a> and
<a href="../rendering/FontInfo.html">FontInfo</a>::<a href="../rendering/FontInfo.html#StyleName">StyleName</a> empty, if font selection
should only happen via the PANOSE description.
</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="#FontDescription">FontDescription</a></td>
<td class="imsum_right">The description of the font. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#CellSize">CellSize</a></td>
<td class="imsum_right">The size of the font in <em>device </em>coordinate space. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#ReferenceAdvancement">ReferenceAdvancement</a></td>
<td class="imsum_right">This value specifies the size of the font in the writing
direction (i.e. width for horizontal writing, and height for
vertical writing). &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Locale">Locale</a></td>
<td class="imsum_right">The locale this font should be able to render. &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="FontDescription" class="membertitle">FontDescription</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="../rendering/FontInfo.html">FontInfo</a> <b>FontDescription</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The description of the font. </dd>
<dd><p>
This member contains the description of the font as returned
by the font listing methods. <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CellSize" class="membertitle">CellSize</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>CellSize</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The size of the font in <em>device </em>coordinate space. </dd>
<dd><p>
This value corresponds to the font height in Western scripts,
but is independent of the writing direction (see
<a href="../rendering/FontRequest.html">FontRequest</a>::<a href="../rendering/FontRequest.html#IsVertical">IsVertical</a> below). That
means, the value specified here is always measured orthogonal
to the text advancement (height for horizontal writing, and
width for vertical writing). <p>
When this value is negative, its absolute value is taken as
the character size of the font. If this value is positive,
it's taken as the cell size of the font. <p>
This member and the referenceAdvancement member are mutually
exclusive, one of them has to be set to 0 (which means don't
care). <p>
For distorted fonts, the render transformation must be
used. That is, the size specified here corresponds to device
pixel only if the combined render transformation during text
output equals the identity transform. This also applies to all
query methods, for both <a href="../rendering/XCanvasFont.html">XCanvasFont</a> and
<a href="../rendering/XTextLayout.html">XTextLayout</a> . <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ReferenceAdvancement" class="membertitle">ReferenceAdvancement</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>ReferenceAdvancement</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This value specifies the size of the font in the writing
direction (i.e. width for horizontal writing, and height for
vertical writing). </dd>
<dd><p>
It is equivalent to the referenceCharSize of the FontMetrics
structure. <p>
This member and the cellSize member are mutually exclusive,
one of them has to be set to 0 (which means don't care). For
distorted fonts, the font matrix must be used. <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Locale" class="membertitle">Locale</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::lang::Locale <b>Locale</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The locale this font should be able to render. </dd>
<dd><p>
This member supplements the
<a href="FontInfo.html">FontInfo</a>::<a href="FontInfo.html#UnicodeRange0">UnicodeRange0</a> entry with a specific
locale; this is e.g. important when selecting between
traditional and simplified chinese is necessary (since the
letters have the same unicode ranges and character values). <p>
</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>