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

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