1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_linguistic2_SingleProofreadingError_idl__ 28#define __com_sun_star_linguistic2_SingleProofreadingError_idl__ 29 30#ifndef __com_sun_star_lang_Locale_idl__ 31#include <com/sun/star/lang/Locale.idl> 32#endif 33 34#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_ 35#include <com/sun/star/beans/PropertyValue.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module linguistic2 { 41 42//============================================================================= 43/** holds a single error found by the proofreader. 44 45 @since OOo 3.0.1 46*/ 47struct SingleProofreadingError 48{ 49 // start index of the error text 50 // indicating the text to be replaced if suggestions are applied 51 long nErrorStart; 52 53 // the length of the error text 54 // indicating the text to be replaced if suggestions are applied 55 long nErrorLength; 56 57 // as in com.sun.star.text.TextMarkupType 58 long nErrorType; 59 60 // the id of the rule that this error is violating 61 string aRuleIdentifier; 62 63 // short error description text (usually to be displayed in context menu) 64 string aShortComment; 65 66 // full error description text (usually to be displayed in dialog) 67 string aFullComment; 68 69 // a list of correction suggestions 70 // Usually emtpy if only automatic checking was done. 71 sequence< string > aSuggestions; 72 73 // a list of properties 74 sequence< com::sun::star::beans::PropertyValue > aProperties; 75}; 76 77//============================================================================= 78 79}; }; }; }; 80 81#endif 82