1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_linguistic2_DictionaryListEvent_idl__ 24#define __com_sun_star_linguistic2_DictionaryListEvent_idl__ 25 26#ifndef __com_sun_star_lang_EventObject_idl__ 27#include <com/sun/star/lang/EventObject.idl> 28#endif 29 30#ifndef __com_sun_star_linguistic2_DictionaryEvent_idl__ 31#include <com/sun/star/linguistic2/DictionaryEvent.idl> 32#endif 33 34 35//============================================================================= 36 37module com { module sun { module star { module linguistic2 { 38 39//============================================================================= 40/** structure representing a dictionary-list event. 41 42 <P>This structure is used by the dictionary-list to inform 43 its listeners about certain events. 44 Since the dictionary-list is able to collect several single 45 events before broadcasting them to it's listeners the 46 integer argument may be a combination (logical or) of several 47 event types. 48 If more specific information about the events is requested by a 49 listener, a sequence of all dictionary-list events since the 50 last broadcasting will be supplied. Otherwise, that list will 51 be empty.</P> 52 53 @see <type scope="com::sun::star::linguistic2">DictionaryList</type> 54 @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> 55 @see <type scope="com::sun::star::lang">EventObject</type> 56*/ 57published struct DictionaryListEvent : com::sun::star::lang::EventObject 58{ 59 //------------------------------------------------------------------------- 60 /** the combined type of the accumulated events. 61 62 <p>The value can be the combination of multiple 63 <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type> 64 by applying the logical OR to them.</p> 65 66 @see <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type> 67 68 <!-- Dennis: Does the <type> tag change the display of its contents --> 69 <!-- Thomas: AFAIK it should translate into a hyperlink or so. --> 70 */ 71 short nCondensedEvent; 72 73 //------------------------------------------------------------------------- 74 /** list of accumulated dictionary events. 75 76 <p>It will be empty if all 77 <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> 78 are satisfied with the condensed representation of the 79 <member scope="com::sun::star::linguistic2">DictionaryListEvent::nCondensedEvent</member>.</p> 80 81 @see <type scope="com::sun::star::linguistic2">DictionaryEvent</type> 82 */ 83 sequence< com::sun::star::linguistic2::DictionaryEvent > aDictionaryEvents; 84 85}; 86 87//============================================================================= 88 89}; }; }; }; 90 91#endif 92