xref: /aoo42x/main/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_XSetSpellAlternatives_idl__
#define __com_sun_star_linguistic2_XSetSpellAlternatives_idl__

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


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

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

//=============================================================================
/**
    allows to modify the suggestion list returned by a spell checker.

    <P>Basically this is needed to post-add further suggestions while keeping the
    originally returned reference from the spell checker.
    E.g. from the user dictionaries.</P>

    @see    <type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
*/
interface XSetSpellAlternatives : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**
        set the list of suggestions to be returned.

        @since  OOo 3.0.1
	*/
    void setAlternatives( [in] sequence< string > aAlternatives );

    //-------------------------------------------------------------------------
    /**
        set the type of error found.

        @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
        @since  OOo 3.0.1
    */
    void setFailureType( [in] short nFailureType );

};

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

}; }; }; };

#endif