Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: linguistic2 ::
interface XSpellAlternatives
Description Gives access to the results of failed spell checking 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 specify why the word was not correct. See also SpellFailure

Methods' Summary
getWord |
getLocale |
getFailureType |
getAlternativesCount |
getAlternatives |

Methods' Details
getWord
string
getWord();
Returns the word that was misspelled.
getLocale
::com::sun::star::lang::Locale
getLocale();
Returns the Locale which specifies the language of the misspelled word.
getFailureType
short
getFailureType();
Returns the type (reason) for spell checking to have failed verification. See also SpellFailure
getAlternativesCount
short
getAlternativesCount();
Returns the number of suggested spelling alternatives available.
getAlternatives
sequence< string >
getAlternatives();
Returns the sequence of suggested spelling alternatives.

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.