blob: 5dd8dcb20f9cd05b3c44795f98374fd4838f6770 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XHyphenatedWord.idl,v $
* $Revision: 1.10 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_linguistic2_XHyphenatedWord_idl__
#define __com_sun_star_linguistic2_XHyphenatedWord_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
//=============================================================================
module com { module sun { module star { module linguistic2 {
//=============================================================================
/** gives information obtained by a successful hyphenation attempt.
<P>This interface is used as a return value for some of the hyphenator
functions.</P>
@see <type scope="com::sun::star::linguistic2">XHyphenator</type>
*/
published interface XHyphenatedWord : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/**
@returns
the word that was hyphenated.
*/
string getWord();
//-------------------------------------------------------------------------
/**
@returns
the language of the hyphenated word.
@see com::sun::star::lang::Locale
*/
com::sun::star::lang::Locale getLocale();
//-------------------------------------------------------------------------
/**
@returns
the position where hyphenation was applied in the word.
<P>The value has to be in the range from 0 (after the first character)
to n-2 (before the last character) where n is the length of
the word.</P>
*/
short getHyphenationPos();
//-------------------------------------------------------------------------
/**
@returns
the hyphenated word as it should be written (without the hyphen
character).
*/
string getHyphenatedWord();
//-------------------------------------------------------------------------
/**
@returns
the position of the hyphen in the hyphenated word.
<P>The value has to be in the range from 0 (after the first character)
to m-2 (before the last character) where m is the length of
the hyphenated word.</P>
*/
short getHyphenPos();
//-------------------------------------------------------------------------
/** is used to query if the hyphenation result is an alternative spelling.
<p>A hyphenation result is an alternative spelling if the hyphenated
word is different from the word that was hyphenated.</p>
@returns
<TRUE/> if it is an alternative spelling, <FALSE/> otherwise.
*/
boolean isAlternativeSpelling();
};
//=============================================================================
}; }; }; };
#endif
|
