offapi/com/sun/star/linguistic2/XProofreadingIterator.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: XProofreadingIterator.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_XProofreadingIterator_idl__
  31 #define __com_sun_star_linguistic2_XProofreadingIterator_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_text_XFlatParagraphIteratorProvider_idl__
  42 #include <com/sun/star/text/XFlatParagraphIteratorProvider.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_text_XFlatParagraph_idl__
  46 #include <com/sun/star/text/XFlatParagraph.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_Locale_idl__
  50 #include <com/sun/star/lang/Locale.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__
  54 #include <com/sun/star/linguistic2/ProofreadingResult.idl>
  55 #endif
  56
  57 //=============================================================================
  58
  59 module com {  module sun {  module star {  module linguistic2 {
  60
  61 //=============================================================================
  62 /** API for the proofreading iterator that mediates between the document and the proofreader.
  63
  64     @since      OOo 3.0.1
  65 */
  66 interface XProofreadingIterator: com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69     /** start proofreading and automatically process the whole text
  70
  71         @param  xDoc
  72                 the text document.
  73
  74         @param  xIteratorProvider
  75                 the flat paragraph iterator provider.
  76
  77         @throws IllegalArgumentException
  78                 when any argument is wrong.
  79     */
  80     void startProofreading( [in] com::sun::star::uno::XInterface xDocument,
  81                     [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider )
  82             raises( com::sun::star::lang::IllegalArgumentException );
  83
  84     //-------------------------------------------------------------------------
  85     /** start proofreading from a given position
  86
  87         @param  xDoc
  88                 the document.
  89
  90         @param  xStartPara
  91                 the single flat paragraph to be checked.
  92
  93         @param  nErrorPosInPara
  94                 the given index.
  95
  96         @throws IllegalArgumentException
  97                 when any argument is wrong.
  98     */
  99
 100     ProofreadingResult checkSentenceAtPosition( [in] com::sun::star::uno::XInterface xDocument,
 101                     [in] com::sun::star::text::XFlatParagraph xFlatParagraph,
 102                     [in] string aText,
 103                     [in] com::sun::star::lang::Locale aLocale,
 104                     [in] long nStartOfSentencePosition,
 105                     [in] long nSuggestedBehindEndOfSentencePosition,
 106                     [in] long nErrorPositionInParagraph )
 107             raises( com::sun::star::lang::IllegalArgumentException );
 108
 109     //-------------------------------------------------------------------------
 110     /** clears the list of ignored rules for each prrofreader
 111     */
 112     void resetIgnoreRules();
 113
 114     //-------------------------------------------------------------------------
 115     /** checks if the given document is currently being checked
 116
 117         @param  xDoc
 118                 the document.
 119
 120         @returns
 121                 if the document is currently being checked.
 122     */
 123     boolean isProofreading( [in] com::sun::star::uno::XInterface xDocument );
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif