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 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 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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.