Interface XProofreadingIterator

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: linguistic2 ::

unpublished

interface XProofreadingIterator

Usage Restrictions: not published
Description: API for the proofreading iterator that mediates between the document and the proofreader.
Since: OOo 3.0.1

Methods' Summary
startProofreading	start proofreading and automatically process the whole text
checkSentenceAtPosition	start proofreading from a given position
resetIgnoreRules	clears the list of ignored rules for each prrofreader
isProofreading	checks if the given document is currently being checked

Methods' Details

startProofreading

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

Description: start proofreading and automatically process the whole text
Parameter xDoc: the text document.
Parameter xIteratorProvider: the flat paragraph iterator provider.
Throws: IllegalArgumentException when any argument is wrong.

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 );

Description: start proofreading from a given position
Parameter xDoc: the document.
Parameter xStartPara: the single flat paragraph to be checked.
Parameter nErrorPosInPara: the given index.
Throws: IllegalArgumentException when any argument is wrong.

resetIgnoreRules

void
resetIgnoreRules();

Description: clears the list of ignored rules for each prrofreader

isProofreading

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

Description: checks if the given document is currently being checked
Parameter xDoc: the document.
Returns: if the document is currently being checked.

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.