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

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