blob: 5acc378f327faf7a952abeb9256cdeb4d63f60a5 [file] [log] [blame]
<html>
<head>
<title>Interface XCanvasFont</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="XCanvasFont-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="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</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">interface XCanvasFont</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XCanvasFont</strong>
&#x2517 ::com::sun::star::uno::XInterface
</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::uno::XInterface</td>
<td class="imsum_right"><dl></dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>This interface provides access to a specific, XCanvas-dependent
font incarnation. This font is not universally usable, but belongs
to the XCanvas it was queried from.
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createTextLayout">createTextLayout</a></td>
<td class="imsum_right">Create a text layout interface. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFontRequest">getFontRequest</a></td>
<td class="imsum_right">Query the FontRequest that was used to generate this object.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFontMetrics">getFontMetrics</a></td>
<td class="imsum_right">Query metric information about the font, that is generic to
all its glyphs. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAvailableSizes">getAvailableSizes</a></td>
<td class="imsum_right">Query the list of available font sizes. &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getExtraFontProperties">getExtraFontProperties</a></td>
<td class="imsum_right">Query the list of additional font properties. &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="createTextLayout" class="membertitle">createTextLayout</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XTextLayout.html">XTextLayout</a></td>
</tr>
<tr>
<td valign="top"><b>createTextLayout</b>(</td>
<td valign="top">[in] <a href="StringContext.html">StringContext</a></td>
<td valign="bottom">&nbsp;aText,</td>
</tr>
<tr>
<td/><td valign="top">[in] byte</td>
<td valign="bottom">&nbsp;nDirection,</td>
</tr>
<tr>
<td/><td valign="top">[in] hyper</td>
<td valign="bottom">&nbsp;nRandomSeed );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Create a text layout interface. </dd>
<dd><p>
Create a text layout interface for the given string, using
this font to generate the glyphs from. <p>
</dd>
<dt><b>Parameter aText</b></dt>
<dd>The text to layout.
</dd>
<dt><b>Parameter nDirection</b></dt>
<dd>Main text direction for the string specified. The main text
direction is e.g. important for characters that are not
strong, i.e. that change affinity according to the current
writing direction. Make sure that across text portions and
lines, the direction is set consistently.
</dd>
<dt><b>Parameter nRandomSeed</b></dt>
<dd>Optional random seed for OpenType glyph variations.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFontRequest" class="membertitle">getFontRequest</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="FontRequest.html">FontRequest</a></td>
</tr>
<tr>
<td valign="top"><b>getFontRequest</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the FontRequest that was used to generate this object.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFontMetrics" class="membertitle">getFontMetrics</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="FontMetrics.html">FontMetrics</a></td>
</tr>
<tr>
<td valign="top"><b>getFontMetrics</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query metric information about the font, that is generic to
all its glyphs. </dd>
<dd><p>
Note that the metric values in the returned result are in the
font coordinate system, i.e. relative to the corresponding
size of this font. That is, when this font was created with a
cell size of 20 units, the metrics returned are calculated
relative to this size.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAvailableSizes" class="membertitle">getAvailableSizes</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; double &gt;</td>
</tr>
<tr>
<td valign="top"><b>getAvailableSizes</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the list of available font sizes. </dd>
<dd><p>
This method queries the list of available font sizes (in
device units) for this font. For scalable fonts that are not
restricted to discrete sizes, this list is <em>empty </em>,
meaning that every size is possible. Fonts that <em>do </em>
restrict the device size to certain discrete values, setting
an overall transformation that scales the
<a href="FontRequest.html">FontRequest</a>::<a href="FontRequest.html#CellSize">CellSize</a> to something not
contained in the list returned by this method can lead to
visible disturbances. <p>
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getExtraFontProperties" class="membertitle">getExtraFontProperties</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::beans::PropertyValue &gt;</td>
</tr>
<tr>
<td valign="top"><b>getExtraFontProperties</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the list of additional font properties. </dd>
<dd><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>