/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_DictionaryEvent_idl__
#define __com_sun_star_linguistic2_DictionaryEvent_idl__

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

#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
#include <com/sun/star/linguistic2/XDictionaryEntry.idl>
#endif


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

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

//=============================================================================
/** represents a dictionary event.

    <P>This type of event is used by a dictionary to inform
    its listeners about changes in its properties or its entry list.
    It consists of an event type and may supply an affected
    dictionary entry.</P>

    @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
    @see    <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type>
    @see    <type scope="com::sun::star::lang">EventObject</type>
*/
published struct DictionaryEvent : com::sun::star::lang::EventObject
{
    //-------------------------------------------------------------------------
    /** is the type of event.

         <p>This must be the value of a single flag. No combinations are
         allowed.</p>

        @see    <type scope="com::sun::star::linguistic2">DictionaryEventFlags</type>
    */
    short nEvent;

    //-------------------------------------------------------------------------
    /** is the affected dictionary entry (if any).

         <p>It must be set if an entry was
         added or deleted, otherwise it should be empty.</p>

        @see    <type scope="com::sun::star::linguistic2">XDictionaryEntry</type>
    */
    com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry;

};

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

}; }; }; };

#endif
