IPreflightFacade.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.
// 
//========================================================================================


#include "IPreflightOptions.h"
#include "IPreflightRuleInfo.h"
#include "IPreflightRuleData.h"

#include "PackageAndPreflightID.h"
#include "Utils.h"

class IPreflightProfile;
class IPreflightBookOptions;

namespace Facade
{
 class IPreflightFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IPREFLIGHTFACADE };

 virtual void TurnOnPreflighting (IDataBase* iTargetDB) = 0;
 virtual void TurnOffPreflighting (IDataBase* iTargetDB) = 0;

 virtual bool16 IsPreflightingOn (IDataBase* iTargetDB) const = 0;

 virtual void SetEmbedProfileInNewDocuments (bool16 autoEmbed) = 0;
 virtual bool16 GetEmbedProfileInNewDocuments (void) const = 0;

 virtual void SetOpenDocumentPolicy (IPreflightOptions::PreflightProfilePolicy& profilePolicy) = 0;
 virtual IPreflightOptions::PreflightProfilePolicy GetOpenDocumentPolicy (void) const = 0;


 virtual void SetIncludeLayers (IDataBase* iTargetDB, const IPreflightOptions::LayerOptions whichLayer) = 0;
 virtual IPreflightOptions::LayerOptions GetIncludeLayers (IDataBase* iTargetDB) const = 0;

 virtual void SetIncludeObjectsOnPasteboard (IDataBase* iTargetDB, const bool16 onOff) = 0;
 virtual bool16 GetIncludeObjectsOnPasteboard (IDataBase*) const = 0;

 virtual void SetIncludeNonPrintingObjects (IDataBase*, const bool16 onOff) = 0;
 virtual bool16 GetIncludeNonPrintingObjects (IDataBase*) const = 0;

 virtual void SetPreflightScope
 (
 IDataBase* iTargetDB, 
 const IPreflightOptions::PreflightScope& scope, 
 PMString* pPageRange = nil
 ) = 0;

 virtual IPreflightOptions::PreflightScope GetPreflightScope (IDataBase* iTargetDB) const = 0;
 
 virtual void GetPreflightScopePageRange (IDataBase* iTargetDB, PMString& pageRange) const = 0;

 virtual void SetWorkingProfile (IDataBase* iTargetDB, const UIDRef& preflightProfile) = 0;
 virtual UIDRef GetWorkingProfile (IDataBase* iTargetDB) const = 0;

 virtual ErrorCode CreateProfile
 (
 const PMString& profileName,
 const PMString& profileDesc,
 bool prepopulateRules,
 UID* newProfileUID
 ) = 0;
 
 virtual ErrorCode DeleteProfile
 (
 const UIDRef& profileRef
 ) = 0;

 

 virtual ErrorCode DuplicateProfile
 (
 IDataBase* targetDB,
 const UIDRef& refSrcProfile,
 UID* newProfileUID
 ) = 0;

 virtual ErrorCode EmbedProfile
 (
 IDataBase* docDB,
 const UIDRef& refProfileToEmbed,
 UID* embeddedProfileUID
 ) = 0;
 
 virtual ErrorCode UnembedProfile
 (
 IDataBase* docDB,
 bool copyEmbeddedToApplication = kTrue
 ) = 0;

 virtual ErrorCode LoadPreflightProfileFromFile
 (
 const IDFile& sourceFile,
 UID* pNewProfileUID,
 bool16 showAlert
 ) = 0;

 virtual ErrorCode ExportPreflightProfileAsINX
 (
 const UIDRef& preflightProfile,
 const IDFile& exportFile
 ) = 0;


 virtual void GetAllProfiles (UIDList& profileList) const = 0;

 virtual void GetProfileName (const UIDRef& preflightProfile, PMString& profileName) const = 0;
 virtual ErrorCode SetProfileName (const UIDRef preflightProfile, const PMString& profileName) = 0;

 virtual void GetProfileDescription (const UIDRef& preflightProfile, PMString& profileDesc) const = 0;
 virtual ErrorCode SetProfileDescription (const UIDRef& preflightProfile, const PMString& profileDesc) = 0;

 virtual UID GetRule (const UIDRef preflightProfile, const PreflightRuleID& ruleID) const = 0;

 virtual UID GetNthRule (const UIDRef preflightProfile, int16 n) const = 0;
 virtual int32 GetProfileRuleCount (const UIDRef preflightProfile) const = 0;

 virtual ErrorCode RemoveAllRules (const UIDRef preflightProfile) = 0;
 
 virtual ErrorCode UpdateEachRulesData (const UIDList& profiles) = 0; 

 virtual ErrorCode CreateRule (const UIDRef& preflightProfile, const PreflightRuleID& ruleID, UID* pNewRuleUID) = 0;

 virtual ErrorCode DeleteRule (const UIDRef& rule) = 0; 

 virtual void GetAllCategories(K2Vector<PMString>& allCategories) const = 0;
 virtual void GetRulesInCategory(const PMString& category, PreflightRuleIDVector& rules) const = 0;

 virtual PMString GetRuleCategory (const UIDRef& rule) const = 0;

 virtual PreflightRuleID GetRuleID (const UIDRef& rule) const = 0;


 virtual bool16 IsRuleEnabled (const UIDRef& rule) const = 0;

 virtual ErrorCode EnableRule (const UIDRef& rule, bool isEnabled) = 0;

 virtual PMString GetRuleDescription (const UIDRef& rule) const = 0;

 virtual ErrorCode SetRuleData (const UIDRef& rule, const IPreflightRuleData::Key& key, const ScriptData& value) = 0;

 virtual ErrorCode GetRuleData (const UIDRef& rule, const IPreflightRuleData::Key& key, ScriptData& value, bool* pExist) const = 0;

 virtual bool16 ArePreflightResultsAvailable (IDataBase* iTargetDB) const = 0;

 virtual void GetPreflightResults (IDataBase* iTargetDB, ScriptListData& results) const = 0;

 };

} // namespace Facade