InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IS4SPPackageBook.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: DaveM
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 // Package API Interface
24 //
25 //========================================================================================
26 
27 #ifndef __IS4SPPackageBook__
28 #define __IS4SPPackageBook__
29 
30 #ifndef __IPMUNKNOWN__
31 #include "IPMUnknown.h"
32 #endif
33 
34 #ifndef __PMTYPES__
35 #include "PMTypes.h"
36 #endif
37 
38 #ifndef __IDFile__
39 #include "IDFile.h"
40 #endif
41 
42 #include "K2Vector.h" // package file lists
43 #include "IBook.h"
44 
45 class IJobTicket;
46 class IDocument;
47 class IPackageUI;
48 
54 {
55 public:
56 
62  enum PackageRC { kPackageOK, kPackageCancelled, kPackageBadPreflight,
63  kPackageCantCreateFolder,
64  kPackageCantCopyFonts,
65  kPackageCantCopyProfiles,
66  kPackageCantCopyLinks,
67  kPackageCantCopyPub,
68  kPackageCantUpdateLinks,
69  kPackageCantRestoreLinks,
70  kPackageCantDoHyphExceptions,
71  kPackageUnknownError,
72  kPackageIDMLError,
73  kPackageIDMLErrorPDFError,
74  kPackageIDMLErrorPDFAlerts,
75  kPackagePDFAlerts,
76  kPackagePDFError
77  };
78 
84  virtual bool16 Init(const IBook* f_iBook) = 0;
85 
91  virtual IBook* GetParentBook() = 0;
92 
97  virtual bool16 GetCopyFontsFlag() = 0;
98 
103  virtual void SetCopyFontsFlag(bool16 in_flag) = 0;
104 
105 // virtual bool16 GetCopyICCFlag() = 0;
106 // virtual void SetCopyICCFlag(bool16 in_flag) = 0;
107 
112  virtual bool16 GetCopyGLinksFlag() = 0;
113 
118  virtual void SetCopyGLinksFlag(bool16 in_flag) = 0;
119 
124  virtual bool16 GetUpdateGLinksFlag() = 0;
125 
130  virtual void SetUpdateGLinksFlag(bool16 in_flag) = 0;
131 
137  virtual bool16 GetHiddenLayersFlag() = 0;
138 
144  virtual void SetHiddenLayersFlag(bool16 in_flag) = 0;
145 
150  virtual bool16 GetViewReportFlag() = 0;
151 
156  virtual void SetViewReportFlag(bool16 in_flag) = 0;
157 
162  virtual bool16 GetCreateIDMLFlag() = 0;
163 
168  virtual void SetCreateIDMLFlag(bool16 in_flag) = 0;
169 
174  virtual bool16 GetCreatePDFFlag() = 0;
175 
180  virtual void SetCreatePDFFlag(bool16 in_flag) = 0;
181 
187  virtual bool16 GetHyphExceptionsFlag() = 0;
188 
194  virtual void SetHyphExceptionsFlag(bool16 in_flag) = 0;
195 
200  virtual const IDFile* GetPackageLocation() = 0;
201 
206  virtual void SetPackageLocation(const IDFile& in_Location) = 0;
207 
217  virtual PackageRC PhysicalPackage() = 0;
218 
222  virtual void ViewReport() = 0;
223 
229 
230 
236 
242 
249 
254  virtual K2Vector<int32>* GetSizeList() = 0;
255 
262  virtual bool16 GetFullBookPackageFlag() const = 0;
263 
270  virtual void SetFullBookPackageFlag(bool16 in_flag) = 0;
271 
277  virtual IDocument* GetCurrentDocument() const = 0;
278 };
279 
280 #endif //__IS4SPPackageBook__
281 
282 
283 /*==============================================================================
284  * $Log: /shuksan/source/components/S4SP/Control/Interfaces/IS4SPPackage.h $
285  *
286  * 3 7/17/98 2:34p Sdu
287  * The Final Check in of the Preflight and Package plug-in by Paradigm
288  *
289  * 16 7/16/98 6:32p Yurik
290  * Clean up done
291  *
292  * 15 03/07/98 19:33 Davem
293  * changed bool to bool16
294  *
295  * 14 7/02/98 3:43p Yurik
296  *
297  * 13 6/30/98 9:08p Yurik
298  * Package workflow revamped
299  *
300  * 12 13/05/98 13:31 Davem
301  *
302  * 11 4/24/98 9:38a Yurik
303  * Fxing interface
304  *
305  * 10 22/04/98 16:20 Davem
306  * Added IDocument Accessors
307  *
308  * 9 4/22/98 9:06a Yurik
309  * Converting APIs from interfaces (to iDoc) to independent objects
310  *
311  * 8 20/04/98 11:16 Davem
312  * Fixed IDFile include
313  *
314  * 7 4/15/98 5:28p Yurik
315  *
316  * 6 3/16/98 7:02p Yurik
317  * IPreflight and IPackage interfaces stubbed
318  *
319  * 5 10/03/98 17:17 Davem
320  * Updated to add gets for their descs
321  *
322  * 4 10/03/98 16:30 Davem
323  * removed unnecessary params
324  *
325  * 3 98.3.7 0:24 PM Davem
326  * Updated Interfaces
327  *
328  * 2 05/03/98 18:37 Davem
329  * fixed up #includes and ifdefd them for minimal compile time
330  *
331  * 1 05/03/98 13:03 Davem
332  * Intial Check In
333  *
334  * 1 04/03/98 12:44 Davem
335  * Adding subproject 'Interfaces' to '$/S4SP/Control'
336  *
337  *=============================================================================
338  */
339 
340