/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XSpellAlternatives.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:13:22 $
 *
 *  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_XSpellAlternatives_idl__
#define __com_sun_star_linguistic2_XSpellAlternatives_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

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

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

//=============================================================================
/** Gives access to the results of failed
    spellchecking attempts and may provide spelling alternatives.

    <P>This is used by the
    <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member>
    function when the word was not found to be correct.
    Suggestions for other words to be used may be provided along with
    a failure-type that may specifiy why the word was not correct.
    </P>

    @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
*/
published interface XSpellAlternatives : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**
         @returns
             the word that was misspelled.
     */
    string getWord();

    //-------------------------------------------------------------------------
    /**
        @returns
            the Locale which specifies the language of the misspelled word.
    */
    com::sun::star::lang::Locale getLocale();

    //-------------------------------------------------------------------------
    /**
        @returns
            the type (reason) for spellchecking to have failed verification.

    @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
    */
    short getFailureType();

    //-------------------------------------------------------------------------
    /**
        @returns
            the number of suggested spelling alternatives available.
    */
    short getAlternativesCount();

    //-------------------------------------------------------------------------
    /**
         @returns
            the sequence of suggested spelling alternatives.
    */
    sequence<string> getAlternatives();

};

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

}; }; }; };

#endif
