AOO410/main/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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