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 spell checking. 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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.