Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 4468

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XIdlClass</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="XIdlClass-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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 XIdlClass</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Provides information reflecting an UNO type.
</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="#getClasses">getClasses</a></td>
<td class="imsum_right"><b>[ DEPRECATED ]<br>
</b>Deprecated. Do not call.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getClass">getClass</a></td>
<td class="imsum_right"><b>[ DEPRECATED ]<br>
</b>Deprecated. Do not call.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#equals">equals</a></td>
<td class="imsum_right">Tests whether two reflecting objects reflect the same type.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isAssignableFrom">isAssignableFrom</a></td>
<td class="imsum_right">Tests whether values of this reflected type are assignable from values
 of a second one (<code>xType</code>).

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getTypeClass">getTypeClass</a></td>
<td class="imsum_right">Returns the ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>
 of the reflected type.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getName">getName</a></td>
<td class="imsum_right">Returns the fully-qualified name of the reflected type.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUik">getUik</a></td>
<td class="imsum_right"><b>[ DEPRECATED ]<br>
</b>Deprecated. Do not call.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSuperclasses">getSuperclasses</a></td>
<td class="imsum_right">If the reflected type is an interface, then the returned
 sequence of <a href="XIdlClass.html">XIdlClass</a> reflect the base interfaces.
 <br>
 If the reflected type is not an interface or an interface that is
 not derived from another, then an empty sequence is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getInterfaces">getInterfaces</a></td>
<td class="imsum_right"><b>[ DEPRECATED ]<br>
</b>Deprecated. Do not call.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getComponentType">getComponentType</a></td>
<td class="imsum_right">If the reflected type is an array or sequence, then this method
 returns a <a href="XIdlClass.html">XIdlClass</a> interface reflecting
 the element.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getField">getField</a></td>
<td class="imsum_right">If the reflected type is an interface, struct or union, then you
 get a <a href="XIdlField.html">XIdlField</a> interface reflecting the demanded
 field (/interface attribute) by name.
 <br>
 If the reflected type is not an interface, struct or union or the
 interace, struct or union does not have a field (/interface attribute)
 with the demanded name, then a null-reference is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFields">getFields</a></td>
<td class="imsum_right">If the reflected type is an interface, struct or union, then you
 get a sequence of <a href="XIdlField.html">XIdlField</a> interfaces reflecting all fields
 (/interface attributes). This also includes all inherited
 fields (/interface attributes) of the interface, struct of union.
 <br>
 If the reflected type is not an interface, struct or union or the
 interface, struct or union does not have any field (/interface attribute),
 then an empty sequence is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMethod">getMethod</a></td>
<td class="imsum_right">If the reflected type is an interface, then you get
 a <a href="XIdlMethod.html">XIdlMethod</a> interface reflecting the demanded method by name.
 <br>
 If the reflected type is not an interface or the interface does not have
 a method with the demanded name (including inherited methods),
 then a null-reference is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMethods">getMethods</a></td>
<td class="imsum_right">If the reflected type is an interface, then you get
 a sequence of <a href="XIdlMethod.html">XIdlMethod</a> interfaces reflecting all methods
 of the interface. This also includes the inherited methods of the interface.
 <br>
 If the reflected type is not an interface or the interface
 does not have any methods, then a null-reference is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getArray">getArray</a></td>
<td class="imsum_right">If the reflected type is an array, then you get
 a <a href="XIdlArray.html">XIdlArray</a> interface to modify instances of the array type.
 <br>
 If the reflected type is not an array, then a null-reference is returned.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createObject">createObject</a></td>
<td class="imsum_right">This method creates instances of the reflected type.

 @attention
 Instances of type <code>any</code> can not be passed using an <code>any</code>, because
 anys cannot be nested. So if the reflected type is an <code>any</code>, then the
 returned value is empty.

 &nbsp;</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="getClasses" class="membertitle">getClasses</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">sequence&lt; <a href="XIdlClass.html">XIdlClass</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getClasses</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dt><b>Description</b></dt>
<dd>Deprecated. Do not call.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getClass" class="membertitle">getClass</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="XIdlClass.html">XIdlClass</a></td>
</tr>
<tr>
<td valign="top"><b>getClass</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dt><b>Description</b></dt>
<dd>Deprecated. Do not call.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="equals" class="membertitle">equals</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>equals</b>(</td>
<td valign="top">[in] <a href="XIdlClass.html">XIdlClass</a></td>
<td valign="bottom">&nbsp;Type );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Tests whether two reflecting objects reflect the same type.

 </dd>
<dt><b>Returns</b></dt>
<dd>true, if the objects reflect the same type, false otherwise.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isAssignableFrom" class="membertitle">isAssignableFrom</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>isAssignableFrom</b>(</td>
<td valign="top">[in] <a href="XIdlClass.html">XIdlClass</a></td>
<td valign="bottom">&nbsp;xType );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Tests whether values of this reflected type are assignable from values
 of a second one (<code>xType</code>).

 </dd>
<dt><b>Parameter xType</b></dt>
<dd>another reflected type
 </dd>
