offapi/com/sun/star/linguistic2/XThesaurus.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_linguistic2_XThesaurus_idl__
  28 #define __com_sun_star_linguistic2_XThesaurus_idl__
  29
  30 #ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__
  31 #include <com/sun/star/linguistic2/XSupportedLocales.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_linguistic2_XMeaning_idl__
  35 #include <com/sun/star/linguistic2/XMeaning.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_PropertyValues_idl__
  43 #include <com/sun/star/beans/PropertyValues.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module linguistic2 {
  49
  50 //=============================================================================
  51 /** allows for the retrieval of possible meanings for a given word and language.
  52
  53     <P>
  54      The meaning of a word is in essence a descriptive text for that word.
  55      Each meaning may have several synonyms where a synonym is a word
  56      (or small text) with the same or similar meaning.
  57     </P>
  58
  59     @see    <type scope="com::sun::star::linguistic2">XSupportedLocales</type>
  60 */
  61 published interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales
  62 {
  63     //-------------------------------------------------------------------------
  64     /**
  65         @returns
  66             a list of meanings for the given word and language.
  67
  68          @param aTerm
  69              the word to query for its meanings.
  70
  71         @param  aLocale
  72             specifies the language of the word.
  73
  74             <P>If the language is not supported, an
  75             <type scope="com::sun::star::lang">IllegalArgumentException</type>
  76             exception is raised.</P>
  77
  78         @param aProperties
  79             provides property values to be used for this function call only.
  80             It is usually empty in order to use the default values supplied with
  81             the property set.
  82
  83         @see    <type scope="com::sun::star::lang">Locale</type>
  84         @see    <type scope="com::sun::star::linguistic2">XMeaning</type>
  85     */
  86     sequence< com::sun::star::linguistic2::XMeaning > queryMeanings(
  87             [in] string aTerm,
  88              [in] com::sun::star::lang::Locale aLocale,
  89             [in] com::sun::star::beans::PropertyValues aProperties )
  90         raises( com::sun::star::lang::IllegalArgumentException );
  91
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif
  99