1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_XBroadcaster_idl__
28#define __com_sun_star_util_XBroadcaster_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module util {
37
38//=============================================================================
39
40/** allows to control notification behaviour of a broadcaster.
41
42	@since OOo 3.0
43 */
44interface XBroadcaster: com::sun::star::uno::XInterface
45{
46	/** suspends broadcasts to the registered listeners.
47
48        <p>
49        The calls to <member>XBroadcaster::lockBroadcast()</member> and
50        <member>XBroadcaster::unlockBroadcasts()</member> may be
51		nested and even overlapping, but they must be in pairs. While
52		there is at least one lock remaining, no broadcasts are
53		sent to registered listeners.
54        </p>
55     */
56	[oneway] void lockBroadcasts();
57
58	//-------------------------------------------------------------------------
59	/** resumes the broadcasts which were suspended by
60        <member>XBroadcaster::lockBroadcasts()</member>.
61
62        <p>
63        The calls to <member>XBroadcaster::lockBroadcast()</member> and
64        <member>XBroadcaster::unlockBroadcasts()</member> may be
65		nested and even overlapping, but they must be in pairs. While
66		there is at least one lock remaining, no broadcasts are
67		sent to registered listeners.
68        </p>
69
70		<p> Pending broadcasts will be sent immediately after the last
71		call to <member>XBroadcaster::lockBroadcast()</member> is matched
72        by a call to <member>XBroadcaster::unlockBroadcasts()</member>.
73		An implementation can decide to broadcast all pending notification in
74		order or batch them in single broadcasts.
75		</p>
76	*/
77	[oneway] void unlockBroadcasts();
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85