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