summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/XSetSpellAlternatives.idl
blob: 6e3304e716a519508c887588028b688af0d22b03 (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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    <type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
*/
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    <type scope="com::sun::star::linguistic2">SpellFailure</type>
        @since  OOo 3.0.1
    */
    void setFailureType( [in] short nFailureType );

};

//=============================================================================

}; }; }; };

#endif

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