LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XTransferable2 Interface Reference

import"XTransferable2.idl";

Inheritance diagram for XTransferable2:
XTransferable XInterface

Public Member Functions

any getTransferData2 ([in] DataFlavor aFlavor, [in] string aDestShellID) raises ( UnsupportedFlavorException, com::sun::star::io::IOException )
 This is equivalent of getTransferData of XTransferable, but takes an additional parameter that specifies the destination document type. More...
 
boolean isComplex ()
 Returns true if the selection contains embedded objects or is a large text blob. More...
 
- Public Member Functions inherited from XTransferable
any getTransferData ([in] DataFlavor aFlavor) raises ( UnsupportedFlavorException, com::sun::star::io::IOException )
 Called by a data consumer to obtain data from the source in a specified format. More...
 
sequence< DataFlavorgetTransferDataFlavors ()
 Returns a sequence of supported DataFlavor. More...
 
boolean isDataFlavorSupported ([in] DataFlavor aFlavor)
 Checks if the data object supports the specified data flavor. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Member Function Documentation

◆ getTransferData2()

any getTransferData2 ( [in] DataFlavor  aFlavor,
[in] string  aDestShellID 
)
raises ( UnsupportedFlavorException,
com::sun::star::io::IOException
)

This is equivalent of getTransferData of XTransferable, but takes an additional parameter that specifies the destination document type.

Parameters
aFlavorrequested data format
aDestShellIDdestination document shell ID. The ID of each individual shell must be unique.
Returns
data in specified data format.
Exceptions
com::sun::star::io::IOExceptionif the data is no longer available in the requested flavor.
com::sun::star::datatransfer::UnsupportedFlavorExceptionif the requested DataFlavor is not supported.

◆ isComplex()

boolean isComplex ( )

Returns true if the selection contains embedded objects or is a large text blob.

Since
LibreOffice 6.4

The documentation for this interface was generated from the following file: