1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 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 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 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. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_util_XBroadcaster_idl__ 24cdf0e10cSrcweir#define __com_sun_star_util_XBroadcaster_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module util { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** allows to control notification behaviour of a broadcaster. 37cdf0e10cSrcweir 38*34c958abSJürgen Schmidt @since OpenOffice 3.0 39cdf0e10cSrcweir */ 40cdf0e10cSrcweirinterface XBroadcaster: com::sun::star::uno::XInterface 41cdf0e10cSrcweir{ 42cdf0e10cSrcweir /** suspends broadcasts to the registered listeners. 43cdf0e10cSrcweir 44cdf0e10cSrcweir <p> 45cdf0e10cSrcweir The calls to <member>XBroadcaster::lockBroadcast()</member> and 46cdf0e10cSrcweir <member>XBroadcaster::unlockBroadcasts()</member> may be 47cdf0e10cSrcweir nested and even overlapping, but they must be in pairs. While 48cdf0e10cSrcweir there is at least one lock remaining, no broadcasts are 49cdf0e10cSrcweir sent to registered listeners. 50cdf0e10cSrcweir </p> 51cdf0e10cSrcweir */ 52cdf0e10cSrcweir [oneway] void lockBroadcasts(); 53cdf0e10cSrcweir 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir /** resumes the broadcasts which were suspended by 56cdf0e10cSrcweir <member>XBroadcaster::lockBroadcasts()</member>. 57cdf0e10cSrcweir 58cdf0e10cSrcweir <p> 59cdf0e10cSrcweir The calls to <member>XBroadcaster::lockBroadcast()</member> and 60cdf0e10cSrcweir <member>XBroadcaster::unlockBroadcasts()</member> may be 61cdf0e10cSrcweir nested and even overlapping, but they must be in pairs. While 62cdf0e10cSrcweir there is at least one lock remaining, no broadcasts are 63cdf0e10cSrcweir sent to registered listeners. 64cdf0e10cSrcweir </p> 65cdf0e10cSrcweir 66cdf0e10cSrcweir <p> Pending broadcasts will be sent immediately after the last 67cdf0e10cSrcweir call to <member>XBroadcaster::lockBroadcast()</member> is matched 68cdf0e10cSrcweir by a call to <member>XBroadcaster::unlockBroadcasts()</member>. 69cdf0e10cSrcweir An implementation can decide to broadcast all pending notification in 70cdf0e10cSrcweir order or batch them in single broadcasts. 71cdf0e10cSrcweir </p> 72cdf0e10cSrcweir */ 73cdf0e10cSrcweir [oneway] void unlockBroadcasts(); 74cdf0e10cSrcweir}; 75cdf0e10cSrcweir 76cdf0e10cSrcweir//============================================================================= 77cdf0e10cSrcweir 78cdf0e10cSrcweir}; }; }; }; 79cdf0e10cSrcweir 80cdf0e10cSrcweir#endif 81