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