AOO410/main/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__
#define __com_sun_star_linguistic2_SingleProofreadingError_idl__

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.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 {

//=============================================================================
/** holds a single error found by the proofreader.

	@since OpenOffice 3.0.1
*/
struct SingleProofreadingError
{
    // start index of the error text
    // indicating the text to be replaced if suggestions are applied
    long nErrorStart;

    // the length of the error text
    // indicating the text to be replaced if suggestions are applied
    long nErrorLength;

    // as in com.sun.star.text.TextMarkupType
    long nErrorType;

    // the id of the rule that this error is violating
    string aRuleIdentifier;

    // short error description text (usually to be displayed in context menu)
    string aShortComment;

    // full error description text (usually to be displayed in dialog)
    string aFullComment;

    // a list of correction suggestions
    // Usually emtpy if only automatic checking was done.
    sequence< string > aSuggestions;
	
    // a list of properties
    sequence< com::sun::star::beans::PropertyValue > aProperties;
};

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

}; }; }; };

#endif