Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: datatransfer ::

interface XTransferable
Description
Interface to be implemented by objects used to provide data for a data transfer operation.
See also
DataFlavor

Methods' Summary
getTransferData Called by a data consumer to obtain data from the source in a specified format.  
getTransferDataFlavors Returns a sequence of supported DataFlavor.  
isDataFlavorSupported Checks if the data object supports the specified data flavor.  
Methods' Details
getTransferData
any
getTransferData( [in] DataFlavor  aFlavor )
raises( UnsupportedFlavorException,
::com::sun::star::io::IOException );

Description
Called by a data consumer to obtain data from the source in a specified format.
Parameter aFlavor
Describes the requested data format
Returns
The data in the specified DataFlavor.
Throws
com::sun::star::io::IOException if the data is no longer available in the requested flavor.
Throws
com::sun::star::datatransfer::UnsupportedFlavorException if the requested DataFlavor is not supported.
getTransferDataFlavors
sequence< DataFlavor >
getTransferDataFlavors();

Description
Returns a sequence of supported DataFlavor.
Returns
The sequence of supported DataFlavor.
See also
DataFlavor
isDataFlavorSupported
boolean
isDataFlavorSupported( [in] DataFlavor  aFlavor );

Description
Checks if the data object supports the specified data flavor.
Parameter aFlavor
Describes the format that should be checked
Returns
A value of true if the DataFlavor is supported by the transfer source.

A value of false if the DataFlavor is unsupported by the transfer source.



Note: This method is only for analogy with the JAVA Clipboard interface. To avoid many calls, the caller should instead use XTransferable::getTransferDataFlavors().

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.