offapi/com/sun/star/frame/TerminationVetoException.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 #ifndef __com_sun_star_frame_TerminationVetoException_idl__
  20 #define __com_sun_star_frame_TerminationVetoException_idl__
  21
  22 #include <com/sun/star/uno/Exception.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27 /** can be thrown by a <type>XTerminateListener</type> to prevent the environment
  28     (e.g., desktop) from terminating
  29
  30     <p>
  31     If a <type>XTerminateListener</type> use this exception for a veto against
  32     the termination of the office, he will be the new "owner" of it.
  33     After his own operation will be finished, he MUST try to terminate the
  34     office again. Any other veto listener can intercept that again or office
  35     will die really.
  36     </p>
  37
  38     @see XDesktop::terminate()
  39     @see XTerminateListener
  40  */
  41 published exception TerminationVetoException: com::sun::star::uno::Exception
  42 {
  43 };
  44
  45
  46 }; }; }; };
  47
  48 #endif
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */