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