#include <dbaexchange.hxx>

Inheritance diagram for svx::OColumnTransferable:

Collaboration diagram for svx::OColumnTransferable:

Public Member Functions
	OColumnTransferable (ColumnTransferFormatFlags nFormats)

void	setDescriptor (const ODataAccessDescriptor &rDescriptor)
	construct the transferable from a data access descriptor More...

	OColumnTransferable (const css::uno::Reference< css::beans::XPropertySet > &_rxForm, const OUString &_rFieldName, const css::uno::Reference< css::beans::XPropertySet > &_rxColumn, const css::uno::Reference< css::sdbc::XConnection > &_rxConnection, ColumnTransferFormatFlags _nFormats)
	construct the transferable from a DatabaseForm component and a field name More...

Public Member Functions inherited from TransferDataContainer
	TransferDataContainer ()

virtual	~TransferDataContainer () override

void	CopyINetBookmark (const INetBookmark &rBkmk)

void	CopyString (const OUString &rStr)

void	CopyString (SotClipboardFormatId nFmt, const OUString &rStr)

void	CopyByteString (SotClipboardFormatId nFormatId, const OString &rStr)

void	CopyAnyData (SotClipboardFormatId nFormatId, const char *pData, sal_uLong nLen)

bool	HasAnyData () const

void	StartDrag (vcl::Window *pWindow, sal_Int8 nDragSourceActions, const Link< sal_Int8, void > &rCallback)

virtual void	DragFinished (sal_Int8 nDropAction) override

void	StartDrag (vcl::Window *pWindow, sal_Int8 nDragSourceActions)

Public Member Functions inherited from TransferableHelper
virtual css::uno::Any SAL_CALL	getTransferData (const css::datatransfer::DataFlavor &rFlavor) override

virtual css::uno::Sequence< css::datatransfer::DataFlavor > SAL_CALL	getTransferDataFlavors () override

virtual sal_Bool SAL_CALL	isDataFlavorSupported (const css::datatransfer::DataFlavor &rFlavor) override

virtual css::uno::Any SAL_CALL	getTransferData2 (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc) override

virtual sal_Bool SAL_CALL	isComplex () override

void	PrepareOLE (const TransferableObjectDescriptor &rObjDesc)

void	CopyToClipboard (const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &rClipboard) const

void	CopyToClipboard (vcl::Window *pWindow) const

void	CopyToPrimarySelection () const

void	StartDrag (vcl::Window *pWindow, sal_Int8 nDragSourceActions)

Static Public Member Functions
static bool	canExtractColumnDescriptor (const DataFlavorExVector &_rFlavors, ColumnTransferFormatFlags _nFormats)
	checks whether or not a column descriptor can be extracted from the data flavor vector given More...

static bool	extractColumnDescriptor (const TransferableDataHelper &_rData, OUString &_rDatasource, OUString &_rDatabaseLocation, OUString &_rConnectionResource, sal_Int32 &_nCommandType, OUString &_rCommand, OUString &_rFieldName)
	extracts a column descriptor from the transferable given More...

static ODataAccessDescriptor	extractColumnDescriptor (const TransferableDataHelper &_rData)
	extracts a column descriptor from the transferable given More...

Static Public Member Functions inherited from TransferableHelper
static void	ClearPrimarySelection ()

Private Member Functions
virtual void	AddSupportedFormats () override

virtual bool	GetData (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc) override

SVX_DLLPRIVATE void	implConstruct (const OUString &_rDatasource, const OUString &_rConnectionResource, const sal_Int32 _nCommandType, const OUString &_rCommand, const OUString &_rFieldName)

Static Private Member Functions
static SotClipboardFormatId	getDescriptorFormatId ()

Private Attributes
ODataAccessDescriptor	m_aDescriptor

OUString	m_sCompatibleFormat

ColumnTransferFormatFlags	m_nFormatFlags

Additional Inherited Members
Protected Member Functions inherited from TransferableHelper
	~TransferableHelper ()

const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &	getOwnClipboard () const

void	implCallOwnLostOwnership (const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &_rxClipboard, const css::uno::Reference< css::datatransfer::XTransferable > &_rxTrans)

void	AddFormat (SotClipboardFormatId nFormat)

void	AddFormat (const css::datatransfer::DataFlavor &rFlavor)

void	RemoveFormat (SotClipboardFormatId nFormat)

void	RemoveFormat (const css::datatransfer::DataFlavor &rFlavor)

bool	HasFormat (SotClipboardFormatId nFormat)

void	ClearFormats ()

