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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module util {
  22
  23 /** broadcasts each tried closing of an object to all interest listener
  24
  25     <p>
  26     The called object for closing must post the closing events immediately
  27     and before any internal cancel operations will be started.
  28     If a listener disagree with that it should throw a CloseVetoException
  29     and called function XCloseable::close() must be broken immediately.
  30     It's not allowed to catch it inside the close() request.
  31     If no listener nor internal processes hinder the object on closing
  32     all listeners get a notification about real closing.
  33     </p>
  34
  35     @see
  36  */
  37 published interface XCloseBroadcaster: com::sun::star::uno::XInterface
  38 {
  39     /** adds the specified listener to receive or have a veto for "close" events
  40
  41         @param Listener
  42             the listener which is interest on closing events
  43      */
  44     void addCloseListener( [in] XCloseListener Listener );
  45
  46     /** removes the specified listener
  47
  48         @param Listener
  49             the listener which isn't interest on closing events any longer
  50      */
  51     void removeCloseListener( [in] XCloseListener Listener );
  52 };
  53
  54
  55 }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */