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