bool	SetAny (const css::uno::Any &rAny)

bool	SetString (const OUString &rString)

bool	SetBitmapEx (const BitmapEx &rBitmap, const css::datatransfer::DataFlavor &rFlavor)

bool	SetGDIMetaFile (const GDIMetaFile &rMtf)

bool	SetGraphic (const Graphic &rGraphic)

bool	SetImageMap (const ImageMap &rIMap)

bool	SetTransferableObjectDescriptor (const TransferableObjectDescriptor &rDesc)

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

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

bool	SetObject (void *pUserObject, sal_uInt32 nUserObjectId, const css::datatransfer::DataFlavor &rFlavor)

virtual void	AddSupportedFormats ()=0

virtual bool	GetData (const css::datatransfer::DataFlavor &rFlavor, const OUString &rDestDoc)=0

virtual bool	WriteObject (tools::SvRef< SotTempStream > &rxOStm, void *pUserObject, sal_uInt32 nUserObjectId, const css::datatransfer::DataFlavor &rFlavor)

virtual void	DragFinished (sal_Int8 nDropAction)

virtual void	ObjectReleased ()

void	CopyToSelection (const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &rClipboard) const

Detailed Description

Definition at line 54 of file dbaexchange.hxx.

Constructor & Destructor Documentation

◆ OColumnTransferable() [1/2]

svx::OColumnTransferable::OColumnTransferable ( ColumnTransferFormatFlags nFormats )

Definition at line 46 of file dbaexchange.cxx.

◆ OColumnTransferable() [2/2]

svx::OColumnTransferable::OColumnTransferable	(	const css::uno::Reference< css::beans::XPropertySet > &	_rxForm,
		const OUString &	_rFieldName,
		const css::uno::Reference< css::beans::XPropertySet > &	_rxColumn,
		const css::uno::Reference< css::sdbc::XConnection > &	_rxConnection,
		ColumnTransferFormatFlags	_nFormats
	)

construct the transferable from a DatabaseForm component and a field name

Parameters

_rxForm	the form which is bound to the data source which's field is to be dragged
_rFieldName	the name of the field to be dragged
_rxColumn	the column object. Won't be used if <arg>_nFormats</arg> does not include the CTF_COLUMN_DESCRIPTOR flag. May be <NULL>.
_rxConnection	the connection the column belongs to. Won't be used if <arg>_nFormats</arg> does not include the CTF_COLUMN_DESCRIPTOR flag. May be <NULL>.
_nFormats	supported formats. Must be a combination of the CTF_XXX flags

References GetData.

Member Function Documentation

◆ AddSupportedFormats()

void svx::OColumnTransferable::AddSupportedFormats ( )

overrideprivatevirtual

Reimplemented from TransferDataContainer.

Definition at line 202 of file dbaexchange.cxx.

References TransferableHelper::AddFormat(), COLUMN_DESCRIPTOR, CONTROL_EXCHANGE, FIELD_DESCRIPTOR, getDescriptorFormatId(), and m_nFormatFlags.

◆ canExtractColumnDescriptor()

bool svx::OColumnTransferable::canExtractColumnDescriptor	(	const DataFlavorExVector &	_rFlavors,
		ColumnTransferFormatFlags	_nFormats
	)

static

checks whether or not a column descriptor can be extracted from the data flavor vector given

Parameters

_rFlavors	available flavors
_nFormats	formats to accept

Definition at line 232 of file dbaexchange.cxx.

References COLUMN_DESCRIPTOR, CONTROL_EXCHANGE, FIELD_DESCRIPTOR, and getDescriptorFormatId().

◆ extractColumnDescriptor() [1/2]

ODataAccessDescriptor svx::OColumnTransferable::extractColumnDescriptor ( const TransferableDataHelper & _rData )

static

extracts a column descriptor from the transferable given

Definition at line 247 of file dbaexchange.cxx.

References Any, svx::ColumnName, svx::Command, svx::CommandType, svx::ConnectionResource, svx::DatabaseLocation, svx::DataSource, extractColumnDescriptor(), TransferableDataHelper::GetAny(), getDescriptorFormatId(), SotExchange::GetFormatDataFlavor(), and TransferableDataHelper::HasFormat().

◆ extractColumnDescriptor() [2/2]

bool svx::OColumnTransferable::extractColumnDescriptor	(	const TransferableDataHelper &	_rData,
		OUString &	_rDatasource,
		OUString &	_rDatabaseLocation,
		OUString &	_rConnectionResource,
		sal_Int32 &	_nCommandType,
		OUString &	_rCommand,
		OUString &	_rFieldName
	)

static

extracts a column descriptor from the transferable given

Definition at line 293 of file dbaexchange.cxx.

References svx::ColumnName, svx::Command, svx::CommandType, svx::ConnectionResource, svx::DatabaseLocation, svx::DataSource, extractColumnDescriptor(), getDescriptorFormatId(), TransferableDataHelper::GetString(), o3tl::getToken(), svx::ODataAccessDescriptor::has(), TransferableDataHelper::HasFormat(), o3tl::toInt32(), and u.

Referenced by extractColumnDescriptor().

◆ GetData()

bool svx::OColumnTransferable::GetData	(	const css::datatransfer::DataFlavor &	rFlavor,
		const OUString &	rDestDoc
	)

overrideprivatevirtual

Reimplemented from TransferDataContainer.

Definition at line 215 of file dbaexchange.cxx.

References Any, svx::ODataAccessDescriptor::createPropertyValueSequence(), getDescriptorFormatId(), SotExchange::GetFormat(), m_aDescriptor, m_sCompatibleFormat, TransferableHelper::SetAny(), and TransferableHelper::SetString().

◆ getDescriptorFormatId()

SotClipboardFormatId svx::OColumnTransferable::getDescriptorFormatId ( )

staticprivate

Definition at line 144 of file dbaexchange.cxx.

References SotExchange::RegisterFormatName().

Referenced by AddSupportedFormats(), canExtractColumnDescriptor(), extractColumnDescriptor(), and GetData().

◆ implConstruct()

void svx::OColumnTransferable::implConstruct	(	const OUString &	_rDatasource,
		const OUString &	_rConnectionResource,
		const sal_Int32	_nCommandType,
		const OUString &	_rCommand,
		const OUString &	_rFieldName
	)

private

Definition at line 156 of file dbaexchange.cxx.

References svx::ODataAccessDescriptor::clear(), COLUMN_DESCRIPTOR, svx::ColumnName, svx::Command, svx::CommandType, svx::ConnectionResource, m_aDescriptor, m_nFormatFlags, m_sCompatibleFormat, svx::ODataAccessDescriptor::setDataSource(), and u.

Referenced by setDescriptor().

◆ setDescriptor()

void svx::OColumnTransferable::setDescriptor ( const ODataAccessDescriptor & rDescriptor )

construct the transferable from a data access descriptor

Note that some of the aspects, in particular all which cannot be represented as string, can only be transported via the CTF_COLUMN_DESCRIPTOR format.

Parameters

rDescriptor

The descriptor for the column. It must contain at least

information sufficient to create a connection, that is, either one of DataSource, DatabaseLocation, ConnectionResource, and DataAccessDescriptorProperty::Connection
a Command
a CommandType
a ColumnName or ColumnObject

Definition at line 51 of file dbaexchange.cxx.

References TransferableHelper::ClearFormats(), COLUMN_DESCRIPTOR, svx::ColumnName, svx::ColumnObject, svx::Command, svx::CommandType, svx::Connection, svx::ConnectionResource, svx::DatabaseLocation, svx::DataSource, svx::ODataAccessDescriptor::has(), implConstruct(), m_aDescriptor, and m_nFormatFlags.

Member Data Documentation

◆ m_aDescriptor

ODataAccessDescriptor svx::OColumnTransferable::m_aDescriptor

private

Definition at line 145 of file dbaexchange.hxx.

Referenced by GetData(), implConstruct(), and setDescriptor().

◆ m_nFormatFlags

ColumnTransferFormatFlags svx::OColumnTransferable::m_nFormatFlags

private

Definition at line 147 of file dbaexchange.hxx.

Referenced by AddSupportedFormats(), implConstruct(), and setDescriptor().

◆ m_sCompatibleFormat

OUString svx::OColumnTransferable::m_sCompatibleFormat

private

Definition at line 146 of file dbaexchange.hxx.

Referenced by GetData(), and implConstruct().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OColumnTransferable() [1/2]

◆ OColumnTransferable() [2/2]

Member Function Documentation

◆ AddSupportedFormats()

◆ canExtractColumnDescriptor()

◆ extractColumnDescriptor() [1/2]

◆ extractColumnDescriptor() [2/2]

◆ GetData()

◆ getDescriptorFormatId()

◆ implConstruct()

◆ setDescriptor()

Member Data Documentation

◆ m_aDescriptor

◆ m_nFormatFlags

◆ m_sCompatibleFormat