offapi/com/sun/star/util/XCloseBroadcaster.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: XCloseBroadcaster.idl,v $
  10  * $Revision: 1.6 $
  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_XCloseBroadcaster_idl__
  31 #define __com_sun_star_util_XCloseBroadcaster_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_XCloseListener_idl__
  38 #include <com/sun/star/util/XCloseListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module util {
  44
  45 //=============================================================================
  46 /** broadcasts each tried closing of an object to all interest listener
  47
  48     <p>
  49     The called object for closing must post the closing events immediately
  50     and before any internal cancel operations will be started.
  51     If a listener disagree with that it should throw a <type>CloseVetoException</type>
  52     and called function <method>XCloseable::close</method> must be breaked immediately.
  53     It's not allowed to catch it inside the close() request.
  54     If no listener nor internal processes hinder the object on closing
  55     all listener get's a notification about real closing.
  56     </p>
  57
  58     @see
  59  */
  60 published interface XCloseBroadcaster: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /** adds the specified listener to receive or have a veto for "close" events
  64
  65         @param Listener
  66             the listener wich is interest on closing events
  67      */
  68     [oneway] void addCloseListener( [in] XCloseListener Listener );
  69
  70     //-------------------------------------------------------------------------
  71     /** removes the specified listener
  72
  73         @param Listener
  74             the listener wich isn't interest on closing events anylonger
  75      */
  76     [oneway] void removeCloseListener( [in] XCloseListener Listener );
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif