LibreOffice 7.4 SDK API Reference
Public Member Functions | List of all members
XProofreader Interface Reference

API for proofreading a text. More...


Inheritance diagram for XProofreader:
XSupportedLocales XInterface Proofreader

Public Member Functions

boolean isSpellChecker ()
 whether is the text checked by the spell checker More...
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 )
 start checking More...
void ignoreRule ([in] string aRuleIdentifier, [in] com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IllegalArgumentException )
 disables a specific rule for a given locale. More...
void resetIgnoreRules ()
 sets all rules back to their default settings. More...
- Public Member Functions inherited from XSupportedLocales
sequence< com::sun::star::lang::LocalegetLocales ()
boolean hasLocale ([in] com::sun::star::lang::Locale aLocale)
- 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 proofreading a text.

OOo 3.0.1

Member Function Documentation

◆ 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

start checking

aDocumentIdentifierthe Document ID.
aTextthe flat text to be checked.
aLocaleLanguage used in the text.
nStartOfSentencePositionStart Index of the text.
nSuggestedBehindEndOfSentencePositionProbable end position of the text.
aPropertiesadditional 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
IllegalArgumentExceptionwhen any argument is wrong.

◆ ignoreRule()

void ignoreRule ( [in] string  aRuleIdentifier,
[in] com::sun::star::lang::Locale  aLocale 
raises (com::sun::star::lang::IllegalArgumentException

disables a specific rule for a given locale.

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

◆ isSpellChecker()

boolean isSpellChecker ( )

whether is the text checked by the spell checker

true if it is also a spell checker

◆ resetIgnoreRules()

void resetIgnoreRules ( )

sets all rules back to their default settings.

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