offapi/com/sun/star/linguistic2/DictionaryEvent.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_DictionaryEvent_idl__
  28 #define __com_sun_star_linguistic2_DictionaryEvent_idl__
  29
  30 #ifndef __com_sun_star_lang_EventObject_idl__
  31 #include <com/sun/star/lang/EventObject.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  35 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module linguistic2 {
  42
  43 //=============================================================================
  44 /** represents a dictionary event.
  45
  46     <P>This type of event is used by a dictionary to inform
  47     its listeners about changes in its properties or its entry list.
  48     It consists of an event type and may supply an affected
  49     dictionary entry.</P>
  50
  51     @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  52     @see    <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
  53     @see    <type scope="com::sun::star::lang">EventObject</type>
  54 */
  55 published struct DictionaryEvent : com::sun::star::lang::EventObject
  56 {
  57     //-------------------------------------------------------------------------
  58     /** is the type of event.
  59
  60          <p>This must be the value of a single flag. No combinations are
  61          allowed.</p>
  62
  63         @see    <type scope="com::sun::star::linguistic2">DictionaryEventFlags</type>
  64     */
  65     short nEvent;
  66
  67     //-------------------------------------------------------------------------
  68     /** is the affected dictionary entry (if any).
  69
  70          <p>It must be set if an entry was
  71          added or deleted, otherwise it should be empty.</p>
  72
  73         @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
  74     */
  75     com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry;
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif