<html> <head> <title>Interface XProofreader</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="XProofreader-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"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XProofreader</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XProofreader</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>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>API for proofreading a text </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.0.1</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="#isSpellChecker">isSpellChecker</a></td> <td class="imsum_right">whether is the text checked by the spellchecker </td> </tr> <tr> <td class="imsum_left"><a href="#doProofreading">doProofreading</a></td> <td class="imsum_right">start checking </td> </tr> <tr> <td class="imsum_left"><a href="#ignoreRule">ignoreRule</a></td> <td class="imsum_right">disables a specific rule for a given locale. </td> </tr> <tr> <td class="imsum_left"><a href="#resetIgnoreRules">resetIgnoreRules</a></td> <td class="imsum_right">sets all rules back to their default settings. </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="isSpellChecker" class="membertitle">isSpellChecker</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>isSpellChecker</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>whether is the text checked by the spellchecker </dd> <dt><b>Returns</b></dt> <dd>true if it is also a spell checker </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="doProofreading" class="membertitle">doProofreading</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="ProofreadingResult.html">ProofreadingResult</a></td> </tr> <tr> <td valign="top"><b>doProofreading</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aDocumentIdentifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aText,</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] long</td> <td valign="bottom"> nStartOfSentencePosition,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nSuggestedBehindEndOfSentencePosition,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</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>start checking </dd> <dt><b>Parameter nDocId</b></dt> <dd>the Document ID. </dd> <dt><b>Parameter rFlatParaText</b></dt> <dd>the flat text to be checked. </dd> <dt><b>Parameter xFlatPara</b></dt> <dd>the flat paragraph to be checked. </dd> <dt><b>Parameter aLocale</b></dt> <dd>Language used in the text. </dd> <dt><b>Parameter nStartOfSentencePos</b></dt> <dd>Start Index of the text. </dd> <dt><b>Parameter nSuggestedSentenceEndPos</b></dt> <dd>Probable end position of the text. </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException when any argument is wrong. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ignoreRule" class="membertitle">ignoreRule</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">void</td> </tr> <tr> <td valign="top"><b>ignoreRule</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aRuleIdentifier,</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 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>disables a specific rule for a given locale. </dd> <dd><p>If the locale is empty the rule should be ignored for all languages.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resetIgnoreRules" class="membertitle">resetIgnoreRules</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">void</td> </tr> <tr> <td valign="top"><b>resetIgnoreRules</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets all rules back to their default settings. </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
>
4243
