offapi/com/sun/star/linguistic2/XSearchableDictionaryList.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: XSearchableDictionaryList.idl,v $
  10  * $Revision: 1.12 $
  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_XSearchableDictionaryList_idl__
  31 #define __com_sun_star_linguistic2_XSearchableDictionaryList_idl__
  32
  33
  34 #ifndef __com_sun_star_linguistic2_XDictionaryList_idl__
  35 #include <com/sun/star/linguistic2/XDictionaryList.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  39 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_Locale_idl__
  43 #include <com/sun/star/lang/Locale.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49 module com { module sun { module star { module linguistic2 {
  50
  51 //=============================================================================
  52 /** allows searching for an entry in all dictionaries of the dictionary-list.
  53
  54     <P> Only active dictionaries of a suitable language will be searched
  55     for the entry.
  56     The language is suitable if it is the same as the dictionary's language or
  57     the dictionary may hold entries of all langauges.
  58     <P>
  59
  60     @see <type scope="com::sun::star::linguistic2">XDictionaryList</type>
  61 */
  62 published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDictionaryList
  63 {
  64     //-------------------------------------------------------------------------
  65     /** looks for an entry for a given word in the list of dictionaries.
  66
  67         @returns
  68             the dictionary entry that was found, <NULL/> otherwise.
  69
  70         @param aWord
  71             the word (entry) to be looked for.
  72
  73         @param aLocale
  74             the language of the word to be looked for.
  75
  76         @param bSearchPosDic
  77             <TRUE/> if only positive dictionaries should be searched.
  78             <FALSE/> if only negative dictionaries should be searched.
  79
  80         @param bSpellEntry
  81             <TRUE/> if entries for purposes of spellchecking are required.
  82             <FALSE/> if only entries for hyphenation purposes are required.
  83 */
  84     com::sun::star::linguistic2::XDictionaryEntry       queryDictionaryEntry(
  85         [in] string  aWord ,
  86         [in] com::sun::star::lang::Locale  aLocale,
  87         [in] boolean bSearchPosDics,
  88         [in] boolean bSpellEntry );
  89
  90 };
  91
  92 //=============================================================================
  93
  94 }; }; }; };
  95
  96 #endif
  97
  98