LibreOffice: com/sun/star/linguistic2/XProofreader.idl Source File

LibreOffice LibreOffice 7.3 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
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/lang/IllegalArgumentException.idl>
24#include <com/sun/star/lang/Locale.idl>
25#include <com/sun/star/linguistic2/XSupportedLocales.idl>
26#include <com/sun/star/text/XFlatParagraph.idl>
27#include <com/sun/star/linguistic2/ProofreadingResult.idl>
28#include <com/sun/star/beans/PropertyValue.idl>
29
30
31module com { module sun { module star { module linguistic2 {
32
37 interface XProofreader: com::sun::star::linguistic2::XSupportedLocales
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 )
89 raises( com::sun::star::lang::IllegalArgumentException );
90
95 void ignoreRule( [in] string aRuleIdentifier,
96 [in] com::sun::star::lang::Locale aLocale )
97 raises( com::sun::star::lang::IllegalArgumentException );
98
101 void resetIgnoreRules();
102
103};
104
105
106}; }; }; };
107
108#endif
109
110/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
Locale.idl
ProofreadingResult.idl
PropertyValue.idl
XFlatParagraph.idl
XInterface.idl
XSupportedLocales.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::linguistic2::XProofreader
API for proofreading a text.
Definition: XProofreader.idl:38
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:43
com
Definition: Accessible.idl:22
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38
com::sun::star::linguistic2::ProofreadingResult
holds the results from proofreading a sentence.
Definition: ProofreadingResult.idl:38