Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / linguistic2 / LinguServiceEvent.idl
blobc5ec0db5d6dc73b2403b8a4613b42f76df158ab3
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: LinguServiceEvent.idl,v $
10 * $Revision: 1.10 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_linguistic2_LinguServiceEvent_idl__
31 #define __com_sun_star_linguistic2_LinguServiceEvent_idl__
33 #ifndef __com_sun_star_lang_EventObject_idl__
34 #include <com/sun/star/lang/EventObject.idl>
35 #endif
37 //=============================================================================
39 module com { module sun { module star { module linguistic2 {
41 //=============================================================================
42 /** represents a linguistic service event.
44 <P>This type of event may be broadcast by a spellchecker or
45 hyphenator service implementation to inform its listeners (clients)
46 that the results of previous function calls may be different now.
47 It is possible to suggest that hyphenation should be done again
48 and/or the spelling of previously incorrect or correct words
49 should be checked again.</P>
51 @see <type scope="com::sun::star::linguistic2">XLinguServiceEventBroadcaster</type>
52 @see <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
53 @see <type scope="com::sun::star::linguistic2">SpellChecker</type>
54 @see <type scope="com::sun::star::linguistic2">Hyphenator</type>
55 @see <type scope="com::sun::star::lang">EventObject</type>
57 published struct LinguServiceEvent : com::sun::star::lang::EventObject
59 //-------------------------------------------------------------------------
60 /** The type of event.
62 <p>The value may be combined via logical OR from those values
63 defined in <type scope="com::sun::star::linguistic2">LinguServiceEventFlags</type></p>
65 short nEvent;
69 //=============================================================================
71 }; }; }; };
73 #endif