#include <ICustomDataSummaryProvider.h>

Inheritance diagram for ICustomDataSummaryProvider:

Public Types
enum	{ kDefaultIID = IID_ICUSTOMDATASUMMARYPROVIDER }

Public Member Functions
virtual void	ConvertToSummary (IGenericSettingsGroup pRootGroup, const IPrintData pData, const IDocument *pDoc, bool16 bWorkingOnStyle) const =0

virtual void	ConvertToSummary (IGenericSettingsGroup pRootGroup, const IPDFExportPrefs pData, const IPDFSecurityPrefs pSecurity, const IDocument pDoc, bool16 bIncludeDescriptionAndWarning) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Provider interface for allowing third parties a chance to add their own custom settings to the Print and PDF summaries, if desired. The providers will be called when the summary is generated. Their summary information is appended to the end.

Third parties can call pRootGroup->AddGroup() to add their sub class of data. From there, they can use APIs in ISummaryUtils to add each of their settings individually, passing in the IGenericSettingsGroup returned from AddGroup().

Example code: { int32 myNumberValue = 52; Utils<ISummaryUtils> utilSummary; InterfacePtr<IGenericSettingsGroup> pMyGroup(pRootGroup->AddGroup("kMyGroupName", ""), UseDefaultIID()); utilSummary->AddNumber(pMyGroup, "kMyNumberLabel", myNumberValue); }

See Also: IGenericSettingsGroup; ISummaryUtils

Member Function Documentation

virtual void ICustomDataSummaryProvider::ConvertToSummary	(	IGenericSettingsGroup *	pRootGroup,
		const IPrintData *	pData,
		const IDocument *	pDoc,
		bool16	bWorkingOnStyle
	)		const

pure virtual

Append third party custom Print data to the summary.

Parameters

pRootGroup	IN the IGenericSettingsGroup interface to add your group to.
pData	IN the IPrintData interface being used.
pDoc	IN the IDocument interface of the pub. If working on a style, pointer will be nil!
bWorkingOnStyle	IN kTrue if working on a Print Preset, kFalse otherwise.

virtual void ICustomDataSummaryProvider::ConvertToSummary	(	IGenericSettingsGroup *	pRootGroup,
		const IPDFExportPrefs *	pData,
		const IPDFSecurityPrefs *	pSecurity,
		const IDocument *	pDoc,
		bool16	bIncludeDescriptionAndWarning
	)		const

pure virtual

Append third party custom PDF data to the summary.

Parameters

pRootGroup	IN the IGenericSettingsGroup interface to add your data to.
pData	IN the IPDFExportPrefs interface being used.
pSecurity	IN the IPDFSecurityPrefs interface being used - this pointer may be nil!
pDoc	IN the IDocument interface of the pub. If working on a style, pointer will be nil!
bIncludeDescriptionAndWarning	IN kTrue if warning text to be included, kFalse otherwise.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation