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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_linguistic2_XSearchableDictionary_idl__
  29 #define __com_sun_star_linguistic2_XSearchableDictionary_idl__
  30
  31 #include <com/sun/star/linguistic2/XDictionary.idl>
  32 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  33
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module linguistic2 {
  38
  39 //=============================================================================
  40 /** This interfaces allows to retrieve suggestions for spell checking from a dictionary.
  41
  42 */
  43 interface 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 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */