offapi/com/sun/star/linguistic2/ProofreadingResult.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: ProofreadingResult.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_ProofreadingResult_idl__
  31 #define __com_sun_star_linguistic2_ProofreadingResult_idl__
  32
  33 #ifndef __com_sun_star_text_XFlatParagraph_idl__
  34 #include <com/sun/star/text/XFlatParagraph.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_Locale_idl__
  38 #include <com/sun/star/lang/Locale.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
  42 #include <com/sun/star/linguistic2/SingleProofreadingError.idl>
  43 #endif
  44
  45 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
  46 #include <com/sun/star/beans/PropertyValue.idl>
  47 #endif
  48
  49
  50
  51 //=============================================================================
  52
  53 module com {  module sun {  module star {  module linguistic2 {
  54
  55 // forward declaration
  56 interface XProofreader;
  57
  58 //=============================================================================
  59 /** holds the results from proofreading a sentence.
  60
  61     @since      OOo 3.0.1
  62 */
  63 struct ProofreadingResult
  64 {
  65     // the document ID
  66     string aDocumentIdentifier;
  67
  68     // the paragraph that was checked
  69     com::sun::star::text::XFlatParagraph xFlatParagraph;
  70
  71     // text that was checked (the paragraphs content may have changed meanwhile!)
  72     string aText;
  73
  74     // language used for checking
  75     com::sun::star::lang::Locale aLocale;
  76
  77     // the start of sentence position passed to the proofreader
  78     long nStartOfSentencePosition;
  79
  80     // the end of sentence position found by the proofreader
  81     // That is the index following the character terminating the sentence.
  82     long nBehindEndOfSentencePosition;
  83
  84     // the start of the next sentence to be checked.
  85     // Basically obtained by skipping all white spaces after the end of sentence position.
  86     long nStartOfNextSentencePosition;
  87
  88     // the list of errors
  89     sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors;
  90
  91     // a list of properties
  92     sequence< com::sun::star::beans::PropertyValue > aProperties;
  93
  94     // reference to the specific proofreader implementation that reported the error
  95     com::sun::star::linguistic2::XProofreader xProofreader;
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif