1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__ 24#define __com_sun_star_linguistic2_XSpellAlternatives_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_lang_Locale_idl__ 31#include <com/sun/star/lang/Locale.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module linguistic2 { 37 38//============================================================================= 39/** Gives access to the results of failed 40 spellchecking attempts and may provide spelling alternatives. 41 42 <P>This is used by the 43 <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member> 44 function when the word was not found to be correct. 45 Suggestions for other words to be used may be provided along with 46 a failure-type that may specifiy why the word was not correct. 47 </P> 48 49 @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> 50*/ 51published interface XSpellAlternatives : com::sun::star::uno::XInterface 52{ 53 //------------------------------------------------------------------------- 54 /** 55 @returns 56 the word that was misspelled. 57 */ 58 string getWord(); 59 60 //------------------------------------------------------------------------- 61 /** 62 @returns 63 the Locale which specifies the language of the misspelled word. 64 */ 65 com::sun::star::lang::Locale getLocale(); 66 67 //------------------------------------------------------------------------- 68 /** 69 @returns 70 the type (reason) for spellchecking to have failed verification. 71 72 @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> 73 */ 74 short getFailureType(); 75 76 //------------------------------------------------------------------------- 77 /** 78 @returns 79 the number of suggested spelling alternatives available. 80 */ 81 short getAlternativesCount(); 82 83 //------------------------------------------------------------------------- 84 /** 85 @returns 86 the sequence of suggested spelling alternatives. 87 */ 88 sequence<string> getAlternatives(); 89 90}; 91 92//============================================================================= 93 94}; }; }; }; 95 96#endif 97