diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/linguistic2/XSpellAlternatives.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/linguistic2/XSpellAlternatives.idl')
-rw-r--r-- | offapi/com/sun/star/linguistic2/XSpellAlternatives.idl | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl new file mode 100644 index 000000000..8f5fd67fa --- /dev/null +++ b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl @@ -0,0 +1,81 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_linguistic2_XSpellAlternatives_idl__ +#define __com_sun_star_linguistic2_XSpellAlternatives_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/Locale.idl> + + +module com { module sun { module star { module linguistic2 { + +/** Gives access to the results of failed + spell checking attempts and may provide spelling alternatives. + + <P>This is used by the + com::sun::star::linguistic2::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. + </P> + + @see com::sun::star::linguistic2::SpellFailure +*/ +published interface XSpellAlternatives : com::sun::star::uno::XInterface +{ + /** + @returns + the word that was misspelled. + */ + string getWord(); + + /** + @returns + the Locale which specifies the language of the misspelled word. + */ + com::sun::star::lang::Locale getLocale(); + + /** + @returns + the type (reason) for spell checking to have failed verification. + + @see com::sun::star::linguistic2::SpellFailure + */ + short getFailureType(); + + /** + @returns + the number of suggested spelling alternatives available. + */ + short getAlternativesCount(); + + /** + @returns + the sequence of suggested spelling alternatives. + */ + sequence<string> getAlternatives(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |