LibreOffice: com/sun/star/linguistic2/ProofreadingResult.idl Source File

LibreOffice LibreOffice 24.8 SDK API Reference

Loading...
Searching...
No Matches
ProofreadingResult.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
23// forward declaration
24interface XProofreader;
25
30 struct ProofreadingResult
31{
32 // the document ID
33 string aDocumentIdentifier;
34
35 // the paragraph that was checked
36 com::sun::star::text::XFlatParagraph xFlatParagraph;
37
38 // text that was checked (the paragraphs content may have changed meanwhile!)
39 string aText;
40
41 // language used for checking
42 com::sun::star::lang::Locale aLocale;
43
44 // the start of sentence position passed to the proofreader
45 long nStartOfSentencePosition;
46
47 // the end of sentence position found by the proofreader
48 // That is the index following the character terminating the sentence.
49 long nBehindEndOfSentencePosition;
50
51 // the start of the next sentence to be checked.
52 // Basically obtained by skipping all white spaces after the end of sentence position.
53 long nStartOfNextSentencePosition;
54
55 // the list of errors
56 sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors;
57
58 // a list of properties
59 sequence< com::sun::star::beans::PropertyValue > aProperties;
60
61 // reference to the specific proofreader implementation that reported the error
62 com::sun::star::linguistic2::XProofreader xProofreader;
63};
64
65
66}; }; }; };
67
68/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::linguistic2::XProofreader
API for proofreading a text.
Definition XProofreader.idl:28
com::sun::star::text::XFlatParagraph
provides functionality to ...
Definition XFlatParagraph.idl:30
com
Definition Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:34
com::sun::star::linguistic2::ProofreadingResult
holds the results from proofreading a sentence.
Definition ProofreadingResult.idl:31
com::sun::star::linguistic2::ProofreadingResult::aErrors
sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors
Definition ProofreadingResult.idl:56
com::sun::star::linguistic2::ProofreadingResult::aLocale
com::sun::star::lang::Locale aLocale
Definition ProofreadingResult.idl:42
com::sun::star::linguistic2::ProofreadingResult::nBehindEndOfSentencePosition
long nBehindEndOfSentencePosition
Definition ProofreadingResult.idl:49
com::sun::star::linguistic2::ProofreadingResult::xProofreader
com::sun::star::linguistic2::XProofreader xProofreader
Definition ProofreadingResult.idl:62
com::sun::star::linguistic2::ProofreadingResult::aText
string aText
Definition ProofreadingResult.idl:39
com::sun::star::linguistic2::ProofreadingResult::xFlatParagraph
com::sun::star::text::XFlatParagraph xFlatParagraph
Definition ProofreadingResult.idl:36
com::sun::star::linguistic2::ProofreadingResult::aDocumentIdentifier
string aDocumentIdentifier
Definition ProofreadingResult.idl:33
com::sun::star::linguistic2::ProofreadingResult::aProperties
sequence< com::sun::star::beans::PropertyValue > aProperties
Definition ProofreadingResult.idl:59
com::sun::star::linguistic2::ProofreadingResult::nStartOfSentencePosition
long nStartOfSentencePosition
Definition ProofreadingResult.idl:45
com::sun::star::linguistic2::ProofreadingResult::nStartOfNextSentencePosition
long nStartOfNextSentencePosition
Definition ProofreadingResult.idl:53