blob: d330a40c4e11faad44de45393af3c9bb8c332133 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XProofreader.idl,v $
* $Revision: 1.1.2.2 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_linguistic2_XProofreader_idl__
#define __com_sun_star_linguistic2_XProofreader_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
#include <com/sun/star/linguistic2/XSupportedLocales.idl>
#endif
#ifndef __com_sun_star_text_XFlatParagraph_idl__
#include <com/sun/star/text/XFlatParagraph.idl>
#endif
#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__
#include <com/sun/star/linguistic2/ProofreadingResult.idl>
#endif
#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
#include <com/sun/star/beans/PropertyValue.idl>
#endif
//=============================================================================
module com { module sun { module star { module linguistic2 {
//=============================================================================
/** API for proofreading a text
@since OOo 3.0.1
*/
interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
{
//-------------------------------------------------------------------------
/** whether is the text checked by the spellchecker
@returns true if it is also a spell checker
*/
boolean isSpellChecker();
//-------------------------------------------------------------------------
/** start checking
@param nDocId
the Document ID.
@param rFlatParaText
the flat text to be checked.
@param xFlatPara
the flat paragraph to be checked.
@param aLocale
Language used in the text.
@param nStartOfSentencePos
Start Index of the text.
@param nSuggestedSentenceEndPos
Probable end position of the text.
@throws IllegalArgumentException
when any argument is wrong.
*/
ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
[in] string aText,
[in] com::sun::star::lang::Locale aLocale,
[in] long nStartOfSentencePosition,
[in] long nSuggestedBehindEndOfSentencePosition,
[in] sequence< com::sun::star::beans::PropertyValue > aProperties )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** disables a specific rule for a given locale.
<p>If the locale is empty the rule should be ignored for all languages.</p>
*/
void ignoreRule( [in] string aRuleIdentifier,
[in] com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** sets all rules back to their default settings.
*/
void resetIgnoreRules();
};
//=============================================================================
}; }; }; };
#endif
|
