summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/ContextInformation.idl
blob: 42ccca25412377062d5755e0900c87d245991444 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*************************************************************************
 *
 *  $RCSfile: ContextInformation.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 09:44:41 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_script_ContextInformation_idl__ 
#define __com_sun_star_script_ContextInformation_idl__ 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module script {  
 
//============================================================================= 
 
// DocMerge from xml: struct com::sun::star::script::ContextInformation
/** provides information about a certain stack frame.
 */
struct ContextInformation
{
    // DocMerge from xml: field com::sun::star::script::ContextInformation::Name
    /** Full qualified name to adress the module or function associated with the context.
        If the module or function can't be adressed by name, e.g. in case that a runtime 
        generated eval-module is executed, this string is empty
     */
    string Name; 
 
    //------------------------------------------------------------------------- 
    // DOCUMENTATION CHANGED FOR ContextInformation::SourceCode 
     
    // DocMerge from xml: field com::sun::star::script::ContextInformation::SourceCode
    /** Source code of the Module, that is associated with the context. If the source can 
        be accessed using the ModuleName or if the source is unknown (executing compiled 
        code) this string can be empty.
     */
    string SourceCode; 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: field com::sun::star::script::ContextInformation::StartLine
    /** contains the first line in the module's source code associated with
        the context.
        
        
        
        <p>If "name" addresses a function, all line and column values
        are nevertheless given relative to the module's source. If
        source code is not available, this value addresses a binary
        position in the compiled code.
        
        </p>@see XLibraryAccess::getModuleCode(string) 
                @see XLibraryAccess::getFunctionCode(string)
     */
    long StartLine; 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: field com::sun::star::script::ContextInformation::StartColumn
    /** contains the first column in the <var>StartLine</var> associated with
        the context.
     */
    long StartColumn; 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: field com::sun::star::script::ContextInformation::EndLine
    /** contains the last line in the module's source code associated with
        the context.
     */
    long EndLine; 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: field com::sun::star::script::ContextInformation::EndColumn
    /** contains the first column in the <var>EndLine</var> that is NOT
        associated with the context.
     */
    long EndColumn; 
 
    //------------------------------------------------------------------------- 
    // DOCUMENTATION CHANGED FOR ContextInformation::LocalVariableNames 
     
    // DocMerge from idl: field com::sun::star::script::ContextInformation::LocalVariableNames
    /** * Get all names of the local variable in this context.
     */
    sequence<string> LocalVariableNames; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:35  hjs
    initial import
    
    Revision 1.5  2000/09/11 11:52:38  mi
    documentation merged from XML
     
    Revision 1.3  2000/04/20 14:14:35  mm 
    #74031# better documentation 
     
    Revision 1.2  2000/02/07 11:24:51  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.1.1.1  1999/11/11 09:48:45  jsc 
    new 
     
 
=============================================================================*/ 
#endif