<html> <head> <title>Interface XDictionaryEntry</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="XDictionaryEntry-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 XDictionaryEntry</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interfaces gives access to a dictionary entry. </dd> <dd><P>A dictionary entry can supply a word and its hyhenation and indicate if it is a negative word. If it is a negative entry it may supply a replacement text to be used instead of the entry word.</P> <P>Hyphenation positions are represented by an '=' in the word. If the '=' is the last character of the word this means it should not be hyphenated. If there is no '=' charcter in the word, hyphenation positions will be determined automatically (i.e., from the hyphenator service alone).</P> <P>Entries whose words only differ in hyphenation are considered to be equal. Also a '.' at the end of the word will make no difference.</P> </dd> <dt><b>See also</b></dt> <dd><a href="XDictionary.html">XDictionary</a>, ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</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="#getDictionaryWord">getDictionaryWord</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#isNegative">isNegative</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getReplacementText">getReplacementText</a></td> <td class="imsum_right">is the suggested replacement text for negative words. </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="getDictionaryWord" class="membertitle">getDictionaryWord</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>getDictionaryWord</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the word defining this entry. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isNegative" class="membertitle">isNegative</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>isNegative</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the word (entry) is a negative one and should not be used, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getReplacementText" class="membertitle">getReplacementText</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>getReplacementText</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is the suggested replacement text for negative words. </dd> <dd><p>It is undefined if the entry is not negative.</p> </dd> <dt><b>Returns</b></dt> <dd>the replacement text for a negative entry. An empty string indicates that no replacement text is provided. </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>