LibreOffice
LibreOffice 7.2 SDK API Reference
SingleProofreadingError.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
20 #define __com_sun_star_linguistic2_SingleProofreadingError_idl__
21 
24 
25 
26 module com { module sun { module star { module linguistic2 {
27 
33 {
34  // start index of the error text
35  // indicating the text to be replaced if suggestions are applied
37 
38  // the length of the error text
39  // indicating the text to be replaced if suggestions are applied
41 
42  // as in com.sun.star.text.TextMarkupType
43  long nErrorType;
44 
45  // the id of the rule that this error is violating
47 
48  // short error description text (usually to be displayed in context menu)
49  string aShortComment;
50 
51  // full error description text (usually to be displayed in dialog)
52  string aFullComment;
53 
54  // a list of correction suggestions
55  // Usually empty if only automatic checking was done.
56  sequence< string > aSuggestions;
57 
58  // a list of properties
59  // <ul>
60  // <li>FullCommentURL: URL to a page providing more details on the
61  // error.</li>
62  // </ul>
63  sequence< com::sun::star::beans::PropertyValue > aProperties;
64 };
65 
66 
67 }; }; }; };
68 
69 #endif
70 
71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Definition: Ambiguous.idl:22
holds a single error found by the proofreader.
Definition: SingleProofreadingError.idl:33
string aRuleIdentifier
Definition: SingleProofreadingError.idl:46
long nErrorStart
Definition: SingleProofreadingError.idl:36
long nErrorType
Definition: SingleProofreadingError.idl:43
long nErrorLength
Definition: SingleProofreadingError.idl:40
string aFullComment
Definition: SingleProofreadingError.idl:52
string aShortComment
Definition: SingleProofreadingError.idl:49
sequence< com::sun::star::beans::PropertyValue > aProperties
Definition: SingleProofreadingError.idl:63
sequence< string > aSuggestions
Definition: SingleProofreadingError.idl:56