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

   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_ContextInformation_idl__
  28 #define __com_sun_star_script_ContextInformation_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module script {
  34
  35 //=============================================================================
  36 /** provides information about a certain stack frame.
  37
  38     @deprecated
  39  */
  40 published struct ContextInformation
  41 {
  42     /** Full qualified name to adress the module or function associated with the context.
  43         If the module or function can't be adressed by name, e.g., in case that a runtime
  44         generated eval-module is executed, this string is empty
  45      */
  46     string Name;
  47
  48     //-------------------------------------------------------------------------
  49     /** Source code of the Module, that is associated with the context. If the source can
  50         be accessed using the ModuleName or if the source is unknown (executing compiled
  51         code) this string can be empty.
  52      */
  53     string SourceCode;
  54
  55     //-------------------------------------------------------------------------
  56     /** contains the first line in the module's source code associated with
  57         the context.
  58
  59         <p>If "name" addresses a function, all line and column values
  60         are nevertheless given relative to the module's source. If
  61         source code is not available, this value addresses a binary
  62         position in the compiled code.  </p>
  63
  64         @see XLibraryAccess::getModuleCode
  65         @see XLibraryAccess::getFunctionCode
  66      */
  67     long StartLine;
  68
  69     //-------------------------------------------------------------------------
  70     /** contains the first column in the <var>StartLine</var> associated with
  71         the context.
  72      */
  73     long StartColumn;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** contains the last line in the module's source code associated with
  78         the context.
  79      */
  80     long EndLine;
  81
  82     //-------------------------------------------------------------------------
  83     /** contains the first column in the <var>EndLine</var> that is NOT
  84         associated with the context.
  85      */
  86     long EndColumn;
  87
  88     //-------------------------------------------------------------------------
  89     /** Get all names of the local variable in this context.
  90      */
  91     sequence<string> LocalVariableNames;
  92
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; };
  98
  99 #endif