summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl
blob: 09aed304fe8b8191ef18cfccd18d7d7ec1119cae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* -*- 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_XSetSpellAlternatives_idl__
#define __com_sun_star_linguistic2_XSetSpellAlternatives_idl__

#include <com/sun/star/uno/XInterface.idl>



module com { module sun { module star { module linguistic2 {

/**
    allows to modify the suggestion list returned by a spell checker.

    <P>Basically this is needed to post-add further suggestions while keeping the
    originally returned reference from the spell checker.
    E.g. from the user dictionaries.</P>

    @see    com::sun::star::linguistic2::XSpellAlternatives
*/
interface XSetSpellAlternatives : com::sun::star::uno::XInterface
{
    /**
        set the list of suggestions to be returned.

        @since  OOo 3.0.1
    */
    void setAlternatives( [in] sequence< string > aAlternatives );

    /**
        set the type of error found.

        @see    com::sun::star::linguistic2::SpellFailure
        @since  OOo 3.0.1
    */
    void setFailureType( [in] short nFailureType );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */