offapi/com/sun/star/linguistic2/XSearchableDictionary.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
  20 #define __com_sun_star_linguistic2_XSearchableDictionary_idl__
  21
  22 #include <com/sun/star/linguistic2/XDictionary.idl>
  23 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  24
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** This interfaces allows to retrieve suggestions for spell checking from a dictionary.
  30
  31 */
  32 interface XSearchableDictionary : com::sun::star::linguistic2::XDictionary
  33 {
  34     /** search for similar entries in the dictionary.
  35
  36         @param  aWord
  37             the word to find similar written entries for.
  38
  39         @returns
  40             the list of similar entries found.
  41
  42         @see    com::sun::star::linguistic2::XDictionaryEntry
  43         @see    com::sun::star::linguistic2::XSearchableDictionaryList
  44         @since OOo 3.0.1
  45     */
  46     sequence< com::sun::star::linguistic2::XDictionaryEntry > searchSimilarEntries( [in] string aWord );
  47
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */