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