1d1766043SAndrew Rist/************************************************************** 2*e9a12502Smseidel * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*e9a12502Smseidel * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*e9a12502Smseidel * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19*e9a12502Smseidel * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_util_XCloseBroadcaster_idl__ 24cdf0e10cSrcweir#define __com_sun_star_util_XCloseBroadcaster_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_util_XCloseListener_idl__ 31cdf0e10cSrcweir#include <com/sun/star/util/XCloseListener.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir module com { module sun { module star { module util { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir/** broadcasts each tried closing of an object to all interest listener 40cdf0e10cSrcweir 41cdf0e10cSrcweir <p> 42cdf0e10cSrcweir The called object for closing must post the closing events immediately 43cdf0e10cSrcweir and before any internal cancel operations will be started. 44cdf0e10cSrcweir If a listener disagree with that it should throw a <type>CloseVetoException</type> 45cdf0e10cSrcweir and called function <method>XCloseable::close</method> must be breaked immediately. 46cdf0e10cSrcweir It's not allowed to catch it inside the close() request. 47cdf0e10cSrcweir If no listener nor internal processes hinder the object on closing 48cdf0e10cSrcweir all listener get's a notification about real closing. 49cdf0e10cSrcweir </p> 50cdf0e10cSrcweir 51cdf0e10cSrcweir @see 52cdf0e10cSrcweir */ 53cdf0e10cSrcweirpublished interface XCloseBroadcaster: com::sun::star::uno::XInterface 54cdf0e10cSrcweir{ 55cdf0e10cSrcweir //------------------------------------------------------------------------- 56cdf0e10cSrcweir /** adds the specified listener to receive or have a veto for "close" events 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param Listener 59a893be29SPedro Giffuni the listener which is interested on closing events 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir [oneway] void addCloseListener( [in] XCloseListener Listener ); 62cdf0e10cSrcweir 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir /** removes the specified listener 65cdf0e10cSrcweir 66cdf0e10cSrcweir @param Listener 67*e9a12502Smseidel the listener which isn't interested on closing events any longer 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir [oneway] void removeCloseListener( [in] XCloseListener Listener ); 70cdf0e10cSrcweir}; 71cdf0e10cSrcweir 72cdf0e10cSrcweir//============================================================================= 73cdf0e10cSrcweir 74cdf0e10cSrcweir}; }; }; }; 75cdf0e10cSrcweir 76cdf0e10cSrcweir#endif 77