ICMSUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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 __ICMSUtils__
#define __ICMSUtils__

#include "ColorMgmtID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "ICMSManager.h" // for ICMSManager::CMSPolicy
#include "ICMSSettings.h"
#include "ICMSProofing.h"

#include "ScriptData.h"

// Flags for command wrappers (cmdFlags):

const uint32 kCMSCmdAutoUndo = (1L<<1);

// Flags for Query operations (cmsQueryFlags):

const int32 kCMSQueryNoAutoCreate = (1L<<0);

class ICMSProfileList;
class IColorPresetsSettings;
class ICommand;
class IScriptRequestData;
class UIDList;


class ICMSUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICMSUTILS };

 virtual ICMSProfileList *QueryCMSProfileList(IDocument *doc, uint32 cmsQueryFlags = 0) = 0;
 
 virtual ICMSProfileList *QueryCMSProfileList(const UIDRef& docRef, uint32 cmsQueryFlags = 0) = 0; 

 virtual ICMSManager *QueryCMSManager(ClassID whichCMSMgr = kInvalidClass, uint32 cmsQueryFlags = 0) = 0;
 
 virtual IColorPresetsSettings *QueryColorPresetsSettings() = 0;
 
 virtual bool16 IsEmulating1xCMSOffState() = 0;
 
 virtual ICMSSettings *QueryCMSSettings
 (
 IDocument *doc, 
 uint32 cmsQueryFlags = 0
 ) = 0;

 virtual ICMSSettings *QueryCMSSettings
 (
 const UIDRef& docRef, 
 uint32 cmsQueryFlags = 0
 ) = 0;

 virtual ICMSSettings *QueryDefaultObjectSettings
 (
 IDocument *doc, 
 uint32 cmsQueryFlags = 0
 ) = 0;

 virtual ICMSSettings *QueryDefaultObjectSettings
 (
 const UIDRef& docRef, 
 uint32 cmsQueryFlags = 0
 ) = 0;
 
 virtual bool16 DoTurnCMSOnOrOff
 (
 bool16 turnItOn, 
 const UIDList& itemlist, 
 uint32 cmdFlags = 0, 
 ClassID cmsMgrID = kInvalidClass 
 ) = 0;

 virtual bool16 DoCMMChoice
 (
 const PMString& cmmChoice, 
 IDocument *doc, 
 uint32 cmdFlags = 0, 
 ClassID cmsMgrID = kInvalidClass
 ) = 0;

 virtual bool16 DoDocUseProfileCmd
 ( 
 const PMString& profileName, 
 IDocument *doc, 
 ICMSProfile::profileCategory which,
 uint32 cmdFlags = 0,
 ClassID cmsMgrID = kInvalidClass,
 bool16 installDefaultFlag = kFalse
 ) = 0; 

 virtual bool16 DoItemUseExternalProfileCmd
 (
 const UIDRef& itemUIDRef,
 const PMString& profileName,
 uint32 cmdFlags = 0,
 ClassID cmsMgrID = kInvalidClass
 ) = 0;
 
 virtual bool16 DoItemUseEmbeddedProfileCmd
 (
 const UIDRef& itemUIDRef,
 void *pProfileData = nil,
 int32 dataSize = 0,
 PMString *pName = nil,
 uint32 cmdFlags = 0,
 ClassID cmsMgrID = kInvalidClass
 ) = 0;
 
 virtual bool16 DoItemUseDocDefaultProfileCmd
 (
 const UIDRef& itemUIDRef,
 uint32 cmdFlags = 0,
 ClassID cmsMgrID = kInvalidClass
 ) = 0;
 
 virtual bool16 DoesProfileExist
 (
 const PMString& profileName,
 IDataBase *db, 
 ClassID cmsMgrID = kInvalidClass
 ) = 0;
 
 virtual bool16 DoSetRenderingIntent
 (
 const UIDRef& itemRef, 
 ICMSSettings::renderingIntent choice, 
 uint32 cmdFlags = 0
 ) = 0;
 
 virtual bool16 DoSetRenderingIntent
 (
 const UIDList& itemList, 
 ICMSSettings::renderingIntent choice, 
 uint32 cmdFlags = 0
 ) = 0;
 
 virtual bool16 DoCopyCMSSettingsCmd
 (
 UIDRef srcItem, 
 UIDRef dstItem, 
 uint32 cmdFlags = 0, 
 ClassID cmsMgrID = kInvalidClass
 ) = 0;

 virtual bool16 DoRemoveCMSSetup
 (
 UIDRef theItem, 
 uint32 cmdFlags = 0, 
 ClassID cmsMgrID = kInvalidClass
 ) = 0;

 virtual bool16 ColorXFormChange
 (
 IDataBase* iDataBase,
 ICommand *cmdChangedBy,
 int32 changeFlags
 ) = 0;
 
 virtual bool16 DoColorPresetsSettingsSetCmd(bool16 emulate1xCMSOff, 
 bool16 isCustom, 
 const PMString &presetName, 
 const PMString &presetPath, 
 const PMString &description, 
 ICMSProfile *workingRGB, 
 const PMString &workingRGBName,
 ICMSProfile::profileCode workingRGBCode,
 ICMSProfile *workingCMYK, 
 const PMString &workingCMYKName,
 ICMSProfile::profileCode workingCMYKCode,
 ICMSManager::CMSPolicy policyRGB, 
 ICMSManager::CMSPolicy policyCMYK, 
 bool16 mismatchAskOpening, 
 bool16 mismatchAskPasting, 
 bool16 missingAskOpening, 
 uint32 engineCMS, 
 uint32 engineCMM, 
 ICMSSettings::renderingIntent intent, 
 bool16 kpc,
 int32 nFlags = 0) = 0;
 
 virtual ErrorCode DoCMSSetProofingCmd
 (
 ICMSProofing *iCMSProofing, 
 bool16 isProofingOn, 
 ICMSProofing::ProofingType proofingType, 
 ICMSProfile *iCMSProfile, 
 bool32 paperWhite, 
 bool32 inkBlack, 
 bool32 preserveNumbers = kTrue
 ) = 0;
 
 virtual ErrorCode DoCMSSetProofingCmd
 (
 ICMSProofing *iCMSProofing, 
 bool16 isProofingOn, 
 ICMSProofing::ProofingType proofingType, 
 PMString &name, 
 bool32 paperWhite, 
 bool32 inkBlack, 
 bool32 preserveNumbers = kTrue
 ) = 0;
 
 virtual ErrorCode DoConvertToProfileCmd
 (
 IDocument *doc, 
 ICMSProfile::profileCategory category, 
 const PMString &name, 
 uint32 engineCMS = 0, 
 uint32 engineCMM = 0, 
 ICMSSettings::renderingIntent intent = ICMSSettings::kImage, 
 bool16 useKPC = kTrue
 ) = 0;

 virtual ICMSSettings::renderingIntent ResolveIntent
 (
 IDocument* iDoc, 
 ICMSSettings::renderingIntent ri
 ) = 0; 
 
#ifdef DEBUG
 virtual void DumpCMSManager(IDocument* document) = 0;
#endif

 virtual bool32 BuildScriptableProfileArray
 (
 CMSAvailableProfileList* plistSource, 
 ScriptListData& plistTarget
 ) = 0;

 virtual bool32 SetupImageFilter
 (
 UIDRef uidImage, 
 CMSMgrProfileFilter& filter
 ) = 0;

 virtual ICMSSettings::renderingIntent ScriptIntentToCMSIntent
 (
 IDocument* pDoc, 
 ScriptID nScriptIntent, 
 ICMSSettings::renderingIntent nIntentType, 
 ErrorCode& nError
 ) = 0;
 
 virtual ScriptID CMSIntentToScriptIntent(ICMSSettings::renderingIntent nCMSIntent) = 0; 

 virtual int32 AccessCMSProfileList
 (
 IScriptRequestData*data, 
 IScript*script, 
 ICMSProfile::profileCategory profileCategory,
 ScriptID propID
 ) = 0;

 virtual int32 AccessCMSProfile
 (
 IDocument* pDoc, 
 IScriptRequestData*data, 
 IScript*script, 
 ICMSProfile::profileCategory nProfileType, 
 ScriptID propID
 ) = 0;

 virtual bool16 CanFindProfile( const PMString& strName ) = 0;

 virtual void GetProfileProofingSupport
 ( 
 const PMString& strName, 
 bool16& bSupportsInkBlack, 
 bool16& bSupportsPaperWhite 
 ) = 0;

 virtual void CopyColorProfiles
 (
 IDataBase* pSrc,
 IDataBase* pDst 
 ) = 0;

};


#endif // __ICMSUtils__