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