ISummaryUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ISummaryUtils__
#define __ISummaryUtils__

#include "GenericSettingsID.h"
#include "IPMUnknown.h"
#include "Utils.h"

class IGenericSettings;
class IGenericSettingsGroup;
#include "IGenericSettingsAttribute.h"
#include "IGenericSettingsOutput.h"


class ISummaryUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISUMMARYUTILS };

 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;

 //________________________________________________________________________________________
 // Followings are methods for Building Generic Settings Objects
 //________________________________________________________________________________________
 
 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;

 //________________________________________________________________________________________
 // Higher-level summarization utilties.
 //________________________________________________________________________________________

 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;
};


#endif // __ISummaryUtils__