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