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_InterruptEngineEvent_idl__
28#define __com_sun_star_script_InterruptEngineEvent_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_InterruptReason_idl__
35#include <com/sun/star/script/InterruptReason.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module script {
42
43//=============================================================================
44/** describes an interrupt which occurs in the scripting engine.
45	@deprecated
46 */
47published struct InterruptEngineEvent: com::sun::star::lang::EventObject
48{
49	//-------------------------------------------------------------------------
50	/** fully qualified name to address the module or function affected by the event that
51		took place.
52
53		<p>If the module or function can't be addressed by name (for example, in case
54		that a runtime-generated eval-module is executed), this string is empty.</p>
55	 */
56	string Name;
57
58	//-------------------------------------------------------------------------
59	/** source code of the Module affected by the event that took place.
60
61		<p>If the source can
62		be accessed using the ModuleName, or if the source is unknown (executing compiled
63		code), this string can be empty.</p>
64	 */
65	string SourceCode;
66
67	//-------------------------------------------------------------------------
68	/** contains the first line in the module's source code that is affected
69		by the event that took place.
70
71
72
73		<p>If "name" addresses a function, all line and column values
74		are nevertheless given relative to the module's source. If
75		source code is not available, this value addresses a binary
76		position in the compiled code.  </p>
77
78		@see XLibraryAccess::getModuleCode
79		@see XLibraryAccess::getFunctionCode
80	 */
81	long StartLine;
82
83	//-------------------------------------------------------------------------
84	/** contains the first column in the "StartLine" that is affected by the
85		event that took place.
86	 */
87	long StartColumn;
88
89	//-------------------------------------------------------------------------
90	/** contains the last line in the module's source code that is affected
91		by the event that took place.
92	 */
93	long EndLine;
94
95	//-------------------------------------------------------------------------
96	/** contains the first column in the "EndLine" which is NOT affected by
97		the event that took place.
98	 */
99	long EndColumn;
100
101	//-------------------------------------------------------------------------
102	/** error message.
103		<p>Only valid if Reason is RuntimeError or CompileError.</p>
104	 */
105	string ErrorMessage;
106
107	//-------------------------------------------------------------------------
108	/** contains the interrupt reason.
109	 */
110	com::sun::star::script::InterruptReason Reason;
111
112};
113
114//=============================================================================
115
116}; }; }; };
117
118#endif
119