IPDFAttributes.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Jordan
// 
// $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 __IPDFAttributes__
#define __IPDFAttributes__

#include "IPMUnknown.h"
#include "PMRect.h"
#include "UIDList.h"
#include "BravoForwardDecl.h"
#include "PDFID.h"

class IPMStream;

#define IDMAXENUM 0x40000000

// Flags to track whether page level transparency
// attributes need to be overriden.
typedef uint32 XPOverrideFlags;
enum {
 kXPOverrideBlendSpace = 1<<0,
 kXPOverrideIsolate = 1<<1,
 kXPOverrideKnockout = 1<<2,

 _MAX_XPOverrideOptions = IDMAXENUM /* force 32 bit enum */
};

class IPDFAttributes : public IPMUnknown
{
public:
 /* Default IID to be used by UseDefaultIID() */
 enum { kDefaultIID = IID_IPDFATTRIBUTES };

 enum {
 kDeviceBlendingNone = 0,
 kDeviceBlendingCMYK,
 kDeviceBlendingRGB,
 kDeviceBlendingGray,
 
 // TODO: Obsolete these for InDesign 3.0
 kExportAuto = 0,
 kExportDL,
 kExportForm,

 // Process colors used in PDF
 kCyanUsed = 0x01,
 kMagentaUsed = 0x02,
 kYellowUsed = 0x04,
 kBlackUsed = 0x08,
 kAllProcessColorsUsed = 0x0F
 };

 virtual uint32 GetPageIndex() const = 0;
 
 virtual void SetPageIndex(uint32 pageIndex) = 0;

 virtual bool16 GetTransparentBackground() const = 0;

 virtual void SetTransparentBackground(bool16 fTransparent) = 0;

 virtual bool16 GetPreserveScreens() const = 0;

 virtual void SetPreserveScreens(bool16 fPreserve) = 0;

 virtual void SetUserEnteredPassword(bool16 enteredPassword) = 0;
 
 virtual bool16 GetUserEnteredPassword() const = 0;
 
 virtual const UIDList* CreateUsedColorUIDList(const UIDList* pUIDList) = 0;
 
 virtual const UIDList* GetUsedColorUIDList() const = 0;

 virtual uint32 GetCropTo() const = 0;
 
 virtual void SetCropTo(uint32 cropTo) = 0;

 virtual bool16 GetContainsTransparency() const = 0;
 
 virtual void SetContainsTransparency( bool16 containsXP ) = 0;
 
 virtual bool16 GetContainsOPIReferences() const = 0;
 
 virtual void SetContainsOPIReferences( bool16 containsOPI ) = 0;
 
 virtual bool16 GetContainsOverprint() const = 0;
 
 virtual void SetContainsOverprint(bool16 opd) = 0;

 virtual bool16 GetContainsNIPBlendingModes() const = 0;
 
 virtual void SetContainsNIPBlendingModes(bool16 nips) = 0;

 virtual bool16 GetXPPreviouslyFlattened() const = 0;
 
 virtual void SetXPPreviouslyFlattened(bool16 flat) = 0;
 
 virtual bool16 HasPageBlending() const = 0;

 virtual CAGMColorSpace GetBlendingColorSpace(bool16 *isOverride = nil) = 0;
 
 virtual void SetBlendingColorSpace(CAGMColorSpace cs, bool16 isOverride) = 0;

 virtual bool16 GetPageIsolation(bool16 *isOverride = nil) const = 0;
 
 virtual void SetPageIsolation(bool16 isolate, bool16 isOverride) = 0;

 virtual bool16 GetPageKnockout(bool16 *isOverride = nil) const = 0;

 virtual void SetPageKnockout(bool16 knockout, bool16 isOverride) = 0;

 virtual void SetApplyColorAliases(bool16 apply) = 0;
 
 virtual bool16 GetApplyColorAliases() const = 0;

 virtual int32 GetExportStrategy() const = 0;
 
 virtual void SetExportStrategy(int32 strategy) = 0;

 virtual bool16 IsFromClipboard() const = 0;
 
 virtual void SetFromClipboard(bool16 fromClipboard) = 0;

 virtual int32 CalculateHasTransparency( bool16& bTransparency ) = 0;

 virtual bool16 GetHasGradient() const = 0;
 
 virtual void SetHasGradient(bool16 hasGradient) = 0;

 virtual bool16 GetHasGradientMesh() const = 0;

 virtual void SetHasGradientMesh(bool16 hasGradientMesh) = 0;

 virtual int32 GetExpectedPDFLibCancelCallbackCount() const = 0;

 virtual void SetExpectedPDFLibCancelCallbackCount(int32 n) = 0;

 virtual bool16 GetIsTrapped() const = 0;
 
 virtual void SetIsTrapped(bool16 bIsTrapped) = 0;

 virtual uint32 GetProcessColorsUsed() const = 0;
 
 virtual void SetProcessColorsUsed(uint32 processColorsUsed) = 0;
};

#endif // __IPDFAttributes__