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_XBroadcaster_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_util_XBroadcaster_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//============================================================================= 35*cdf0e10cSrcweir 36*cdf0e10cSrcweirmodule com { module sun { module star { module util { 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** allows to control notification behaviour of a broadcaster. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir @since OOo 3.0 43*cdf0e10cSrcweir */ 44*cdf0e10cSrcweirinterface XBroadcaster: com::sun::star::uno::XInterface 45*cdf0e10cSrcweir{ 46*cdf0e10cSrcweir /** suspends broadcasts to the registered listeners. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir <p> 49*cdf0e10cSrcweir The calls to <member>XBroadcaster::lockBroadcast()</member> and 50*cdf0e10cSrcweir <member>XBroadcaster::unlockBroadcasts()</member> may be 51*cdf0e10cSrcweir nested and even overlapping, but they must be in pairs. While 52*cdf0e10cSrcweir there is at least one lock remaining, no broadcasts are 53*cdf0e10cSrcweir sent to registered listeners. 54*cdf0e10cSrcweir </p> 55*cdf0e10cSrcweir */ 56*cdf0e10cSrcweir [oneway] void lockBroadcasts(); 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir //------------------------------------------------------------------------- 59*cdf0e10cSrcweir /** resumes the broadcasts which were suspended by 60*cdf0e10cSrcweir <member>XBroadcaster::lockBroadcasts()</member>. 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir <p> 63*cdf0e10cSrcweir The calls to <member>XBroadcaster::lockBroadcast()</member> and 64*cdf0e10cSrcweir <member>XBroadcaster::unlockBroadcasts()</member> may be 65*cdf0e10cSrcweir nested and even overlapping, but they must be in pairs. While 66*cdf0e10cSrcweir there is at least one lock remaining, no broadcasts are 67*cdf0e10cSrcweir sent to registered listeners. 68*cdf0e10cSrcweir </p> 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir <p> Pending broadcasts will be sent immediately after the last 71*cdf0e10cSrcweir call to <member>XBroadcaster::lockBroadcast()</member> is matched 72*cdf0e10cSrcweir by a call to <member>XBroadcaster::unlockBroadcasts()</member>. 73*cdf0e10cSrcweir An implementation can decide to broadcast all pending notification in 74*cdf0e10cSrcweir order or batch them in single broadcasts. 75*cdf0e10cSrcweir </p> 76*cdf0e10cSrcweir */ 77*cdf0e10cSrcweir [oneway] void unlockBroadcasts(); 78*cdf0e10cSrcweir}; 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir//============================================================================= 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir}; }; }; }; 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir#endif 85