1 files changed, 81 insertions, 0 deletions
diff --git a/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl b/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl
new file mode 100644
index 000000000000..95d4ce58991c
--- /dev/null
+++ b/offapi/com/sun/star/linguistic2/SingleProofreadingError.idl
@@ -0,0 +1,81 @@
+/*************************************************************************
+ *
+ * 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_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  OOo 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