(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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
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
::com::sun::star::lang::Locale
spell
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
XSpellAlternatives, ::com::sun::star::lang::Locale
Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

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

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.