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_XConversionPropertyType_idl__
28#define __com_sun_star_linguistic2_XConversionPropertyType_idl__
29
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35
36#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
37#include <com/sun/star/lang/IllegalArgumentException.idl>
38#endif
39
40#ifndef __com_sun_star_container_NoSuchElementException_idl__
41#include <com/sun/star/container/NoSuchElementException.idl>
42#endif
43
44
45//=============================================================================
46
47module com { module sun { module star { module linguistic2 {
48
49//=============================================================================
50/** allows set and retrieve the property type of an entry in a
51    conversion dictionary
52
53    <p>The property type must be one of
54    <type scope="com::sun::star::linguistic2">ConversionPropertyType</type></p>
55
56    @see    com::sun::star::linguistic2::XConversionDictionary
57    @see    com::sun::star::linguistic2::ConversionPropertyType
58
59    @since OOo 2.0
60*/
61published interface XConversionPropertyType : com::sun::star::uno::XInterface
62{
63
64    //-------------------------------------------------------------------------
65    /** sets the property type for the specified entry.
66
67        <p>The conversion entry is specified by the pair
68        ( aLeftText, aRightText ).</p>
69
70        @param aLeftText
71            the left text of the dictionary entry.
72        @param aRightText
73            the right text of the dictionary entry.
74        @param nPropertyType
75            the property type to be set for the entry
76    */
77    void setPropertyType(
78            [in] string aLeftText,
79            [in] string aRightText,
80            [in] short nPropertyType )
81        raises( com::sun::star::container::NoSuchElementException,
82                com::sun::star::lang::IllegalArgumentException );
83
84    //-------------------------------------------------------------------------
85    /** returns the property type for the specified entry.
86
87        <p>The conversion entry is specified by the pair
88        ( aLeftText, aRightText ).</p>
89
90        @param aLeftText
91            the left text of the dictionary entry.
92        @param aRightText
93            the right text of the dictionary entry.
94        @returns
95            returns the property type for the entry with the specified
96            left text.
97    */
98    short getPropertyType(
99            [in] string aLeftText,
100            [in] string aRightText )
101        raises( com::sun::star::container::NoSuchElementException );
102
103};
104
105//=============================================================================
106
107}; }; }; };
108
109#endif
110
111