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

interface XProofreader
Base Interfaces
XProofreaderXSupportedLocales

XSupportedLocales
(referenced interface's summary:)

Methods' Summary
isSpellChecker whether is the text checked by the spell checker  
doProofreading start checking  
ignoreRule disables a specific rule for a given locale.  
resetIgnoreRules sets all rules back to their default settings.  
Methods' Details
isSpellChecker
boolean
isSpellChecker();

Description
whether is the text checked by the spell checker
Returns
true if it is also a spell checker
doProofreading
ProofreadingResult
doProofreading( [in] string  aDocumentIdentifier,
[in] string  aText,
[in] ::com::sun::star::lang::Locale  aLocale,
[in] long  nStartOfSentencePosition,
[in] long  nSuggestedBehindEndOfSentencePosition,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aProperties )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
start checking
Parameter aDocumentIdentifier
the Document ID.
Parameter aText
the flat text to be checked.
Parameter aLocale
Language used in the text.
Parameter nStartOfSentencePosition
Start Index of the text.
Parameter nSuggestedBehindEndOfSentencePosition
Probable end position of the text.
Parameter aProperties
additional properties of the text. Currently the following properties may be supported:
FieldPositions sequence<long> indexes of fields in aText
FootnotePositions sequence<long> indexes of footnotes in aText
Throws
IllegalArgumentException when any argument is wrong.
ignoreRule
void
ignoreRule( [in] string  aRuleIdentifier,
[in] ::com::sun::star::lang::Locale  aLocale )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
disables a specific rule for a given locale.

If the locale is empty the rule should be ignored for all languages.

resetIgnoreRules
void
resetIgnoreRules();

Description
sets all rules back to their default settings.
Top of Page