TransferableDataHelper Class Reference

#include <transfer.hxx>

Public Member Functions
	TransferableDataHelper ()
	TransferableDataHelper (const TransferableDataHelper &rDataHelper)
	TransferableDataHelper (TransferableDataHelper &&rDataHelper) noexcept
	TransferableDataHelper (const css::uno::Reference< css::datatransfer::XTransferable > &rxTransferable)
	~TransferableDataHelper ()
TransferableDataHelper &	operator= (const TransferableDataHelper &rDataHelper)
TransferableDataHelper &	operator= (TransferableDataHelper &&rDataHelper)
const css::uno::Reference< css::datatransfer::XTransferable > &	GetTransferable () const
css::uno::Reference< css::datatransfer::XTransferable >	GetXTransferable () const
bool	HasFormat (SotClipboardFormatId nFormat) const
bool	HasFormat (const css::datatransfer::DataFlavor &rFlavor) const
sal_uInt32	GetFormatCount () const
SotClipboardFormatId	GetFormat (sal_uInt32 nFormat) const
css::datatransfer::DataFlavor	GetFormatDataFlavor (sal_uInt32 nFormat) const
const DataFlavorExVector &	GetDataFlavorExVector () const
bool	StartClipboardListening ()
void	StopClipboardListening ()
void	Rebind (const css::uno::Reference< css::datatransfer::XTransferable > &_rxNewData)
css::uno::Any	GetAny (SotClipboardFormatId nFormat, const OUString &rDestDoc) const
css::uno::Any	GetAny (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc) const
bool	GetString (SotClipboardFormatId nFormat, OUString &rStr) const
bool	GetString (const css::datatransfer::DataFlavor &rFlavor, OUString &rStr) const
bool	GetBitmapEx (SotClipboardFormatId nFormat, BitmapEx &rBmp) const
bool	GetBitmapEx (const css::datatransfer::DataFlavor &rFlavor, BitmapEx &rBmp) const
bool	GetGDIMetaFile (SotClipboardFormatId nFormat, GDIMetaFile &rMtf, size_t nMaxActions=0) const
	Return as GDI metafile. More...
bool	GetGDIMetaFile (const css::datatransfer::DataFlavor &rFlavor, GDIMetaFile &rMtf) const
bool	GetGraphic (SotClipboardFormatId nFormat, Graphic &rGraphic) const
bool	GetGraphic (const css::datatransfer::DataFlavor &rFlavor, Graphic &rGraphic) const
bool	GetImageMap (SotClipboardFormatId nFormat, ImageMap &rIMap) const
bool	GetImageMap (const css::datatransfer::DataFlavor &rFlavor, ImageMap &rImap) const
bool	GetTransferableObjectDescriptor (SotClipboardFormatId nFormat, TransferableObjectDescriptor &rDesc)
bool	GetTransferableObjectDescriptor (TransferableObjectDescriptor &rDesc)
bool	GetINetBookmark (SotClipboardFormatId nFormat, INetBookmark &rBmk) const
bool	GetINetBookmark (const css::datatransfer::DataFlavor &rFlavor, INetBookmark &rBmk) const
bool	GetINetImage (SotClipboardFormatId nFormat, INetImage &rINtImg) const
bool	GetINetImage (const css::datatransfer::DataFlavor &rFlavor, INetImage &rINtImg) const
bool	GetFileList (SotClipboardFormatId nFormat, FileList &rFileList) const
bool	GetFileList (FileList &rFileList) const
css::uno::Sequence< sal_Int8 >	GetSequence (SotClipboardFormatId nFormat, const OUString &rDestDoc) const
css::uno::Sequence< sal_Int8 >	GetSequence (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc) const
bool	GetSotStorageStream (SotClipboardFormatId nFormat, tools::SvRef< SotTempStream > &rStreamRef) const
bool	GetSotStorageStream (const css::datatransfer::DataFlavor &rFlavor, tools::SvRef< SotTempStream > &rStreamRef) const
css::uno::Reference< css::io::XInputStream >	GetInputStream (SotClipboardFormatId nFormat, const OUString &rDestDoc) const
css::uno::Reference< css::io::XInputStream >	GetInputStream (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc) const

Static Public Member Functions
static void	FillDataFlavorExVector (const css::uno::Sequence< css::datatransfer::DataFlavor > &rDataFlavorSeq, DataFlavorExVector &rDataFlavorExVector)
static TransferableDataHelper	CreateFromClipboard (const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &rClipboard)
static TransferableDataHelper	CreateFromSystemClipboard (vcl::Window *pWindow)
static TransferableDataHelper	CreateFromPrimarySelection ()
static bool	IsEqual (const css::datatransfer::DataFlavor &rInternalFlavor, const css::datatransfer::DataFlavor &rRequestFlavor)

Private Member Functions
void	InitFormats ()

Private Attributes
css::uno::Reference< css::datatransfer::XTransferable >	mxTransfer
css::uno::Reference< css::datatransfer::clipboard::XClipboard >	mxClipboard
DataFlavorExVector	maFormats
std::unique_ptr< TransferableObjectDescriptor >	mxObjDesc
std::unique_ptr< TransferableDataHelper_Impl >	mxImpl

Friends
class	DropTargetHelper

Detailed Description

Definition at line 278 of file transfer.hxx.

Constructor & Destructor Documentation

TransferableDataHelper() [1/4]

TransferableDataHelper::TransferableDataHelper

(

)

Definition at line 1095 of file transfer.cxx.

Referenced by CreateFromClipboard(), and CreateFromPrimarySelection().

TransferableDataHelper() [2/4]

TransferableDataHelper::TransferableDataHelper

(

const TransferableDataHelper &

rDataHelper

)

Definition at line 1109 of file transfer.cxx.

TransferableDataHelper() [3/4]

TransferableDataHelper::TransferableDataHelper ( TransferableDataHelper &&  rDataHelper )

noexcept

Definition at line 1118 of file transfer.cxx.

TransferableDataHelper() [4/4]

TransferableDataHelper::TransferableDataHelper

(

const css::uno::Reference< css::datatransfer::XTransferable > &

rxTransferable

)

~TransferableDataHelper()

TransferableDataHelper::~TransferableDataHelper

(

)

Definition at line 1170 of file transfer.cxx.

References maFormats, mxImpl, mxObjDesc, and StopClipboardListening().

Member Function Documentation

CreateFromClipboard()

TransferableDataHelper TransferableDataHelper::CreateFromClipboard ( const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &  rClipboard )

static

Definition at line 2109 of file transfer.cxx.

References mxClipboard, and TransferableDataHelper().

Referenced by CreateFromSystemClipboard().

CreateFromPrimarySelection()

TransferableDataHelper TransferableDataHelper::CreateFromPrimarySelection ( )

static

Definition at line 2146 of file transfer.cxx.

References GetSystemPrimarySelection(), mxClipboard, and TransferableDataHelper().

CreateFromSystemClipboard()

TransferableDataHelper TransferableDataHelper::CreateFromSystemClipboard ( vcl::Window *  pWindow )

static

Definition at line 2134 of file transfer.cxx.

References CreateFromClipboard(), DBG_ASSERT, and vcl::Window::GetClipboard().

FillDataFlavorExVector()

void TransferableDataHelper::FillDataFlavorExVector ( const css::uno::Sequence< css::datatransfer::DataFlavor > &  rDataFlavorSeq, DataFlavorExVector &  rDataFlavorExVector  )

static

Definition at line 1180 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), DataFlavorEx::mnSotId, SotExchange::RegisterFormat(), and u.

Referenced by DropTargetHelper::ImplBeginDrag(), and InitFormats().

GetAny() [1/2]

css::uno::Any TransferableDataHelper::GetAny	(	const css::datatransfer::DataFlavor &	rFlavor,
		const OUString &	rDestDoc
	)		const

References GetString().

GetAny() [2/2]

Any TransferableDataHelper::GetAny	(	SotClipboardFormatId	nFormat,
		const OUString &	rDestDoc
	)		const

Definition at line 1369 of file transfer.cxx.

References Any, GetAny(), and SotExchange::GetFormatDataFlavor().

Referenced by GetAny().

GetBitmapEx() [1/2]

bool TransferableDataHelper::GetBitmapEx	(	const css::datatransfer::DataFlavor &	rFlavor,
		BitmapEx &	rBmp
	)		const

GetBitmapEx() [2/2]

bool TransferableDataHelper::GetBitmapEx	(	SotClipboardFormatId	nFormat,
		BitmapEx &	rBmp
	)		const

Definition at line 1488 of file transfer.cxx.

References GetBitmapEx(), and SotExchange::GetFormatDataFlavor().

Referenced by GetBitmapEx(), and GetGraphic().

GetDataFlavorExVector()

const DataFlavorExVector & TransferableDataHelper::GetDataFlavorExVector ( ) const

inline

Definition at line 315 of file transfer.hxx.

References DropTargetHelper::maFormats.

GetFileList() [1/2]

bool TransferableDataHelper::GetFileList

(

FileList &

rFileList

)

const

Definition at line 1987 of file transfer.cxx.

References FileList::AppendFile(), ERRCODE_NONE, SvStream::GetError(), GetFormat(), GetFormatCount(), GetFormatDataFlavor(), GetSotStorageStream(), i, and ReadFileList().

GetFileList() [2/2]

bool TransferableDataHelper::GetFileList	(	SotClipboardFormatId	nFormat,
		FileList &	rFileList
	)		const

Definition at line 1979 of file transfer.cxx.

References GetFileList(), and SotExchange::GetFormatDataFlavor().

Referenced by GetFileList().

GetFormat()

SotClipboardFormatId TransferableDataHelper::GetFormat

(

sal_uInt32

nFormat

)

const

Definition at line 1324 of file transfer.cxx.

References DBG_ASSERT, maFormats, and mxImpl.

Referenced by GetFileList().

GetFormatCount()

sal_uInt32 TransferableDataHelper::GetFormatCount

(

)

const

Definition at line 1318 of file transfer.cxx.

References maFormats, and mxImpl.

Referenced by GetFileList().

GetFormatDataFlavor()

DataFlavor TransferableDataHelper::GetFormatDataFlavor

(

sal_uInt32

nFormat

)

const

Definition at line 1331 of file transfer.cxx.

References DBG_ASSERT, maFormats, and mxImpl.

Referenced by GetFileList().

GetGDIMetaFile() [1/2]

bool TransferableDataHelper::GetGDIMetaFile	(	const css::datatransfer::DataFlavor &	rFlavor,
		GDIMetaFile &	rMtf
	)		const

GetGDIMetaFile() [2/2]

bool TransferableDataHelper::GetGDIMetaFile	(	SotClipboardFormatId	nFormat,
		GDIMetaFile &	rMtf,
		size_t	nMaxActions = 0
	)		const

Return as GDI metafile.

Parameters

nMaxAction

Allows you to limit the amount of actions; defaults to 0 which means no limit.

When you eg. Ctrl+a in Excel, you can get the entire sheet as metafile, with over 3 million (!) actions; which is just too large for any reasonable handling - and you need to set a limit.

Definition at line 1620 of file transfer.cxx.

References GDIMetaFile::GetActionSize(), SotExchange::GetFormatDataFlavor(), and GetGDIMetaFile().

Referenced by GetGDIMetaFile(), and GetGraphic().

GetGraphic() [1/2]

bool TransferableDataHelper::GetGraphic	(	const css::datatransfer::DataFlavor &	rFlavor,
		Graphic &	rGraphic
	)		const

Definition at line 1695 of file transfer.cxx.

References ERRCODE_NONE, GetBitmapEx(), SotExchange::GetFormatDataFlavor(), GetGDIMetaFile(), GetSotStorageStream(), GraphicConverter::Import(), IsEqual(), and TypeSerializer::readGraphic().

GetGraphic() [2/2]

bool TransferableDataHelper::GetGraphic	(	SotClipboardFormatId	nFormat,
		Graphic &	rGraphic
	)		const

Definition at line 1674 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetGraphic().

Referenced by GetGraphic().

GetImageMap() [1/2]

bool TransferableDataHelper::GetImageMap	(	const css::datatransfer::DataFlavor &	rFlavor,
		ImageMap &	rImap
	)		const

Definition at line 1773 of file transfer.cxx.

References ERRCODE_NONE, GetSotStorageStream(), and ImageMap::Read().

GetImageMap() [2/2]

bool TransferableDataHelper::GetImageMap	(	SotClipboardFormatId	nFormat,
		ImageMap &	rIMap
	)		const

Definition at line 1766 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetImageMap().

Referenced by GetImageMap().

GetINetBookmark() [1/2]

