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