/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: DictionaryListEvent.idl,v $
 * $Revision: 1.12 $
 *
 * 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_DictionaryListEvent_idl__
#define __com_sun_star_linguistic2_DictionaryListEvent_idl__

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

#ifndef __com_sun_star_linguistic2_DictionaryEvent_idl__
#include <com/sun/star/linguistic2/DictionaryEvent.idl>
#endif


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

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

//=============================================================================
/** structure representing a dictionary-list event.

    <P>This structure is used by the dictionary-list to inform
    its listeners about certain events.
    Since the dictionary-list is able to collect several single
    events before broadcasting them to it's listeners the
    integer argument may be a combination (logical or) of several
    event types.
    If more specific information about the events is requested by a
    listener, a sequence of all dictionary-list events since the
    last broadcasting will be supplied. Otherwise, that list will
    be empty.</P>

    @see    <type scope="com::sun::star::linguistic2">DictionaryList</type>
    @see    <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
    @see    <type scope="com::sun::star::lang">EventObject</type>
*/
published struct DictionaryListEvent : com::sun::star::lang::EventObject
{
    //-------------------------------------------------------------------------
    /** the combined type of the accumulated events.

    <p>The value can be the combination of multiple
     <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type>
     by applying the logical OR to them.</p>

    @see    <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type>

    <!-- Dennis: Does the <type> tag change the display of its contents -->
    <!-- Thomas: AFAIK it should translate into a hyperlink or so. -->
    */
    short nCondensedEvent;

    //-------------------------------------------------------------------------
    /** list of accumulated dictionary events.

         <p>It will be empty if all
        <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type>
         are satisfied with the condensed representation of the
        <member scope="com::sun::star::linguistic2">DictionaryListEvent::nCondensedEvent</member>.</p>

        @see    <type scope="com::sun::star::linguistic2">DictionaryEvent</type>
    */
    sequence< com::sun::star::linguistic2::DictionaryEvent > aDictionaryEvents;

};

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

}; }; }; };

#endif