Gives UNO access to the global mail merge functionality, via the com.sun.star.text.MailMerge service. More...

#include <unomailmerge.hxx>

Inheritance diagram for SwXMailMerge:

Collaboration diagram for SwXMailMerge:

Public Member Functions
	SwXMailMerge ()

void	LaunchMailMergeEvent (const css::text::MailMergeEvent &rData) const

virtual css::uno::Any SAL_CALL	execute (const css::uno::Sequence< css::beans::NamedValue > &Arguments) override

virtual void SAL_CALL	cancel () override

virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL	getPropertySetInfo () override

virtual void SAL_CALL	setPropertyValue (const OUString &aPropertyName, const css::uno::Any &aValue) override

virtual css::uno::Any SAL_CALL	getPropertyValue (const OUString &PropertyName) override

virtual void SAL_CALL	addPropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override

virtual void SAL_CALL	removePropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) override

virtual void SAL_CALL	addVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override

virtual void SAL_CALL	removeVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override

virtual void SAL_CALL	addMailMergeEventListener (const css::uno::Reference< css::text::XMailMergeListener > &xListener) override

virtual void SAL_CALL	removeMailMergeEventListener (const css::uno::Reference< css::text::XMailMergeListener > &xListener) override

virtual void SAL_CALL	dispose () override

virtual void SAL_CALL	addEventListener (const css::uno::Reference< css::lang::XEventListener > &xListener) override

virtual void SAL_CALL	removeEventListener (const css::uno::Reference< css::lang::XEventListener > &aListener) override

virtual OUString SAL_CALL	getImplementationName () override

virtual sal_Bool SAL_CALL	supportsService (const OUString &ServiceName) override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

Private Member Functions
void	launchEvent (const css::beans::PropertyChangeEvent &rEvt) const

	SwXMailMerge (const SwXMailMerge &)=delete

SwXMailMerge &	operator= (const SwXMailMerge &)=delete

virtual	~SwXMailMerge () override

Private Attributes
comphelper::OInterfaceContainerHelper3< css::lang::XEventListener >	m_aEvtListeners

comphelper::OInterfaceContainerHelper2	m_aMergeListeners

OPropertyListenerContainerHelper	m_aPropListeners

const SfxItemPropertySet *	m_pPropSet

SfxObjectShellRef	m_xDocSh

OUString	m_aTmpFileName

css::uno::Sequence< css::uno::Any >	m_aSelection

css::uno::Reference< css::sdbc::XResultSet >	m_xResultSet

css::uno::Reference< css::sdbc::XConnection >	m_xConnection

css::uno::Reference< css::frame::XModel >	m_xModel

OUString	m_aDataSourceName

OUString	m_aDataCommand

OUString	m_aFilter

OUString	m_aDocumentURL

OUString	m_aOutputURL

OUString	m_aFileNamePrefix

sal_Int32	m_nDataCommandType

sal_Int16	m_nOutputType

bool	m_bEscapeProcessing

bool	m_bSinglePrintJobs

bool	m_bFileNameFromColumn

OUString	m_sInServerPassword

OUString	m_sOutServerPassword

OUString	m_sSubject

OUString	m_sAddressFromColumn

OUString	m_sMailBody

OUString	m_sAttachmentName

OUString	m_sAttachmentFilter

css::uno::Sequence< OUString >	m_aCopiesTo

css::uno::Sequence< OUString >	m_aBlindCopiesTo

bool	m_bSendAsHTML

bool	m_bSendAsAttachment

css::uno::Sequence< css::beans::PropertyValue >	m_aPrintSettings

bool	m_bSaveAsSingleFile

OUString	m_sSaveFilter

OUString	m_sSaveFilterOptions

css::uno::Sequence< css::beans::PropertyValue >	m_aSaveFilterData

bool	m_bDisposing

SwDBManager *	m_pMgr

Friends
class	MailMergeExecuteFinalizer

Detailed Description

Gives UNO access to the global mail merge functionality, via the com.sun.star.text.MailMerge service.

Definition at line 70 of file unomailmerge.hxx.

Constructor & Destructor Documentation

◆ SwXMailMerge() [1/2]

SwXMailMerge::SwXMailMerge ( const SwXMailMerge & )

privatedelete

◆ ~SwXMailMerge()

SwXMailMerge::~SwXMailMerge ( )

overrideprivatevirtual

we still need to close the model and doc shell manually because there is no automatism that will do that later. #120086#

Definition at line 390 of file unomailmerge.cxx.

