Sophie

Sophie

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

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

<html>
<head>
<title>Interface XFastPropertyState</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="XFastPropertyState-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">beans</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XFastPropertyState</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>makes it possible to query information about the state of
 one or more properties.

 </dd>
<dd><p>The state contains the information if:</p>
 <ul>
 <li>a value is available or void</li>
 <li>the value is stored in the object itself, or if a default value is to be used</li>
 <li>and if the value cannot be determined, due to ambiguity
 (multi selection with multiple values).</li>
 </ul>
 </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="#getFastPropertyState">getFastPropertyState</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFastPropertyStates">getFastPropertyStates</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setFastPropertyToDefault">setFastPropertyToDefault</a></td>
<td class="imsum_right">Sets the property to default value.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFastPropertyDefault">getFastPropertyDefault</a></td>
<td class="imsum_right">&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="getFastPropertyState" class="membertitle">getFastPropertyState</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="PropertyState.html">PropertyState</a></td>
</tr>
<tr>
<td valign="top"><b>getFastPropertyState</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nHandle )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the state of the property.

 </dd>
<dt><b>Parameter aPropertyName</b></dt>
<dd>specifies the name of the property.

 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException
 if the property does not exist.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFastPropertyStates" class="membertitle">getFastPropertyStates</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="PropertyState.html">PropertyState</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getFastPropertyStates</b>(</td>
<td valign="top">[in] sequence&lt; long &gt;</td>
<td valign="bottom">&nbsp;aHandles )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a sequence of the states of the properties which are specified
 by their names.

 <p>The order of the states is correlating to the order of the
 given property names. </p>

 </dd>
<dt><b>Parameter aPropertyNames</b></dt>
<dd>contains the sequence of property names.

 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException
 if one property does not exist.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setFastPropertyToDefault" class="membertitle">setFastPropertyToDefault</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>setFastPropertyToDefault</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nHandle )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Sets the property to default value.

 </dd>
<dd><p>The value depends on the implementation of this interface.
 If it is a bound property, you must change the value before
 the change events are fired. If it is a constrained property, you
 must fire the vetoable event before you change the property value.
 </p>

 </dd>
<dt><b>Parameter aPropertyname</b></dt>
<dd>specifies the name of the property.

 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException
 if the property does not exist.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFastPropertyDefault" class="membertitle">getFastPropertyDefault</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>getFastPropertyDefault</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nHandle )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnknownPropertyException.html">UnknownPropertyException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the default value of the property with the name PropertyName.

 <p>If no default exists, is not known or is void,
 then the return type is ::void.

 </dd>
<dt><b>Parameter aPropertyName</b></dt>
<dd>specifies the name of the property.

 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException
 if the property does not exist.

 </dd>
<dt><b>Throws</b></dt>
<dd>::com::sun::star::lang::WrappedTargetException
 if the implementation has an internal reason for the exception.
 In this case the original exception is wrapped into that
 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</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>