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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
/*************************************************************************
*
* $RCSfile: XIdlClass.idl,v $
*
* $Revision: 1.5 $
*
* last change: $Author: mi $ $Date: 2000-12-19 13:49:36 $
*
* 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_reflection_XIdlClass_idl__
#define __com_sun_star_reflection_XIdlClass_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_uno_TypeClass_idl__
#include <com/sun/star/uno/TypeClass.idl>
#endif
#ifndef __com_sun_star_uno_Uik_idl__
#include <com/sun/star/uno/Uik.idl>
#endif
//=============================================================================
module com { module sun { module star { module reflection {
interface XIdlField;
interface XIdlMethod;
interface XIdlArray;
//=============================================================================
// DocMerge from xml: interface com::sun::star::reflection::XIdlClass
/** provides information about a type or module in an UNO environment.
Every array also belongs to a type that is reflected as an
<type>XIdlClass</type> object that is shared by all arrays with the
same element type and number of dimensions. Finally, any of the
primitive IDL types are also represented as <type>XIdlClass</type>
objects. This includes "void, any, boolean, char, float, double, octet,
short, long, hypher, unsigned octet, unsigned short, unsigned long" and
"unsigned hypher".
*/
[ uik(E227A3A0-33D6-11D1-AABE00A0-249D5590), ident( "XIdlClass", 1.0 ) ]
interface XIdlClass: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getClasses
/** @returns
all types and modules which are declared in this class.
*/
sequence<XIdlClass> getClasses();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getClass
/** @returns
a type or module with the given name that is declared in this
class.
*/
XIdlClass getClass( [in] string aName );
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::equals
/** @returns
<TRUE/> if the instances describe the same type,
otherwise <FALSE/>.
*/
boolean equals( [in] XIdlClass Type );
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::reflection::XIdlClass::isAssignableFrom
/** tests if the parameter <var>xType</var> is a subclass of this
class.
*/
boolean isAssignableFrom( [in] XIdlClass xType );
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getTypeClass
/** @returns
the type that this instance represents.
*/
com::sun::star::uno::TypeClass getTypeClass();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getName
/** @returns
the fully-qualified name of the type of object
(class, interface, array, sequence, struct, union, enum or
primitive) represented by this <type>XIdlClass</type>.
*/
string getName();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getUik
/** @returns
the UIK from this type. If the type has no UIK, then the
returned UIK is zero.
*/
[const] com::sun::star::uno::Uik getUik();
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR XIdlClass::getSuperclasses
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getSuperclasses
/** * If this object represents an interface or a class,
* then the objects that represents the superclasses or superinterfaces
* of that class are returned.
* <p>
* If this object is the one that represents the topmost class
* or interface, an empty sequence is returned.
*
* @return the superclass or interface of the type represented by this object.
*/
sequence<XIdlClass> getSuperclasses();
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR XIdlClass::getInterfaces
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getInterfaces
/** * Determines the interfaces implemented by the class or interface
* represented by this object.
* <p>
* If the class or interface implements no interfaces, the method
* returns a sequence of length 0.
*
* @return a sequence of interfaces implemented by this class.
*/
sequence<XIdlClass> getInterfaces();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::reflection::XIdlClass::getComponentType
/** If this class represents an array or sequence type, this method
returns the <type>XIdlClass</type> object representing the
component type of the array or sequence; otherwise it returns
<NULL/>.
*/
XIdlClass getComponentType();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getField
/** @returns
an <type>XIdlField</type> that reflects the specified member
field of the class, interface, struct, union, enum or
exception represented by this <type>XIdlClass</type> object.
If a field with the specified name is not found, 0 is returned.
<p>The field to be reflected is located by searching all the
member fields of the class, interface, struct, union, enum or
exception represented by this <type>XIdlClass</type> object
for a field with the specified name or for NULL, if a field
with the specified name is not found.
@param aName
specifies the simple name of the desired field.
*/
XIdlField getField( [in] string aName );
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR XIdlClass::getFields
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getFields
/** * Returns a sequence containing Field objects reflecting all the
* accessible fields of the class, interface, struct, union or enum represented
* by this XIdlClass object. Returns a sequence of length 0 if the
* class or interface has no accessible fields, or if it
* represents an array, a sequence or a primitive type.
*
* <p>Specifically, if this XIdlClass object represents a class,
* returns the fields of this class and of all its
* superclasses. If this XIdlClass object represents an interface,
* returns the fields of this interface and of all its
* superinterfaces. If this XIdlClass object represents an array,
* sequence or primitive type, returns a sequence of length 0.
*/
sequence<XIdlField> getFields();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getMethod
/** @returns
an <type>XIdlMethod</type> that reflects the specified
member method of the interface represented by this
<type>XIdlClass</type> object. If a method with the specified
name is not found, "0" is returned.
<p>The method to be reflected is located by searching all the
member methods of the interface represented by this
<type>XIdlClass</type> object for a method with the specified
name.
@param aName
specifies the simple name of the desired method.
*/
XIdlMethod getMethod( [in] string aName );
//-------------------------------------------------------------------------
// DOCUMENTATION CHANGED FOR XIdlClass::getMethods
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getMethods
/** * Returns a sequence containing XIdlMethod objects reflecting all the
* <em>member</em> methods of the class or interface
* represented by this XIdlClass object, including those declared by
* the class or interface and and those inherited from
* superclasses and superinterfaces. Returns a sequence of length 0
* if the class or interface has no member methods.
*
*/
sequence<XIdlMethod> getMethods();
//-------------------------------------------------------------------------
// DocMerge from idl: method com::sun::star::reflection::XIdlClass::getArray
/** @returns
the <type>XIdlArray</type> interface to get and set the
elements by index if the represented type is an array or
sequence.
*/
XIdlArray getArray();
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::reflection::XIdlClass::createObject
/** creates an instance of the type represented by this
<type>XIdlClass</type> object if the represented type is a
basic type, struct, enum, or sequence.
*/
void createObject( [out] any obj );
};
//=============================================================================
}; }; }; };
/*=============================================================================
$Log: not supported by cvs2svn $
Revision 1.4 2000/11/08 12:28:46 mi
moved from api
Revision 1.1.1.1 2000/09/18 23:35:32 hjs
initial import
Revision 1.6 2000/09/11 11:52:36 mi
documentation merged from XML
Revision 1.4 2000/04/20 14:09:39 mm
#74031# better documentation
Revision 1.3 2000/02/17 18:30:24 mi
proofreading in layouted version
Revision 1.2 2000/02/07 11:24:44 mi
zu #70728# missing documentation marked
Revision 1.1.1.1 1999/11/11 09:48:44 jsc
new
=============================================================================*/
#endif
|
