LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21module com { module sun { module star { module linguistic2 {
22
27 struct SingleProofreadingError
28{
29 // start index of the error text
30 // indicating the text to be replaced if suggestions are applied
31 long nErrorStart;
32
33 // the length of the error text
34 // indicating the text to be replaced if suggestions are applied
35 long nErrorLength;
36
37 // as in com.sun.star.text.TextMarkupType
38 long nErrorType;
39
40 // the id of the rule that this error is violating
41 string aRuleIdentifier;
42
43 // short error description text (usually to be displayed in context menu)
44 string aShortComment;
45
46 // full error description text (usually to be displayed in dialog)
47 string aFullComment;
48
49 // a list of correction suggestions
50 // Usually empty if only automatic checking was done.
51 sequence< string > aSuggestions;
52
53 // a list of properties
54 // <ul>
55 // <li>FullCommentURL: URL to a page providing more details on the
56 // error.</li>
57 // </ul>
58 sequence< com::sun::star::beans::PropertyValue > aProperties;
59};
60
61
62}; }; }; };
63
64/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com
Definition Ambiguous.idl:20
com::sun::star::linguistic2::SingleProofreadingError
holds a single error found by the proofreader.
Definition SingleProofreadingError.idl:28
com::sun::star::linguistic2::SingleProofreadingError::aRuleIdentifier
string aRuleIdentifier
Definition SingleProofreadingError.idl:41
com::sun::star::linguistic2::SingleProofreadingError::nErrorStart
long nErrorStart
Definition SingleProofreadingError.idl:31
com::sun::star::linguistic2::SingleProofreadingError::nErrorType
long nErrorType
Definition SingleProofreadingError.idl:38
com::sun::star::linguistic2::SingleProofreadingError::nErrorLength
long nErrorLength
Definition SingleProofreadingError.idl:35
com::sun::star::linguistic2::SingleProofreadingError::aFullComment
string aFullComment
Definition SingleProofreadingError.idl:47
com::sun::star::linguistic2::SingleProofreadingError::aShortComment
string aShortComment
Definition SingleProofreadingError.idl:44
com::sun::star::linguistic2::SingleProofreadingError::aProperties
sequence< com::sun::star::beans::PropertyValue > aProperties
Definition SingleProofreadingError.idl:58
com::sun::star::linguistic2::SingleProofreadingError::aSuggestions
sequence< string > aSuggestions
Definition SingleProofreadingError.idl:51