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