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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XProofreader.idl,v $
  10  * $Revision: 1.1.2.2 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_XProofreader_idl__
  31 #define __com_sun_star_linguistic2_XProofreader_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_Locale_idl__
  42 #include <com/sun/star/lang/Locale.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
  46 #include <com/sun/star/linguistic2/XSupportedLocales.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_text_XFlatParagraph_idl__
  50 #include <com/sun/star/text/XFlatParagraph.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__
  54 #include <com/sun/star/linguistic2/ProofreadingResult.idl>
  55 #endif
  56
  57 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
  58 #include <com/sun/star/beans/PropertyValue.idl>
  59 #endif
  60
  61 //=============================================================================
  62
  63 module com {  module sun {  module star {  module linguistic2 {
  64
  65 //=============================================================================
  66 /** API for proofreading a text
  67
  68     @since      OOo 3.0.1
  69 */
  70 interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
  71 {
  72
  73     //-------------------------------------------------------------------------
  74     /** whether is the text checked by the spellchecker
  75
  76         @returns true if it is also a spell checker
  77     */
  78     boolean isSpellChecker();
  79
  80     //-------------------------------------------------------------------------
  81     /** start checking
  82
  83         @param  nDocId
  84                 the Document ID.
  85
  86         @param  rFlatParaText
  87                 the flat text to be checked.
  88
  89         @param  xFlatPara
  90                 the flat paragraph to be checked.
  91
  92         @param  aLocale
  93                 Language used in the text.
  94
  95         @param  nStartOfSentencePos
  96                 Start Index of the text.
  97
  98         @param  nSuggestedSentenceEndPos
  99                 Probable end position of the text.
 100
 101         @throws IllegalArgumentException
 102                 when any argument is wrong.
 103     */
 104     ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
 105                             [in] string aText,
 106                             [in] com::sun::star::lang::Locale aLocale,
 107                             [in] long nStartOfSentencePosition,
 108                             [in] long nSuggestedBehindEndOfSentencePosition,
 109                             [in] sequence< com::sun::star::beans::PropertyValue > aProperties )
 110             raises( com::sun::star::lang::IllegalArgumentException );
 111
 112     //-------------------------------------------------------------------------
 113     /** disables a specific rule for a given locale.
 114
 115         <p>If the locale is empty the rule should be ignored for all languages.</p>
 116     */
 117     void ignoreRule( [in] string aRuleIdentifier,
 118                      [in] com::sun::star::lang::Locale aLocale )
 119             raises( com::sun::star::lang::IllegalArgumentException );
 120
 121     //-------------------------------------------------------------------------
 122     /** sets all rules back to their default settings.
 123     */
 124     void resetIgnoreRules();
 125
 126 };
 127
 128 //=============================================================================
 129
 130 }; }; }; };
 131
 132 #endif