diff options
Diffstat (limited to 'offapi/com/sun/star/linguistic2/XSpellChecker.idl')
| -rw-r--r-- | offapi/com/sun/star/linguistic2/XSpellChecker.idl | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/offapi/com/sun/star/linguistic2/XSpellChecker.idl b/offapi/com/sun/star/linguistic2/XSpellChecker.idl new file mode 100644 index 000000000000..0883bd723ab3 --- /dev/null +++ b/offapi/com/sun/star/linguistic2/XSpellChecker.idl @@ -0,0 +1,158 @@ +/************************************************************************* + * + * $RCSfile: XSpellChecker.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:49 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_linguistic2_XSpellChecker_idl__ +#define __com_sun_star_linguistic2_XSpellChecker_idl__ + +#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__ +#include <com/sun/star/linguistic2/XSupportedLocales.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_linguistic2_XDictionaryList_idl__ +#include <com/sun/star/linguistic2/XDictionaryList.idl> +#endif + +#ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__ +#include <com/sun/star/linguistic2/XSpellAlternatives.idl> +#endif + +#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUES_idl_ +#include <com/sun/star/beans/PropertyValues.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module linguistic2 { + +//============================================================================= +/** This interface allows for spellchecking. + + @see XSupportedLocales +*/ +[ uik(4BD5A962-5D68-11d4-9F090050-04D8BBC5), ident( "XSpellChecker", 1.0 ) ] +interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales +{ + //------------------------------------------------------------------------- + /** checks if a word is spelled correct in a given language. + + @returns + <TRUE/> if <var>aWord<var/> is spelled correct using + <var>aLocale</var>, <FALSE/> otherwise. + + @param aWord + the word to be checked. + + @param aLocale + the Locale to be used. + If <var>aLocale</var> is empty the word is spelled correct by + definition! If <var>aLocale</var> is not supported an + IllegalArgumentException exception is raised. + + @see XSupportedLocales + @see Locale + */ + boolean isValid( + [in] string aWord, + [in] com::sun::star::lang::Locale aLocale, + [in] com::sun::star::beans::PropertyValues aProperties ) + raises( com::sun::star::lang::IllegalArgumentException ); + + //------------------------------------------------------------------------- + /** This method checks if a word is spelled correct in a given + language. + + @returns + <NULL/> if <var>aWord</var> is spelled correct using + <var>aLocale</var>. Otherwise an XSpellAlternatives + object with information about the reason of failure and (maybe) + proposals for spelling alternatives will be returned. + + @param aWord + the word to be checked. + + @param aLocale + the language to be used. + + <P>If the language is not supported an IllegalArgumentException + exception is raised.</P> + + @see XSupportedLocales + @see XSpellAlternatives + @see Locale + */ + com::sun::star::linguistic2::XSpellAlternatives spell( + [in] string aWord, + [in] com::sun::star::lang::Locale aLocale, + [in] com::sun::star::beans::PropertyValues aProperties ) + raises( com::sun::star::lang::IllegalArgumentException ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |