/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: FinishEngineEvent.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_script_FinishEngineEvent_idl__ 
#define __com_sun_star_script_FinishEngineEvent_idl__ 
 
#ifndef __com_sun_star_lang_EventObject_idl__ 
#include <com/sun/star/lang/EventObject.idl> 
#endif 
 
#ifndef __com_sun_star_script_FinishReason_idl__ 
#include <com/sun/star/script/FinishReason.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module script {  
 
//============================================================================= 
/** event contains the reasons and the data for the 
	<member>XEngineListener::finished()</member> method.
	@deprecated
 */
published struct FinishEngineEvent: com::sun::star::lang::EventObject
{ 
	//------------------------------------------------------------------------- 
	/** specifies why the script terminates.
	 */
	com::sun::star::script::FinishReason Finish; 
 
	//------------------------------------------------------------------------- 
	/** error message. 
		
		<p>Only valid if Reason is RuntimeError or CompileError.</p>
	 */
	string ErrorMessage; 
 
	//------------------------------------------------------------------------- 
	/** contains the return value. 
		
		<p>This field is only valid if <member>FinishEngineEvent::Finish</member> is 
		<const>FinishReason::OK</const>.</p>
	 */
	any Return; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 
