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