:: com :: sun :: star :: linguistic2 ::
|
interface XSpellChecker |
- Base Interfaces
XSpellChecker
┗ XSupportedLocales
XSupportedLocales |
- (referenced interface's summary:)
- Offers information about which languages are supported by the object.
|
|
- 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
- XSupportedLocales
|
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
- 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
- ::com::sun::star::lang::Locale
|
|
spell
- 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
- XSpellAlternatives, ::com::sun::star::lang::Locale
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.