InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPDFAttributes.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Michael Jordan
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __IPDFAttributes__
25 #define __IPDFAttributes__
26 
27 #include "IPMUnknown.h"
28 #include "PMRect.h"
29 #include "UIDList.h"
30 #include "BravoForwardDecl.h"
31 #include "PDFID.h"
32 
33 class IPMStream;
34 
35 #define IDMAXENUM 0x40000000
36 
37 // Flags to track whether page level transparency
38 // attributes need to be overriden.
39 typedef uint32 XPOverrideFlags;
40 enum {
42  kXPOverrideBlendSpace = 1<<0,
44  kXPOverrideIsolate = 1<<1,
46  kXPOverrideKnockout = 1<<2,
47 
48  _MAX_XPOverrideOptions = IDMAXENUM /* force 32 bit enum */
49 };
50 
54 class IPDFAttributes : public IPMUnknown
55 {
56 public:
57  /* Default IID to be used by UseDefaultIID() */
58  enum { kDefaultIID = IID_IPDFATTRIBUTES };
59 
60  enum {
61  kDeviceBlendingNone = 0,
62  kDeviceBlendingCMYK,
63  kDeviceBlendingRGB,
64  kDeviceBlendingGray,
65 
66  // TODO: Obsolete these for InDesign 3.0
67  kExportAuto = 0,
68  kExportDL,
69  kExportForm,
70 
71  // Process colors used in PDF
72  kCyanUsed = 0x01,
73  kMagentaUsed = 0x02,
74  kYellowUsed = 0x04,
75  kBlackUsed = 0x08,
76  kAllProcessColorsUsed = 0x0F
77  };
78 
82  virtual uint32 GetPageIndex() const = 0;
83 
89  virtual void SetPageIndex(uint32 pageIndex) = 0;
90 
94  virtual bool16 GetTransparentBackground() const = 0;
95 
101  virtual void SetTransparentBackground(bool16 fTransparent) = 0;
102 
106  virtual bool16 GetPreserveScreens() const = 0;
107 
113  virtual void SetPreserveScreens(bool16 fPreserve) = 0;
114 
118  virtual void SetUserEnteredPassword(bool16 enteredPassword) = 0;
119 
123  virtual bool16 GetUserEnteredPassword() const = 0;
124 
134  virtual const UIDList* CreateUsedColorUIDList(const UIDList* pUIDList) = 0;
135 
142  virtual const UIDList* GetUsedColorUIDList() const = 0;
143 
150  virtual uint32 GetCropTo() const = 0;
151 
158  virtual void SetCropTo(uint32 cropTo) = 0;
159 
163  virtual bool16 GetContainsTransparency() const = 0;
164 
170  virtual void SetContainsTransparency( bool16 containsXP ) = 0;
171 
175  virtual bool16 GetContainsOPIReferences() const = 0;
176 
182  virtual void SetContainsOPIReferences( bool16 containsOPI ) = 0;
183 
187  virtual bool16 GetContainsOverprint() const = 0;
188 
194  virtual void SetContainsOverprint(bool16 opd) = 0;
195 
199  virtual bool16 GetContainsNIPBlendingModes() const = 0;
200 
206  virtual void SetContainsNIPBlendingModes(bool16 nips) = 0;
207 
211  virtual bool16 GetXPPreviouslyFlattened() const = 0;
212 
218  virtual void SetXPPreviouslyFlattened(bool16 flat) = 0;
219 
223  virtual bool16 HasPageBlending() const = 0;
224 
234  virtual CAGMColorSpace GetBlendingColorSpace(bool16 *isOverride = nil) = 0;
235 
245  virtual void SetBlendingColorSpace(CAGMColorSpace cs, bool16 isOverride) = 0;
246 
251  virtual bool16 GetPageIsolation(bool16 *isOverride = nil) const = 0;
252 
259  virtual void SetPageIsolation(bool16 isolate, bool16 isOverride) = 0;
260 
265  virtual bool16 GetPageKnockout(bool16 *isOverride = nil) const = 0;
266 
273  virtual void SetPageKnockout(bool16 knockout, bool16 isOverride) = 0;
274 
280  virtual void SetApplyColorAliases(bool16 apply) = 0;
281 
285  virtual bool16 GetApplyColorAliases() const = 0;
286 
292  virtual int32 GetExportStrategy() const = 0;
293 
301  virtual void SetExportStrategy(int32 strategy) = 0;
302 
306  virtual bool16 IsFromClipboard() const = 0;
307 
313  virtual void SetFromClipboard(bool16 fromClipboard) = 0;
314 
329  virtual int32 CalculateHasTransparency( bool16& bTransparency ) = 0;
330 
334  virtual bool16 GetHasGradient() const = 0;
335 
341  virtual void SetHasGradient(bool16 hasGradient) = 0;
342 
346  virtual bool16 GetHasGradientMesh() const = 0;
347 
353  virtual void SetHasGradientMesh(bool16 hasGradientMesh) = 0;
354 
358  virtual int32 GetExpectedPDFLibCancelCallbackCount() const = 0;
359 
363  virtual void SetExpectedPDFLibCancelCallbackCount(int32 n) = 0;
364 
371  virtual bool16 GetIsTrapped() const = 0;
372 
379  virtual void SetIsTrapped(bool16 bIsTrapped) = 0;
380 
389  virtual uint32 GetProcessColorsUsed() const = 0;
390 
399  virtual void SetProcessColorsUsed(uint32 processColorsUsed) = 0;
400 };
401 
402 #endif // __IPDFAttributes__