1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__
24#define __com_sun_star_linguistic2_ProofreadingResult_idl__
25
26#ifndef __com_sun_star_text_XFlatParagraph_idl__
27#include <com/sun/star/text/XFlatParagraph.idl>
28#endif
29
30#ifndef __com_sun_star_lang_Locale_idl__
31#include <com/sun/star/lang/Locale.idl>
32#endif
33
34#ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
35#include <com/sun/star/linguistic2/SingleProofreadingError.idl>
36#endif
37
38#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
39#include <com/sun/star/beans/PropertyValue.idl>
40#endif
41
42
43
44//=============================================================================
45
46module com {  module sun {  module star {  module linguistic2 {
47
48// forward declaration
49interface XProofreader;
50
51//=============================================================================
52/** holds the results from proofreading a sentence.
53
54	@since OpenOffice 3.0.1
55*/
56struct ProofreadingResult
57{
58    // the document ID
59    string aDocumentIdentifier;
60
61    // the paragraph that was checked
62    com::sun::star::text::XFlatParagraph xFlatParagraph;
63
64    // text that was checked (the paragraphs content may have changed meanwhile!)
65    string aText;
66
67    // language used for checking
68    com::sun::star::lang::Locale aLocale;
69
70    // the start of sentence position passed to the proofreader
71    long nStartOfSentencePosition;
72
73    // the end of sentence position found by the proofreader
74    // That is the index following the character terminating the sentence.
75    long nBehindEndOfSentencePosition;
76
77    // the start of the next sentence to be checked.
78    // Basically obtained by skipping all white spaces after the end of sentence position.
79    long nStartOfNextSentencePosition;
80
81    // the list of errors
82    sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors;
83
84    // a list of properties
85    sequence< com::sun::star::beans::PropertyValue > aProperties;
86
87    // reference to the specific proofreader implementation that reported the error
88    com::sun::star::linguistic2::XProofreader xProofreader;
89};
90
91//=============================================================================
92
93}; }; }; };
94
95#endif
96