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_ProofreadingResult_idl__
28#define __com_sun_star_linguistic2_ProofreadingResult_idl__
29
30#ifndef __com_sun_star_text_XFlatParagraph_idl__
31#include <com/sun/star/text/XFlatParagraph.idl>
32#endif
33
34#ifndef __com_sun_star_lang_Locale_idl__
35#include <com/sun/star/lang/Locale.idl>
36#endif
37
38#ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
39#include <com/sun/star/linguistic2/SingleProofreadingError.idl>
40#endif
41
42#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
43#include <com/sun/star/beans/PropertyValue.idl>
44#endif
45
46
47
48//=============================================================================
49
50module com {  module sun {  module star {  module linguistic2 {
51
52// forward declaration
53interface XProofreader;
54
55//=============================================================================
56/** holds the results from proofreading a sentence.
57
58	@since	OOo 3.0.1
59*/
60struct ProofreadingResult
61{
62    // the document ID
63    string aDocumentIdentifier;
64
65    // the paragraph that was checked
66    com::sun::star::text::XFlatParagraph xFlatParagraph;
67
68    // text that was checked (the paragraphs content may have changed meanwhile!)
69    string aText;
70
71    // language used for checking
72    com::sun::star::lang::Locale aLocale;
73
74    // the start of sentence position passed to the proofreader
75    long nStartOfSentencePosition;
76
77    // the end of sentence position found by the proofreader
78    // That is the index following the character terminating the sentence.
79    long nBehindEndOfSentencePosition;
80
81    // the start of the next sentence to be checked.
82    // Basically obtained by skipping all white spaces after the end of sentence position.
83    long nStartOfNextSentencePosition;
84
85    // the list of errors
86    sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors;
87
88    // a list of properties
89    sequence< com::sun::star::beans::PropertyValue > aProperties;
90
91    // reference to the specific proofreader implementation that reported the error
92    com::sun::star::linguistic2::XProofreader xProofreader;
93};
94
95//=============================================================================
96
97}; }; }; };
98
99#endif
100