1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_script_InterruptEngineEvent_idl__ 24#define __com_sun_star_script_InterruptEngineEvent_idl__ 25 26#ifndef __com_sun_star_lang_EventObject_idl__ 27#include <com/sun/star/lang/EventObject.idl> 28#endif 29 30#ifndef __com_sun_star_script_InterruptReason_idl__ 31#include <com/sun/star/script/InterruptReason.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module script { 38 39//============================================================================= 40/** describes an interrupt which occurs in the scripting engine. 41 @deprecated 42 */ 43published struct InterruptEngineEvent: com::sun::star::lang::EventObject 44{ 45 //------------------------------------------------------------------------- 46 /** fully qualified name to address the module or function affected by the event that 47 took place. 48 49 <p>If the module or function can't be addressed by name (for example, in case 50 that a runtime-generated eval-module is executed), this string is empty.</p> 51 */ 52 string Name; 53 54 //------------------------------------------------------------------------- 55 /** source code of the Module affected by the event that took place. 56 57 <p>If the source can 58 be accessed using the ModuleName, or if the source is unknown (executing compiled 59 code), this string can be empty.</p> 60 */ 61 string SourceCode; 62 63 //------------------------------------------------------------------------- 64 /** contains the first line in the module's source code that is affected 65 by the event that took place. 66 67 68 69 <p>If "name" addresses a function, all line and column values 70 are nevertheless given relative to the module's source. If 71 source code is not available, this value addresses a binary 72 position in the compiled code. </p> 73 74 @see XLibraryAccess::getModuleCode 75 @see XLibraryAccess::getFunctionCode 76 */ 77 long StartLine; 78 79 //------------------------------------------------------------------------- 80 /** contains the first column in the "StartLine" that is affected by the 81 event that took place. 82 */ 83 long StartColumn; 84 85 //------------------------------------------------------------------------- 86 /** contains the last line in the module's source code that is affected 87 by the event that took place. 88 */ 89 long EndLine; 90 91 //------------------------------------------------------------------------- 92 /** contains the first column in the "EndLine" which is NOT affected by 93 the event that took place. 94 */ 95 long EndColumn; 96 97 //------------------------------------------------------------------------- 98 /** error message. 99 <p>Only valid if Reason is RuntimeError or CompileError.</p> 100 */ 101 string ErrorMessage; 102 103 //------------------------------------------------------------------------- 104 /** contains the interrupt reason. 105 */ 106 com::sun::star::script::InterruptReason Reason; 107 108}; 109 110//============================================================================= 111 112}; }; }; }; 113 114#endif 115