xref: /AOO41X/main/offapi/com/sun/star/linguistic2/XMeaning.idl (revision ff0525f24f03981d56b7579b645949f111420994)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_linguistic2_XMeaning_idl__
24#define __com_sun_star_linguistic2_XMeaning_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module linguistic2 {
34
35//=============================================================================
36/** one of the possible meanings for a word.
37
38    <P> Represents one of the possible meanings that may be returned from a
39    <member scope="com::sun::star::linguistic2">XThesaurus::queryMeanings</member>
40    call and allows for retrieval of its synonyms.
41    </P>
42
43    @see    <type scope="com::sun::star::linguistic2">XThesaurus</type>
44 */
45published interface XMeaning : com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48    /**
49        @returns
50            the meaning represented by this object.
51    */
52    string getMeaning();
53
54    //-------------------------------------------------------------------------
55    /**
56        @returns
57            a sequence of strings where each entry is a synonym of the
58            current objects meaning.
59    */
60    sequence<string> querySynonyms();
61
62};
63
64//=============================================================================
65
66}; }; }; };
67
68#endif
69