1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_util_XCloseBroadcaster_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_util_XCloseBroadcaster_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_util_XCloseListener_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/util/XCloseListener.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir module com { module sun { module star { module util { 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir//============================================================================= 43*cdf0e10cSrcweir/** broadcasts each tried closing of an object to all interest listener 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir <p> 46*cdf0e10cSrcweir The called object for closing must post the closing events immediately 47*cdf0e10cSrcweir and before any internal cancel operations will be started. 48*cdf0e10cSrcweir If a listener disagree with that it should throw a <type>CloseVetoException</type> 49*cdf0e10cSrcweir and called function <method>XCloseable::close</method> must be breaked immediately. 50*cdf0e10cSrcweir It's not allowed to catch it inside the close() request. 51*cdf0e10cSrcweir If no listener nor internal processes hinder the object on closing 52*cdf0e10cSrcweir all listener get's a notification about real closing. 53*cdf0e10cSrcweir </p> 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir @see 56*cdf0e10cSrcweir */ 57*cdf0e10cSrcweirpublished interface XCloseBroadcaster: com::sun::star::uno::XInterface 58*cdf0e10cSrcweir{ 59*cdf0e10cSrcweir //------------------------------------------------------------------------- 60*cdf0e10cSrcweir /** adds the specified listener to receive or have a veto for "close" events 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @param Listener 63*cdf0e10cSrcweir the listener wich is interest on closing events 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweir [oneway] void addCloseListener( [in] XCloseListener Listener ); 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir //------------------------------------------------------------------------- 68*cdf0e10cSrcweir /** removes the specified listener 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @param Listener 71*cdf0e10cSrcweir the listener wich isn't interest on closing events anylonger 72*cdf0e10cSrcweir */ 73*cdf0e10cSrcweir [oneway] void removeCloseListener( [in] XCloseListener Listener ); 74*cdf0e10cSrcweir}; 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir//============================================================================= 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir}; }; }; }; 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir#endif 81