Sophie

Sophie

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

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

<html>
<head>
<title>Interface XTransferable</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="XTransferable-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">datatransfer</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XTransferable</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Interface to be implemented by objects used to provide data for a data 
 transfer operation.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="DataFlavor.html">DataFlavor</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="#getTransferData">getTransferData</a></td>
<td class="imsum_right">Called by a data consumer to obtain data from the source in a specified 
 format.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getTransferDataFlavors">getTransferDataFlavors</a></td>
<td class="imsum_right">Returns a sequence of supported <a href="DataFlavor.html">DataFlavor</a>.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isDataFlavorSupported">isDataFlavorSupported</a></td>
<td class="imsum_right">Checks if the data object supports the specified data flavor.

 &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="getTransferData" class="membertitle">getTransferData</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>getTransferData</b>(</td>
<td valign="top">[in] <a href="DataFlavor.html">DataFlavor</a></td>
<td valign="bottom">&nbsp;aFlavor )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="UnsupportedFlavorException.html">UnsupportedFlavorException</a>,<br>
::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>Called by a data consumer to obtain data from the source in a specified 
 format.
 
 </dd>
<dt><b>Parameter aFlavor</b></dt>
<dd>Describes the requested data format 

 </dd>
<dt><b>Returns</b></dt>
<dd>The data in the specified <a href="DataFlavor.html">DataFlavor</a>.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::io::IOException 
 if the data is no longer available in the requested flavor.
 
 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::datatransfer::UnsupportedFlavorException
 if the requested <a href="DataFlavor.html">DataFlavor</a> is not supported. 
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getTransferDataFlavors" class="membertitle">getTransferDataFlavors</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="DataFlavor.html">DataFlavor</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getTransferDataFlavors</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns a sequence of supported <a href="DataFlavor.html">DataFlavor</a>.

 </dd>
<dt><b>Returns</b></dt>
<dd>The sequence of supported <a href="DataFlavor.html">DataFlavor</a>.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="DataFlavor.html">DataFlavor</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isDataFlavorSupported" class="membertitle">isDataFlavorSupported</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>isDataFlavorSupported</b>(</td>
<td valign="top">[in] <a href="DataFlavor.html">DataFlavor</a></td>
<td valign="bottom">&nbsp;aFlavor );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Checks if the data object supports the specified data flavor.

 </dd>
<dt><b>Parameter aFlavor</b></dt>
<dd>Describes the format that should be checked

 </dd>
<dt><b>Returns</b></dt>
<dd>A value of <b>true</b> if the <a href="DataFlavor.html">DataFlavor</a> is supported by the transfer source.
 <p>A value of <b>false</b> if the <a href="DataFlavor.html">DataFlavor</a> is unsupported by the transfer source.</p>
 
 <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To
 avoid many calls, the caller should instead use 
 <a href="XTransferable.html">XTransferable</a>::<a href="XTransferable.html#getTransferDataFlavors">getTransferDataFlavors()</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>