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_util_XCloseBroadcaster_idl__ 24#define __com_sun_star_util_XCloseBroadcaster_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_util_XCloseListener_idl__ 31#include <com/sun/star/util/XCloseListener.idl> 32#endif 33 34//============================================================================= 35 36 module com { module sun { module star { module util { 37 38//============================================================================= 39/** broadcasts each tried closing of an object to all interest listener 40 41 <p> 42 The called object for closing must post the closing events immediately 43 and before any internal cancel operations will be started. 44 If a listener disagree with that it should throw a <type>CloseVetoException</type> 45 and called function <method>XCloseable::close</method> must be breaked immediately. 46 It's not allowed to catch it inside the close() request. 47 If no listener nor internal processes hinder the object on closing 48 all listener get's a notification about real closing. 49 </p> 50 51 @see 52 */ 53published interface XCloseBroadcaster: com::sun::star::uno::XInterface 54{ 55 //------------------------------------------------------------------------- 56 /** adds the specified listener to receive or have a veto for "close" events 57 58 @param Listener 59 the listener which is interested on closing events 60 */ 61 [oneway] void addCloseListener( [in] XCloseListener Listener ); 62 63 //------------------------------------------------------------------------- 64 /** removes the specified listener 65 66 @param Listener 67 the listener which isn't interested on closing events any longer 68 */ 69 [oneway] void removeCloseListener( [in] XCloseListener Listener ); 70}; 71 72//============================================================================= 73 74}; }; }; }; 75 76#endif 77