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_XHyphenatedWord_idl__
24#define __com_sun_star_linguistic2_XHyphenatedWord_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_Locale_idl__
31#include <com/sun/star/lang/Locale.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module linguistic2 {
38
39//=============================================================================
40/** gives information obtained by a successful hyphenation attempt.
41
42	<P>This interface is used as a return value for some of the hyphenator
43	functions.</P>
44
45    @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
46*/
47published interface XHyphenatedWord : com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50	/**
51	 	@returns
52		 	the word that was hyphenated.
53	 */
54	string getWord();
55
56	//-------------------------------------------------------------------------
57	/**
58	 	@returns
59			the language of the hyphenated word.
60
61		@see	com::sun::star::lang::Locale
62	*/
63	com::sun::star::lang::Locale getLocale();
64
65	//-------------------------------------------------------------------------
66	/**
67		@returns
68			the position where hyphenation was applied in the word.
69
70		<P>The value has to be in the range from 0 (after the first character)
71	 	to n-2 (before the last character) where n is the length of
72	 	the word.</P>
73	*/
74	short getHyphenationPos();
75
76	//-------------------------------------------------------------------------
77	/**
78	 	@returns
79		 	the hyphenated word as it should be written (without the hyphen
80		 	character).
81	 */
82	string getHyphenatedWord();
83
84	//-------------------------------------------------------------------------
85	/**
86		@returns
87			the position of the hyphen in the hyphenated word.
88
89		<P>The value has to be in the range from 0 (after the first character)
90	 	to m-2 (before the last character) where m is the length of
91	 	the hyphenated word.</P>
92	*/
93	short getHyphenPos();
94
95	//-------------------------------------------------------------------------
96	/** is used to query if the hyphenation result is an alternative spelling.
97
98	 	<p>A hyphenation result is an alternative spelling if the hyphenated
99	 	word is different from the word that was hyphenated.</p>
100
101	 	@returns
102	 		<TRUE/> if it is an alternative spelling, <FALSE/> otherwise.
103	*/
104	boolean isAlternativeSpelling();
105
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113
114