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

interface XGrammarChecker
Base Interfaces
XGrammarCheckerXSupportedLocales

XSupportedLocales
(referenced interface's summary:)
Offers information about which languages are supported by the object.

Methods' Summary
isSpellChecker whether is the text checked by the spellchecker  
startDocument start checking document. This enables the grammar checker to maintain state information about the document  
startParagraph start checking paragraph  
endParagraph end checking paragraph  
endDocument end checking document  
doGrammarChecking start checking  
hasOptionsDialog check whether the checker has the options dialog  
runOptionsDialog call a dialog in order to display the setting options  
Methods' Details
isSpellChecker
boolean
isSpellChecker();

Description
whether is the text checked by the spellchecker
Returns
true if it is also a spell checker
startDocument
void
startDocument( [in] long  nDocId )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start checking document. This enables the grammar checker to maintain state information about the document
Parameter nDocId
the Document ID.
Throws
IllegalArgumentException when any argument is wrong.
startParagraph
void
startParagraph( [in] long  nDocId )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start checking paragraph
Parameter nDocId
the Document ID.
Throws
IllegalArgumentException when any argument is wrong.
endParagraph
void
endParagraph( [in] long  nDocId )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
end checking paragraph
Parameter nDocId
the Document ID.
Throws
IllegalArgumentException when any argument is wrong.
endDocument
void
endDocument( [in] long  nDocId )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
end checking document
Parameter nDocId
the Document ID.
Throws
IllegalArgumentException when any argument is wrong.
doGrammarChecking
GrammarCheckingResult
doGrammarChecking( [in] long  nDocId,
[in] string  aText,
[in] ::com::sun::star::lang::Locale  aLocale,
[in] long  nStartOfSentencePos,
[in] long  nSuggestedEndOfSentencePos,
[in] sequence< long >  aLanguagePortions,
[in] sequence< ::com::sun::star::lang::Locale >  aLanguagePortionsLocales )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start checking
Parameter nDocId
the Document ID.
Parameter rFlatParaText
the flat text to be checked.
Parameter xFlatPara
the flat paragraph to be checked.
Parameter aLocale
Language used in the text.
Parameter nStartOfSentencePos
Start Index of the text.
Parameter nSuggestedSentenceEndPos
Probable end position of the text.
Throws
IllegalArgumentException when any argument is wrong.
hasOptionsDialog
boolean
hasOptionsDialog();

Description
check whether the checker has the options dialog
Returns
true If it has false otherwise.
runOptionsDialog
void
runOptionsDialog();

Description
call a dialog in order to display the setting options
Throws
IllegalArgumentException when any argument is wrong.
Top of Page