bool TransferableDataHelper::GetINetBookmark	(	const css::datatransfer::DataFlavor &	rFlavor,
		INetBookmark &	rBmk
	)		const

Definition at line 1809 of file transfer.cxx.

References aSeq, aURL, utl::UcbStreamHelper::CreateStream(), SotExchange::GetFormat(), SotExchange::GetFormatDataFlavor(), GetSequence(), GetString(), HasFormat(), INetURLObject::NONE, SAL_INFO, and u.

GetINetBookmark() [2/2]

bool TransferableDataHelper::GetINetBookmark	(	SotClipboardFormatId	nFormat,
		INetBookmark &	rBmk
	)		const

Definition at line 1802 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetINetBookmark().

Referenced by GetINetBookmark().

GetINetImage() [1/2]

bool TransferableDataHelper::GetINetImage	(	const css::datatransfer::DataFlavor &	rFlavor,
		INetImage &	rINtImg
	)		const

Definition at line 1966 of file transfer.cxx.

References SotExchange::GetFormat(), GetSotStorageStream(), and INetImage::Read().

GetINetImage() [2/2]

bool TransferableDataHelper::GetINetImage	(	SotClipboardFormatId	nFormat,
		INetImage &	rINtImg
	)		const

Definition at line 1958 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetINetImage().

Referenced by GetINetImage().

GetInputStream() [1/2]

css::uno::Reference< css::io::XInputStream > TransferableDataHelper::GetInputStream	(	const css::datatransfer::DataFlavor &	rFlavor,
		const OUString &	rDestDoc
	)		const

GetInputStream() [2/2]

Reference< XInputStream > TransferableDataHelper::GetInputStream	(	SotClipboardFormatId	nFormat,
		const OUString &	rDestDoc
	)		const

Definition at line 2061 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetInputStream().

Referenced by GetInputStream().

GetSequence() [1/2]

css::uno::Sequence< sal_Int8 > TransferableDataHelper::GetSequence	(	const css::datatransfer::DataFlavor &	rFlavor,
		const OUString &	rDestDoc
	)		const

GetSequence() [2/2]

Sequence< sal_Int8 > TransferableDataHelper::GetSequence	(	SotClipboardFormatId	nFormat,
		const OUString &	rDestDoc
	)		const

Definition at line 2020 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetSequence().

Referenced by GetINetBookmark(), and GetSequence().

GetSotStorageStream() [1/2]

bool TransferableDataHelper::GetSotStorageStream	(	const css::datatransfer::DataFlavor &	rFlavor,
		tools::SvRef< SotTempStream > &	rStreamRef
	)		const

GetSotStorageStream() [2/2]

bool TransferableDataHelper::GetSotStorageStream	(	SotClipboardFormatId	nFormat,
		tools::SvRef< SotTempStream > &	rStreamRef
	)		const

Definition at line 2040 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetSotStorageStream().

Referenced by GetFileList(), GetGraphic(), GetImageMap(), GetINetImage(), and GetSotStorageStream().

GetString() [1/2]

bool TransferableDataHelper::GetString	(	const css::datatransfer::DataFlavor &	rFlavor,
		OUString &	rStr
	)		const

GetString() [2/2]

bool TransferableDataHelper::GetString	(	SotClipboardFormatId	nFormat,
		OUString &	rStr
	)		const

Definition at line 1446 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetString().

Referenced by GetINetBookmark(), and GetString().

GetTransferable()

const css::uno::Reference< css::datatransfer::XTransferable > & TransferableDataHelper::GetTransferable ( ) const

inline

Definition at line 304 of file transfer.hxx.

GetTransferableObjectDescriptor() [1/2]

bool TransferableDataHelper::GetTransferableObjectDescriptor	(	SotClipboardFormatId	nFormat,
		TransferableObjectDescriptor &	rDesc
	)

Definition at line 1788 of file transfer.cxx.

References SotExchange::GetFormatDataFlavor(), and GetTransferableObjectDescriptor().

Referenced by GetTransferableObjectDescriptor().

GetTransferableObjectDescriptor() [2/2]

bool TransferableDataHelper::GetTransferableObjectDescriptor

(

TransferableObjectDescriptor &

rDesc

)

Definition at line 1795 of file transfer.cxx.

References mxObjDesc.

GetXTransferable()

Reference< XTransferable > TransferableDataHelper::GetXTransferable

(

)

const

