offapi/com/sun/star/linguistic2/LinguServiceEvent.idl

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