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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ContextInformation.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_ContextInformation_idl__
  31 #define __com_sun_star_script_ContextInformation_idl__
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module script {
  37
  38 //=============================================================================
  39 /** provides information about a certain stack frame.
  40
  41     @deprecated
  42  */
  43 published struct ContextInformation
  44 {
  45     /** Full qualified name to adress the module or function associated with the context.
  46         If the module or function can't be adressed by name, e.g., in case that a runtime
  47         generated eval-module is executed, this string is empty
  48      */
  49     string Name;
  50
  51     //-------------------------------------------------------------------------
  52     /** Source code of the Module, that is associated with the context. If the source can
  53         be accessed using the ModuleName or if the source is unknown (executing compiled
  54         code) this string can be empty.
  55      */
  56     string SourceCode;
  57
  58     //-------------------------------------------------------------------------
  59     /** contains the first line in the module's source code associated with
  60         the context.
  61
  62         <p>If "name" addresses a function, all line and column values
  63         are nevertheless given relative to the module's source. If
  64         source code is not available, this value addresses a binary
  65         position in the compiled code.  </p>
  66
  67         @see XLibraryAccess::getModuleCode
  68         @see XLibraryAccess::getFunctionCode
  69      */
  70     long StartLine;
  71
  72     //-------------------------------------------------------------------------
  73     /** contains the first column in the <var>StartLine</var> associated with
  74         the context.
  75      */
  76     long StartColumn;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** contains the last line in the module's source code associated with
  81         the context.
  82      */
  83     long EndLine;
  84
  85     //-------------------------------------------------------------------------
  86     /** contains the first column in the <var>EndLine</var> that is NOT
  87         associated with the context.
  88      */
  89     long EndColumn;
  90
  91     //-------------------------------------------------------------------------
  92     /** Get all names of the local variable in this context.
  93      */
  94     sequence<string> LocalVariableNames;
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif