interface XTransferable in module com::sun::star::datatransfer::

(Global Index)

Syntax

interface XTransferable : com::sun::star::uno::XInterface ;

Description

Interface to be implemented by objects used to provide data for a data transfer operation.

See also

DataFlavor

Method 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.

Method Details



getTransferData

Syntax

any getTransferData (
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 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

Syntax

sequence< com::sun::star::datatransfer::DataFlavor > getTransferDataFlavors ();

Description

Returns a sequence of supported DataFlavor .

Returns

The sequence of supported DataFlavor .

See also

DataFlavor

isDataFlavorSupported

Syntax

boolean isDataFlavorSupported (
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 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