Sophie

Sophie

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

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

<html>
<head>
<title>Interface XMultiPropertySet</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="XMultiPropertySet-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Properties" 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">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 XMultiPropertySet</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to multiple properties with a single call.
 </dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Properties">ProUNO - Properties</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="#getPropertySetInfo">getPropertySetInfo</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPropertyValues">setPropertyValues</a></td>
<td class="imsum_right">sets the values to the properties with the specified names.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPropertyValues">getPropertyValues</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#addPropertiesChangeListener">addPropertiesChangeListener</a></td>
<td class="imsum_right">adds an <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a> to the 
 specified property with the specified names.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removePropertiesChangeListener">removePropertiesChangeListener</a></td>
<td class="imsum_right">removes an <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a> from the listener list.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#firePropertiesChangeEvent">firePropertiesChangeEvent</a></td>
<td class="imsum_right">fires a sequence of <a href="PropertyChangeEvent.html">PropertyChangeEvent</a>s to the specified 
 listener.

 &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="getPropertySetInfo" class="membertitle">getPropertySetInfo</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="XPropertySetInfo.html">XPropertySetInfo</a></td>
</tr>
<tr>
<td valign="top"><b>getPropertySetInfo</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>the <a href="XPropertySetInfo.html">XPropertySetInfo</a> interface, which describes 
 all properties of the object to which this interface belongs. 
 <b>NULL</b> is returned if the object cannot or will 
 not provide information about the properties. 
 
 </dd>
<dt><b>See also</b></dt>
<dd><a href="XPropertySet.html">XPropertySet</a>::<a href="XPropertySet.html#getPropertySetInfo">getPropertySetInfo</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPropertyValues" class="membertitle">setPropertyValues</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>setPropertyValues</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; any &gt;</td>
<td valign="bottom">&nbsp;aValues )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="PropertyVetoException.html">PropertyVetoException</a>,<br>
::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/WrappedTargetException.html">WrappedTargetException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>sets the values to the properties with the specified names.
 
 </dd>
<dd><p>The values of the properties must change before the bound 
 events are fired. The values of the constrained properties 
 should change after the vetoable events are fired and only if no 
 exception occured. Unknown properties are ignored. </p>

 </dd>
<dt><b>Parameter aPropertyNames</b></dt>
<dd>specifies the names of the properties. All names must be unique.
 This sequence must be alphabetically sorted.

 </dd>
<dt><b>Parameter aValues</b></dt>
<dd>contains the new values of the properties. The order is the same
 as in <var>aPropertyNames</var>.

 </dd>
<dt><b>Throws</b></dt>
<dd>IllegalArgumentException
 if one of the new values cannot be converted to the type
 of the underlying property by an identity or widening conversion.

 </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.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPropertyValues" class="membertitle">getPropertyValues</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>getPropertyValues</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Returns</b></dt>
<dd>a sequence of all values of the properties which are specified by their names. 
 
 <p>The order of the values in the returned sequence will be the same 
 as the order of the names in the argument. </p>

 </dd>
<dt><b>Parameter aPropertyNames</b></dt>
<dd>specifies the names of the properties. 
 This sequence must be alphabetically sorted.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="addPropertiesChangeListener" class="membertitle">addPropertiesChangeListener</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>addPropertiesChangeListener</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a></td>
<td valign="bottom">&nbsp;xListener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adds an <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a> to the 
 specified property with the specified names.
 
 </dd>
<dd><p>The implementation can ignore the names of the properties
 and fire the event on all properties. </p>

 <p>It is suggested to allow multiple registration of the same listener,
 thus for each time a listener is added, it has to be removed.

 </dd>
<dt><b>Parameter aPropertyNames</b></dt>
<dd>specifies the names of the properties.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>contains the listener for the property change events.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#removePropertiesChangeListener">removePropertiesChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removePropertiesChangeListener" class="membertitle">removePropertiesChangeListener</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>removePropertiesChangeListener</b>(</td>
<td valign="top">[in] <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a></td>
<td valign="bottom">&nbsp;xListener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes an <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a> from the listener list.
 
 </dd>
<dd><p>It is a "noop" if the listener is not registered. </p>

 <p>It is suggested to allow multiple registration of the same listener,
 thus for each time a listener is added, it has to be removed.

 </dd>
<dt><b>Parameter contains</b></dt>
<dd>the listener to be removed.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#addPropertiesChangeListener">addPropertiesChangeListener</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="firePropertiesChangeEvent" class="membertitle">firePropertiesChangeEvent</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>firePropertiesChangeEvent</b>(</td>
<td valign="top">[in] sequence&lt; string &gt;</td>
<td valign="bottom">&nbsp;aPropertyNames,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPropertiesChangeListener.html">XPropertiesChangeListener</a></td>
<td valign="bottom">&nbsp;xListener );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>fires a sequence of <a href="PropertyChangeEvent.html">PropertyChangeEvent</a>s to the specified 
 listener.

 </dd>
<dt><b>Parameter aPropertynames</b></dt>
<dd>specifies the sorted names of the properties.

 </dd>
<dt><b>Parameter xListener</b></dt>
<dd>contains the listener for the property change events.
 </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>