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

interface XTransferable
Base Interfaces
::com::sun::star::uno::XInterface
  |  
  +--XTransferable
::com::sun::star::uno::XInterface
(referenced interface's summary:)
base interface of all UNO interfaces
Description
Interface to be implemented by objects used to provide data for a data transfer operation.
See also
::com::sun::star::datatransfer::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 ::com::sun::star::datatransfer::DataFlavor .  
isDataFlavorSupported Checks if the data object supports the specified data flavor.  
Methods' Details
getTransferData
any
getTransferData( [in] ::com::sun::star::datatransfer::DataFlavor  aFlavor )
raises( ::com::sun::star::datatransfer::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 ::com::sun::star::datatransfer::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 ::com::sun::star::datatransfer::DataFlavor is not supported.
getTransferDataFlavors
sequence< ::com::sun::star::datatransfer::DataFlavor >
getTransferDataFlavors();

Description
Returns a sequence of supported ::com::sun::star::datatransfer::DataFlavor .
Returns
The sequence of supported ::com::sun::star::datatransfer::DataFlavor .
See also
::com::sun::star::datatransfer::DataFlavor
isDataFlavorSupported
boolean
isDataFlavorSupported( [in] ::com::sun::star::datatransfer::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 ::com::sun::star::datatransfer::DataFlavor is supported by the transfer source.

A value of false if the ::com::sun::star::datatransfer::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 ::com::sun::star::datatransfer::XTransferable::getTransferDataFlavors() .

Top of Page