1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_linguistic2_XSearchableDictionaryList_idl__
24#define __com_sun_star_linguistic2_XSearchableDictionaryList_idl__
25
26
27#ifndef __com_sun_star_linguistic2_XDictionaryList_idl__
28#include <com/sun/star/linguistic2/XDictionaryList.idl>
29#endif
30
31#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
32#include <com/sun/star/linguistic2/XDictionaryEntry.idl>
33#endif
34
35#ifndef __com_sun_star_lang_Locale_idl__
36#include <com/sun/star/lang/Locale.idl>
37#endif
38
39
40//=============================================================================
41
42module com { module sun { module star { module linguistic2 {
43
44//=============================================================================
45/** allows searching for an entry in all dictionaries of the dictionary-list.
46
47	<P> Only active dictionaries of a suitable language will be searched
48	for the entry.
49	The language is suitable if it is the same as the dictionary's language or
50	the dictionary may hold entries of all langauges.
51	<P>
52
53    @see <type scope="com::sun::star::linguistic2">XDictionaryList</type>
54*/
55published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDictionaryList
56{
57	//-------------------------------------------------------------------------
58	/** looks for an entry for a given word in the list of dictionaries.
59
60		@returns
61			the dictionary entry that was found, <NULL/> otherwise.
62
63		@param aWord
64			the word (entry) to be looked for.
65
66		@param aLocale
67			the language of the word to be looked for.
68
69		@param bSearchPosDic
70			<TRUE/> if only positive dictionaries should be searched.
71			<FALSE/> if only negative dictionaries should be searched.
72
73		@param bSpellEntry
74			<TRUE/> if entries for purposes of spellchecking are required.
75			<FALSE/> if only entries for hyphenation purposes are required.
76*/
77	com::sun::star::linguistic2::XDictionaryEntry	queryDictionaryEntry(
78		[in] string  aWord ,
79		[in] com::sun::star::lang::Locale  aLocale,
80		[in] boolean bSearchPosDics,
81		[in] boolean bSpellEntry );
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90
91
92