summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/linguistic2/XSearchableDictionary.idl
blob: a4488541224a951634f5a5a2cf83c718942e2e05 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
#define __com_sun_star_linguistic2_XSearchableDictionary_idl__

#include <com/sun/star/linguistic2/XDictionary.idl>
#include <com/sun/star/linguistic2/XDictionaryEntry.idl>



module com { module sun { module star { module linguistic2 {

/** This interfaces allows to retrieve suggestions for spell checking from a dictionary.

*/
interface XSearchableDictionary : com::sun::star::linguistic2::XDictionary
{
    /** search for similar entries in the dictionary.

        @param  aWord
            the word to find similar written entries for.

        @returns
            the list of similar entries found.

        @see    com::sun::star::linguistic2::XDictionaryEntry
        @see    com::sun::star::linguistic2::XSearchableDictionaryList
        @since OOo 3.0.1
    */
    sequence< com::sun::star::linguistic2::XDictionaryEntry > searchSimilarEntries( [in] string aWord );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */