<html> <head> <title>Interface XTypeDescriptionEnumerationAccess</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XTypeDescriptionEnumerationAccess-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">reflection</a> :: </p> </td> </tr> <tr> <td class="title">interface XTypeDescriptionEnumerationAccess</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Defines an interface for creating enumerations for type descriptions. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#createTypeDescriptionEnumeration">createTypeDescriptionEnumeration</a></td> <td class="imsum_right">Creates an enumeration for type descriptions. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="createTypeDescriptionEnumeration" class="membertitle">createTypeDescriptionEnumeration</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XTypeDescriptionEnumeration.html">XTypeDescriptionEnumeration</a></td> </tr> <tr> <td valign="top"><b>createTypeDescriptionEnumeration</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> moduleName,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a> ></td> <td valign="bottom"> types,</td> </tr> <tr> <td/><td valign="top">[in] <a href="TypeDescriptionSearchDepth.html">TypeDescriptionSearchDepth</a></td> <td valign="bottom"> depth )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="NoSuchTypeNameException.html">NoSuchTypeNameException</a>,<br> <a href="InvalidTypeNameException.html">InvalidTypeNameException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Creates an enumeration for type descriptions. </dd> <dd><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. </dd> <dt><b>Parameter moduleName</b></dt> <dd>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. </dd> <dt><b>Parameter types</b></dt> <dd>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>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#MODULE">MODULE</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#INTERFACE">INTERFACE</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#SERVICE">SERVICE</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#STRUCT">STRUCT</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#ENUM">ENUM</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#EXCEPTION">EXCEPTION</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#TYPEDEF">TYPEDEF</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#CONSTANT">CONSTANT</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#CONSTANTS">CONSTANTS</a> <li>::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>::<a href="../uno/TypeClass.html#SINGLETON">SINGLETON</a> </ul> </dd> <dt><b>Parameter depth</b></dt> <dd>specifies the depth of search in the underlying tree of type descriptions. Clients should be aware of the fact that specifiying <a href="TypeDescriptionSearchDepth.html">TypeDescriptionSearchDepth</a>::<a href="TypeDescriptionSearchDepth.html#INFINITE">INFINITE</a> can lead to larger delays when constructing or using the <a href="XTypeDescriptionEnumeration.html">XTypeDescriptionEnumeration</a> instance. </dd> <dt><b>Returns</b></dt> <dd>an enumeration of type descriptions. <p>The enumeration returns implementations of <a href="XTypeDescription.html">XTypeDescription</a>. Following concrete UNOIDL parts represented by specialized interfaces derived from <a href="XTypeDescription.html">XTypeDescription</a> 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><a href="XEnumTypeDescription.html">XEnumTypeDescription</a></td> </tr> <tr> <td>struct</td> <td><a href="XCompoundTypeDescription.html">XCompoundTypeDescription</a> (the returned object should actually implement <a href="XStructTypeDescription.html">XStructTypeDescription</a>)</td> </tr> <tr> <td>exception</td> <td><a href="XCompoundTypeDescription.html">XCompoundTypeDescription</a></td> </tr> <tr> <td>interface</td> <td><a href="XInterfaceTypeDescription.html">XInterfaceTypeDescription</a> (the returned object should actually implement <a href="XInterfaceTypeDescription2.html">XInterfaceTypeDescription2</a>)</td> </tr> <tr> <td>service</td> <td><a href="XServiceTypeDescription.html">XServiceTypeDescription</a> (the returned object should actually implement <a href="XServiceTypeDescription2.html">XServiceTypeDescription2</a>)</td> </tr> <tr> <td>singleton</td> <td><a href="XSingletonTypeDescription.html">XSingletonTypeDescription</a> (the returned object should actually implement <a href="XSingletonTypeDescription2.html">XSingletonTypeDescription2</a>)</td> </tr> <tr> <td>module</td> <td><a href="XModuleTypeDescription.html">XModuleTypeDescription</a></td> </tr> <tr> <td>typedef</td> <td><a href="XIndirectTypeDescription.html">XIndirectTypeDescription</a></td> </tr> <tr> <td>constant</td> <td><a href="XConstantTypeDescription.html">XConstantTypeDescription</a></td> </tr> <tr> <td>constants</td> <td><a href="XConstantsTypeDescription.html">XConstantsTypeDescription</a></td> </tr> </tbody> </table> </dd> <dt><b>Throws</b></dt> <dd>NoSuchTypeNameException in case that the given module name does not exist. This exception will never be thrown in case moduleName is the empty string. </dd> <dt><b>Throws</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4697
