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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DictionaryEvent.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_DictionaryEvent_idl__
  31 #define __com_sun_star_linguistic2_DictionaryEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  38 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module linguistic2 {
  45
  46 //=============================================================================
  47 /** represents a dictionary event.
  48
  49     <P>This type of event is used by a dictionary to inform
  50     its listeners about changes in its properties or its entry list.
  51     It consists of an event type and may supply an affected
  52     dictionary entry.</P>
  53
  54     @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  55     @see    <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
  56     @see    <type scope="com::sun::star::lang">EventObject</type>
  57 */
  58 published struct DictionaryEvent : com::sun::star::lang::EventObject
  59 {
  60     //-------------------------------------------------------------------------
  61     /** is the type of event.
  62
  63          <p>This must be the value of a single flag. No combinations are
  64          allowed.</p>
  65
  66         @see    <type scope="com::sun::star::linguistic2">DictionaryEventFlags</type>
  67     */
  68     short nEvent;
  69
  70     //-------------------------------------------------------------------------
  71     /** is the affected dictionary entry (if any).
  72
  73          <p>It must be set if an entry was
  74          added or deleted, otherwise it should be empty.</p>
  75
  76         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
  77     */
  78     com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry;
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif