interface XSpellAlternatives in module com::sun::star::linguistic2::

(Global Index)

Syntax

interface XSpellAlternatives : com::sun::star::uno::XInterface ;

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

SpellFailure

Method Summary

getWord

getLocale

getFailureType

getAlternativesCount

getAlternatives

Method Details



getWord

Syntax

string getWord ();

Description

Returns

the word that was misspelled.

getLocale

Syntax

com::sun::star::lang::Locale getLocale ();

Description

Returns

the Locale which specifies the language of the misspelled word.

getFailureType

Syntax

short getFailureType ();

Description

Returns

the type (reason) for spellchecking to have failed verification.

See also

SpellFailure

getAlternativesCount

Syntax

short getAlternativesCount ();

Description

Returns

the number of suggested spelling alternatives available.

getAlternatives

Syntax

sequence< string > getAlternatives ();

Description

Returns

the sequence of suggested spelling alternatives.
Top of Page