1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_linguistic2_XProofreadingIterator_idl__ 28#define __com_sun_star_linguistic2_XProofreadingIterator_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35#include <com/sun/star/lang/IllegalArgumentException.idl> 36#endif 37 38#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__ 39#include <com/sun/star/text/XFlatParagraphIteratorProvider.idl> 40#endif 41 42#ifndef __com_sun_star_text_XFlatParagraph_idl__ 43#include <com/sun/star/text/XFlatParagraph.idl> 44#endif 45 46#ifndef __com_sun_star_lang_Locale_idl__ 47#include <com/sun/star/lang/Locale.idl> 48#endif 49 50#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__ 51#include <com/sun/star/linguistic2/ProofreadingResult.idl> 52#endif 53 54//============================================================================= 55 56module com { module sun { module star { module linguistic2 { 57 58//============================================================================= 59/** API for the proofreading iterator that mediates between the document and the proofreader. 60 61 @since OOo 3.0.1 62*/ 63interface XProofreadingIterator: com::sun::star::uno::XInterface 64{ 65 //------------------------------------------------------------------------- 66 /** start proofreading and automatically process the whole text 67 68 @param xDoc 69 the text document. 70 71 @param xIteratorProvider 72 the flat paragraph iterator provider. 73 74 @throws IllegalArgumentException 75 when any argument is wrong. 76 */ 77 void startProofreading( [in] com::sun::star::uno::XInterface xDocument, 78 [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider ) 79 raises( com::sun::star::lang::IllegalArgumentException ); 80 81 //------------------------------------------------------------------------- 82 /** start proofreading from a given position 83 84 @param xDoc 85 the document. 86 87 @param xStartPara 88 the single flat paragraph to be checked. 89 90 @param nErrorPosInPara 91 the given index. 92 93 @throws IllegalArgumentException 94 when any argument is wrong. 95 */ 96 97 ProofreadingResult checkSentenceAtPosition( [in] com::sun::star::uno::XInterface xDocument, 98 [in] com::sun::star::text::XFlatParagraph xFlatParagraph, 99 [in] string aText, 100 [in] com::sun::star::lang::Locale aLocale, 101 [in] long nStartOfSentencePosition, 102 [in] long nSuggestedBehindEndOfSentencePosition, 103 [in] long nErrorPositionInParagraph ) 104 raises( com::sun::star::lang::IllegalArgumentException ); 105 106 //------------------------------------------------------------------------- 107 /** clears the list of ignored rules for each prrofreader 108 */ 109 void resetIgnoreRules(); 110 111 //------------------------------------------------------------------------- 112 /** checks if the given document is currently being checked 113 114 @param xDoc 115 the document. 116 117 @returns 118 if the document is currently being checked. 119 */ 120 boolean isProofreading( [in] com::sun::star::uno::XInterface xDocument ); 121}; 122 123//============================================================================= 124 125}; }; }; }; 126 127#endif 128