Definition at line 1345 of file transfer.cxx.

References mxTransfer.

HasFormat() [1/2]

bool TransferableDataHelper::HasFormat

(

const css::datatransfer::DataFlavor &

rFlavor

)

const

References GetFormat().

HasFormat() [2/2]

bool TransferableDataHelper::HasFormat

(

SotClipboardFormatId

nFormat

)

const

Definition at line 1299 of file transfer.cxx.

References maFormats, and mxImpl.

Referenced by GetINetBookmark().

InitFormats()

void TransferableDataHelper::InitFormats ( )

private

Definition at line 1275 of file transfer.cxx.

References FillDataFlavorExVector(), ImplSetParameterString(), maFormats, mxImpl, mxObjDesc, and mxTransfer.

Referenced by Rebind().

IsEqual()

bool TransferableDataHelper::IsEqual ( const css::datatransfer::DataFlavor &  rInternalFlavor, const css::datatransfer::DataFlavor &  rRequestFlavor  )

static

Definition at line 2173 of file transfer.cxx.

References u.

Referenced by GetGraphic(), TransferableHelper::getTransferData2(), and TransferableHelper::isDataFlavorSupported().

operator=() [1/2]

TransferableDataHelper & TransferableDataHelper::operator=

(

const TransferableDataHelper &

rDataHelper

)

Definition at line 1127 of file transfer.cxx.

References maFormats, mxClipboard, mxImpl, mxObjDesc, mxTransfer, StartClipboardListening(), and StopClipboardListening().

operator=() [2/2]

TransferableDataHelper & TransferableDataHelper::operator=

(

TransferableDataHelper &&

rDataHelper

)

Definition at line 1150 of file transfer.cxx.

References maFormats, mxClipboard, mxImpl, mxObjDesc, mxTransfer, StartClipboardListening(), and StopClipboardListening().

Rebind()

void TransferableDataHelper::Rebind

(

const css::uno::Reference< css::datatransfer::XTransferable > &

_rxNewData

)

Definition at line 2081 of file transfer.cxx.

References InitFormats(), and mxTransfer.

StartClipboardListening()

bool TransferableDataHelper::StartClipboardListening

(

)

Definition at line 2087 of file transfer.cxx.

References mxClipboard, mxImpl, and StopClipboardListening().

Referenced by operator=().

StopClipboardListening()

void TransferableDataHelper::StopClipboardListening

(

)

Definition at line 2098 of file transfer.cxx.

References mxImpl.

Referenced by operator=(), StartClipboardListening(), and ~TransferableDataHelper().

Friends And Related Function Documentation

DropTargetHelper

friend class DropTargetHelper

friend

Definition at line 280 of file transfer.hxx.

Member Data Documentation

maFormats

DataFlavorExVector TransferableDataHelper::maFormats

private

Definition at line 284 of file transfer.hxx.

Referenced by GetFormat(), GetFormatCount(), GetFormatDataFlavor(), HasFormat(), InitFormats(), operator=(), and ~TransferableDataHelper().

mxClipboard

css::uno::Reference< css::datatransfer::clipboard::XClipboard > TransferableDataHelper::mxClipboard

private

Definition at line 283 of file transfer.hxx.

Referenced by CreateFromClipboard(), CreateFromPrimarySelection(), operator=(), and StartClipboardListening().

mxImpl

std::unique_ptr<TransferableDataHelper_Impl> TransferableDataHelper::mxImpl

private

Definition at line 286 of file transfer.hxx.

Referenced by GetFormat(), GetFormatCount(), GetFormatDataFlavor(), HasFormat(), InitFormats(), operator=(), StartClipboardListening(), StopClipboardListening(), and ~TransferableDataHelper().

mxObjDesc

std::unique_ptr<TransferableObjectDescriptor> TransferableDataHelper::mxObjDesc

private

Definition at line 285 of file transfer.hxx.

Referenced by GetTransferableObjectDescriptor(), InitFormats(), operator=(), and ~TransferableDataHelper().

mxTransfer

css::uno::Reference< css::datatransfer::XTransferable > TransferableDataHelper::mxTransfer

private

Definition at line 282 of file transfer.hxx.

Referenced by GetXTransferable(), InitFormats(), operator=(), and Rebind().

---

The documentation for this class was generated from the following files:

• transfer.hxx
• transfer.cxx