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