#include <ie_mailmerge.h>

Inheritance diagram for IE_MailMerge:

Classes
class	IE_MailMerge_Listener
Public Member Functions
virtual	~IE_MailMerge ()
virtual UT_Error	mergeFile (const char *szFilename)=0
virtual UT_Error	getHeaders (const char *szFilename, UT_Vector &out_vec)=0
void	setListener (IE_MailMerge_Listener *listener)
const UT_GenericStringMap < UT_UTF8String * > &	getCurrentMapping () const
Static Public Member Functions
static IEMergeType	fileTypeForContents (const char *szBuf, UT_uint32 iNumbytes)
static IEMergeType	fileTypeForSuffix (const char *szSuffix)
static IEMergeType	fileTypeForDescription (const char *szSuffix)
static IEMergeType	fileTypeForSuffixes (const char *suffixList)
static IE_MergeSniffer *	snifferForFileType (IEMergeType ieft)
static const char *	suffixesForFileType (IEMergeType ieft)
static const char *	descriptionForFileType (IEMergeType ieft)
static UT_Error	constructMerger (const char szFilename, IEMergeType ieft, IE_MailMerge ppie, IEMergeType pieft=NULL)
static bool	enumerateDlgLabels (UT_uint32 ndx, const char pszDesc, const char pszSuffixList, IEMergeType *ft)
static UT_uint32	getMergerCount (void)
static void	registerMerger (IE_MergeSniffer *sniffer)
static void	unregisterMerger (IE_MergeSniffer *sniffer)
static void	unregisterAllMergers ()
Protected Member Functions
	IE_MailMerge ()
bool	fireMergeSet ()
void	addMergePair (const UT_UTF8String &key, const UT_UTF8String &value)
Private Attributes
IE_MailMerge_Listener *	m_pListener
UT_GenericStringMap < UT_UTF8String * >	m_map

Constructor & Destructor Documentation

IE_MailMerge::~IE_MailMerge ( ) [virtual]

IE_MailMerge::IE_MailMerge ( ) [protected]

Member Function Documentation

void IE_MailMerge::addMergePair	(	const UT_UTF8String &	key,
		const UT_UTF8String &	value
	)			`[protected]`

References m_map, UT_GenericStringMap< T >::set(), and UT_UTF8String::utf8_str().

Referenced by IE_MailMerge_XML_Listener::endElement(), and IE_MailMerge_Delimiter_Listener::fire().

UT_Error IE_MailMerge::constructMerger	(	const char *	szFilename,
		IEMergeType	ieft,
		IE_MailMerge **	ppie,
		IEMergeType *	pieft = `NULL`
	)			`[static]`

const char * IE_MailMerge::descriptionForFileType ( IEMergeType ieft ) [static]

References IE_MergeSniffer::getDlgLabels(), snifferForFileType(), UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

bool IE_MailMerge::enumerateDlgLabels	(	UT_uint32	ndx,
		const char **	pszDesc,
		const char **	pszSuffixList,
		IEMergeType *	ft
	)			`[static]`

References IE_MergeSniffer::getDlgLabels(), getMergerCount(), m_sniffers, and s.

Referenced by Defun1(), AP_Dialog_MailMerge::eventOpen(), and AP_CocoaPlugin_Document::selectMailMergeSource.

IEMergeType IE_MailMerge::fileTypeForContents	(	const char *	szBuf,
		UT_uint32	iNumbytes
	)			`[static]`

References getMergerCount(), IEMT_Unknown, m_sniffers, IE_MergeSniffer::recognizeContents(), s, IE_MergeSniffer::supportsFileType(), and UT_CONFIDENCE_PERFECT.

IEMergeType IE_MailMerge::fileTypeForDescription ( const char * szSuffix ) [static]

References IE_MergeSniffer::getDlgLabels(), getMergerCount(), m_sniffers, UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

IEMergeType IE_MailMerge::fileTypeForSuffix ( const char * szSuffix ) [static]

References getMergerCount(), IEMT_Unknown, m_sniffers, IE_MergeSniffer::recognizeSuffix(), s, IE_MergeSniffer::supportsFileType(), and UT_CONFIDENCE_PERFECT.

Referenced by Defun1(), AP_Dialog_MailMerge::eventOpen(), fileTypeForSuffixes(), and AP_CocoaPlugin_Document::selectMailMergeSource.

IEMergeType IE_MailMerge::fileTypeForSuffixes ( const char * suffixList ) [static]

References UT_String::c_str(), fileTypeForSuffix(), IEMT_Unknown, UT_String::substr(), and UT_DEBUGMSG.

bool IE_MailMerge::fireMergeSet ( ) [protected]

References IE_MailMerge::IE_MailMerge_Listener::fireUpdate(), IE_MailMerge::IE_MailMerge_Listener::getMergeDocument(), m_map, m_pListener, UT_GenericStringMap< T >::purgeData(), and PD_Document::setMailMergeField().

Referenced by IE_MailMerge_XML_Listener::endElement(), and IE_MailMerge_Delimiter_Listener::fire().

const UT_GenericStringMap<UT_UTF8String *>& IE_MailMerge::getCurrentMapping ( ) const [inline]

Referenced by XAP_Cocoa_MailMerge_Listener::fireUpdate().

virtual UT_Error IE_MailMerge::getHeaders	(	const char *	szFilename,
		UT_Vector &	out_vec
	)			`[pure virtual]`

Implemented in IE_MailMerge_Delimiter_Listener.

Referenced by AP_Dialog_MailMerge::eventOpen(), AP_CocoaPlugin_Document::importMailMergeSource:, and AP_Dialog_MailMerge::init().

UT_uint32 IE_MailMerge::getMergerCount ( void ) [static]

References m_sniffers.

Referenced by constructMerger(), Defun1(), Defun_EV_GetMenuItemState_Fn(), enumerateDlgLabels(), AP_Dialog_MailMerge::eventOpen(), fileTypeForContents(), fileTypeForDescription(), fileTypeForSuffix(), AP_CocoaPlugin_Document::selectMailMergeSource, and snifferForFileType().

virtual UT_Error IE_MailMerge::mergeFile ( const char * szFilename ) [pure virtual]

Implemented in IE_MailMerge_Delimiter_Listener.

Referenced by Defun1(), IE_MailMerge_Delimiter_Listener::getHeaders(), handleMerge(), AP_CocoaPlugin_Document::importMailMergeSource:, and IE_MailMerge_Delimiter_Listener::mergeFile().

void IE_MailMerge::registerMerger ( IE_MergeSniffer * sniffer ) [static]

References m_sniffers, IE_MergeSniffer::setFileType(), UT_OK, and UT_return_if_fail.

Referenced by IE_MailMerge_RegisterXP().

void IE_MailMerge::setListener ( IE_MailMerge_Listener * listener )

References m_pListener.

Referenced by Defun1(), handleMerge(), and AP_CocoaPlugin_Document::importMailMergeSource:.

IE_MergeSniffer * IE_MailMerge::snifferForFileType ( IEMergeType ieft ) [static]

References getMergerCount(), m_sniffers, s, and IE_MergeSniffer::supportsFileType().

Referenced by descriptionForFileType(), and suffixesForFileType().

const char * IE_MailMerge::suffixesForFileType ( IEMergeType ieft ) [static]

References IE_MergeSniffer::getDlgLabels(), snifferForFileType(), UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

void IE_MailMerge::unregisterAllMergers ( ) [static]

References DELETEP, m_sniffers, and size.

Referenced by IE_MailMerge_UnRegisterXP().

void IE_MailMerge::unregisterMerger ( IE_MergeSniffer * sniffer ) [static]

References IE_MergeSniffer::getFileType(), m_sniffers, IE_MergeSniffer::setFileType(), size, and UT_return_if_fail.

Member Data Documentation

UT_GenericStringMap<UT_UTF8String *> IE_MailMerge::m_map [private]

Referenced by addMergePair(), and fireMergeSet().

IE_MailMerge_Listener* IE_MailMerge::m_pListener [private]

Referenced by fireMergeSet(), and setListener().

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

IE_MailMerge Class Reference

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation