/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTerminateListener.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 01:28:13 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_frame_XTerminateListener_idl__
#define __com_sun_star_frame_XTerminateListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

#ifndef __com_sun_star_frame_TerminationVetoException_idl__
#include <com/sun/star/frame/TerminationVetoException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module frame {

//=============================================================================
/** has to be provided if an object wants to receive an event
    when the master environment (e.g., desktop) is terminated.

    @see XDesktop::terminate()
    @see XDesktop::addTerminateListener()
    @see XDesktop::removeTerminateListener()
 */
published interface XTerminateListener: com::sun::star::lang::XEventListener
{
	//-------------------------------------------------------------------------
	/** is called when the master environment (e.g., desktop) is about to terminate.

        <p>
        Termination can be intercepted by throwing <type>TerminationVetoException</type>.
        Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member>
        after finishing his own operations.
        </p>

        @param Event
            describe the source of the event (e.g., the desktop)

        @throws TerminationVetoException
            listener can disagree with this query by throwing this veto exception
	 */
    void queryTermination( [in] com::sun::star::lang::EventObject Event )
            raises( TerminationVetoException );

	//-------------------------------------------------------------------------
	/** is called when the master environment is finally terminated.
        Not veto will be accepted then.

        @param Event
            describe the source of the event (e.g., the desktop)
	 */
    void notifyTermination( [in] com::sun::star::lang::EventObject Event );
};

//=============================================================================

}; }; }; };

#endif
