1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_XProofreadingIterator_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_linguistic2_XProofreadingIterator_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XFlatParagraphIteratorProvider.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XFlatParagraph_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XFlatParagraph.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_Locale_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/Locale.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__ 47*b1cdbd2cSJim Jagielski#include <com/sun/star/linguistic2/ProofreadingResult.idl> 48*b1cdbd2cSJim Jagielski#endif 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski//============================================================================= 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module linguistic2 { 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski//============================================================================= 55*b1cdbd2cSJim Jagielski/** API for the proofreading iterator that mediates between the document and the proofreader. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @since OpenOffice 3.0.1 58*b1cdbd2cSJim Jagielski*/ 59*b1cdbd2cSJim Jagielskiinterface XProofreadingIterator: com::sun::star::uno::XInterface 60*b1cdbd2cSJim Jagielski{ 61*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 62*b1cdbd2cSJim Jagielski /** start proofreading and automatically process the whole text 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski @param xDoc 65*b1cdbd2cSJim Jagielski the text document. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @param xIteratorProvider 68*b1cdbd2cSJim Jagielski the flat paragraph iterator provider. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @throws IllegalArgumentException 71*b1cdbd2cSJim Jagielski when any argument is wrong. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski void startProofreading( [in] com::sun::star::uno::XInterface xDocument, 74*b1cdbd2cSJim Jagielski [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider ) 75*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 78*b1cdbd2cSJim Jagielski /** start proofreading from a given position 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @param xDoc 81*b1cdbd2cSJim Jagielski the document. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @param xStartPara 84*b1cdbd2cSJim Jagielski the single flat paragraph to be checked. 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param nErrorPosInPara 87*b1cdbd2cSJim Jagielski the given index. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @throws IllegalArgumentException 90*b1cdbd2cSJim Jagielski when any argument is wrong. 91*b1cdbd2cSJim Jagielski */ 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski ProofreadingResult checkSentenceAtPosition( [in] com::sun::star::uno::XInterface xDocument, 94*b1cdbd2cSJim Jagielski [in] com::sun::star::text::XFlatParagraph xFlatParagraph, 95*b1cdbd2cSJim Jagielski [in] string aText, 96*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale, 97*b1cdbd2cSJim Jagielski [in] long nStartOfSentencePosition, 98*b1cdbd2cSJim Jagielski [in] long nSuggestedBehindEndOfSentencePosition, 99*b1cdbd2cSJim Jagielski [in] long nErrorPositionInParagraph ) 100*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException ); 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 103*b1cdbd2cSJim Jagielski /** clears the list of ignored rules for each prrofreader 104*b1cdbd2cSJim Jagielski */ 105*b1cdbd2cSJim Jagielski void resetIgnoreRules(); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 108*b1cdbd2cSJim Jagielski /** checks if the given document is currently being checked 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @param xDoc 111*b1cdbd2cSJim Jagielski the document. 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski @returns 114*b1cdbd2cSJim Jagielski if the document is currently being checked. 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski boolean isProofreading( [in] com::sun::star::uno::XInterface xDocument ); 117*b1cdbd2cSJim Jagielski}; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski//============================================================================= 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski}; }; }; }; 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski#endif 124