/* -*- 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 . */ module com { module sun { module star { module reflection { /** Defines an interface for creating enumerations for type descriptions. @since OOo 1.1.2 */ published interface XTypeDescriptionEnumerationAccess : com::sun::star::uno::XInterface { /** Creates an enumeration for type descriptions.
An enumeration is always created for a 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 a UNOIDL module. Modules are separated 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.
Valid types classes are:
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 |
---|---|
enum | XEnumTypeDescription |
struct | XCompoundTypeDescription (the returned object should actually implement XStructTypeDescription) |
exception | XCompoundTypeDescription |
interface | XInterfaceTypeDescription (the returned object should actually implement XInterfaceTypeDescription2) |
service | XServiceTypeDescription (the returned object should actually implement XServiceTypeDescription2) |
singleton | XSingletonTypeDescription (the returned object should actually implement XSingletonTypeDescription2) |
module | XModuleTypeDescription |
typedef | XIndirectTypeDescription |
constant | XConstantTypeDescription |
constants | XConstantsTypeDescription |