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

interface XSpellAlternatives
Base Interfaces
::com::sun::star::uno::XInterface
  |  
  +--XSpellAlternatives
::com::sun::star::uno::XInterface
(referenced interface's summary:)
base interface of all UNO interfaces
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
unknown ?
SpellFailure

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

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

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

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

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

Description
Returns
the sequence of suggested spelling alternatives.
Top of Page