Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XSpellAlternatives
Description
Gives access to the results of failed spellchecking attempts and may provide spelling alternatives.

This is used by the XSpellChecker::spell function when the word was not found to be correct. Suggestions for other words to be used may be provided along with a failure-type that may specifiy why the word was not correct.

See also
? (no identifier found)
SpellFailure

Methods' Summary
getWord  
getLocale  
getFailureType  
getAlternativesCount  
getAlternatives  
Methods' Details
getWord
string
getWord();

Returns
the word that was misspelled.
getLocale
::com::sun::star::lang::Locale
getLocale();

Returns
the Locale which specifies the language of the misspelled word.
getFailureType
short
getFailureType();

Returns
the type (reason) for spellchecking to have failed verification.
See also
? (no identifier found)
SpellFailure
getAlternativesCount
short
getAlternativesCount();

Returns
the number of suggested spelling alternatives available.
getAlternatives
sequence< string >
getAlternatives();

Returns
the sequence of suggested spelling alternatives.
Top of Page

Apache Software Foundation

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

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