1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_linguistic2_XSearchableDictionaryList_idl__
28#define __com_sun_star_linguistic2_XSearchableDictionaryList_idl__
29
30
31#ifndef __com_sun_star_linguistic2_XDictionaryList_idl__
32#include <com/sun/star/linguistic2/XDictionaryList.idl>
33#endif
34
35#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
36#include <com/sun/star/linguistic2/XDictionaryEntry.idl>
37#endif
38
39#ifndef __com_sun_star_lang_Locale_idl__
40#include <com/sun/star/lang/Locale.idl>
41#endif
42
43
44//=============================================================================
45
46module com { module sun { module star { module linguistic2 {
47
48//=============================================================================
49/** allows searching for an entry in all dictionaries of the dictionary-list.
50
51	<P> Only active dictionaries of a suitable language will be searched
52	for the entry.
53	The language is suitable if it is the same as the dictionary's language or
54	the dictionary may hold entries of all langauges.
55	<P>
56
57    @see <type scope="com::sun::star::linguistic2">XDictionaryList</type>
58*/
59published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDictionaryList
60{
61	//-------------------------------------------------------------------------
62	/** looks for an entry for a given word in the list of dictionaries.
63
64		@returns
65			the dictionary entry that was found, <NULL/> otherwise.
66
67		@param aWord
68			the word (entry) to be looked for.
69
70		@param aLocale
71			the language of the word to be looked for.
72
73		@param bSearchPosDic
74			<TRUE/> if only positive dictionaries should be searched.
75			<FALSE/> if only negative dictionaries should be searched.
76
77		@param bSpellEntry
78			<TRUE/> if entries for purposes of spellchecking are required.
79			<FALSE/> if only entries for hyphenation purposes are required.
80*/
81	com::sun::star::linguistic2::XDictionaryEntry	queryDictionaryEntry(
82		[in] string  aWord ,
83		[in] com::sun::star::lang::Locale  aLocale,
84		[in] boolean bSearchPosDics,
85		[in] boolean bSpellEntry );
86
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94
95
96