blob: 77ece342bd6f9a836f10dcf3b0069fb4ae653551 [file] [log] [blame]
<html>
<head>
<title>Interface XFont</title>
<style>h3 { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:1pt; }
p, dt, dd, pre { font-size:11pt; margin-top:3pt; margin-bottom:1pt; }
table.lightbg { background-color:#eeeeff; }
table.subtitle { margin-top:6pt; margin-bottom:6pt; }
td { font-size:11pt; }
td.title { font-family: Arial; font-size:19pt; font-weight:bold; text-align:center; background-color:#ccccff; line-height:30pt; }
td.subtitle { font-family: Arial; font-size:13pt; background-color:#ccccff; line-height:20pt; }
td.imdetail { width:100%; background-color:#eeeeff; }
a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; }
td.imsum_left { width:30%; }
td.imsum_right { width:70%; }
td.navimain, a.navimain { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; }
td.navimainself { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; color:#ffffff; background-color:#2222ad; }
td.navimainnone { text-align:center; font-family: Arial; font-size:12pt; }
td.attrtitle { font-weight:bold; background-color:#eeeeff; }
td.navisub, a.navisub, td.attrtitle, td.attrvalue { text-align:center; font-family: Arial; font-size:9pt; font-variant:small-caps; }
td.navimain, td.navisub { padding-left:7pt; padding-right:7pt; }
p.raise { font-size:11pt; margin-top:0pt; text-align:right; padding-right:5pt; }
a.navimain, a.navisub { color:#000000; }
.dt { font-weight:bold; }
.namechain { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:6pt; }
.tpl { font-size:13pt; margin-top:3pt; margin-bottom:6pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="3" class="lightbg">
<tr>
<td class="navimain"><a href="com/sun/star/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="XFont-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 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" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="module-ix.html" class="namechain">::</a> </p>
</td>
</tr>
<tr>
<td class="title">interface XFont</td>
</tr>
<tr>
<td/></tr>
<tr>
<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="#queryTextShapes">queryTextShapes</a></td>
<td class="imsum_right"> Extract the polygonal shapes of the given text. Each glyph is
represented by a separate polyPolygon in the returned sequence.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryTightMeasures">queryTightMeasures</a></td>
<td class="imsum_right"> Query the tight bounding boxes for every character in the
given text string. Tight bounding boxes means that for e.g. an
'a', the bounding box for the polyPolygon describing the glyph
'a' is returned, not the logical dimensions of the character
in the font.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryTextMeasures">queryTextMeasures</a></td>
<td class="imsum_right"> Query the logical bounding boxes of every character in the
given text string. Logical bounding boxes means the space that
the font allocates for the given character, which, e.g. for a
'.', might be significantly broader than the bounds returned
via queryTightMeasures.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryTextOffsets">queryTextOffsets</a></td>
<td class="imsum_right"> Query the offsets of the output corresponding to every
character in the given text string. The result of this method
can be directly fed into the XCanvas::drawOffsettedText
method.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryTextBounds">queryTextBounds</a></td>
<td class="imsum_right"> Similar to queryTextMeasures, only that the overall bounds are
returned by this method.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFontDescriptor">getFontDescriptor</a></td>
<td class="imsum_right"> Query the FontDescriptor that was used to generate this object.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFontMetrics">getFontMetrics</a></td>
<td class="imsum_right"/></tr>
<tr>
<td class="imsum_left"><a href="#getAssociatedCanvas">getAssociatedCanvas</a></td>
<td class="imsum_right"> Query the Canvas this font was generated from.
</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="queryTextShapes" class="membertitle">queryTextShapes</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; <a href="XPolyPolygon2D.html">XPolyPolygon2D</a> &gt;<br>
<b>queryTextShapes</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="StringContext.html">StringContext</a><br>
[in] <a href="ViewState.html">ViewState</a><br>
[in] <a href="RenderState.html">RenderState</a><br>
[in] <a href="TextDirection.html">TextDirection</a></td>
<td valign="top">&nbsp;<br>
text,<br>
viewState,<br>
renderState,<br>
direction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Extract the polygonal shapes of the given text. Each glyph is
represented by a separate polyPolygon in the returned sequence.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryTightMeasures" class="membertitle">queryTightMeasures</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; <a href="Rectangle2D.html">Rectangle2D</a> &gt;<br>
<b>queryTightMeasures</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="StringContext.html">StringContext</a><br>
[in] <a href="ViewState.html">ViewState</a><br>
[in] <a href="RenderState.html">RenderState</a><br>
[in] <a href="TextDirection.html">TextDirection</a></td>
<td valign="top">&nbsp;<br>
text,<br>
viewState,<br>
renderState,<br>
direction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the tight bounding boxes for every character in the
given text string. Tight bounding boxes means that for e.g. an
'a', the bounding box for the polyPolygon describing the glyph
'a' is returned, not the logical dimensions of the character
in the font.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryTextMeasures" class="membertitle">queryTextMeasures</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; <a href="Rectangle2D.html">Rectangle2D</a> &gt;<br>
<b>queryTextMeasures</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="StringContext.html">StringContext</a><br>
[in] <a href="ViewState.html">ViewState</a><br>
[in] <a href="RenderState.html">RenderState</a><br>
[in] <a href="TextDirection.html">TextDirection</a></td>
<td valign="top">&nbsp;<br>
text,<br>
viewState,<br>
renderState,<br>
direction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the logical bounding boxes of every character in the
given text string. Logical bounding boxes means the space that
the font allocates for the given character, which, e.g. for a
'.', might be significantly broader than the bounds returned
via queryTightMeasures.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryTextOffsets" class="membertitle">queryTextOffsets</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">sequence&lt; double &gt;<br>
<b>queryTextOffsets</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="StringContext.html">StringContext</a><br>
[in] <a href="ViewState.html">ViewState</a><br>
[in] <a href="RenderState.html">RenderState</a><br>
[in] <a href="TextDirection.html">TextDirection</a></td>
<td valign="top">&nbsp;<br>
text,<br>
viewState,<br>
renderState,<br>
direction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the offsets of the output corresponding to every
character in the given text string. The result of this method
can be directly fed into the XCanvas::drawOffsettedText
method.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryTextBounds" class="membertitle">queryTextBounds</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top"><a href="Rectangle2D.html">Rectangle2D</a><br>
<b>queryTextBounds</b>(</td>
<td valign="top">&nbsp;<br>
[in] <a href="StringContext.html">StringContext</a><br>
[in] <a href="ViewState.html">ViewState</a><br>
[in] <a href="RenderState.html">RenderState</a><br>
[in] <a href="TextDirection.html">TextDirection</a></td>
<td valign="top">&nbsp;<br>
text,<br>
viewState,<br>
renderState,<br>
direction );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Similar to queryTextMeasures, only that the overall bounds are
returned by this method.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFontDescriptor" class="membertitle">getFontDescriptor</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">FontDescriptor<br>
<b>getFontDescriptor</b>();</td>
<td valign="top">&nbsp;<br>
</td>
<td valign="top">&nbsp;<br>
</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the FontDescriptor 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" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">FontMetrics<br>
<b>getFontMetrics</b>();</td>
<td valign="top">&nbsp;<br>
</td>
<td valign="top">&nbsp;<br>
</td>
</tr>
</table>
<hr>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAssociatedCanvas" class="membertitle">getAssociatedCanvas</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top"><a href="XCanvas.html">XCanvas</a><br>
<b>getAssociatedCanvas</b>();</td>
<td valign="top">&nbsp;<br>
</td>
<td valign="top">&nbsp;<br>
</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Query the Canvas this font was generated from.
</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>
</body>
</html>