offapi/com/sun/star/linguistic2/XSpellAlternatives.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: XSpellAlternatives.idl,v $
  10  * $Revision: 1.10 $
  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_XSpellAlternatives_idl__
  31 #define __com_sun_star_linguistic2_XSpellAlternatives_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_Locale_idl__
  38 #include <com/sun/star/lang/Locale.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module linguistic2 {
  44
  45 //=============================================================================
  46 /** Gives access to the results of failed
  47     spellchecking attempts and may provide spelling alternatives.
  48
  49     <P>This is used by the
  50     <member scope="com::sun::star::linguistic2">XSpellChecker::spell</member>
  51     function when the word was not found to be correct.
  52     Suggestions for other words to be used may be provided along with
  53     a failure-type that may specifiy why the word was not correct.
  54     </P>
  55
  56     @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
  57 */
  58 published interface XSpellAlternatives : com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61     /**
  62          @returns
  63              the word that was misspelled.
  64      */
  65     string getWord();
  66
  67     //-------------------------------------------------------------------------
  68     /**
  69         @returns
  70             the Locale which specifies the language of the misspelled word.
  71     */
  72     com::sun::star::lang::Locale getLocale();
  73
  74     //-------------------------------------------------------------------------
  75     /**
  76         @returns
  77             the type (reason) for spellchecking to have failed verification.
  78
  79     @see    <tyoe scope="com::sun::star::linguistic2">SpellFailure</type>
  80     */
  81     short getFailureType();
  82
  83     //-------------------------------------------------------------------------
  84     /**
  85         @returns
  86             the number of suggested spelling alternatives available.
  87     */
  88     short getAlternativesCount();
  89
  90     //-------------------------------------------------------------------------
  91     /**
  92          @returns
  93             the sequence of suggested spelling alternatives.
  94     */
  95     sequence<string> getAlternatives();
  96
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif