offapi/com/sun/star/linguistic2/XProofreader.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module linguistic2 {
  22
  23 /** API for proofreading a text
  24
  25     @since  OOo 3.0.1
  26 */
  27 interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
  28 {
  29
  30     /** whether is the text checked by the spell checker
  31
  32         @returns true if it is also a spell checker
  33     */
  34     boolean isSpellChecker();
  35
  36     /** start checking
  37
  38         @param  aDocumentIdentifier
  39                 the Document ID.
  40
  41         @param  aText
  42                 the flat text to be checked.
  43
  44         @param  aLocale
  45                 Language used in the text.
  46
  47         @param  nStartOfSentencePosition
  48                 Start Index of the text.
  49
  50         @param  nSuggestedBehindEndOfSentencePosition
  51                 Probable end position of the text.
  52
  53         @param  aProperties
  54                 additional properties of the text.
  55
  56                 Currently the following properties may be supported:
  57                 <table>
  58                     <tr>
  59                         <td>FieldPositions</td>
  60                         <td>sequence&lt;long&gt;</td>
  61                         <td>indexes of fields in aText</td>
  62                     </tr>
  63                     <tr>
  64                         <td>FootnotePositions</td>
  65                         <td>sequence&lt;long&gt;</td>
  66                         <td>indexes of footnotes in aText</td>
  67                     </tr>
  68                 </table>
  69
  70         @throws IllegalArgumentException
  71                 when any argument is wrong.
  72     */
  73     ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
  74                             [in] string aText,
  75                             [in] com::sun::star::lang::Locale aLocale,
  76                             [in] long nStartOfSentencePosition,
  77                             [in] long nSuggestedBehindEndOfSentencePosition,
  78                             [in] sequence< com::sun::star::beans::PropertyValue > aProperties )
  79             raises( com::sun::star::lang::IllegalArgumentException );
  80
  81     /** disables a specific rule for a given locale.
  82
  83         <p>If the locale is empty the rule should be ignored for all languages.</p>
  84     */
  85     void ignoreRule( [in] string aRuleIdentifier,
  86                      [in] com::sun::star::lang::Locale aLocale )
  87             raises( com::sun::star::lang::IllegalArgumentException );
  88
  89     /** sets all rules back to their default settings.
  90     */
  91     void resetIgnoreRules();
  92
  93 };
  94
  95
  96 }; }; }; };
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */