LibreOffice
LibreOffice 7.2 SDK API Reference
XProofreader.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_linguistic2_XProofreader_idl__
20 #define __com_sun_star_linguistic2_XProofreader_idl__
21 
29 
30 
31 module com { module sun { module star { module linguistic2 {
32 
38 {
39 
44  boolean isSpellChecker();
45 
83  ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
84  [in] string aText,
85  [in] com::sun::star::lang::Locale aLocale,
86  [in] long nStartOfSentencePosition,
87  [in] long nSuggestedBehindEndOfSentencePosition,
88  [in] sequence< com::sun::star::beans::PropertyValue > aProperties )
90 
95  void ignoreRule( [in] string aRuleIdentifier,
96  [in] com::sun::star::lang::Locale aLocale )
98 
102 
103 };
104 
105 
106 }; }; }; };
107 
108 #endif
109 
110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
API for proofreading a text.
Definition: XProofreader.idl:38
ProofreadingResult doProofreading([in] string aDocumentIdentifier, [in] string aText, [in] com::sun::star::lang::Locale aLocale, [in] long nStartOfSentencePosition, [in] long nSuggestedBehindEndOfSentencePosition, [in] sequence< com::sun::star::beans::PropertyValue > aProperties)
start checking
void ignoreRule([in] string aRuleIdentifier, [in] com::sun::star::lang::Locale aLocale)
disables a specific rule for a given locale.
boolean isSpellChecker()
whether is the text checked by the spell checker
void resetIgnoreRules()
sets all rules back to their default settings.
Offers information about which languages are supported by the object.
Definition: XSupportedLocales.idl:43
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:48
holds the results from proofreading a sentence.
Definition: ProofreadingResult.idl:38