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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_script_FinishEngineEvent_idl__
  28 #define __com_sun_star_script_FinishEngineEvent_idl__
  29
  30 #ifndef __com_sun_star_lang_EventObject_idl__
  31 #include <com/sun/star/lang/EventObject.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_script_FinishReason_idl__
  35 #include <com/sun/star/script/FinishReason.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module script {
  42
  43 //=============================================================================
  44 /** event contains the reasons and the data for the
  45     <member>XEngineListener::finished()</member> method.
  46     @deprecated
  47  */
  48 published struct FinishEngineEvent: com::sun::star::lang::EventObject
  49 {
  50     //-------------------------------------------------------------------------
  51     /** specifies why the script terminates.
  52      */
  53     com::sun::star::script::FinishReason Finish;
  54
  55     //-------------------------------------------------------------------------
  56     /** error message.
  57
  58         <p>Only valid if Reason is RuntimeError or CompileError.</p>
  59      */
  60     string ErrorMessage;
  61
  62     //-------------------------------------------------------------------------
  63     /** contains the return value.
  64
  65         <p>This field is only valid if <member>FinishEngineEvent::Finish</member> is
  66         <const>FinishReason::OK</const>.</p>
  67      */
  68     any Return;
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif