offapi/com/sun/star/linguistic2/XThesaurus.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_XThesaurus_idl__
  20 #define __com_sun_star_linguistic2_XThesaurus_idl__
  21
  22 #include <com/sun/star/linguistic2/XSupportedLocales.idl>
  23 #include <com/sun/star/linguistic2/XMeaning.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/beans/PropertyValues.idl>
  26
  27
  28 module com { module sun { module star { module linguistic2 {
  29
  30 /** allows for the retrieval of possible meanings for a given word and language.
  31
  32     <P>
  33      The meaning of a word is in essence a descriptive text for that word.
  34      Each meaning may have several synonyms where a synonym is a word
  35      (or small text) with the same or similar meaning.
  36     </P>
  37
  38     @see    com::sun::star::linguistic2::XSupportedLocales
  39 */
  40 published interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales
  41 {
  42     /**
  43         @returns
  44             a list of meanings for the given word and language.
  45
  46          @param aTerm
  47              the word to query for its meanings.
  48
  49         @param  aLocale
  50             specifies the language of the word.
  51
  52             <P>If the language is not supported, an
  53             com::sun::star::lang::IllegalArgumentException
  54             exception is raised.</P>
  55
  56         @param aProperties
  57             provides property values to be used for this function call only.
  58             It is usually empty in order to use the default values supplied with
  59             the property set.
  60
  61         @see    com::sun::star::lang::Locale
  62         @see    com::sun::star::linguistic2::XMeaning
  63     */
  64     sequence< com::sun::star::linguistic2::XMeaning > queryMeanings(
  65             [in] string aTerm,
  66              [in] com::sun::star::lang::Locale aLocale,
  67             [in] com::sun::star::beans::PropertyValues aProperties )
  68         raises( com::sun::star::lang::IllegalArgumentException );
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */