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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_beans_XIntrospectionAccess_idl__
#define __com_sun_star_beans_XIntrospectionAccess_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/Property.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/reflection/XIdlMethod.idl>
#include <com/sun/star/lang/NoSuchMethodException.idl>
#include <com/sun/star/reflection/XIdlClass.idl>
#include <com/sun/star/beans/IllegalTypeException.idl>
module com { module sun { module star { module beans {
/** represents the result of an introspection operation done by
the inspect method of XIntrospection.
<p>This interface gives information about an object's
properties and methods as detected in the introspection
process. It's not possible to access properties or call
methods directly using this interface but it provides
access to other interfaces to do so.
See com::sun::star::beans::XIntrospectionAccess::queryAdapter()</p>
<p>The XExactName interface has to be supported
in order to implement inaccurate name access for all objects
which implement the com::sun::star::container::XNameAccess interface
or XPropertySet.</p>
<p>The XMaterialHolder interface has to be
supported to give access to the inspected object.</p>
@see XPropertySet
@see com::sun::star::beans::XExactName
*/
published interface XIntrospectionAccess: com::sun::star::uno::XInterface
{
/** returns information about which method concepts described in
the MethodConcept constants group are supported
by this XIntrospectionAccess implementation.
<p>The minimum supported concepts should be:</p>
<ul>
<li> MethodConcept::PROPERTY, </li>
<li> MethodConcept::LISTENER, </li>
<li> MethodConcept::ENUMERATION, </li>
<li> MethodConcept::NAMECONTAINER</li>
<li> MethodConcept::INDEXCONTAINER; </li>
</ul>
@returns
zero or more constants of the MethodConcept
constants group combined by an arithmetical or-operation.
*/
long getSuppliedMethodConcepts();
/** returns information about which property concepts described in
the PropertyConcept constants group are supported
by this XIntrospectionAccess implementation.
<p>The minimum supported concepts should be:</p>
<ul>
<li> PropertyConcept::PROPERTYSET, </li>
<li> PropertyConcept::ATTRIBUTES and </li>
<li> PropertyConcept::METHODS. </li>
</ul>
@returns
zero or more constants of the PropertyConcept
constants group.combined by an arithmetical or-operation.
*/
long getSuppliedPropertyConcepts();
/** returns information about a property if a property with
the demanded name exists and if it accords to one of the
demanded PropertyConcepts. The information
is provided as Property struct.
@returns
A Property struct providing
information about the demanded property,
if a corresponding property exists.
@param aName
the name of the property.
@param nPropertyConcepts
zero or more constants of the PropertyConcept
constants group combined by an arithmetical
or-operation.
@throws NoSuchElementException
when a property with the demanded name doesn't exist
or if it accords to a wrong PropertyConcept.
*/
com::sun::star::beans::Property getProperty( [in] string aName,
[in] long nPropertyConcepts )
raises( com::sun::star::container::NoSuchElementException );
/** allows to ask if a property with the demanded name exists
and if it accords to one of the demanded PropertyConcept.
@returns
`TRUE` if the property exists and accords to one of
the demanded PropertyConcepts, otherwise
`FALSE` is returned.
@param aName
the name of the property.
@param nPropertyConcepts
zero or more constants of the PropertyConcept
constants group combined by an arithmetical
or-operation.
*/
boolean hasProperty( [in] string aName,
[in] long nPropertyConcepts );
/** returns a sequence of properties of the introspected object
@returns
all properties of the introspected object which accord
to the demanded PropertyConcepts.
@param nPropertyConcepts
zero or more constants of the PropertyConcept
constants group combined by an arithmetical
or-operation.
*/
sequence<com::sun::star::beans::Property> getProperties(
[in] long nPropertyConcepts );
/** returns information about a method if a method with
the demanded name exists and if it accords to one of
the demanded MethodConcepts. The information is
provided as com::sun::star::reflection::XIdlMethod.
@returns
A com::sun::star::reflection::XIdlMethod providing
information about and
access to the demanded method if a corresponding
method exists.
@param aName
the name of the method.
@param nMethodConcepts
zero or more constants of the MethodConcept
constants group combined by an arithmetical
or-operation.
@throws NoSuchElementException
when a method with the demanded name doesn't exist
or if it accords to a wrong MethodConcept.
*/
com::sun::star::reflection::XIdlMethod getMethod( [in] string aName,
[in] long nMethodConcepts )
raises( com::sun::star::lang::NoSuchMethodException );
/** allows to ask if a method with the demanded name exists
and if it accords to one of the demanded MethodConcept.
@returns
`TRUE` if the method exists and accords to one of
the demanded MethodConcepts, otherwise
`FALSE` is returned.
@param aName
the name of the method.
@param nMethodConcepts
zero or more constants of the MethodConcept
constants group combined by an arithmetical
or-operation.
*/
boolean hasMethod( [in] string aName,
[in] long nMethodConcepts );
/** returns a sequence of methods of the introspected object.
@returns
all methods of the introspected object which accord
to the demanded MethodConcepts.
@param nMethodConcepts
zero or more constants of the MethodConcept
constants group combined by an arithmetical
or-operation.
*/
sequence<com::sun::star::reflection::XIdlMethod> getMethods(
[in] long nMethodConcepts );
/** returns the listener types supported by the introspected
object.
<p>If the introspected object has the methods
<code>addFooListener( XFooListener xFoo )</code> and
<code>removeFooListener( XFooListener xFoo )</code>
the type of XFooListener will be one of the elements
in the returned sequence.
@returns
a sequence of the types of listener interfaces
which are supported by the introspected object.
*/
sequence<type> getSupportedListeners();
/** creates an adapter that implements an interface with the
specified type.
<p>To access properties, query for the XPropertySet
interface. If the XPropertySet can
be queried, the XFastPropertySet interface
must be supported too. </p>
<p>If the introspected object implements a name container,
the introspection should return the
com::sun::star::container::XNameAccess and
com::sun::star::container::XNameContainer interfaces.</p>
<p>If the introspected object implements an index container,
the introspection should return the
com::sun::star::container::XIndexAccess and
com::sun::star::container::XIndexContainer interfaces.</p>
<p>If the introspected object implements an enumeration
container, the introspection should return the
com::sun::star::container::XEnumerationAccess interface.</p>
<p>If the introspected object implements the
com::sun::star::reflection::XIdlArray interface,
the introspection should return this.</p>
<p>To implement inaccurate name access, at all objects,
which implement the com::sun::star::container::XNameAccess or
XPropertySet interface, the XExactName interface has to be supported.
</p>
@see com::sun::star::beans::XExactName
*/
com::sun::star::uno::XInterface queryAdapter( [in] type aInterfaceType )
raises( com::sun::star::beans::IllegalTypeException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
