/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__
#define __com_sun_star_linguistic2_ProofreadingResult_idl__

#ifndef __com_sun_star_text_XFlatParagraph_idl__
#include <com/sun/star/text/XFlatParagraph.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
#include <com/sun/star/linguistic2/SingleProofreadingError.idl>
#endif

#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_
#include <com/sun/star/beans/PropertyValue.idl>
#endif



//=============================================================================

module com {  module sun {  module star {  module linguistic2 {

// forward declaration
interface XProofreader;

//=============================================================================
/** holds the results from proofreading a sentence.

    @since  OOo 3.0.1
*/
struct ProofreadingResult
{
    // the document ID
    string aDocumentIdentifier;

    // the paragraph that was checked
    com::sun::star::text::XFlatParagraph xFlatParagraph;

    // text that was checked (the paragraphs content may have changed meanwhile!)
    string aText;

    // language used for checking
    com::sun::star::lang::Locale aLocale;

    // the start of sentence position passed to the proofreader
    long nStartOfSentencePosition;

    // the end of sentence position found by the proofreader
    // That is the index following the character terminating the sentence.
    long nBehindEndOfSentencePosition;

    // the start of the next sentence to be checked.
    // Basically obtained by skipping all white spaces after the end of sentence position.
    long nStartOfNextSentencePosition;

    // the list of errors
    sequence< com::sun::star::linguistic2::SingleProofreadingError > aErrors;

    // a list of properties
    sequence< com::sun::star::beans::PropertyValue > aProperties;

    // reference to the specific proofreader implementation that reported the error
    com::sun::star::linguistic2::XProofreader xProofreader;
};

//=============================================================================

}; }; }; };

#endif