1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
24cdf0e10cSrcweir#define __com_sun_star_linguistic2_XDictionaryEntry_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_lang_Locale_idl__
31cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweirmodule com { module sun { module star { module linguistic2 {
37cdf0e10cSrcweir
38cdf0e10cSrcweir//=============================================================================
39cdf0e10cSrcweir/** This interfaces gives access to a dictionary entry.
40cdf0e10cSrcweir
41cdf0e10cSrcweir	<P>A dictionary entry can supply a word and its hyhenation
42cdf0e10cSrcweir	and indicate if it is a negative word.
43cdf0e10cSrcweir	If it is a negative entry it may supply a replacement text to
44cdf0e10cSrcweir	be used instead of the entry word.</P>
45cdf0e10cSrcweir
46cdf0e10cSrcweir 	<P>Hyphenation positions are represented by an '=' in the word.
47cdf0e10cSrcweir 	If the '=' is the last character of the word this means it should not
48cdf0e10cSrcweir 	be hyphenated. If there is no '=' charcter in the word, hyphenation
49cdf0e10cSrcweir 	positions will be determined automatically (i.e., from the hyphenator
50cdf0e10cSrcweir	service alone).</P>
51cdf0e10cSrcweir
52cdf0e10cSrcweir 	<P>Entries whose words only differ in hyphenation are considered
53cdf0e10cSrcweir 	to be equal. Also a '.' at the end of the word will make no
54cdf0e10cSrcweir 	difference.</P>
55cdf0e10cSrcweir
56cdf0e10cSrcweir    @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
57cdf0e10cSrcweir    @see    <type scope="com::sun::star::uno">XInterface</type>
58cdf0e10cSrcweir*/
59cdf0e10cSrcweirpublished interface XDictionaryEntry : com::sun::star::uno::XInterface
60cdf0e10cSrcweir{
61cdf0e10cSrcweir	//-------------------------------------------------------------------------
62cdf0e10cSrcweir	/**
63cdf0e10cSrcweir	 	@returns
64cdf0e10cSrcweir	 		the word defining this entry.
65cdf0e10cSrcweir	 */
66cdf0e10cSrcweir	string getDictionaryWord();
67cdf0e10cSrcweir
68cdf0e10cSrcweir	//-------------------------------------------------------------------------
69cdf0e10cSrcweir	/**
70cdf0e10cSrcweir		@returns
71cdf0e10cSrcweir			<TRUE/> if the word (entry) is a negative one and should not be
72cdf0e10cSrcweir	 		used, <FALSE/> otherwise.
73cdf0e10cSrcweir	*/
74cdf0e10cSrcweir	boolean isNegative();
75cdf0e10cSrcweir
76cdf0e10cSrcweir	//-------------------------------------------------------------------------
77cdf0e10cSrcweir	/** is the suggested replacement text for negative words.
78cdf0e10cSrcweir
79cdf0e10cSrcweir	 	<p>It is undefined if the entry is not negative.</p>
80cdf0e10cSrcweir
81cdf0e10cSrcweir	 	@returns
82cdf0e10cSrcweir	 		the replacement text for a negative entry.
83cdf0e10cSrcweir	 		An empty string indicates that no replacement text is provided.
84cdf0e10cSrcweir	 */
85cdf0e10cSrcweir	string getReplacementText();
86cdf0e10cSrcweir
87cdf0e10cSrcweir};
88cdf0e10cSrcweir
89cdf0e10cSrcweir//=============================================================================
90cdf0e10cSrcweir
91cdf0e10cSrcweir}; }; }; };
92cdf0e10cSrcweir
93cdf0e10cSrcweir#endif
94