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_XSpellAlternatives_idl__ 24cdf0e10cSrcweir#define __com_sun_star_linguistic2_XSpellAlternatives_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 36cdf0e10cSrcweirmodule com { module sun { module star { module linguistic2 { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir/** Gives access to the results of failed 40cdf0e10cSrcweir spellchecking attempts and may provide spelling alternatives. 41cdf0e10cSrcweir 42cdf0e10cSrcweir <P>This is used by the 43cdf0e10cSrcweir <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member> 44cdf0e10cSrcweir function when the word was not found to be correct. 45cdf0e10cSrcweir Suggestions for other words to be used may be provided along with 46cdf0e10cSrcweir a failure-type that may specifiy why the word was not correct. 47cdf0e10cSrcweir </P> 48cdf0e10cSrcweir 49cdf0e10cSrcweir @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> 50cdf0e10cSrcweir*/ 51cdf0e10cSrcweirpublished interface XSpellAlternatives : com::sun::star::uno::XInterface 52cdf0e10cSrcweir{ 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir /** 55cdf0e10cSrcweir @returns 56cdf0e10cSrcweir the word that was misspelled. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir string getWord(); 59cdf0e10cSrcweir 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir /** 62cdf0e10cSrcweir @returns 63cdf0e10cSrcweir the Locale which specifies the language of the misspelled word. 64cdf0e10cSrcweir */ 65cdf0e10cSrcweir com::sun::star::lang::Locale getLocale(); 66cdf0e10cSrcweir 67cdf0e10cSrcweir //------------------------------------------------------------------------- 68cdf0e10cSrcweir /** 69cdf0e10cSrcweir @returns 70cdf0e10cSrcweir the type (reason) for spellchecking to have failed verification. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir short getFailureType(); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir /** 78cdf0e10cSrcweir @returns 79cdf0e10cSrcweir the number of suggested spelling alternatives available. 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir short getAlternativesCount(); 82cdf0e10cSrcweir 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir /** 85cdf0e10cSrcweir @returns 86cdf0e10cSrcweir the sequence of suggested spelling alternatives. 87cdf0e10cSrcweir */ 88cdf0e10cSrcweir sequence<string> getAlternatives(); 89cdf0e10cSrcweir 90cdf0e10cSrcweir}; 91cdf0e10cSrcweir 92cdf0e10cSrcweir//============================================================================= 93cdf0e10cSrcweir 94cdf0e10cSrcweir}; }; }; }; 95cdf0e10cSrcweir 96cdf0e10cSrcweir#endif 97