udkapi/com/sun/star/script/FinishEngineEvent.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_script_FinishEngineEvent_idl__
  20 #define __com_sun_star_script_FinishEngineEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24 #include <com/sun/star/script/FinishReason.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module script {
  29
  30 /** event contains the reasons and the data for the
  31     XEngineListener::finished() method.
  32     @deprecated
  33  */
  34 published struct FinishEngineEvent: com::sun::star::lang::EventObject
  35 {
  36     /** specifies why the script terminates.
  37      */
  38     com::sun::star::script::FinishReason Finish;
  39
  40     /** error message.
  41
  42         <p>Only valid if Reason is RuntimeError or CompileError.</p>
  43      */
  44     string ErrorMessage;
  45
  46     /** contains the return value.
  47
  48         <p>This field is only valid if FinishEngineEvent::Finish is
  49         FinishReason::OK.</p>
  50      */
  51     any Return;
  52
  53 };
  54
  55
  56 }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */