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

(Global Index)

Syntax

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

Description

Interface to be implemented by objects used to translate a DataFlavor to a system dependent data transfer type and vice versa.

Different platforms use different types to describe data formats available during data exchange operations like clipboard or drag&drop. Windows for instance uses integer values to describe an available clipboard or drag&drop format, Unix X11 uses so called Atoms etc.

Method Summary

getSystemDataTypeFromDataFlavor Converts a DataFlavor to system dependend data type.

getDataFlavorFromSystemDataType Converts a system dependent data type to a DataFlavor .

Known Services Which Export this Interface

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

Method Details



getSystemDataTypeFromDataFlavor

Syntax

any getSystemDataTypeFromDataFlavor (
com::sun::star::datatransfer::DataFlavor aDataFlavor );

Description

Converts a DataFlavor to system dependend data type.

Parameter aDataFlavor

Describes the format for which a system dependent data types is requested.

Returns

A system dependent data transfer type for the given DataFlavor if there is one available.

If the is no system dependent data type for a given DataFlavor the returned any is empty.


getDataFlavorFromSystemDataType

Syntax

com::sun::star::datatransfer::DataFlavor getDataFlavorFromSystemDataType (
any aSysDataType );

Description

Converts a system dependent data type to a DataFlavor .

Parameter aSysDataType

A system dependent data type. If aSysDataType is empty so is the returned DataFlavor .

Returns

A DataFlavor for the given system dependent data transfer type.

If there is no appropriate mapping for a sytem dependent data type, the returned DataFlavor will be empty.

Top of Page