<html> <head> <title>Interface XHyphenatedWord</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="XHyphenatedWord-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">linguistic2</a> :: </p> </td> </tr> <tr> <td class="title">interface XHyphenatedWord</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>gives information obtained by a successful hyphenation attempt. </dd> <dd><P>This interface is used as a return value for some of the hyphenator functions.</P> </dd> <dt><b>See also</b></dt> <dd><a href="XHyphenator.html">XHyphenator</a></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="#getWord">getWord</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getLocale">getLocale</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getHyphenationPos">getHyphenationPos</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getHyphenatedWord">getHyphenatedWord</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getHyphenPos">getHyphenPos</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#isAlternativeSpelling">isAlternativeSpelling</a></td> <td class="imsum_right">is used to query if the hyphenation result is an alternative spelling. </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="getWord" class="membertitle">getWord</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">string</td> </tr> <tr> <td valign="top"><b>getWord</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the word that was hyphenated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocale" class="membertitle">getLocale</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">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>getLocale</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the language of the hyphenated word. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHyphenationPos" class="membertitle">getHyphenationPos</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">short</td> </tr> <tr> <td valign="top"><b>getHyphenationPos</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the position where hyphenation was applied in the word. <P>The value has to be in the range from 0 (after the first character) to n-2 (before the last character) where n is the length of the word.</P> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHyphenatedWord" class="membertitle">getHyphenatedWord</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">string</td> </tr> <tr> <td valign="top"><b>getHyphenatedWord</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the hyphenated word as it should be written (without the hyphen character). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHyphenPos" class="membertitle">getHyphenPos</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">short</td> </tr> <tr> <td valign="top"><b>getHyphenPos</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the position of the hyphen in the hyphenated word. <P>The value has to be in the range from 0 (after the first character) to m-2 (before the last character) where m is the length of the hyphenated word.</P> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isAlternativeSpelling" class="membertitle">isAlternativeSpelling</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">boolean</td> </tr> <tr> <td valign="top"><b>isAlternativeSpelling</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to query if the hyphenation result is an alternative spelling. </dd> <dd><p>A hyphenation result is an alternative spelling if the hyphenated word is different from the word that was hyphenated.</p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if it is an alternative spelling, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>