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_XSpellChecker_idl__ 24cdf0e10cSrcweir#define __com_sun_star_linguistic2_XSpellChecker_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__ 27cdf0e10cSrcweir#include <com/sun/star/linguistic2/XSupportedLocales.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_linguistic2_XDictionaryList_idl__ 35cdf0e10cSrcweir#include <com/sun/star/linguistic2/XDictionaryList.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__ 39cdf0e10cSrcweir#include <com/sun/star/linguistic2/XSpellAlternatives.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUES_idl_ 43cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValues.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweirmodule com { module sun { module star { module linguistic2 { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir/** This interface allows for spellchecking. 53cdf0e10cSrcweir 54cdf0e10cSrcweir <P>It is possible to simply check if a word, in a specified language, 55cdf0e10cSrcweir is correct or additionally, if it was misspelled, some proposals 56cdf0e10cSrcweir how it might be correctly written.</P> 57cdf0e10cSrcweir 58cdf0e10cSrcweir @see <type scope="com::sun::star::linguistic2">XSupportedLocales</type> 59cdf0e10cSrcweir*/ 60cdf0e10cSrcweirpublished interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales 61cdf0e10cSrcweir{ 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir /** checks if a word is spelled correctly in a given language. 64cdf0e10cSrcweir 65cdf0e10cSrcweir @returns 66cdf0e10cSrcweir <TRUE/> if the word is spelled correctly using 67cdf0e10cSrcweir the specified language, <FALSE/> otherwise. 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param aWord 70cdf0e10cSrcweir the word to be checked. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @param aLocale 73cdf0e10cSrcweir the Locale (language) to be used. 74cdf0e10cSrcweir If the Locale is empty, the word is spelled correctly by 75cdf0e10cSrcweir definition. 76cdf0e10cSrcweir 77cdf0e10cSrcweir <P>If <var>aLocale</var> is not supported an 78cdf0e10cSrcweir IllegalArgumentException exception is raised.</P> 79cdf0e10cSrcweir 80cdf0e10cSrcweir @param aProperties 81cdf0e10cSrcweir provides property values to be used for this function call only. 82cdf0e10cSrcweir It is usually empty in order to use the default values supplied with 83cdf0e10cSrcweir the property set. 84cdf0e10cSrcweir 85cdf0e10cSrcweir @see <type scope="com::sun::star::lang">Locale</type> 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir boolean isValid( 88cdf0e10cSrcweir [in] string aWord, 89cdf0e10cSrcweir [in] com::sun::star::lang::Locale aLocale, 90cdf0e10cSrcweir [in] com::sun::star::beans::PropertyValues aProperties ) 91cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 92cdf0e10cSrcweir 93cdf0e10cSrcweir //------------------------------------------------------------------------- 94cdf0e10cSrcweir /** This method checks if a word is spelled correctly in a given 95cdf0e10cSrcweir language. 96cdf0e10cSrcweir 97cdf0e10cSrcweir @returns 98cdf0e10cSrcweir <NULL/> if <var>aWord</var> is spelled correctly using 99cdf0e10cSrcweir <var>aLocale</var>. Otherwise, an XSpellAlternatives 100cdf0e10cSrcweir object with information about the reason of failure and, if available, 101cdf0e10cSrcweir proposals for spelling alternatives will be returned. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @param aWord 104cdf0e10cSrcweir the word to be checked. 105cdf0e10cSrcweir 106cdf0e10cSrcweir @param aLocale 107cdf0e10cSrcweir the language to be used. 108cdf0e10cSrcweir 109cdf0e10cSrcweir <P>If the language is not supported an IllegalArgumentException exception is raised. 110cdf0e10cSrcweir 111cdf0e10cSrcweir @param aProperties 112cdf0e10cSrcweir provides property values to be used for this function call only. 113cdf0e10cSrcweir It is usually empty in order to use the default values supplied with 114cdf0e10cSrcweir the property set. 115cdf0e10cSrcweir exception is raised.</P> 116cdf0e10cSrcweir 117cdf0e10cSrcweir @see <type scope="com::sun::star::linguistic2">XSpellAlternatives</type> 118cdf0e10cSrcweir @see <type scope="com::sun::star::lang">Locale</type> 119cdf0e10cSrcweir */ 120cdf0e10cSrcweir com::sun::star::linguistic2::XSpellAlternatives spell( 121cdf0e10cSrcweir [in] string aWord, 122cdf0e10cSrcweir [in] com::sun::star::lang::Locale aLocale, 123cdf0e10cSrcweir [in] com::sun::star::beans::PropertyValues aProperties ) 124cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 125cdf0e10cSrcweir 126cdf0e10cSrcweir}; 127cdf0e10cSrcweir 128cdf0e10cSrcweir//============================================================================= 129cdf0e10cSrcweir 130cdf0e10cSrcweir}; }; }; }; 131cdf0e10cSrcweir 132cdf0e10cSrcweir#endif 133cdf0e10cSrcweir 134