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_XPossibleHyphens_idl__
28#define __com_sun_star_linguistic2_XPossibleHyphens_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//=============================================================================
40
41module com { module sun { module star { module linguistic2 {
42
43//=============================================================================
44/** Gives information about a word's possible hyphenation points.
45
46 	<P>Example: In German pre-spelling-reform you may have the following:
47 	getWord:					Dampfschiffahrt
48 	getPossibleHyphens:			Dampf=schiff=fahrt
49 	getOrigHyphensPositions:	4, 9
50 	That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and
51 	between the double "ff" (9). And if you are going to hyphenate it at
52 	position 9 you will get an additional "f" before the hyphen
53 	character.</P>
54
55    @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
56*/
57published interface XPossibleHyphens : com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60	/**
61	 	@returns
62	 		the word for which the information of possible hyphenation
63	 		points was obtained.
64	*/
65	string getWord();
66
67	//-------------------------------------------------------------------------
68	/** @returns
69			the language of the hyphenated word.
70
71        @see    <type scope="com::sun::star::lang">Locale</type>
72	*/
73	com::sun::star::lang::Locale getLocale();
74
75	//-------------------------------------------------------------------------
76	/**
77	 	@returns
78	 		a string depicting the word with all hyphen positions
79	 		which are represented by '=' characters.
80	 		If there are any alternative spellings, the word will be altered
81	 		accordingly.
82	*/
83	string getPossibleHyphens();
84
85	//-------------------------------------------------------------------------
86	/**
87	 	@returns
88	 		an ascending sequence of numbers where each number is an offset
89	 		within the original word which denotes a hyphenation
90	 		position corresponding to one of the hyphens in the
91            string returned by
92            <member scope="com::sun::star::linguistic2">XPossibleHyphens::getPossibleHyphens</member>.
93	*/
94	sequence<short> getHyphenationPositions();
95
96};
97
98//=============================================================================
99
100}; }; }; };
101
102#endif
103