/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SpellFailure.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 02:08:13 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_SpellFailure_idl__
#define __com_sun_star_linguistic2_SpellFailure_idl__


//=============================================================================

module com { module sun { module star { module linguistic2 {

//=============================================================================
/** these define the various return types for spellchecking to fail verification.

    <P>A value of this type is part of the
	<type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
    interface which is the return type for an unsuccessfull
	spelling attempt.</P>

    @see    <type scope="com::sun::star::linguistic2">XSpellChecker</type>
*/
published constants SpellFailure
{
	//-------------------------------------------------------------------------
	/** The word is a negative one, that is, it should not be used.
	*/
	const short IS_NEGATIVE_WORD = 2;

	//-------------------------------------------------------------------------
    /** The capitalization of the word is wrong.
	*/
	const short CAPTION_ERROR = 3;

	//-------------------------------------------------------------------------
	/** The spelling of the word is wrong (or at least not known to be correct).
	*/
	const short SPELLING_ERROR = 4;

};

//=============================================================================

}; }; }; };

#endif
