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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__
  28 #define __com_sun_star_linguistic2_XSpellAlternatives_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_Locale_idl__
  35 #include <com/sun/star/lang/Locale.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module linguistic2 {
  41
  42 //=============================================================================
  43 /** Gives access to the results of failed
  44     spellchecking attempts and may provide spelling alternatives.
  45
  46     <P>This is used by the
  47     <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member>
  48     function when the word was not found to be correct.
  49     Suggestions for other words to be used may be provided along with
  50     a failure-type that may specifiy why the word was not correct.
  51     </P>
  52
  53     @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
  54 */
  55 published interface XSpellAlternatives : com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /**
  59          @returns
  60              the word that was misspelled.
  61      */
  62     string getWord();
  63
  64     //-------------------------------------------------------------------------
  65     /**
  66         @returns
  67             the Locale which specifies the language of the misspelled word.
  68     */
  69     com::sun::star::lang::Locale getLocale();
  70
  71     //-------------------------------------------------------------------------
  72     /**
  73         @returns
  74             the type (reason) for spellchecking to have failed verification.
  75
  76     @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
  77     */
  78     short getFailureType();
  79
  80     //-------------------------------------------------------------------------
  81     /**
  82         @returns
  83             the number of suggested spelling alternatives available.
  84     */
  85     short getAlternativesCount();
  86
  87     //-------------------------------------------------------------------------
  88     /**
  89          @returns
  90             the sequence of suggested spelling alternatives.
  91     */
  92     sequence<string> getAlternatives();
  93
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif