1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_script_FinishEngineEvent_idl__
24#define __com_sun_star_script_FinishEngineEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30#ifndef __com_sun_star_script_FinishReason_idl__
31#include <com/sun/star/script/FinishReason.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module script {
38
39//=============================================================================
40/** event contains the reasons and the data for the
41	<member>XEngineListener::finished()</member> method.
42	@deprecated
43 */
44published struct FinishEngineEvent: com::sun::star::lang::EventObject
45{
46	//-------------------------------------------------------------------------
47	/** specifies why the script terminates.
48	 */
49	com::sun::star::script::FinishReason Finish;
50
51	//-------------------------------------------------------------------------
52	/** error message.
53
54		<p>Only valid if Reason is RuntimeError or CompileError.</p>
55	 */
56	string ErrorMessage;
57
58	//-------------------------------------------------------------------------
59	/** contains the return value.
60
61		<p>This field is only valid if <member>FinishEngineEvent::Finish</member> is
62		<const>FinishReason::OK</const>.</p>
63	 */
64	any Return;
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73