summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XGrammarCheckingIterator.idl
blob: cbf24953dd58354501a4a63cbb700a1e16286b16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XGrammarCheckingIterator.idl,v $
 * $Revision: 1.3 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_XGrammarCheckingIterator_idl__
#define __com_sun_star_linguistic2_XGrammarCheckingIterator_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
#include <com/sun/star/text/XFlatParagraphIteratorProvider.idl>
#endif

#ifndef __com_sun_star_text_XFlatParagraph_idl__
#include <com/sun/star/text/XFlatParagraph.idl>
#endif

#ifndef __com_sun_star_text_XTextDocument_idl__
#include <com/sun/star/text/XTextDocument.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module linguistic2 {

//=============================================================================
interface XGrammarCheckingIterator: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** start grammar checking and automatically process the whole text

        @param  xDoc
                the text document.

        @param  xIteratorProvider
                the flat paragraph iterator provider.

        @param  bAutomatic
                automatic grammar checking.

        @throws IllegalArgumentException
                when any argument is wrong.
    */
    void startGrammarChecking( [in] com::sun::star::uno::XInterface xDoc,
                               [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider,
                               [in] boolean bAutomatic )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** start grammar checking from one given position

        @param  xDoc
                the document.

        @param  xStartPara
                the single flat paragraph to be checked.

        @param  nPosInPara
                the given index.

        @throws IllegalArgumentException
                when any argument is wrong.
    */

    void checkGrammarAtPos( [in] com::sun::star::uno::XInterface xDoc,
                            [in] com::sun::star::text::XFlatParagraph xStartPara,
                            [in] long nPosInPara )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** get the sentence boundary

        @param  nSentenceStartPos
                the start index of the sentence.

        @returns
                the end position.

        @throws IllegalArgumentException
                when any argument is wrong.
    */
    long getEndOfSentence( [in] long nSentenceStartPos )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** checks if the given document is currently being checked

        @param  xDoc
                the document.

        @returns
                if the document is currently being checked.
    */
    boolean isChecking( [in] com::sun::star::uno::XInterface xDoc );
};

//=============================================================================

}; }; }; };

#endif