Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 1420

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XMultiPropertyStates</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="XMultiPropertyStates-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">beans</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XMultiPropertyStates</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 of a property contains information about the source of
 the value, e.g. the object itself, a default or a stylesheet.
 For more information see <a href="PropertyState.html">PropertyState</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="#getPropertyStates">getPropertyStates</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setAllPropertiesToDefault">setAllPropertiesToDefault</a></td>
<td class="imsum_right">sets all properties to their default values. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPropertiesToDefault">setPropertiesToDefault</a></td>
<td class="imsum_right">sets the specified properties to their default values. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPropertyDefaults">getPropertyDefaults</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="getPropertyStates" class="membertitle">getPropertyStates</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>getPropertyStates</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyName )</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. 

 </dd>
<dt><b>Parameter aPropertyName</b></dt>
<dd>specifies the names of the properties. All names must be unique.
 This sequence must be alphabetically sorted.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setAllPropertiesToDefault" class="membertitle">setAllPropertiesToDefault</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>setAllPropertiesToDefault</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sets all properties to their default values. 
 
 </dd>
<dd><p>Each 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>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPropertiesToDefault" class="membertitle">setPropertiesToDefault</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>setPropertiesToDefault</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames )</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 specified properties to their default values. 
 
 </dd>
<dd><p>Each 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 names of the properties. All names must be unique.
 This sequence must be alphabetically sorted.
 
 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException 
 if one of the properties does not exist.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPropertyDefaults" class="membertitle">getPropertyDefaults</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; any &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPropertyDefaults</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames )</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 values of the propertes with the specified names.
 
 <p>If no default exists, is not known, or is void,
 then the return type at the corresponding position in the
 sequence returned is <code>void</code>. </p>
 
 </dd>
<dt><b>Parameter aPropertyName</b></dt>
<dd>specifies the names of the properties. All names must be unique.
 This sequence must be alphabetically sorted.
 
 </dd>
<dt><b>Throws</b></dt>
<dd>UnknownPropertyException 
 if one of the propertes 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; 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>