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 #ifndef __com_sun_star_linguistic2_XProofreader_idl__
  20 #define __com_sun_star_linguistic2_XProofreader_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/lang/Locale.idl>
  25 #include <com/sun/star/linguistic2/XSupportedLocales.idl>
  26 #include <com/sun/star/text/XFlatParagraph.idl>
  27 #include <com/sun/star/linguistic2/ProofreadingResult.idl>
  28 #include <com/sun/star/beans/PropertyValue.idl>
  29
  30
  31 module com {  module sun {  module star {  module linguistic2 {
  32
  33 /** API for proofreading a text
  34
  35     @since  OOo 3.0.1
  36 */
  37 interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
  38 {
  39
  40     /** whether is the text checked by the spell checker
  41
  42         @returns true if it is also a spell checker
  43     */
  44     boolean isSpellChecker();
  45
  46     /** start checking
  47
  48         @param  aDocumentIdentifier
  49                 the Document ID.
  50
  51         @param  aText
  52                 the flat text to be checked.
  53
  54         @param  aLocale
  55                 Language used in the text.
  56
  57         @param  nStartOfSentencePosition
  58                 Start Index of the text.
  59
  60         @param  nSuggestedBehindEndOfSentencePosition
  61                 Probable end position of the text.
  62
  63         @param  aProperties
  64                 additional properties of the text.
  65
  66                 Currently the following properties may be supported:
  67                 <table>
  68                     <tr>
  69                         <td>FieldPositions</td>
  70                         <td>sequence&lt;long&gt;</td>
  71                         <td>indexes of fields in aText</td>
  72                     </tr>
  73                     <tr>
  74                         <td>FootnotePositions</td>
  75                         <td>sequence&lt;long&gt;</td>
  76                         <td>indexes of footnotes in aText</td>
  77                     </tr>
  78                 </table>
  79
  80         @throws IllegalArgumentException
  81                 when any argument is wrong.
  82     */
  83     ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
  84                             [in] string aText,
  85                             [in] com::sun::star::lang::Locale aLocale,
  86                             [in] long nStartOfSentencePosition,
  87                             [in] long nSuggestedBehindEndOfSentencePosition,
  88                             [in] sequence< com::sun::star::beans::PropertyValue > aProperties )
  89             raises( com::sun::star::lang::IllegalArgumentException );
  90
  91     /** disables a specific rule for a given locale.
  92
  93         <p>If the locale is empty the rule should be ignored for all languages.</p>
  94     */
  95     void ignoreRule( [in] string aRuleIdentifier,
  96                      [in] com::sun::star::lang::Locale aLocale )
  97             raises( com::sun::star::lang::IllegalArgumentException );
  98
  99     /** sets all rules back to their default settings.
 100     */
 101     void resetIgnoreRules();
 102
 103 };
 104
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */