offapi/com/sun/star/linguistic2/SpellFailure.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: SpellFailure.idl,v $
  10  * $Revision: 1.9 $
  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_SpellFailure_idl__
  31 #define __com_sun_star_linguistic2_SpellFailure_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module linguistic2 {
  37
  38 //=============================================================================
  39 /** these define the various return types for spellchecking to fail verification.
  40
  41     <P>A value of this type is part of the
  42     <type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
  43     interface which is the return type for an unsuccessfull
  44     spelling attempt.</P>
  45
  46     @see    <type scope="com::sun::star::linguistic2">XSpellChecker</type>
  47 */
  48 published constants SpellFailure
  49 {
  50     //-------------------------------------------------------------------------
  51     /** The word is a negative one, that is, it should not be used.
  52     */
  53     const short IS_NEGATIVE_WORD = 2;
  54
  55     //-------------------------------------------------------------------------
  56     /** The capitalization of the word is wrong.
  57     */
  58     const short CAPTION_ERROR = 3;
  59
  60     //-------------------------------------------------------------------------
  61     /** The spelling of the word is wrong (or at least not known to be correct).
  62     */
  63     const short SPELLING_ERROR = 4;
  64
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif