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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_linguistic2_XSetSpellAlternatives_idl__
  20 #define __com_sun_star_linguistic2_XSetSpellAlternatives_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com { module sun { module star { module linguistic2 {
  27
  28 /**
  29     allows to modify the suggestion list returned by a spell checker.
  30
  31     <P>Basically this is needed to post-add further suggestions while keeping the
  32     originally returned reference from the spell checker.
  33     E.g. from the user dictionaries.</P>
  34
  35     @see    com::sun::star::linguistic2::XSpellAlternatives
  36 */
  37 interface XSetSpellAlternatives : com::sun::star::uno::XInterface
  38 {
  39     /**
  40         set the list of suggestions to be returned.
  41
  42         @since  OOo 3.0.1
  43     */
  44     void setAlternatives( [in] sequence< string > aAlternatives );
  45
  46     /**
  47         set the type of error found.
  48
  49         @see    com::sun::star::linguistic2::SpellFailure
  50         @since  OOo 3.0.1
  51     */
  52     void setFailureType( [in] short nFailureType );
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */