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