<html> <head> <title>Interface XStorable</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="XStorable-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" 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">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XStorable</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>offers a simple way to store a component to an URL. </dd> <dd><p> It is usually only useful for two cases: </p> <ol> <li> Large components which are wrapped up in UNO interfaces and for which distinct filters are not available separately as components. </li> <li> Very small components for which only one or very few hard coded file format filters make sense or even exist. </li> </ol> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Drawings/Storing">Drawings - Storing</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Storing_Documents">OfficeDev - Storing Documents</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Saving_Spreadsheet_Documents#Storing">Spreadsheets - Saving Spreadsheet Documents - Storing</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Saving_Text_Documents#Storing">Text - Saving Text Documents - Storing</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="#hasLocation">hasLocation</a></td> <td class="imsum_right">The object may know the location because it was loaded from there, or because it is stored there. </td> </tr> <tr> <td class="imsum_left"><a href="#getLocation">getLocation</a></td> <td class="imsum_right">After <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeAsURL">storeAsURL()</a> it returns the URL the object was stored to. </td> </tr> <tr> <td class="imsum_left"><a href="#isReadonly">isReadonly</a></td> <td class="imsum_right">It is not possible to call <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#store">store()</a> successfully when the data store is read-only. </td> </tr> <tr> <td class="imsum_left"><a href="#store">store</a></td> <td class="imsum_right">stores the data to the URL from which it was loaded. </td> </tr> <tr> <td class="imsum_left"><a href="#storeAsURL">storeAsURL</a></td> <td class="imsum_right">stores the object's persistent data to a URL and makes this URL the new location of the object. </td> </tr> <tr> <td class="imsum_left"><a href="#storeToURL">storeToURL</a></td> <td class="imsum_right">stores the object's persistent data to a URL and continues to be a representation of the old URL. </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="hasLocation" class="membertitle">hasLocation</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>hasLocation</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>The object may know the location because it was loaded from there, or because it is stored there. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the object knows a location where it is persistent <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocation" class="membertitle">getLocation</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">string</td> </tr> <tr> <td valign="top"><b>getLocation</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>After <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeAsURL">storeAsURL()</a> it returns the URL the object was stored to. </dd> <dt><b>Returns</b></dt> <dd>the URL of the resource which is represented by this object. </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>It is not possible to call <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#store">store()</a> successfully when the data store is read-only. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the data store is readonly or opened readonly <b>false</b> otherwise </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="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores the data to the URL from which it was loaded. </dd> <dd><p>Only objects which know their locations can be stored.</p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown) </dd> <dt><b>See also</b></dt> <dd><a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeAsURL">storeAsURL</a>, <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeToURL">storeToURL</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeAsURL" class="membertitle">storeAsURL</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>storeAsURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sURL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> lArguments )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores the object's persistent data to a URL and makes this URL the new location of the object. </dd> <dd><p>This is the normal behavior for UI's "save-as" feature.</p> <p>The change of the location makes it necessary to store the document in a format that the object can load. For this reason the implementation of <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeAsURL">storeAsURL()</a> will throw an exception if a pure export filter is used, it will accept only combined import/export filters. For such filters the method <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeToURL">storeToURL()</a> must be used that does not change the location of the object.</p> </dd> <dt><b>Parameter sURL</b></dt> <dd>specifies the new location of this component </dd> <dt><b>Parameter lArguments</b></dt> <dd>optional parameters for saving (see ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a> for further details) </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown) </dd> <dt><b>See also</b></dt> <dd><a href="XStorable.html">XStorable</a>::<a href="XStorable.html#store">store</a>, <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeToURL">storeToURL</a>, ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="storeToURL" class="membertitle">storeToURL</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>storeToURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sURL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> lArguments )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stores the object's persistent data to a URL and continues to be a representation of the old URL. </dd> <dd><p>This is the normal behavior for UI's export feature.</p> <p>This method accepts all kinds of export filters, not only combined import/export filters because it implements an exporting capability, not a persistence capability.</p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException if an IO error occured during save operation (may the location is unknown) </dd> <dt><b>Parameter lArguments</b></dt> <dd>optional parameters for saving (see ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a> for further details) </dd> <dt><b>See also</b></dt> <dd><a href="XStorable.html">XStorable</a>::<a href="XStorable.html#store">store</a>, <a href="XStorable.html">XStorable</a>::<a href="XStorable.html#storeAsURL">storeAsURL</a>, ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</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 © 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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3601
