offapi/com/sun/star/linguistic2/SingleProofreadingError.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: SingleProofreadingError.idl,v $
  10  * $Revision: 1.1.2.2 $
  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_SingleProofreadingError_idl__
  31 #define __com_sun_star_linguistic2_SingleProofreadingError_idl__
  32
  33 #ifndef __com_sun_star_lang_Locale_idl__
  34 #include <com/sun/star/lang/Locale.idl>
  35 #endif
  36
  37 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module linguistic2 {
  44
  45 //=============================================================================
  46 /** holds a single error found by the proofreader.
  47
  48     @since      OOo 3.0.1
  49 */
  50 struct SingleProofreadingError
  51 {
  52     // start index of the error text
  53     // indicating the text to be replaced if suggestions are applied
  54     long nErrorStart;
  55
  56     // the length of the error text
  57     // indicating the text to be replaced if suggestions are applied
  58     long nErrorLength;
  59
  60     // as in com.sun.star.text.TextMarkupType
  61     long nErrorType;
  62
  63     // the id of the rule that this error is violating
  64     string aRuleIdentifier;
  65
  66     // short error description text (usually to be displayed in context menu)
  67     string aShortComment;
  68
  69     // full error description text (usually to be displayed in dialog)
  70     string aFullComment;
  71
  72     // a list of correction suggestions
  73     // Usually emtpy if only automatic checking was done.
  74     sequence< string > aSuggestions;
  75
  76     // a list of properties
  77     sequence< com::sun::star::beans::PropertyValue > aProperties;
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 #endif