offapi/com/sun/star/frame/TerminationVetoException.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_frame_TerminationVetoException_idl__
  28 #define __com_sun_star_frame_TerminationVetoException_idl__
  29
  30 #ifndef __com_sun_star_uno_Exception_idl__
  31 #include <com/sun/star/uno/Exception.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module frame {
  37
  38 //=============================================================================
  39 /** can be thrown by a <type>XTerminateListener</type> to prevent the environment
  40     (e.g., desktop) from terminating
  41
  42     <p>
  43     If a <type>XTerminateListener</type> use this exception for a veto against
  44     the termination of the office, he will be the new "owner" of it.
  45     After his own operation will be finished, he MUST try to terminate the
  46     office again. Any other veto listener can intercept that again or office
  47     will die realy.
  48     </p>
  49
  50     @see XDesktop::terminate()
  51     @see XTerminateListener
  52  */
  53 published exception TerminationVetoException: com::sun::star::uno::Exception
  54 {
  55 };
  56
  57 //=============================================================================
  58
  59 }; }; }; };
  60
  61 #endif