offapi/com/sun/star/linguistic2/XMeaning.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: XMeaning.idl,v $
  10  * $Revision: 1.10 $
  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_XMeaning_idl__
  31 #define __com_sun_star_linguistic2_XMeaning_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module linguistic2 {
  41
  42 //=============================================================================
  43 /** one of the possible meanings for a word.
  44
  45     <P> Represents one of the possible meanings that may be returned from a
  46      <member scope="com::sun::star::linguistic2">XThesaurus::queryMeanings</member>
  47     call and allows for retrieval of its synonyms.
  48     </P>
  49
  50     @see    <type scope="com::sun::star::linguistic2">XThesaurus</type>
  51  */
  52 published interface XMeaning : com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /**
  56          @returns
  57              the meaning represented by this object.
  58      */
  59     string getMeaning();
  60
  61     //-------------------------------------------------------------------------
  62     /**
  63          @returns
  64              a sequence of strings where each entry is a synonym of the
  65              current objects meaning.
  66      */
  67     sequence<string> querySynonyms();
  68
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif