offapi/com/sun/star/util/XBroadcaster.idl

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