/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__
#define __com_sun_star_linguistic2_XSpellAlternatives_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>


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

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

    <P>This is used by the
    com::sun::star::linguistic2::XSpellChecker::spell()
    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 specify why the word was not correct.
    </P>

    @see    com::sun::star::linguistic2::SpellFailure
*/
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 spell checking to have failed verification.

    @see    com::sun::star::linguistic2::SpellFailure
    */
    short getFailureType();

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

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

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
