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
  20
  21
  22  module com {  module sun {  module star {  module script {
  23
  24 /** event contains the reasons and the data for the
  25     XEngineListener::finished() method.
  26     @deprecated
  27  */
  28 published struct FinishEngineEvent: com::sun::star::lang::EventObject
  29 {
  30     /** specifies why the script terminates.
  31      */
  32     com::sun::star::script::FinishReason Finish;
  33
  34     /** error message.
  35
  36         <p>Only valid if Reason is RuntimeError or CompileError.</p>
  37      */
  38     string ErrorMessage;
  39
  40     /** contains the return value.
  41
  42         <p>This field is only valid if FinishEngineEvent::Finish is
  43         FinishReason::OK.</p>
  44      */
  45     any Return;
  46
  47 };
  48
  49
  50 }; }; }; };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */