InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPublishPrefs.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Matt Phillips
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // ADOBE CONFIDENTIAL
16 //
17 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
18 //
19 // NOTICE: All information contained herein is, and remains
20 // the property of Adobe Systems Incorporated and its suppliers,
21 // if any. The intellectual and technical concepts contained
22 // herein are proprietary to Adobe Systems Incorporated and its
23 // suppliers and may be covered by U.S. and Foreign Patents,
24 // patents in process, and are protected by trade secret or copyright law.
25 // Dissemination of this information or reproduction of this material
26 // is strictly forbidden unless prior written permission is obtained
27 // from Adobe Systems Incorporated.
28 //
29 //========================================================================================
30 
31 #ifndef __IPUBLISHPREFS__
32 #define __IPUBLISHPREFS__
33 
34 #include "IPMUnknown.h"
35 #include "IXMLExportOptions.h"
36 #include "HTMLEPubExportTypes.h"
37 #include "EBookExportID.h"
38 
39 static const char* kPublishExtPdfExport = "LastMile PDF export";
40 static const char* kPublishExtExportWarn = "LastMile warning dialog";
41 
42 using namespace HTMLExport;
43 
44 class IPublishPrefs : public IPMUnknown
45 {
46 public:
47  enum { kDefaultIID = IID_IPUBLISHPREFS };
48 
49  //Get Set Export order
50  virtual ExportOrder GetExportOrder() const = 0;
51  virtual void SetExportOrder(ExportOrder order) = 0;
52  //Get Set description
53  virtual PMString GetDescription() const = 0;
54  virtual void SetDescription(PMString& des) = 0;
55  //Get/Set File Name
56  virtual PMString GetFileName() const = 0;
57  virtual void SetFileName(PMString& fileName) = 0;
58  //Get/Set Page range
59  virtual PMString GetPageRange() const = 0;
60  virtual void SetPageRange(PMString& pageRange) = 0;
61  //Get/set page range format
62  virtual PageRangeFormat GetRangeFormat() const = 0;
63  virtual void SetRangeFormat(PageRangeFormat rangeFormat) = 0;
64  //Get/set export is page wise or spread wise.
65  virtual int32 GetSpreadControl() const = 0;
66  virtual void SetSpreadControl(int32 spreadControl) = 0;
67 
68  //Get/set gif interlaced
69  virtual bool16 GetGIFInterlaced() const = 0;
70  virtual void SetGIFInterlaced(bool16 gif) = 0;
71 
72  //Get/set cover options.
73  virtual EBookCover GetCoverOptions() const = 0;
74  virtual void SetCoverOptions(EBookCover coverOptions)= 0;
75  //Get/set cover image path.
76  virtual PMString GetCoverImage() const = 0;
77  virtual void SetCoverImage(const PMString & image) = 0;
78  //Get/set exported image ppi.
79  virtual uint32 GetImagePPI() const = 0;
80  virtual void SetImagePPI(uint32 ppi) = 0;
81  //Get/set exported image format.
82  virtual IXMLExportOptions::ImageType GetImageType() const = 0;
83  virtual void SetImageType(IXMLExportOptions::ImageType type) = 0;
84  //Get/Set GIF Palette type
85  virtual IXMLExportOptions::PaletteType GetGIFPaletteType() const =0;
86  virtual void SetGIFPaletteType(IXMLExportOptions::PaletteType type) =0;
87 
88  //Get/Set cover page
89  virtual PMString GetCoverPage() const =0;
90  virtual void SetCoverPage(const PMString& pageNumber) =0;
91  //Get/Set JPEG Quality
92  virtual IXMLExportOptions::JPEGQuality GetJPEGQuality() const =0;
93  virtual void SetJPEGQuality (const IXMLExportOptions::JPEGQuality qual) =0;
94  //Get/Set JPEG Encoding
95  virtual IXMLExportOptions::JPEGEncoding GetJPEGEncoding() const =0;
96  virtual void SetJPEGEncoding(IXMLExportOptions::JPEGEncoding jpgEnc)=0;
97  //Function to copy IPublishPrefs
98  virtual void Copy(IPublishPrefs const * other) = 0;
99 
100  // Google Analytics
101  // Adobe internal use only
102  virtual PMString GetMeasurementId() const =0;
103 
104  // Adobe internal use only
105  virtual void SetMeasurementId(const PMString& measurementId) =0;
106 
107  // Adobe internal use only
108  virtual bool16 GetShowCookieConsentBanner() const =0;
109 
110  // Adobe internal use only
111  virtual void SetShowCookieConsentBanner(bool16 showCookieConsentBanner) =0;
112 
113  // Adobe internal use only
114  virtual PMString GetCookieConsentBannerText() const =0;
115 
116  // Adobe internal use only
117  virtual void SetCookieConsentBannerText(const PMString& cookieConsentBannerText) =0;
118  // Google Analytics - End
119 
120  // HTML Package Export - Start
121  // Adobe internal use only
122  virtual void SetExportTextContentAsSVG(bool16 textContentAsSVG) = 0;
123 
124  // Adobe internal use only
125  virtual bool16 GetExportTextContentAsSVG() const = 0;;
126  // HTML Package Export - End
127 };
128 #endif