1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_XBroadcaster_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_util_XBroadcaster_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module util { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski/** allows to control notification behaviour of a broadcaster. 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski @since OpenOffice 3.0 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielskiinterface XBroadcaster: com::sun::star::uno::XInterface 41*b1cdbd2cSJim Jagielski{ 42*b1cdbd2cSJim Jagielski /** suspends broadcasts to the registered listeners. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p> 45*b1cdbd2cSJim Jagielski The calls to <member>XBroadcaster::lockBroadcast()</member> and 46*b1cdbd2cSJim Jagielski <member>XBroadcaster::unlockBroadcasts()</member> may be 47*b1cdbd2cSJim Jagielski nested and even overlapping, but they must be in pairs. While 48*b1cdbd2cSJim Jagielski there is at least one lock remaining, no broadcasts are 49*b1cdbd2cSJim Jagielski sent to registered listeners. 50*b1cdbd2cSJim Jagielski </p> 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski [oneway] void lockBroadcasts(); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 55*b1cdbd2cSJim Jagielski /** resumes the broadcasts which were suspended by 56*b1cdbd2cSJim Jagielski <member>XBroadcaster::lockBroadcasts()</member>. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski <p> 59*b1cdbd2cSJim Jagielski The calls to <member>XBroadcaster::lockBroadcast()</member> and 60*b1cdbd2cSJim Jagielski <member>XBroadcaster::unlockBroadcasts()</member> may be 61*b1cdbd2cSJim Jagielski nested and even overlapping, but they must be in pairs. While 62*b1cdbd2cSJim Jagielski there is at least one lock remaining, no broadcasts are 63*b1cdbd2cSJim Jagielski sent to registered listeners. 64*b1cdbd2cSJim Jagielski </p> 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski <p> Pending broadcasts will be sent immediately after the last 67*b1cdbd2cSJim Jagielski call to <member>XBroadcaster::lockBroadcast()</member> is matched 68*b1cdbd2cSJim Jagielski by a call to <member>XBroadcaster::unlockBroadcasts()</member>. 69*b1cdbd2cSJim Jagielski An implementation can decide to broadcast all pending notification in 70*b1cdbd2cSJim Jagielski order or batch them in single broadcasts. 71*b1cdbd2cSJim Jagielski </p> 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski [oneway] void unlockBroadcasts(); 74*b1cdbd2cSJim Jagielski}; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski//============================================================================= 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski}; }; }; }; 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski#endif 81