| /************************************************************** |
| * |
| * 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 |