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

interface XGrammarCheckingIterator

Methods' Summary
startGrammarChecking start grammar checking and automatically process the whole text  
checkGrammarAtPos start grammar checking from one given position  
getEndOfSentence get the sentence boundary  
isGrammarChecking checks if the given document is currently being checked  
Methods' Details
startGrammarChecking
void
startGrammarChecking( [in] ::com::sun::star::uno::XInterface  xDoc,
[in] ::com::sun::star::text::XFlatParagraphIteratorProvider  xIteratorProvider,
[in] boolean  bAutomatic )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start grammar checking and automatically process the whole text
Parameter xDoc
the text document.
Parameter xIteratorProvider
the flat paragraph iterator provider.
Parameter bAutomatic
automatic grammar checking.
Throws
IllegalArgumentException when any argument is wrong.
checkGrammarAtPos
GrammarCheckingResult
checkGrammarAtPos( [in] ::com::sun::star::uno::XInterface  xDoc,
[in] ::com::sun::star::text::XFlatParagraph  xFlatPara,
[in] string  aText,
[in] ::com::sun::star::lang::Locale  aLocale,
[in] long  nStartOfSentencePos,
[in] long  nSuggestedEndOfSentencePos,
[in] long  nErrorPosInPara )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start grammar checking from one 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.
getEndOfSentence
long
getEndOfSentence( [in] ::com::sun::star::text::XFlatParagraph  xFlatPara,
[in] long  nSentenceStartPos )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
get the sentence boundary
Parameter nSentenceStartPos
the start index of the sentence.
Returns
the end position.
Throws
IllegalArgumentException when any argument is wrong.
isGrammarChecking
boolean
isGrammarChecking( [in] ::com::sun::star::uno::XInterface  xDoc,
[in] boolean  bAutomatic );

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