Sophie

Sophie

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

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

<html>
<head>
<title>Interface XUIConfigurationPersistence</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="XUIConfigurationPersistence-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">ui</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 XUIConfigurationPersistence</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>specifies a persistence interface which supports to load/store user 
 interface configuration data to a storage and to retrieve information 
 about the current state.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</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="#reload">reload</a></td>
<td class="imsum_right">reloads the configuration data from the storage and reinitialize 
 the user interface configuration manager instance with this data.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#store">store</a></td>
<td class="imsum_right">stores the configuration data to the storage provided by 
 <a href="#setStorage">setStorage</a> from the storage and initialize the 
 user interface configuration manager instance with the newly 
 data. This call can throw an 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> if 
 <a href="#store">store</a> cannot store its data into the internal 
 storage.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#storeToStorage">storeToStorage</a></td>
<td class="imsum_right">stores the configuration data to the provided storage, ignoring 
 the previously set storage by <a href="#setStorage">setStorage</a>. Can 
 be used to make copy of the current user interface configuration 
 data to another storage. This call will throw an 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> if the provided
 storage is in read-only mode.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isModified">isModified</a></td>
<td class="imsum_right">provides the current modify state of the configuration manager 
 instance.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td>
<td class="imsum_right">provides the current read-only state of the user configuration 
 manager. Storing a user interface configuration to a read-only storage 
 is not possible. A read-only configuration manager instance will also 
 not support any changes to its configuration settings.

 &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="reload" class="membertitle">reload</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>reload</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>reloads the configuration data from the storage and reinitialize 
 the user interface configuration manager instance with this data.

 </dd>
<dd><p>
 It is up to the implementation if it defers the first loading process 
 until the first data request using <a href="XUIConfigurationManager.html">XUIConfigurationManager</a> 
 interface.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="store" class="membertitle">store</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>store</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stores the configuration data to the storage provided by 
 <a href="#setStorage">setStorage</a> from the storage and initialize the 
 user interface configuration manager instance with the newly 
 data. This call can throw an 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> if 
 <a href="#store">store</a> cannot store its data into the internal 
 storage.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="storeToStorage" class="membertitle">storeToStorage</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>storeToStorage</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a></td>
<td valign="bottom">&nbsp;Storage )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stores the configuration data to the provided storage, ignoring 
 the previously set storage by <a href="#setStorage">setStorage</a>. Can 
 be used to make copy of the current user interface configuration 
 data to another storage. This call will throw an 
 ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> if the provided
 storage is in read-only mode.

 </dd>
<dt><b>Parameter Storage</b></dt>
<dd>all configuration data will be stored to this storage.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isModified" class="membertitle">isModified</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>isModified</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides the current modify state of the configuration manager 
 instance.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the configuration manager has changed since the 
 last <a href="#store">store</a> call. <b>false</b> if the configuration 
 manager has not been changed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>isReadOnly</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides the current read-only state of the user configuration 
 manager. Storing a user interface configuration to a read-only storage 
 is not possible. A read-only configuration manager instance will also 
 not support any changes to its configuration settings.

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the configuration manager storage is read-only otherwise 
 <b>false</b>.
 </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>