offapi/com/sun/star/linguistic2/XSpellAlternatives.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_XSpellAlternatives_idl__
  20 #define __com_sun_star_linguistic2_XSpellAlternatives_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24
  25
  26 module com { module sun { module star { module linguistic2 {
  27
  28 /** Gives access to the results of failed
  29     spell checking attempts and may provide spelling alternatives.
  30
  31     <P>This is used by the
  32     com::sun::star::linguistic2::XSpellChecker::spell()
  33     function when the word was not found to be correct.
  34     Suggestions for other words to be used may be provided along with
  35     a failure-type that may specify why the word was not correct.
  36     </P>
  37
  38     @see    com::sun::star::linguistic2::SpellFailure
  39 */
  40 published interface XSpellAlternatives : com::sun::star::uno::XInterface
  41 {
  42     /**
  43          @returns
  44              the word that was misspelled.
  45      */
  46     string getWord();
  47
  48     /**
  49         @returns
  50             the Locale which specifies the language of the misspelled word.
  51     */
  52     com::sun::star::lang::Locale getLocale();
  53
  54     /**
  55         @returns
  56             the type (reason) for spell checking to have failed verification.
  57
  58     @see    com::sun::star::linguistic2::SpellFailure
  59     */
  60     short getFailureType();
  61
  62     /**
  63         @returns
  64             the number of suggested spelling alternatives available.
  65     */
  66     short getAlternativesCount();
  67
  68     /**
  69          @returns
  70             the sequence of suggested spelling alternatives.
  71     */
  72     sequence<string> getAlternatives();
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */