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_XDictionaryEntry_idl__
28#define __com_sun_star_linguistic2_XDictionaryEntry_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_lang_Locale_idl__
35#include <com/sun/star/lang/Locale.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module linguistic2 {
41
42//=============================================================================
43/** This interfaces gives access to a dictionary entry.
44
45	<P>A dictionary entry can supply a word and its hyhenation
46	and indicate if it is a negative word.
47	If it is a negative entry it may supply a replacement text to
48	be used instead of the entry word.</P>
49
50 	<P>Hyphenation positions are represented by an '=' in the word.
51 	If the '=' is the last character of the word this means it should not
52 	be hyphenated. If there is no '=' charcter in the word, hyphenation
53 	positions will be determined automatically (i.e., from the hyphenator
54	service alone).</P>
55
56 	<P>Entries whose words only differ in hyphenation are considered
57 	to be equal. Also a '.' at the end of the word will make no
58 	difference.</P>
59
60    @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
61    @see    <type scope="com::sun::star::uno">XInterface</type>
62*/
63published interface XDictionaryEntry : com::sun::star::uno::XInterface
64{
65	//-------------------------------------------------------------------------
66	/**
67	 	@returns
68	 		the word defining this entry.
69	 */
70	string getDictionaryWord();
71
72	//-------------------------------------------------------------------------
73	/**
74		@returns
75			<TRUE/> if the word (entry) is a negative one and should not be
76	 		used, <FALSE/> otherwise.
77	*/
78	boolean isNegative();
79
80	//-------------------------------------------------------------------------
81	/** is the suggested replacement text for negative words.
82
83	 	<p>It is undefined if the entry is not negative.</p>
84
85	 	@returns
86	 		the replacement text for a negative entry.
87	 		An empty string indicates that no replacement text is provided.
88	 */
89	string getReplacementText();
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98