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