IPreflightUtils.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.
// 
// 
// General (application-wide) preflight utilities. Note that there are other utility 
// files such as IPreflightProfileUtils which address specific kinds of objects.
// 
//========================================================================================


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

#include "IPreflightArtworkShapeContext.h"
#include "IPreflightArtworkTextContext.h"
#include "IPreflightArtworkTableContext.h"
#include "IViewPortAttributes.h"
#include "IGraphicsPort.h"
#include "TransformTypes.h"

class IPreflightManager;
class IPreflightObjectModel;
class IPreflightProfileManager;
class IPreflightRuleManager;
class IPreflightProcessManager;
class IPreflightOptions;
class IDocument;
class IDataBase;
class ISubject;
class IPreflightProcess;
class IPreflightProfile;
class IPreflightBookOptions;
class IShape;
class ISpread;

class IPreflightUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTUTILS };

public:
 virtual IPreflightManager *QueryPreflightManager() const = 0;

 virtual IPreflightObjectModel *QueryObjectModel() const = 0;

 virtual IPreflightRuleManager *QueryRuleManager() const = 0;

 virtual IPreflightProcessManager *QueryProcessManager() const = 0;

 virtual IPreflightProfileManager *QueryProfileManager(IDocument* iDoc) const = 0;

 virtual IPreflightProfileManager *QueryProfileManager(IDataBase* iDataBase) const = 0;

 virtual ISubject* QueryAppMessageSubject() const = 0;

 virtual ISubject* QueryDocumentSubject(IDataBase* iDB) const = 0;

 virtual IPreflightOptions* QueryPreflightOptions (IDataBase* iDB) const = 0;

 virtual IPreflightProcess* QueryProcessForDocument(IDataBase* iDocDB) const = 0;

 virtual void ApplyOptionsToDocument
 (
 IDataBase* iDocDB, 
 const IPreflightOptions* iNewOptions
 ) const = 0;

 virtual IPreflightProfile* QueryEmbeddedProfile(IDataBase* iDocDB) const = 0;

 virtual IPreflightProfile* QueryWorkingProfile() const = 0;

 virtual IPreflightProfile* QueryDefaultProfile() const = 0;

 virtual void BeginShapeGroup(IGraphicsPort* iPort, UID itemUID, ClassID subpartID) const = 0;

 virtual void EndShapeGroup(IGraphicsPort* iPort, UID itemUID, ClassID subpartID) const = 0;

 class AutoShapeGroup
 {
 IGraphicsPort* fPort;
 bool fIssueGroup;
 ClassID fSubPartID;
 UID fUID;

 public:
 AutoShapeGroup
 (
 IGraphicsPort* iPort, 
 IPMUnknown* iThing, 
 ClassID subPartID, 
 bool issueGroup = kTrue
 )
 : fPort(iPort), fUID(kInvalidUID), fIssueGroup(kFalse), fSubPartID(subPartID)
 {
 if (issueGroup)
 {
 InterfacePtr<IViewPortAttributes> iAttr(iPort, UseDefaultIID());
 fIssueGroup = (iAttr && iAttr->GetAttr(kPreflightIssuePortGroupsVPAttr));
 if (fIssueGroup) 
 {
 fUID = ::GetUID(iThing);
 Utils<IPreflightUtils>()->BeginShapeGroup(iPort, fUID, subPartID);
 }
 }
 }

 ~AutoShapeGroup()
 {
 if (fIssueGroup) Utils<IPreflightUtils>()->EndShapeGroup(fPort, fUID, fSubPartID);
 }
 };

 virtual bool SelectPageItem(const UIDRef& itemRef) const = 0;

 virtual PMString GetPageDescription(IShape* iPageShape) const = 0;

 virtual PMString GetSpreadDescription(ISpread* iSpread) const = 0;

// virtual void GetSpreadRect(ISpread* iSpread, Transform::CoordinateSpace coordSpace, PMRect& r) const = 0;

 virtual ErrorCode NewProfile
 (
 IDataBase* iTargetDB,
 const PMString& profileName,
 const PMString& profileDesc,
 bool prepopulateRules,
 UID* pNewProfileUID
 ) = 0;

 virtual ErrorCode CopyProfileData
 (
 const UIDRef& dstProfileRef,
 const IPreflightProfile* iSrcProfile
 ) = 0;
 
 virtual ErrorCode SetProfileStrings
 (
 const UIDRef& dstProfileRef,
 bool setName,
 const PMString& newName,
 bool setDesc,
 const PMString& newDesc
 ) = 0;


 virtual const IPreflightBookOptions* QueryBookOptions
 (
 IDataBase* iBookDB
 ) const = 0;

 virtual const IPreflightBookOptions* QueryActiveBookOptions
 (
 IDataBase* iBookDB
 ) const = 0;

 virtual IPreflightBookOptions* CloneBookOptions
 (
 const IPreflightBookOptions* iSrc = nil
 ) const = 0;

 virtual ErrorCode SetPreflightBookOptions
 (
 IDataBase* iBookDB,
 const IPreflightBookOptions* iOptions
 ) = 0;

 virtual ErrorCode SetActivePreflightBookOptions
 (
 IDataBase* iBookDB,
 const IPreflightBookOptions* iOptions
 ) = 0;

 virtual const IPreflightOptions* QueryOptions
 (
 IDataBase* iDocumentDB
 ) const = 0;

 virtual IPreflightOptions* CloneOptions
 (
 const IPreflightOptions* iSrc = nil
 ) const = 0;

 virtual ErrorCode UpdateActivePreflightOptions
 (
 IDataBase* iDataBase,
 const IPreflightOptions* iOptions
 ) = 0;

 virtual ErrorCode SetPreflightOptions
 (
 IDataBase* iDataBase,
 const IPreflightOptions* iOptions
 ) = 0;
};