summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl
blob: 407a45517827bb9478aed455dba17b9eb20603da (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: LinguServiceEvent.idl,v $
 * $Revision: 1.10 $
 *
 * 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_LinguServiceEvent_idl__
#define __com_sun_star_linguistic2_LinguServiceEvent_idl__

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

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

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

//=============================================================================
/** represents a linguistic service event.

    <P>This type of event may be broadcast by a spellchecker or
    hyphenator service implementation to inform its listeners (clients)
    that the results of previous function calls may be different now.
    It is possible to suggest that hyphenation should be done again
    and/or the spelling of previously incorrect or correct words
    should be checked again.</P>

    @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventBroadcaster</type>
    @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
    @see    <type scope="com::sun::star::linguistic2">SpellChecker</type>
    @see    <type scope="com::sun::star::linguistic2">Hyphenator</type>
    @see    <type scope="com::sun::star::lang">EventObject</type>
*/
published struct LinguServiceEvent : com::sun::star::lang::EventObject
{
    //-------------------------------------------------------------------------
    /** The type of event.

         <p>The value may be combined via logical OR from those values
        defined in <type scope="com::sun::star::linguistic2">LinguServiceEventFlags</type></p>
    */
    short nEvent;

};

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

}; }; }; };

#endif