LibreOffice LibreOffice 25.2 SDK API Reference

XProofreadingIterator.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 XProofreadingIterator: com::sun::star::uno::XInterface
28{
40 void startProofreading( [in] com::sun::star::uno::XInterface xDocument,
41 [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider )
42 raises( com::sun::star::lang::IllegalArgumentException );
43
71 ProofreadingResult checkSentenceAtPosition( [in] com::sun::star::uno::XInterface xDocument,
72 [in] com::sun::star::text::XFlatParagraph xFlatParagraph,
73 [in] string aText,
74 [in] com::sun::star::lang::Locale aLocale,
75 [in] long nStartOfSentencePosition,
76 [in] long nSuggestedBehindEndOfSentencePosition,
77 [in] long nErrorPositionInParagraph )
78 raises( com::sun::star::lang::IllegalArgumentException );
79
82 void resetIgnoreRules();
83
92 boolean isProofreading( [in] com::sun::star::uno::XInterface xDocument );
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::XProofreadingIterator
API for the proofreading iterator that mediates between the document and the proofreader.
Definition: XProofreadingIterator.idl:28
com::sun::star::linguistic2::XProofreadingIterator::checkSentenceAtPosition
ProofreadingResult checkSentenceAtPosition([in] com::sun::star::uno::XInterface xDocument, [in] com::sun::star::text::XFlatParagraph xFlatParagraph, [in] string aText, [in] com::sun::star::lang::Locale aLocale, [in] long nStartOfSentencePosition, [in] long nSuggestedBehindEndOfSentencePosition, [in] long nErrorPositionInParagraph)
start proofreading from a given position
com::sun::star::linguistic2::XProofreadingIterator::startProofreading
void startProofreading([in] com::sun::star::uno::XInterface xDocument, [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider)
start proofreading and automatically process the whole text
com::sun::star::linguistic2::XProofreadingIterator::resetIgnoreRules
void resetIgnoreRules()
clears the list of ignored rules for each proofreader
com::sun::star::linguistic2::XProofreadingIterator::isProofreading
boolean isProofreading([in] com::sun::star::uno::XInterface xDocument)
checks if the given document is currently being checked
com::sun::star::text::XFlatParagraphIteratorProvider
provides functionality to ...
Definition: XFlatParagraphIteratorProvider.idl:35
com::sun::star::text::XFlatParagraph
provides functionality to ...
Definition: XFlatParagraph.idl:30
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
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