/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: SpellFailure.idl,v $
 * $Revision: 1.9 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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