References CloseModelAndDocSh(), DeleteTmpFile_Impl(), m_aTmpFileName, m_xDocSh, and m_xModel.

◆ SwXMailMerge() [2/2]

SwXMailMerge::SwXMailMerge ( )

Definition at line 364 of file unomailmerge.cxx.

References CommandType, SfxShell::GetViewShell(), SfxViewFrame::LoadHiddenDocument(), m_xDocSh, m_xModel, PRINTER, SFX_INTERFACE_NONE, and TABLE.

Member Function Documentation

◆ addEventListener()

void SAL_CALL SwXMailMerge::addEventListener ( const css::uno::Reference< css::lang::XEventListener > & xListener )

overridevirtual

Definition at line 1121 of file unomailmerge.cxx.

References comphelper::OInterfaceContainerHelper3< class ListenerT >::addInterface(), m_aEvtListeners, and m_bDisposing.

◆ addMailMergeEventListener()

void SAL_CALL SwXMailMerge::addMailMergeEventListener ( const css::uno::Reference< css::text::XMailMergeListener > & xListener )

overridevirtual

Definition at line 1137 of file unomailmerge.cxx.

References comphelper::OInterfaceContainerHelper2::addInterface(), m_aMergeListeners, and m_bDisposing.

◆ addPropertyChangeListener()

void SAL_CALL SwXMailMerge::addPropertyChangeListener	(	const OUString &	aPropertyName,
		const css::uno::Reference< css::beans::XPropertyChangeListener > &	xListener
	)

overridevirtual

Definition at line 1062 of file unomailmerge.cxx.

References comphelper::OMultiTypeInterfaceContainerHelperVar3< class listener, class key, class equalImpl >::addInterface(), SfxItemPropertyMap::getByName(), SfxItemPropertySet::getPropertyMap(), m_aPropListeners, m_bDisposing, m_pPropSet, and SfxItemPropertyMapEntry::nWID.

◆ addVetoableChangeListener()

void SAL_CALL SwXMailMerge::addVetoableChangeListener	(	const OUString &	PropertyName,
		const css::uno::Reference< css::beans::XVetoableChangeListener > &	aListener
	)

overridevirtual

Definition at line 1090 of file unomailmerge.cxx.

◆ cancel()

void SAL_CALL SwXMailMerge::cancel ( )

overridevirtual

cleanup in the execute function.

Definition at line 823 of file unomailmerge.cxx.

References GetMailMergeMutex(), m_pMgr, and SwDBManager::MergeCancel().

◆ dispose()

void SAL_CALL SwXMailMerge::dispose ( void )

overridevirtual

Definition at line 1106 of file unomailmerge.cxx.

References comphelper::OInterfaceContainerHelper2::disposeAndClear(), comphelper::OInterfaceContainerHelper3< class ListenerT >::disposeAndClear(), comphelper::OMultiTypeInterfaceContainerHelperVar3< class listener, class key, class equalImpl >::disposeAndClear(), m_aEvtListeners, m_aMergeListeners, m_aPropListeners, m_bDisposing, and XPropertySet.

◆ execute()

uno::Any SAL_CALL SwXMailMerge::execute ( const css::uno::Sequence< css::beans::NamedValue > & Arguments )

overridevirtual

Definition at line 429 of file unomailmerge.cxx.

◆ getImplementationName()

OUString SAL_CALL SwXMailMerge::getImplementationName ( )

overridevirtual

Definition at line 1153 of file unomailmerge.cxx.

◆ getPropertySetInfo()

uno::Reference< beans::XPropertySetInfo > SAL_CALL SwXMailMerge::getPropertySetInfo ( )

overridevirtual

Definition at line 851 of file unomailmerge.cxx.

References SfxItemPropertySet::getPropertySetInfo(), and m_pPropSet.

◆ getPropertyValue()

uno::Any SAL_CALL SwXMailMerge::getPropertyValue ( const OUString & PropertyName )

overridevirtual

Definition at line 1011 of file unomailmerge.cxx.

References Any, SfxItemPropertyMap::getByName(), SfxItemPropertySet::getPropertyMap(), m_aBlindCopiesTo, m_aCopiesTo, m_aDataCommand, m_aDataSourceName, m_aDocumentURL, m_aFileNamePrefix, m_aFilter, m_aOutputURL, m_aPrintSettings, m_aSaveFilterData, m_aSelection, m_bEscapeProcessing, m_bFileNameFromColumn, m_bSaveAsSingleFile, m_bSendAsAttachment, m_bSendAsHTML, m_bSinglePrintJobs, m_nDataCommandType, m_nOutputType, m_pPropSet, m_sAddressFromColumn, m_sAttachmentFilter, m_sAttachmentName, m_sInServerPassword, m_sMailBody, m_sOutServerPassword, m_sSaveFilter, m_sSaveFilterOptions, m_sSubject, m_xConnection, m_xModel, m_xResultSet, SfxItemPropertyMapEntry::nWID, WID_ADDRESS_FROM_COLUMN, WID_ATTACHMENT_FILTER, WID_ATTACHMENT_NAME, WID_BLIND_COPIES_TO, WID_CONNECTION, WID_COPIES_TO, WID_DATA_COMMAND, WID_DATA_COMMAND_TYPE, WID_DATA_SOURCE_NAME, WID_DOCUMENT_URL, WID_ESCAPE_PROCESSING, WID_FILE_NAME_FROM_COLUMN, WID_FILE_NAME_PREFIX, WID_FILTER, WID_IN_SERVER_PASSWORD, WID_MAIL_BODY, WID_MAIL_SUBJECT, WID_MODEL, WID_OUT_SERVER_PASSWORD, WID_OUTPUT_TYPE, WID_OUTPUT_URL, WID_PRINT_OPTIONS, WID_RESULT_SET, WID_SAVE_AS_SINGLE_FILE, WID_SAVE_FILTER, WID_SAVE_FILTER_DATA, WID_SAVE_FILTER_OPTIONS, WID_SELECTION, WID_SEND_AS_ATTACHMENT, WID_SEND_AS_HTML, and WID_SINGLE_PRINT_JOBS.

◆ getSupportedServiceNames()

uno::Sequence< OUString > SAL_CALL SwXMailMerge::getSupportedServiceNames ( )

overridevirtual

Definition at line 1163 of file unomailmerge.cxx.

◆ launchEvent()

void SwXMailMerge::launchEvent ( const css::beans::PropertyChangeEvent & rEvt ) const

private

Definition at line 841 of file unomailmerge.cxx.

References comphelper::OMultiTypeInterfaceContainerHelperVar3< class listener, class key, class equalImpl >::getContainer(), m_aPropListeners, and comphelper::OInterfaceContainerHelper3< class ListenerT >::notifyEach().

Referenced by setPropertyValue().

◆ LaunchMailMergeEvent()

void SwXMailMerge::LaunchMailMergeEvent ( const css::text::MailMergeEvent & rData ) const

Definition at line 832 of file unomailmerge.cxx.

References comphelper::OInterfaceIteratorHelper2::hasMoreElements(), m_aMergeListeners, and comphelper::OInterfaceIteratorHelper2::next().

◆ operator=()

SwXMailMerge & SwXMailMerge::operator= ( const SwXMailMerge & )

privatedelete

◆ removeEventListener()

void SAL_CALL SwXMailMerge::removeEventListener ( const css::uno::Reference< css::lang::XEventListener > & aListener )

overridevirtual

Definition at line 1129 of file unomailmerge.cxx.

References m_aEvtListeners, m_bDisposing, and comphelper::OInterfaceContainerHelper3< class ListenerT >::removeInterface().

◆ removeMailMergeEventListener()

void SAL_CALL SwXMailMerge::removeMailMergeEventListener ( const css::uno::Reference< css::text::XMailMergeListener > & xListener )

overridevirtual

Definition at line 1145 of file unomailmerge.cxx.

References m_aMergeListeners, m_bDisposing, and comphelper::OInterfaceContainerHelper2::removeInterface().

◆ removePropertyChangeListener()

void SAL_CALL SwXMailMerge::removePropertyChangeListener	(	const OUString &	aPropertyName,
		const css::uno::Reference< css::beans::XPropertyChangeListener > &	aListener
	)

overridevirtual

Definition at line 1076 of file unomailmerge.cxx.

References SfxItemPropertyMap::getByName(), SfxItemPropertySet::getPropertyMap(), m_aPropListeners, m_bDisposing, m_pPropSet, SfxItemPropertyMapEntry::nWID, and comphelper::OMultiTypeInterfaceContainerHelperVar3< class listener, class key, class equalImpl >::removeInterface().

◆ removeVetoableChangeListener()

void SAL_CALL SwXMailMerge::removeVetoableChangeListener	(	const OUString &	PropertyName,
		const css::uno::Reference< css::beans::XVetoableChangeListener > &	aListener
	)