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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: InterruptEngineEvent.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_InterruptEngineEvent_idl__
  31 #define __com_sun_star_script_InterruptEngineEvent_idl__
  32
  33 #ifndef __com_sun_star_lang_EventObject_idl__
  34 #include <com/sun/star/lang/EventObject.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_script_InterruptReason_idl__
  38 #include <com/sun/star/script/InterruptReason.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module script {
  45
  46 //=============================================================================
  47 /** describes an interrupt which occurs in the scripting engine.
  48     @deprecated
  49  */
  50 published struct InterruptEngineEvent: com::sun::star::lang::EventObject
  51 {
  52     //-------------------------------------------------------------------------
  53     /** fully qualified name to address the module or function affected by the event that
  54         took place.
  55
  56         <p>If the module or function can't be addressed by name (for example, in case
  57         that a runtime-generated eval-module is executed), this string is empty.</p>
  58      */
  59     string Name;
  60
  61     //-------------------------------------------------------------------------
  62     /** source code of the Module affected by the event that took place.
  63
  64         <p>If the source can
  65         be accessed using the ModuleName, or if the source is unknown (executing compiled
  66         code), this string can be empty.</p>
  67      */
  68     string SourceCode;
  69
  70     //-------------------------------------------------------------------------
  71     /** contains the first line in the module's source code that is affected
  72         by the event that took place.
  73
  74
  75
  76         <p>If "name" addresses a function, all line and column values
  77         are nevertheless given relative to the module's source. If
  78         source code is not available, this value addresses a binary
  79         position in the compiled code.  </p>
  80
  81         @see XLibraryAccess::getModuleCode
  82         @see XLibraryAccess::getFunctionCode
  83      */
  84     long StartLine;
  85
  86     //-------------------------------------------------------------------------
  87     /** contains the first column in the "StartLine" that is affected by the
  88         event that took place.
  89      */
  90     long StartColumn;
  91
  92     //-------------------------------------------------------------------------
  93     /** contains the last line in the module's source code that is affected
  94         by the event that took place.
  95      */
  96     long EndLine;
  97
  98     //-------------------------------------------------------------------------
  99     /** contains the first column in the "EndLine" which is NOT affected by
 100         the event that took place.
 101      */
 102     long EndColumn;
 103
 104     //-------------------------------------------------------------------------
 105     /** error message.
 106         <p>Only valid if Reason is RuntimeError or CompileError.</p>
 107      */
 108     string ErrorMessage;
 109
 110     //-------------------------------------------------------------------------
 111     /** contains the interrupt reason.
 112      */
 113     com::sun::star::script::InterruptReason Reason;
 114
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif