Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XSpellChecker

Base Interface
com::sun::star::linguistic2::XSupportedLocales

Description
This interface allows for spellchecking.

It is possible to simply check if a word, in a specified language, is correct or additionally, if it was misspelled, some proposals how it might be correctly written.

See also
unknown ?
XSupportedLocales


Known Services which Export this Interface

com::sun::star::linguistic2::SpellChecker offers spellchecking functionality.

Methods' Summary

isValid checks if a word is spelled correctly in a given language.
spell This method checks if a word is spelled correctly in a given language.

Methods' Details

isValid
 
boolean
isValid(
[ in ] string aWord,
[ in ] com::sun::star::lang::Locale aLocale,
[ in ] com::sun::star::beans::PropertyValues aProperties )
raises ( com::sun::star::lang::IllegalArgumentException );

Description
checks if a word is spelled correctly in a given language.
Returns
true if the word is spelled correctly using the specified language, false otherwise.
Parameter aWord
the word to be checked.
Parameter aLocale
the Locale (language) to be used. If the Locale is empty, the word is spelled correctly by definition.

If aLocale is not supported an IllegalArgumentException exception is raised.

Parameter aProperties
provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set.
See also
unknown ?
Locale
spell
 
com::sun::star::linguistic2::XSpellAlternatives
spell(
[ in ] string aWord,
[ in ] com::sun::star::lang::Locale aLocale,
[ in ] com::sun::star::beans::PropertyValues aProperties )
raises ( com::sun::star::lang::IllegalArgumentException );

Description
This method checks if a word is spelled correctly in a given language.
Returns
NULL if aWord is spelled correctly using aLocale . Otherwise, an XSpellAlternatives object with information about the reason of failure and, if available, proposals for spelling alternatives will be returned.
Parameter aWord
the word to be checked.
Parameter aLocale
the language to be used.

If the language is not supported an IllegalArgumentException exception is raised.

Parameter aProperties
provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. exception is raised.

See also
unknown ?
XSpellAlternatives
See also
unknown ?
Locale

Top of Page