Sophie

Sophie

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

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

<html>
<head>
<title>Interface XIdlField2</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="XIdlField2-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 XIdlField2</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XIdlField2</strong>
&#x2517 <a href="XIdlMember.html">XIdlMember</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XIdlMember.html">XIdlMember</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Base interface for <a href="XIdlField2.html">XIdlField2</a>s and <a href="XIdlMethod.html">XIdlMethod</a>s.
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Reflects an IDL interface attribute, enum or compound type
 (i.e. struct/exception) member.
</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="#getType">getType</a></td>
<td class="imsum_right">Returns the type of the field.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getAccessMode">getAccessMode</a></td>
<td class="imsum_right">Returns the access mode of the field, i.e. read-write, read-only or
 write-only (access mode "const" is deprecated).
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#get">get</a></td>
<td class="imsum_right">Gets the value of the reflected field from the given object,
 i.e. an interface, enum or compound type (struct/exception).
 For enums, the given object is ignored; the returned value
 reflects the constant enum 32-bit value.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#set">set</a></td>
<td class="imsum_right">Sets the value of the reflected field of the given object,
 i.e. an interface or compound type (struct/exception).

 &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="getType" class="membertitle">getType</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>getType</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the type of the field.

 </dd>
<dt><b>Returns</b></dt>
<dd>type of the field
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getAccessMode" class="membertitle">getAccessMode</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="FieldAccessMode.html">FieldAccessMode</a></td>
</tr>
<tr>
<td valign="top"><b>getAccessMode</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns the access mode of the field, i.e. read-write, read-only or
 write-only (access mode "const" is deprecated).
 
 </dd>
<dt><b>Returns</b></dt>
<dd>access mode of the field
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="get" class="membertitle">get</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">any</td>
</tr>
<tr>
<td valign="top"><b>get</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;obj )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Gets the value of the reflected field from the given object,
 i.e. an interface, enum or compound type (struct/exception).
 For enums, the given object is ignored; the returned value
 reflects the constant enum 32-bit value.
 
 </dd>
<dd><p>When setting an interface attribute raises a
 non-::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/RuntimeException.html">RuntimeException</a>, it is
 wrapped in a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetRuntimeException.html">WrappedTargetRuntimeException</a>.</p>
 
 </dd>
<dt><b>Parameter obj</b></dt>
<dd>object instance having member of reflected type
 </dd>
<dt><b>Returns</b></dt>
<dd>value of field
 
 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalAccessException
 An ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a>
 is thrown if the given object is no interface, enum or compound type;
 or the given object does not have the reflected field.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="set" class="membertitle">set</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>set</b>(</td>
<td valign="top">[inout] any</td>
<td valign="bottom">&nbsp;obj,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;value )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Sets the value of the reflected field of the given object,
 i.e. an interface or compound type (struct/exception).

 </dd>
<dd><p>When setting an interface attribute raises a
 non-::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/RuntimeException.html">RuntimeException</a>, it is
 wrapped in a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetRuntimeException.html">WrappedTargetRuntimeException</a>.</p>
 
 </dd>
<dt><b>Parameter obj</b></dt>
<dd>object instance having member of reflected type
 </dd>
<dt><b>Parameter value</b></dt>
<dd>value to be set
 
 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalAccessException
 An ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a>
 is thrown if the given object is no interface or compound type;
 or the given object does not have the reflected field.
 </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>