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_XSearchableDictionary_idl__
24#define __com_sun_star_linguistic2_XSearchableDictionary_idl__
25
26#ifndef __com_sun_star_linguistic2_XDictionary_idl__
27#include <com/sun/star/linguistic2/XDictionary.idl>
28#endif
29
30#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
31#include <com/sun/star/linguistic2/XDictionaryEntry.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module linguistic2 {
38
39//=============================================================================
40/** This interfaces allows to retrieve suggestions for spell checking from a dictionary.
41
42*/
43interface XSearchableDictionary : com::sun::star::linguistic2::XDictionary
44{
45	//-------------------------------------------------------------------------
46    /** search for similar entries in the dictionary.
47
48        @param  aWord
49            the word to find similar written entries for.
50
51        @returns
52            the list of similar entries found.
53
54        @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
55        @see    <type scope="com::sun::star::linguistic2">XSearchableDictionaryList</type>
56        @since OOo 3.0.1
57	*/
58    sequence< com::sun::star::linguistic2::XDictionaryEntry > searchSimilarEntries( [in] string aWord );
59
60};
61
62//=============================================================================
63
64}; }; }; };
65
66#endif
67
68