Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: reflection ::
interface XTypeDescriptionEnumerationAccess
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XTypeDescriptionEnumerationAccess
Description Defines an interface for creating enumerations for type descriptions. Since version OpenOffice.org 1.1.1

Methods' Summary
createTypeDescriptionEnumeration | Creates an enumeration for type descriptions.

Methods' Details
createTypeDescriptionEnumeration
XTypeDescriptionEnumeration createTypeDescriptionEnumeration( | [in] string [in] sequence< ::com::sun::star::uno::TypeClass > [in] TypeDescriptionSearchDepth raises( | moduleName, types, depth ) NoSuchTypeNameException, InvalidTypeNameException );
Description Creates an enumeration for type descriptions. 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. Parameter 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. Parameter 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. Valid types classes are: ::com::sun::star::uno::TypeClass::MODULE ::com::sun::star::uno::TypeClass::INTERFACE ::com::sun::star::uno::TypeClass::SERVICE ::com::sun::star::uno::TypeClass::STRUCT ::com::sun::star::uno::TypeClass::ENUM ::com::sun::star::uno::TypeClass::EXCEPTION ::com::sun::star::uno::TypeClass::TYPEDEF ::com::sun::star::uno::TypeClass::CONSTANT ::com::sun::star::uno::TypeClass::CONSTANTS ::com::sun::star::uno::TypeClass::SINGLETON Parameter depth specifies the depth of search in the underlying tree of type descriptions. Clients should be aware of the fact that specifiying TypeDescriptionSearchDepth::INFINITE can lead to larger delays when constructing or using the XTypeDescriptionEnumeration instance. Returns an enumeration of type descriptions. The enumeration returns implementations of XTypeDescription . Following concrete UNOIDL parts represented by specialized interfaces derived from XTypeDescription can be returned by the enumerator: IDL | interface | module | XModuleTypeDescription | interface | XInterfaceTypeDescription | service | XServiceTypeDescription | struct | XCompoundTypeDescription | enum | XEnumTypeDescription | exception | XCompoundTypeDescription | typedef | XIndirectTypeDescription | constant | XConstantTypeDescription | constants | XConstantsTypeDescription | singleton | XSingletonTypeDescription Throws NoSuchTypeNameException in case that the given type name does not exist. Throws InvalidTypeNameException in case that the given type name does exist, but does not specify an UNOIDL module.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.