Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

unpublished interface XProofreader
Base Interfaces
XProofreader
┗ XSupportedLocales
XSupportedLocales
(referenced interface's summary:)
Offers information about which languages are supported by the object.
Usage Restrictions
not published
Description
API for proofreading a text
Since
OOo 3.0.1
Methods' Summary
isSpellChecker whether is the text checked by the spellchecker  
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 spellchecker
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 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.
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

Copyright © 2013, 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.

The ASF

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.