1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_XProofreader_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_linguistic2_XProofreader_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_Locale_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/Locale.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_XSupportedLocales_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/linguistic2/XSupportedLocales.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_XFlatParagraph_idl__ 43*b1cdbd2cSJim Jagielski#include <com/sun/star/text/XFlatParagraph.idl> 44*b1cdbd2cSJim Jagielski#endif 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_linguistic2_ProofreadingResult_idl__ 47*b1cdbd2cSJim Jagielski#include <com/sun/star/linguistic2/ProofreadingResult.idl> 48*b1cdbd2cSJim Jagielski#endif 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski#ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_idl_ 51*b1cdbd2cSJim Jagielski#include <com/sun/star/beans/PropertyValue.idl> 52*b1cdbd2cSJim Jagielski#endif 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski//============================================================================= 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module linguistic2 { 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski//============================================================================= 59*b1cdbd2cSJim Jagielski/** API for proofreading a text 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @since OpenOffice 3.0.1 62*b1cdbd2cSJim Jagielski*/ 63*b1cdbd2cSJim Jagielskiinterface XProofreader: com::sun::star::linguistic2::XSupportedLocales 64*b1cdbd2cSJim Jagielski{ 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 67*b1cdbd2cSJim Jagielski /** whether is the text checked by the spellchecker 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @returns true if it is also a spell checker 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski boolean isSpellChecker(); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski /** start checking 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @param nDocId 77*b1cdbd2cSJim Jagielski the Document ID. 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @param rFlatParaText 80*b1cdbd2cSJim Jagielski the flat text to be checked. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski @param xFlatPara 83*b1cdbd2cSJim Jagielski the flat paragraph to be checked. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @param aLocale 86*b1cdbd2cSJim Jagielski Language used in the text. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @param nStartOfSentencePos 89*b1cdbd2cSJim Jagielski Start Index of the text. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param nSuggestedSentenceEndPos 92*b1cdbd2cSJim Jagielski Probable end position of the text. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @throws IllegalArgumentException 95*b1cdbd2cSJim Jagielski when any argument is wrong. 96*b1cdbd2cSJim Jagielski */ 97*b1cdbd2cSJim Jagielski ProofreadingResult doProofreading( [in] string aDocumentIdentifier, 98*b1cdbd2cSJim Jagielski [in] string aText, 99*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale, 100*b1cdbd2cSJim Jagielski [in] long nStartOfSentencePosition, 101*b1cdbd2cSJim Jagielski [in] long nSuggestedBehindEndOfSentencePosition, 102*b1cdbd2cSJim Jagielski [in] sequence< com::sun::star::beans::PropertyValue > aProperties ) 103*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException ); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 106*b1cdbd2cSJim Jagielski /** disables a specific rule for a given locale. 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski <p>If the locale is empty the rule should be ignored for all languages.</p> 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski void ignoreRule( [in] string aRuleIdentifier, 111*b1cdbd2cSJim Jagielski [in] com::sun::star::lang::Locale aLocale ) 112*b1cdbd2cSJim Jagielski raises( com::sun::star::lang::IllegalArgumentException ); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 115*b1cdbd2cSJim Jagielski /** sets all rules back to their default settings. 116*b1cdbd2cSJim Jagielski */ 117*b1cdbd2cSJim Jagielski void resetIgnoreRules(); 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski}; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski//============================================================================= 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski}; }; }; }; 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski#endif 126