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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSearchableDictionary.idl,v $
  10  * $Revision: 1.1.2.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
  31 #define __com_sun_star_linguistic2_XSearchableDictionary_idl__
  32
  33 #ifndef __com_sun_star_linguistic2_XDictionary_idl__
  34 #include <com/sun/star/linguistic2/XDictionary.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  38 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module linguistic2 {
  45
  46 //=============================================================================
  47 /** This interfaces allows to retrieve suggestions for spell checking from a dictionary.
  48
  49 */
  50 interface XSearchableDictionary : com::sun::star::linguistic2::XDictionary
  51 {
  52     //-------------------------------------------------------------------------
  53     /** search for similar entries in the dictionary.
  54
  55         @param  aWord
  56             the word to find similar written entries for.
  57
  58         @returns
  59             the list of similar entries found.
  60
  61         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
  62         @see    <type scope="com::sun::star::linguistic2">XSearchableDictionaryList</type>
  63         @since OOo 3.0.1
  64     */
  65     sequence< com::sun::star::linguistic2::XDictionaryEntry > searchSimilarEntries( [in] string aWord );
  66
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif
  74