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