1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_XHyphenatedWord_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_linguistic2_XHyphenatedWord_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_Locale_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/Locale.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module linguistic2 { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski/** gives information obtained by a successful hyphenation attempt. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <P>This interface is used as a return value for some of the hyphenator 43*b1cdbd2cSJim Jagielski functions.</P> 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski @see <type scope="com::sun::star::linguistic2">XHyphenator</type> 46*b1cdbd2cSJim Jagielski*/ 47*b1cdbd2cSJim Jagielskipublished interface XHyphenatedWord : com::sun::star::uno::XInterface 48*b1cdbd2cSJim Jagielski{ 49*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 50*b1cdbd2cSJim Jagielski /** 51*b1cdbd2cSJim Jagielski @returns 52*b1cdbd2cSJim Jagielski the word that was hyphenated. 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielski string getWord(); 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 57*b1cdbd2cSJim Jagielski /** 58*b1cdbd2cSJim Jagielski @returns 59*b1cdbd2cSJim Jagielski the language of the hyphenated word. 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @see com::sun::star::lang::Locale 62*b1cdbd2cSJim Jagielski */ 63*b1cdbd2cSJim Jagielski com::sun::star::lang::Locale getLocale(); 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 66*b1cdbd2cSJim Jagielski /** 67*b1cdbd2cSJim Jagielski @returns 68*b1cdbd2cSJim Jagielski the position where hyphenation was applied in the word. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski <P>The value has to be in the range from 0 (after the first character) 71*b1cdbd2cSJim Jagielski to n-2 (before the last character) where n is the length of 72*b1cdbd2cSJim Jagielski the word.</P> 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski short getHyphenationPos(); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 77*b1cdbd2cSJim Jagielski /** 78*b1cdbd2cSJim Jagielski @returns 79*b1cdbd2cSJim Jagielski the hyphenated word as it should be written (without the hyphen 80*b1cdbd2cSJim Jagielski character). 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski string getHyphenatedWord(); 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 85*b1cdbd2cSJim Jagielski /** 86*b1cdbd2cSJim Jagielski @returns 87*b1cdbd2cSJim Jagielski the position of the hyphen in the hyphenated word. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski <P>The value has to be in the range from 0 (after the first character) 90*b1cdbd2cSJim Jagielski to m-2 (before the last character) where m is the length of 91*b1cdbd2cSJim Jagielski the hyphenated word.</P> 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski short getHyphenPos(); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 96*b1cdbd2cSJim Jagielski /** is used to query if the hyphenation result is an alternative spelling. 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski <p>A hyphenation result is an alternative spelling if the hyphenated 99*b1cdbd2cSJim Jagielski word is different from the word that was hyphenated.</p> 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @returns 102*b1cdbd2cSJim Jagielski <TRUE/> if it is an alternative spelling, <FALSE/> otherwise. 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski boolean isAlternativeSpelling(); 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski}; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski//============================================================================= 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski}; }; }; }; 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski#endif 113*b1cdbd2cSJim Jagielski 114