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_SingleProofreadingError_idl__
24#define __com_sun_star_linguistic2_SingleProofreadingError_idl__
25
26#ifndef __com_sun_star_lang_Locale_idl__
27#include <com/sun/star/lang/Locale.idl>
28#endif
29
30#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module linguistic2 {
37
38//=============================================================================
39/** holds a single error found by the proofreader.
40
41	@since	OOo 3.0.1
42*/
43struct SingleProofreadingError
44{
45    // start index of the error text
46    // indicating the text to be replaced if suggestions are applied
47    long nErrorStart;
48
49    // the length of the error text
50    // indicating the text to be replaced if suggestions are applied
51    long nErrorLength;
52
53    // as in com.sun.star.text.TextMarkupType
54    long nErrorType;
55
56    // the id of the rule that this error is violating
57    string aRuleIdentifier;
58
59    // short error description text (usually to be displayed in context menu)
60    string aShortComment;
61
62    // full error description text (usually to be displayed in dialog)
63    string aFullComment;
64
65    // a list of correction suggestions
66    // Usually emtpy if only automatic checking was done.
67    sequence< string > aSuggestions;
68
69    // a list of properties
70    sequence< com::sun::star::beans::PropertyValue > aProperties;
71};
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78