InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IS4SPPackage.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 __IS4SPPackage__
28 #define __IS4SPPackage__
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 
44 class IJobTicket;
45 class IDocument;
46 class IPackageUI;
47 
53 class IS4SPPackage : public IPMUnknown
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  kPackageMissingPlugins,
72  kPackageUnknownError,
73  kPackageIDMLError,
74  kPackageIDMLErrorPDFError,
75  kPackageIDMLErrorPDFAlerts,
76  kPackagePDFAlerts,
77  kPackagePDFError
78  };
84  virtual bool16 Init(const IDocument* in_iDoc) = 0;
85 
91  virtual IDocument* GetParentDocument() = 0;
92 
97  virtual bool16 GetCopyFontsFlag() = 0;
98 
103  virtual void SetCopyFontsFlag(bool16 in_flag) = 0;
104 
109  virtual bool16 GetCopyGLinksFlag() = 0;
110 
115  virtual void SetCopyGLinksFlag(bool16 in_flag) = 0;
116 
121  virtual bool16 GetUpdateGLinksFlag() = 0;
122 
127  virtual void SetUpdateGLinksFlag(bool16 in_flag) = 0;
128 
134  virtual bool16 GetHiddenLayersFlag() = 0;
135 
141  virtual void SetHiddenLayersFlag(bool16 in_flag) = 0;
142 
147  virtual bool16 GetViewReportFlag() = 0;
148 
153  virtual void SetViewReportFlag(bool16 in_flag) = 0;
154 
159  virtual bool16 GetCreateIDMLFlag() = 0;
160 
165  virtual void SetCreateIDMLFlag(bool16 in_flag) = 0;
166 
171  virtual bool16 GetCreatePDFFlag() = 0;
172 
177  virtual void SetCreatePDFFlag(bool16 in_flag) = 0;
183  virtual bool16 GetHyphExceptionsFlag() = 0;
184 
190  virtual void SetHyphExceptionsFlag(bool16 in_flag) = 0;
191 
196  virtual const IDFile* GetPackageLocation() = 0;
197 
202  virtual void SetPackageLocation(const IDFile& in_Location) = 0;
203 
212  virtual PackageRC PhysicalPackage() = 0;
213 
217  virtual void ViewReport() = 0;
218 
224 
230 
236 };
237 
238 #endif //__IS4SPPackage__
239 
240 
241 /*==============================================================================
242  * $Log: /shuksan/source/components/S4SP/Control/Interfaces/IS4SPPackage.h $
243  *
244  * 3 7/17/98 2:34p Sdu
245  * The Final Check in of the Preflight and Package plug-in by Paradigm
246  *
247  * 16 7/16/98 6:32p Yurik
248  * Clean up done
249  *
250  * 15 03/07/98 19:33 Davem
251  * changed bool to bool16
252  *
253  * 14 7/02/98 3:43p Yurik
254  *
255  * 13 6/30/98 9:08p Yurik
256  * Package workflow revamped
257  *
258  * 12 13/05/98 13:31 Davem
259  *
260  * 11 4/24/98 9:38a Yurik
261  * Fxing interface
262  *
263  * 10 22/04/98 16:20 Davem
264  * Added IDocument Accessors
265  *
266  * 9 4/22/98 9:06a Yurik
267  * Converting APIs from interfaces (to iDoc) to independent objects
268  *
269  * 8 20/04/98 11:16 Davem
270  * Fixed IDFile include
271  *
272  * 7 4/15/98 5:28p Yurik
273  *
274  * 6 3/16/98 7:02p Yurik
275  * IPreflight and IPackage interfaces stubbed
276  *
277  * 5 10/03/98 17:17 Davem
278  * Updated to add gets for their descs
279  *
280  * 4 10/03/98 16:30 Davem
281  * removed unnecessary params
282  *
283  * 3 98.3.7 0:24 PM Davem
284  * Updated Interfaces
285  *
286  * 2 05/03/98 18:37 Davem
287  * fixed up #includes and ifdefd them for minimal compile time
288  *
289  * 1 05/03/98 13:03 Davem
290  * Intial Check In
291  *
292  * 1 04/03/98 12:44 Davem
293  * Adding subproject 'Interfaces' to '$/S4SP/Control'
294  *
295  *=============================================================================
296  */
297 
298