offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSetSpellAlternatives.idl,v $
  10  * $Revision: 1.1.2.2 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_XSetSpellAlternatives_idl__
  31 #define __com_sun_star_linguistic2_XSetSpellAlternatives_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module linguistic2 {
  41
  42 //=============================================================================
  43 /**
  44     allows to modify the suggestion list returned by a spell checker.
  45
  46     <P>Basically this is needed to post-add further suggestions while keeping the
  47     originally returned reference from the spell checker.
  48     E.g. from the user dictionaries.</P>
  49
  50     @see    <type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
  51 */
  52 interface XSetSpellAlternatives : com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /**
  56         set the list of suggestions to be returned.
  57
  58         @since  OOo 3.0.1
  59     */
  60     void setAlternatives( [in] sequence< string > aAlternatives );
  61
  62     //-------------------------------------------------------------------------
  63     /**
  64         set the type of error found.
  65
  66         @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
  67         @since  OOo 3.0.1
  68     */
  69     void setFailureType( [in] short nFailureType );
  70
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif