#include <ISummaryUtils.h>

Inheritance diagram for ISummaryUtils:

Public Types
enum	{ kDefaultIID = IID_ISUMMARYUTILS }

Public Member Functions
virtual void	GenerateHumanTextSummary (IGenericSettings *pSettings, PMString &strResult)=0

virtual void	ExportHumanTextSummary (IGenericSettings *pSettings, const PMString &strDefaultFilename, const PMString &strExportDialogTitle, const PMString &strFileType, const PMString &strFileExtension)=0

virtual void	WriteToFile (IGenericSettings pSettings, IGenericSettingsOutputStrategy pStrategy, IDFile &fileTarget)=0

virtual IGenericSettingsAttribute *	AddNumber (IGenericSettingsGroup pGroup, const char pszName, int32 nValue, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddNumber (IGenericSettingsGroup pGroup, const char pszName, const PMReal &nValue, int32 nDigits=-1, bool16 bRound=kFalse, bool16 bEliminateZeros=kFalse, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddNumberUnit (IGenericSettingsGroup pGroup, const char pszName, const PMString &unitString, const PMReal &nValue, int32 nDigits=-1, bool16 bRound=kFalse, bool16 bEliminateZeros=kFalse, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddOnOff (IGenericSettingsGroup pGroup, const char pszName, bool16 bOn, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddYesNo (IGenericSettingsGroup pGroup, const char pszName, bool16 bYes, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddString (IGenericSettingsGroup *pGroup, const PMString &pszName, bool16 bFirst, const PMString &pszStr1, const PMString &pszStr2)=0

virtual IGenericSettingsAttribute *	AddString (IGenericSettingsGroup *pGroup, const PMString &pszName, const PMString &pszValue, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddStringDefault (IGenericSettingsGroup *pGroup, const PMString &pszName, const PMString &strValue, const PMString &pszDefault, bool16 bRelevant=kTrue, bool16 bTranslateNonDefault=kTrue)=0

virtual IGenericSettingsAttribute *	AddRealUnit (IGenericSettingsGroup pGroup, const char pszName, const PMReal &nValue, ClassID nWidgetBoss, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddPercent (IGenericSettingsGroup pGroup, const char pszName, const PMReal &nValue, bool16 bRelevant=kTrue)=0

virtual PMString	ValueToUnitString (ClassID widgetBoss, const PMReal &value)=0

virtual IGenericSettingsAttribute *	AddMarkWeight (IGenericSettingsGroup pGroup, const char pszLabel, const PMReal &nWeight)=0

virtual void	AddBleeds (IGenericSettingsGroup *pGroup, bool16 bSpreads, const PMReal &nTop, const PMReal &nBottom, const PMReal &nLeft, const PMReal &nRight, bool16 bRelevant=kTrue)=0

virtual IGenericSettingsAttribute *	AddFlattenerStyle (IGenericSettingsGroup *pGroup, UID &flattenerStyleUID)=0

virtual int32	QualityFromCompression (int32 nCompression, bool16 bUsingMono=kFalse)=0

virtual int32	TypeFromCompression (int32 nCompression, bool16 bUsingMono=kFalse)=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

A helper interface for use with IGenericSettings.

See Also: also IGenericSettings

Member Function Documentation

virtual void ISummaryUtils::AddBleeds	(	IGenericSettingsGroup *	pGroup,
		bool16	bSpreads,
		const PMReal &	nTop,
		const PMReal &	nBottom,
		const PMReal &	nLeft,
		const PMReal &	nRight,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add summary text for bleeds to the specified group

Parameters

pGroup	specifies the settings group to add number to.
bSpreads	controls the name of the bleeds
nTop	specifies the top bleed amount
nBottom	specifies the bottom bleed amount
nLeft	specifies the left bleed amount
nRight	specifies the right bleed amount
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddFlattenerStyle	(	IGenericSettingsGroup *	pGroup,
		UID &	flattenerStyleUID
	)

pure virtual

Add summary text for the specified flattener style for the settings group.

Parameters

pGroup	specifies the settings group to add number to.
flattenerStyleUID	is the flattener style UID

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddMarkWeight	(	IGenericSettingsGroup *	pGroup,
		const char *	pszLabel,
		const PMReal &	nWeight
	)

pure virtual

Add summary text for the mark weight to the specified settings group

Parameters

pGroup	specifies the settings group to add number to.
pszLabel	specifies the name of the mark weight
nWeight	is the value

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddNumber	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		int32	nValue,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add an integer number specified by nValue to the settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
nValue	specifies the value to add as number.
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddNumber	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		const PMReal &	nValue,
		int32	nDigits = `-1`,
		bool16	bRound = `kFalse`,
		bool16	bEliminateZeros = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a floating-point number specified by nValue to the specified settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
nValue	specifies the floating-point value to add as number.
nDigits	specifies the desired number of digits for format the number.
bRound	if true the nValue is rounded.
bEliminateZeros	if true trailing zeros are eliminated
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddNumberUnit	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		const PMString &	unitString,
		const PMReal &	nValue,
		int32	nDigits = `-1`,
		bool16	bRound = `kFalse`,
		bool16	bEliminateZeros = `kFalse`,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a number specified by nValue with unit to the specified settings group. The unit is specified with unitString and should be translated.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
unitString	is the unit string.
nValue	specifies the floating-point value to add as number.
nDigits	specifies the desired number of digits to format the number.
bRound	if true the nValue is rounded.
bEliminateZeros	if true trailing zeros are eliminated
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddOnOff	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		bool16	bOn,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add "On" or "Off" value to the specified settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
bOn	if true "On" is added otherwise "Off" is added.
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddPercent	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		const PMReal &	nValue,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a percent value to the specified settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
nValue	specifies the percent value.
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddRealUnit	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		const PMReal &	nValue,
		ClassID	nWidgetBoss,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a floating-point value with unit to the specified setting group. Converts units as appropriate.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
nValue
nWidgetBoss
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddString	(	IGenericSettingsGroup *	pGroup,
		const PMString &	pszName,
		bool16	bFirst,
		const PMString &	pszStr1,
		const PMString &	pszStr2
	)

pure virtual

Add a string data to the specified settings group.

Parameters

pGroup	specifies the settings group to add string to.
pszName	specifies the name for this value.
bFirst	if true pszStr1 is used. Otherwise pszStr2 is used.
pszStr1	specifies string 1
pszStr2	specifies string 2

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddString	(	IGenericSettingsGroup *	pGroup,
		const PMString &	pszName,
		const PMString &	pszValue,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add a string data to the specified settings group.

Parameters

pGroup	specifies the settings group to add string to.
pszName	specifies the name for this value.
pszValue	is the string
bTranslate	true if the string should be translated.
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddStringDefault	(	IGenericSettingsGroup *	pGroup,
		const PMString &	pszName,
		const PMString &	strValue,
		const PMString &	pszDefault,
		bool16	bRelevant = `kTrue`,
		bool16	bTranslateNonDefault = `kTrue`
	)

pure virtual

Add a string with default value to the settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
strValue
pszDefault
bRelevant	if true the specified value is used as given. If false, the value is ignored.
bTranslateNonDefault

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual IGenericSettingsAttribute* ISummaryUtils::AddYesNo	(	IGenericSettingsGroup *	pGroup,
		const char *	pszName,
		bool16	bYes,
		bool16	bRelevant = `kTrue`
	)

pure virtual

Add "Yes" or "No" value to the specified settings group.

Parameters

pGroup	specifies the settings group to add number to.
pszName	specifies the name for this value.
bYes	if true "Yes" is added otherwise "No" is added.
bRelevant	if true the specified value is used as given. If false, the value is ignored.

Returns: a interface pointer to IGenericSettingsAttribute that is added to the pGroup for this value.

virtual void ISummaryUtils::ExportHumanTextSummary	(	IGenericSettings *	pSettings,
		const PMString &	strDefaultFilename,
		const PMString &	strExportDialogTitle,
		const PMString &	strFileType,
		const PMString &	strFileExtension
	)

pure virtual

Export the specified settings to a text file.

Parameters

pSettings	specifies the settings from which to generate the summary text for export.
strDefaultFilename	specifies the default filename to use.
strExportDialogTitle	specifies the title for the export dialog.
strFileType	specifies the string representing the default file type.
strFileExtension	specified the file extension string.

virtual void ISummaryUtils::GenerateHumanTextSummary	(	IGenericSettings *	pSettings,
		PMString &	strResult
	)

pure virtual

Generates a human text summary from the specified settings.

Parameters

pSettings	specifies the settings from which to generate the summary text.
strResult	is where the resulting summary text string is returned.

virtual int32 ISummaryUtils::QualityFromCompression	(	int32	nCompression,
		bool16	bUsingMono = `kFalse`
	)

pure virtual

Get Pcompression quality from the specified compression type.

Parameters

nCompression	specifies the type of compression.
bUsingMono	if true monochrome image type is used.

Returns: the compression quality.

virtual int32 ISummaryUtils::TypeFromCompression	(	int32	nCompression,
		bool16	bUsingMono = `kFalse`
	)

pure virtual

Get compression type from the specified compression quality

Parameters

nCompression	is the compression quality
bUsingMono	if true monochrome image type is used

Returns: the compression type.

virtual PMString ISummaryUtils::ValueToUnitString	(	ClassID	widgetBoss,
		const PMReal &	value
	)

pure virtual

Convert from a value to a unit string.

Parameters

widgetBoss	the unit widget class to use for the conversion
value	specifies the value to convert

Returns: a formatted unit string.

virtual void ISummaryUtils::WriteToFile	(	IGenericSettings *	pSettings,
		IGenericSettingsOutputStrategy *	pStrategy,
		IDFile &	fileTarget
	)

pure virtual

Write the settings to a file.

Parameters

pSettings	specifies the settings to write.
pStrategy	the output strategy to use

See Also: also IGenericSettingsOutputStragegy

Parameters

fileTarget specifies a IDFile to write to.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation