<html> <head> <title>Interface XSpellChecker</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="XSpellChecker-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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 XSpellChecker</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XSpellChecker</strong> ┗ <a href="XSupportedLocales.html">XSupportedLocales</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XSupportedLocales.html">XSupportedLocales</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Offers information about which languages are supported by the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface allows for spellchecking. </dd> <dd><P>It is possible to simply check if a word, in a specified language, is correct or additionally, if it was misspelled, some proposals how it might be correctly written.</P> </dd> <dt><b>See also</b></dt> <dd><a href="XSupportedLocales.html">XSupportedLocales</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="#isValid">isValid</a></td> <td class="imsum_right">checks if a word is spelled correctly in a given language. </td> </tr> <tr> <td class="imsum_left"><a href="#spell">spell</a></td> <td class="imsum_right">This method checks if a word is spelled correctly in a given language. </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="isValid" class="membertitle">isValid</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>isValid</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValues.html">PropertyValues</a></td> <td valign="bottom"> aProperties )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if a word is spelled correctly in a given language. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the word is spelled correctly using the specified language, <b>false</b> otherwise. </dd> <dt><b>Parameter aWord</b></dt> <dd>the word to be checked. </dd> <dt><b>Parameter aLocale</b></dt> <dd>the Locale (language) to be used. If the Locale is empty, the word is spelled correctly by definition. <P>If <var>aLocale</var> is not supported an IllegalArgumentException exception is raised.</P> </dd> <dt><b>Parameter aProperties</b></dt> <dd>provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. </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="spell" class="membertitle">spell</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="XSpellAlternatives.html">XSpellAlternatives</a></td> </tr> <tr> <td valign="top"><b>spell</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValues.html">PropertyValues</a></td> <td valign="bottom"> aProperties )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>This method checks if a word is spelled correctly in a given language. </dd> <dt><b>Returns</b></dt> <dd><b>NULL</b> if <var>aWord</var> is spelled correctly using <var>aLocale</var>. Otherwise, an XSpellAlternatives object with information about the reason of failure and, if available, proposals for spelling alternatives will be returned. </dd> <dt><b>Parameter aWord</b></dt> <dd>the word to be checked. </dd> <dt><b>Parameter aLocale</b></dt> <dd>the language to be used. <P>If the language is not supported an IllegalArgumentException exception is raised. </dd> <dt><b>Parameter aProperties</b></dt> <dd>provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. exception is raised.</P> </dd> <dt><b>See also</b></dt> <dd><a href="XSpellAlternatives.html">XSpellAlternatives</a>, ::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> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4255
