blob: 1ffe33b8deb0133c9beaa1fc030292013e470967 (
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef __com_sun_star_reflection_XTypeDescriptionEnumerationAccess_idl__
#define __com_sun_star_reflection_XTypeDescriptionEnumerationAccess_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_reflection_XTypeDescriptionEnumeration_idl__
#include <com/sun/star/reflection/XTypeDescriptionEnumeration.idl>
#endif
#ifndef __com_sun_star_reflection_TypeDescriptionSearchDepth_idl__
#include <com/sun/star/reflection/TypeDescriptionSearchDepth.idl>
#endif
#ifndef __com_sun_star_reflection_NoSuchTypeNameException_idl__
#include <com/sun/star/reflection/NoSuchTypeNameException.idl>
#endif
#ifndef __com_sun_star_reflection_InvalidTypeNameException_idl__
#include <com/sun/star/reflection/InvalidTypeNameException.idl>
#endif
//=============================================================================
module com { module sun { module star { module reflection {
//=============================================================================
/** Defines an interface for creating enumerations for type descriptions.
@since OpenOffice 1.1.2
*/
published interface XTypeDescriptionEnumerationAccess : com::sun::star::uno::XInterface
{
/** Creates an enumeration for type descriptions.
<p>An enumeration is always created for an UNOIDL module. The
enumeration contents can be restricted by specifying type classes.
Only types that match one of the supplied type classes will be part of
the collection. Additionally, it is possible to specify the depth
for the search within the underlying type description tree.
@param moduleName
contains the name of an UNOIDL module. Modules are seperated by a
single '.' (i.e., "com.sun.star.reflection"). The root of the module
hierarchy is specified with an empty string. Module names are always
absolute, never relative.
@param types
restricts the contents of the enumeration. It will only contain
type descriptions that match one of the supplied type classes. An
empty sequence specifies that the enumeration shall contain all
type descriptions.
<p>Valid types classes are:
<ul>
<li><member scope="com::sun::star::uno">TypeClass::MODULE</member>
<li><member scope="com::sun::star::uno">TypeClass::INTERFACE</member>
<li><member scope="com::sun::star::uno">TypeClass::SERVICE</member>
<li><member scope="com::sun::star::uno">TypeClass::STRUCT</member>
<li><member scope="com::sun::star::uno">TypeClass::ENUM</member>
<li><member scope="com::sun::star::uno">TypeClass::EXCEPTION</member>
<li><member scope="com::sun::star::uno">TypeClass::TYPEDEF</member>
<li><member scope="com::sun::star::uno">TypeClass::CONSTANT</member>
<li><member scope="com::sun::star::uno">TypeClass::CONSTANTS</member>
<li><member scope="com::sun::star::uno">TypeClass::SINGLETON</member>
</ul>
@param depth
specifies the depth of search in the underlying tree of type
descriptions. Clients should be aware of the fact that specifiying
<member>TypeDescriptionSearchDepth::INFINITE</member> can lead to
larger delays when constructing or using the
<type>XTypeDescriptionEnumeration</type> instance.
@returns
an enumeration of type descriptions.
<p>The enumeration returns implementations of
<type>XTypeDescription</type>. Following concrete UNOIDL parts
represented by specialized interfaces derived from
<type>XTypeDescription</type> can be returned by the enumerator:
<table border="1">
<thead><tr><th>IDL</th><th>interface</th></tr></thead>
<tbody>
<tr>
<td>enum</td>
<td><type>XEnumTypeDescription</type></td>
</tr>
<tr>
<td>struct</td>
<td><type>XCompoundTypeDescription</type> (the returned
object should actually implement
<type>XStructTypeDescription</type>)</td>
</tr>
<tr>
<td>exception</td>
<td><type>XCompoundTypeDescription</type></td>
</tr>
<tr>
<td>interface</td>
<td><type>XInterfaceTypeDescription</type> (the returned
object should actually implement
<type>XInterfaceTypeDescription2</type>)</td>
</tr>
<tr>
<td>service</td>
<td><type>XServiceTypeDescription</type> (the returned
object should actually implement
<type>XServiceTypeDescription2</type>)</td>
</tr>
<tr>
<td>singleton</td>
<td><type>XSingletonTypeDescription</type> (the returned
object should actually implement
<type>XSingletonTypeDescription2</type>)</td>
</tr>
<tr>
<td>module</td>
<td><type>XModuleTypeDescription</type></td>
</tr>
<tr>
<td>typedef</td>
<td><type>XIndirectTypeDescription</type></td>
</tr>
<tr>
<td>constant</td>
<td><type>XConstantTypeDescription</type></td>
</tr>
<tr>
<td>constants</td>
<td><type>XConstantsTypeDescription</type></td>
</tr>
</tbody>
</table>
@throws NoSuchTypeNameException
in case that the given module name does not exist. This exception
will never be thrown in case moduleName is the empty string.
@throws InvalidTypeNameException
in case that the given module name does exist, but does not specify
an UNOIDL module. This exception will never be thrown in case
moduleName is the empty string.
*/
XTypeDescriptionEnumeration
createTypeDescriptionEnumeration(
[in] string moduleName,
[in] sequence< com::sun::star::uno::TypeClass > types,
[in] TypeDescriptionSearchDepth depth )
raises( NoSuchTypeNameException, InvalidTypeNameException );
};
//=============================================================================
}; }; }; };
#endif
|
