LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21module com { module sun { module star { module linguistic2 {
22
27 interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
28{
29
34 boolean isSpellChecker();
35
73 ProofreadingResult doProofreading( [in] string aDocumentIdentifier,
74 [in] string aText,
75 [in] com::sun::star::lang::Locale aLocale,
76 [in] long nStartOfSentencePosition,
77 [in] long nSuggestedBehindEndOfSentencePosition,
78 [in] sequence< com::sun::star::beans::PropertyValue > aProperties )
79 raises( com::sun::star::lang::IllegalArgumentException );
80
85 void ignoreRule( [in] string aRuleIdentifier,
86 [in] com::sun::star::lang::Locale aLocale )
87 raises( com::sun::star::lang::IllegalArgumentException );
88
91 void resetIgnoreRules();
92
93};
94
95
96}; }; }; };
97
98/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::linguistic2::XProofreader
API for proofreading a text.
Definition XProofreader.idl:28
com::sun::star::linguistic2::XProofreader::doProofreading
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
com::sun::star::linguistic2::XProofreader::ignoreRule
void ignoreRule([in] string aRuleIdentifier, [in] com::sun::star::lang::Locale aLocale)
disables a specific rule for a given locale.
com::sun::star::linguistic2::XProofreader::isSpellChecker
boolean isSpellChecker()
whether is the text checked by the spell checker
com::sun::star::linguistic2::XProofreader::resetIgnoreRules
void resetIgnoreRules()
sets all rules back to their default settings.
com::sun::star::linguistic2::XSupportedLocales
Offers information about which languages are supported by the object.
Definition XSupportedLocales.idl:37
com
Definition Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:34
com::sun::star::linguistic2::ProofreadingResult
holds the results from proofreading a sentence.
Definition ProofreadingResult.idl:31