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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_XLinguServiceManager_idl__
#define __com_sun_star_linguistic2_XLinguServiceManager_idl__
#ifndef __com_sun_star_linguistic2_XSpellChecker_idl__
#include <com/sun/star/linguistic2/XSpellChecker.idl>
#endif
#ifndef __com_sun_star_linguistic2_XHyphenator_idl__
#include <com/sun/star/linguistic2/XHyphenator.idl>
#endif
#ifndef __com_sun_star_linguistic2_XThesaurus_idl__
#include <com/sun/star/linguistic2/XThesaurus.idl>
#endif
#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif
//=============================================================================
module com { module sun { module star { module linguistic2 {
//=============================================================================
/** the basic interface to be used to access linguistic functionality.
<P>This interface is used to access spellchecker, hyphenator, and
thesaurus functionality.
Additionally, it can query what implementations of those services are
available (for specific languages or in general).
It can select and query which of those implementations should
be used for a specific language.</P>
<P>
For spellchecking and thesaurus, the order in the list defines the order
of creation/usage of those services.
That is, if the first spellchecker implementation does not recognize
the given word as correct, the second service implementation for that
language is created and gets queried. If that one fails, the third one
gets created and queried and so on.
This chain stops if an implementation reports the word as correct or the
end of the list is reached, in which case the word is reported as incorrect.
</P>
<P> For the thesaurus, the behavior is the same when no meaning was found.
</P>
@see <type scope="com::sun::star::linguistic2">SpellChecker</type>
@see <type scope="com::sun::star::linguistic2">Hyphenator</type>
@see <type scope="com::sun::star::linguistic2">Thesaurus</type>
*/
published interface XLinguServiceManager : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/**
@returns
the <type scope="com::sun::star::linguistic2">XSpellChecker</type>
interface to be used for spellchecking.
*/
com::sun::star::linguistic2::XSpellChecker getSpellChecker();
//-------------------------------------------------------------------------
/**
@returns
the <type scope="com::sun::star::linguistic2">XHyphenator</type>
interface to be used for hyphenation.
*/
com::sun::star::linguistic2::XHyphenator getHyphenator();
//-------------------------------------------------------------------------
/**
@returns
the <type scope="com::sun::star::linguistic2">XThesaurus</type>
interface to be used for thesaurus functionality.
*/
com::sun::star::linguistic2::XThesaurus getThesaurus();
//-------------------------------------------------------------------------
/** adds a listener to the list of event listeners.
<P>The listeners may support one or both of
<type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
and
<type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
interfaces.
</P>
@returns
<TRUE/> if the listener was succesfully added, <FALSE/> otherwise.
@param xListener
the listener to be added.
*/
boolean addLinguServiceManagerListener(
[in] com::sun::star::lang::XEventListener xListener );
//-------------------------------------------------------------------------
/** removes a listener from the list of event listeners.
@returns
<TRUE/> if the listener was succesfully removed, <FALSE/> otherwise.
@param xListener
the listener to be removed.
*/
boolean removeLinguServiceManagerListener(
[in] com::sun::star::lang::XEventListener xListener );
//-------------------------------------------------------------------------
/**
@returns
the list of implementation names of the available services.
@param aServiceName
the name of the service requesting the list of available
implementations.
@param aLocale
the language used to query the list of available implementations.
*/
sequence< string > getAvailableServices(
[in] string aServiceName,
[in] com::sun::star::lang::Locale aLocale );
//-------------------------------------------------------------------------
/** sets the list of service implementations to be used for a
given service and language.
@param aServiceName
the name of the service to set the list of implementations
to be used.
@param aLocale
the language to set the list.
@param aServiceImplNames
the name of the service to set the list.
*/
void setConfiguredServices(
[in] string aServiceName,
[in] com::sun::star::lang::Locale aLocale,
[in] sequence< string > aServiceImplNames );
//-------------------------------------------------------------------------
/** queries the list of service implementations to be used for a
given service and language.
@returns
the list of implementation names of the services to be used.
@param aServiceName
the name of the service to get queried.
@param aLocale
the language to get queried.
*/
sequence< string > getConfiguredServices(
[in] string aServiceName,
[in] com::sun::star::lang::Locale aLocale );
};
//=============================================================================
}; }; }; };
#endif
|
