Sophie

Sophie

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

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

<html>
<head>
<title>Interface XIntrospection</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="XIntrospection-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AdvUNO/UNO_Reflection_API" class="navimain">Devguide</a></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">beans</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XIntrospection</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>allows the inspection of an object's properties and methods. 
 
 </dd>
<dd><p><strong>Important note:</strong>An object can only be
 inspected completely if it supports the ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XTypeProvider.html">XTypeProvider</a> interface.</p>
 
 <p>For details see method <a href="XIntrospection.html#inspect">inspect</a>. </p>
 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="XIntrospectionAccess.html">XIntrospectionAccess</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/AdvUNO/UNO_Reflection_API">AdvUNO - UNO Reflection API</a></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="#inspect">inspect</a></td>
<td class="imsum_right">inspects the given object.
 
 &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="inspect" class="membertitle">inspect</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="XIntrospectionAccess.html">XIntrospectionAccess</a></td>
</tr>
<tr>
<td valign="top"><b>inspect</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;aObject );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>inspects the given object.
 
 </dd>
<dd><p>It identifies all properties supported by the object
 if they are represented in one of the following ways: </p>
 
 <dl>
 <dt>property set </dt>
 <dd>If the object supports an <a href="XPropertySet.html">XPropertySet</a> 
 interface, all its properties are adopted. 
 </dd> 

 <dt>attributes </dt>
 <dd>All of an object's attributes are considered as properties 
 with same name. If an attribute is read-only, the property 
 also is read-only.
 </dd>

 <dt>get/set methods </dt>
 <dd>Every method <code>RetType getX()</code> defines a 
 property where "X" stands for the property name and 
 "RetType" for its type. The method must not have any 
 parameters, or there is no property access method 
 and "X" has no property. If there is also a method 
 <code>void setX( [in] RetType )</code>, the property
 "X" also allows write access; otherwise it is read-only.
 </dd>

 <dt> <strong>Important note:</strong></dt>
 <dd>If an object implements ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a>, 
 the items that can be accessed are not considered as properties 
 of the object and so are not included in the property list offered by 
 <a href="XIntrospectionAccess.html">XIntrospectionAccess</a>::<a href="XIntrospectionAccess.html#getProperties">getProperties()</a>. 
 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> items have to be 
 accessed separately by <a href="XIntrospectionAccess.html">XIntrospectionAccess</a>::<a href="XIntrospectionAccess.html#getNameAccess">getNameAccess()</a>.
 </dd>
 </dl>
 
 <p>In addition, the inspect method identifies all listener 
 access methods in the form <code>add...Listener</code>/
 <code>remove...Listener</code> (except methods of interface
 <a href="XPropertySet.html">XPropertySet</a>) where "..." stands for the listener type. 
 </p>

 <p>Methods which do not belong to a property nor which represent 
 a listener access nor which are methods of <a href="XPropertySet.html">XPropertySet</a>, 
 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a>, 
 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a>, or
 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a>, are considered to be normal 
 methods. </p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XIntrospectionAccess.html">XIntrospectionAccess</a></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>