<dt><b>Returns</b></dt>
<dd>true, if values of this reflected type are assignable
 from values of <code>xType</code>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getTypeClass" class="membertitle">getTypeClass</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">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a></td>
</tr>
<tr>
<td valign="top"><b>getTypeClass</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/TypeClass.html">TypeClass</a>
 of the reflected type.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>type class of the reflected type.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getName" class="membertitle">getName</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">string</td>
</tr>
<tr>
<td valign="top"><b>getName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the fully-qualified name of the reflected type.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>the fully-qualified name of the type
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUik" class="membertitle">getUik</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">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Uik.html">Uik</a></td>
</tr>
<tr>
<td valign="top"><b>getUik</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dt><b>Description</b></dt>
<dd>Deprecated. Do not call.

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSuperclasses" class="membertitle">getSuperclasses</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">sequence&lt; <a href="XIdlClass.html">XIdlClass</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getSuperclasses</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an interface, then the returned
 sequence of <a href="XIdlClass.html">XIdlClass</a> reflect the base interfaces.
 <br>
 If the reflected type is not an interface or an interface that is
 not derived from another, then an empty sequence is returned.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>all base interfaces of an interface type or an empty sequence.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getInterfaces" class="membertitle">getInterfaces</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">sequence&lt; <a href="XIdlClass.html">XIdlClass</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getInterfaces</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dt><b>Description</b></dt>
<dd>Deprecated. Do not call.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getComponentType" class="membertitle">getComponentType</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="XIdlClass.html">XIdlClass</a></td>
</tr>
<tr>
<td valign="top"><b>getComponentType</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an array or sequence, then this method
 returns a <a href="XIdlClass.html">XIdlClass</a> interface reflecting
 the element.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>reflection interface of the element type of an array or
 sequence type (null-reference otherwise).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getField" class="membertitle">getField</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="XIdlField.html">XIdlField</a></td>
</tr>
<tr>
<td valign="top"><b>getField</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an interface, struct or union, then you
 get a <a href="XIdlField.html">XIdlField</a> interface reflecting the demanded
 field (/interface attribute) by name.
 <br>
 If the reflected type is not an interface, struct or union or the
 interace, struct or union does not have a field (/interface attribute)
 with the demanded name, then a null-reference is returned.
 
 </dd>
<dt><b>Parameter aName</b></dt>
<dd>name of the demanded field reflection
 </dd>
<dt><b>Returns</b></dt>
<dd>demanded field (/interface attribute) reflection (or null-reference)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFields" class="membertitle">getFields</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">sequence&lt; <a href="XIdlField.html">XIdlField</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getFields</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an interface, struct or union, then you
 get a sequence of <a href="XIdlField.html">XIdlField</a> interfaces reflecting all fields
 (/interface attributes). This also includes all inherited
 fields (/interface attributes) of the interface, struct of union.
 <br>
 If the reflected type is not an interface, struct or union or the
 interface, struct or union does not have any field (/interface attribute),
 then an empty sequence is returned.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>all field (/interface attribute) reflections (or empty sequence)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMethod" class="membertitle">getMethod</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="XIdlMethod.html">XIdlMethod</a></td>
</tr>
<tr>
<td valign="top"><b>getMethod</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an interface, then you get
 a <a href="XIdlMethod.html">XIdlMethod</a> interface reflecting the demanded method by name.
 <br>
 If the reflected type is not an interface or the interface does not have
 a method with the demanded name (including inherited methods),
 then a null-reference is returned.
 
 </dd>
<dt><b>Parameter aName</b></dt>
<dd>name of demanded method reflection
 </dd>
<dt><b>Returns</b></dt>
<dd>demanded method reflection (or null-reference)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMethods" class="membertitle">getMethods</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">sequence&lt; <a href="XIdlMethod.html">XIdlMethod</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getMethods</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an interface, then you get
 a sequence of <a href="XIdlMethod.html">XIdlMethod</a> interfaces reflecting all methods
 of the interface. This also includes the inherited methods of the interface.
 <br>
 If the reflected type is not an interface or the interface
 does not have any methods, then a null-reference is returned.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>all method reflections (or empty sequence)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getArray" class="membertitle">getArray</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="XIdlArray.html">XIdlArray</a></td>
</tr>
<tr>
<td valign="top"><b>getArray</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If the reflected type is an array, then you get
 a <a href="XIdlArray.html">XIdlArray</a> interface to modify instances of the array type.
 <br>
 If the reflected type is not an array, then a null-reference is returned.
 
 </dd>
<dt><b>Returns</b></dt>
<dd>inteface to modify array instances (or null-reference)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createObject" class="membertitle">createObject</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">void</td>
</tr>
<tr>
<td valign="top"><b>createObject</b>(</td>
<td valign="top">[out] any</td>
<td valign="bottom">&nbsp;obj );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>This method creates instances of the reflected type.

 @attention
 Instances of type <code>any</code> can not be passed using an <code>any</code>, because
 anys cannot be nested. So if the reflected type is an <code>any</code>, then the
 returned value is empty.

 </dd>
<dt><b>Parameter obj</b></dt>
<dd>pure out parameter to pass the created instance
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>