LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XProofreadingIterator Interface Reference

API for the proofreading iterator that mediates between the document and the proofreader. More...

import"XProofreadingIterator.idl";

Inheritance diagram for XProofreadingIterator:
XInterface ProofreadingIterator

Public Member Functions

void startProofreading ([in] com::sun::star::uno::XInterface xDocument, [in] com::sun::star::text::XFlatParagraphIteratorProvider xIteratorProvider) raises ( com::sun::star::lang::IllegalArgumentException )
 start proofreading and automatically process the whole text More...
 
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) raises ( com::sun::star::lang::IllegalArgumentException )
 start proofreading from a given position More...
 
void resetIgnoreRules ()
 clears the list of ignored rules for each proofreader More...
 
boolean isProofreading ([in] com::sun::star::uno::XInterface xDocument)
 checks if the given document is currently being checked More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

API for the proofreading iterator that mediates between the document and the proofreader.

Since
OOo 3.0.1

Member Function Documentation

◆ 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 
)
raises (com::sun::star::lang::IllegalArgumentException
)

start proofreading from a given position

Parameters
xDocumentthe document.
xFlatParagraphthe single flat paragraph to be checked.
aTextthe text of the paragraph to be checked.
aLocalecurrently unused parameter.
nStartOfSentencePositionthe start position of the current sentence.
nSuggestedBehindEndOfSentencePositioncurrently unused parameter.
nErrorPositionInParagraphthe given index.
Exceptions
IllegalArgumentExceptionwhen any argument is wrong.

◆ isProofreading()

boolean isProofreading ( [in] com::sun::star::uno::XInterface  xDocument)

checks if the given document is currently being checked

Parameters
xDocumentthe document.
Returns
if the document is currently being checked.

◆ resetIgnoreRules()

void resetIgnoreRules ( )

clears the list of ignored rules for each proofreader

◆ startProofreading()

void startProofreading ( [in] com::sun::star::uno::XInterface  xDocument,
[in] com::sun::star::text::XFlatParagraphIteratorProvider  xIteratorProvider 
)
raises (com::sun::star::lang::IllegalArgumentException
)

start proofreading and automatically process the whole text

Parameters
xDocumentthe text document.
xIteratorProviderthe flat paragraph iterator provider.
Exceptions
IllegalArgumentExceptionwhen any argument is wrong.

The documentation for this interface was generated from the following file: