InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IEPubExportPrefs.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Gang Xiao
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 __IEPubExportPrefs_h__
32 #define __IEPubExportPrefs_h__
33 
34 //#include "IPMUnknown.h"
35 #include "IXMLExportOptions.h"
36 
37 #include "HTMLEPubExportTypes.h"
38 
39 #include "EBookExportID.h"
40 
41 #include "K2Vector.h"
42 
43 class IEPubExportPrefs : public IPMUnknown
44 {
45 public:
46  enum { kDefaultIID = IID_IEPUBEXPORTPREFS };
47 
48  // general panel
49 
52  virtual HTMLExport::EBookFormat GetEBookFormat() const = 0;
53  virtual void SetEBookFormat(HTMLExport::EBookFormat format) = 0;
54 
57  virtual HTMLExport::EBookCover GetEBookCoverOption() const = 0;
58  virtual void SetEBookCoverOption(HTMLExport::EBookCover option) = 0;
59 
62  virtual PMString GetCoverImage() const = 0;
63  virtual void SetCoverImage(const PMString & image) = 0;
64 
67  virtual PMString GetTOCStyleName() const = 0;
68  virtual void SetTOCStyleName(const PMString & name) = 0;
69 
72  virtual PMReal GetMarginLeft() const = 0;
73  virtual void SetMarginLeft(const PMReal & left) = 0;
74 
75  virtual PMReal GetMarginRight() const = 0;
76  virtual void SetMarginRight(const PMReal & right) = 0;
77 
78  virtual PMReal GetMarginTop() const = 0;
79  virtual void SetMarginTop(const PMReal & top) = 0;
80 
81  virtual PMReal GetMarginBottom() const = 0;
82  virtual void SetMarginBottom(const PMReal & bottom) = 0;
83 
86  virtual HTMLExport::ExportOrder GetExportOrder() const = 0;
87  virtual void SetExportOrder(HTMLExport::ExportOrder order) = 0;
88 
91  virtual bool16 GetFootnoteAfterPara() const = 0;
92  virtual void SetFootnoteAfterPara(bool16 ft) = 0;
93 
96  virtual bool16 GetRemoveSoftReturn() const = 0;
97  virtual void SetRemoveSoftReturn(bool16 sr) = 0;
98 
101  virtual HTMLExport::BulletOption GetBulletOption() const = 0;
102  virtual void SetBulletOption(HTMLExport::BulletOption option) = 0;
103 
106  virtual HTMLExport::NumberingOption GetNumberingOption() const = 0;
107  virtual void SetNumberingOption(HTMLExport::NumberingOption option) = 0;
108 
109  // image option
110 
113  virtual bool16 GetLayoutAppearance() const = 0;
114  virtual void SetLayoutAppearance(bool16 layoutFormat) = 0;
115 
118  virtual uint32 GetImagePPI() const = 0;
119  virtual void SetImagePPI(uint32 ppi) = 0;
120 
124  virtual HTMLExport::ImageSize GetImageSize() const = 0;
125  virtual void SetImageSize(HTMLExport::ImageSize option) = 0;
126 
129  virtual HTMLExport::ImageAlignment GetImageAlignment() const = 0;
130  virtual void SetImageAlignment(HTMLExport::ImageAlignment align) = 0;
131 
134  virtual PMReal GetImageSpaceBefore() const = 0;
135  virtual void SetImageSpaceBefore(const PMReal & before) = 0;
136 
139  virtual PMReal GetImageSpaceAfter() const = 0;
140  virtual void SetImageSpaceAfter(const PMReal & after) = 0;
141 
144  virtual bool16 GetUseImagePageBreak() const = 0;
145  virtual void SetUseImagePageBreak(bool16 use) = 0;
146 
149  virtual HTMLExport::PageBreak GetImagePageBreak() const = 0;
150  virtual void SetImagePageBreak(HTMLExport::PageBreak imageBreak) = 0;
151 
156  virtual bool16 GetApplyImageASToAnchoredObject() const = 0;
157  virtual void SetApplyImageASToAnchoredObject(bool16 apply) = 0;
158 
161  virtual IXMLExportOptions::ImageType GetImageType() const = 0;
162  virtual void SetImageType(IXMLExportOptions::ImageType type) = 0;
163 
164  virtual IXMLExportOptions::PaletteType GetGIFPaletteType() const = 0;
165  virtual void SetGIFPaletteType(IXMLExportOptions::PaletteType type) = 0;
166 
167  virtual bool16 GetGIFInterlaced() const = 0;
168  virtual void SetGIFInterlaced(bool16 gif) = 0;
169 
170  virtual IXMLExportOptions::JPEGEncoding GetJPEGEncoding() const = 0;
171  virtual void SetJPEGEncoding(IXMLExportOptions::JPEGEncoding encoding) = 0;
172 
173  virtual IXMLExportOptions::JPEGQuality GetJPEGQuality() const = 0;
174  virtual void SetJPEGQuality(IXMLExportOptions::JPEGQuality quality) = 0;
175 
176  // SVG export type options
177  virtual HTMLExport::SVGExportType GetSVGExportType() const = 0;
178  virtual void SetSVGExportType(HTMLExport::SVGExportType type) = 0;
179 
182  virtual uint32 GetPNGCompression() const = 0;
183  virtual void SetPNGCompression(uint32 compression) = 0;
184 
187  virtual bool16 GetIgnorePageitemImageSetting() const = 0;
188  virtual void SetIgnorePageitemImageSetting(bool16 setting) = 0;
189 
190  // content options
191 
194  virtual bool16 GetBreakDocument() const = 0;
195  virtual void SetBreakDocument(bool16 chunk) = 0;
196 
200  virtual PMString GetBreakDocParaStyleName() const = 0;
201  virtual void SetBreakDocParaStyleName(const PMString & name) = 0;
202 
205  virtual bool16 GetIncludeDocMetadata() const = 0;
206  virtual void SetIncludeDocMetadata(bool16 include) = 0;
207 
210  virtual PMString GetPublisherEntry() const = 0;
211  virtual void SetPublisherEntry(const PMString & entry) = 0;
212 
215  virtual PMString GetMetadataIdentifier() const = 0;
216  virtual void SetMetadataIdentifier(const PMString & uuid) = 0;
217 
220  virtual bool16 GetGenerateCSS() const = 0;
221  virtual void SetGenerateCSS(bool16 content) = 0;
222 
225  virtual bool16 GetIncludeOverrides() const = 0;
226  virtual void SetIncludeOverrides(bool16 overrides) = 0;
227 
230  virtual bool16 GetEmbedFont() const = 0;
231  virtual void SetEmbedFont(bool16 embed) = 0;
232 
235  virtual K2Vector<PMString> GetCascadeStyleSheets() const = 0;
236  virtual void SetCascadeStyleSheets(const K2Vector<PMString> & sheets) = 0;
237 
240  virtual K2Vector<PMString> GetJavascripts() const = 0;
241  virtual void SetJavascripts(const K2Vector<PMString> & scripts) = 0;
242 
246  virtual void Copy(IEPubExportPrefs const * other) = 0;
247 
248  // image option
249  virtual HTMLExport::ImageOption GetImageOption() const = 0;
250  virtual void SetImageOption(HTMLExport::ImageOption option) = 0;
251 
252  /* footnote placement option
253  After Story, After paragraph, inside popup
254  */
255  virtual HTMLExport::FootnotePlacement GetFootnotePlacement() const = 0;
256  virtual void SetFootnotePlacement(HTMLExport::FootnotePlacement footnotePlacement) = 0;
257 
260  virtual PMString GetMetadataTitle() const = 0;
261  virtual void SetMetadataTitle(const PMString & title) = 0;
262 
265  virtual PMString GetMetadataCreator() const = 0;
266  virtual void SetMetadataCreator(const PMString & creator) = 0;
267 
270  virtual PMString GetMetadataDate() const = 0;
271  virtual void SetMetadataDate(const PMString & date) = 0;
272 
276  virtual PMString GetMetadataDescription() const = 0;
277  virtual void SetMetadataDescription(const PMString & description) = 0;
278 
282  virtual PMString GetMetadataRights() const = 0;
283  virtual void SetMetadataRights(const PMString & rights) = 0;
284 
288  virtual PMString GetMetadataSubject() const = 0;
289  virtual void SetMetadataSubject(const PMString & subject) = 0;
290 
295  virtual bool16 GetIncludeClassesInHTML() const = 0;
296  virtual void SetIncludeClassesInHTML(bool16 includeClassesInHTML) = 0;
297 
300  virtual PMString GetMetadataAccessibilityFeature() const = 0;
301  virtual void SetMetadataAccessibilityFeature(const PMString & feature) = 0;
302 
305  virtual PMString GetMetadataAccessibilityHazard() const = 0;
306  virtual void SetMetadataAccessibilityHazard(const PMString & hazard) = 0;
307 
310  virtual PMString GetMetadataAccessibilityMode() const = 0;
311  virtual void SetMetadataAccessibilityMode(const PMString & mode) = 0;
312 
315  virtual PMString GetMetadataAccessibilityModeSufficient() const = 0;
316  virtual void SetMetadataAccessibilityModeSufficient(const PMString & modeSufficient) = 0;
317 
320  virtual PMString GetMetadataAccessibilitySummary() const = 0;
321  virtual void SetMetadataAccessibilitySummary(const PMString & summary) = 0;
322 
325  virtual PMString GetMetadataAccessibilityConformsTo() const = 0;
326  virtual void SetMetadataAccessibilityConformsTo(const PMString & conformTo) = 0;
327 
330  virtual PMString GetMetadataAccessibilityCertifiedBy() const = 0;
331  virtual void SetMetadataAccessibilityCertifiedBy(const PMString & certifiedBy) = 0;
332 
335  virtual PMString GetMetadataAccessibilityCredentials() const = 0;
336  virtual void SetMetadataAccessibilityCredentials(const PMString & credentials) = 0;
337 
340  virtual PMString GetMetadataAccessibilityReportLink() const = 0;
341  virtual void SetMetadataAccessibilityReportLink(const PMString & reportLink) = 0;
342 
345  virtual bool16 GetCreatePageNavigation() const = 0;
346  virtual void SetCreatePageNavigation(bool16 enable) = 0;
347 
350  virtual PMString GetCoverAltText() const = 0;
351  virtual void SetCoverAltText(const PMString & coverAltText) = 0;
352 
355  virtual PMString GetPageBreakSourceText() const = 0;
356  virtual void SetPageBreakSourceText(const PMString & sourceText) = 0;
357 
360  virtual HTMLExport::EPageBreakSourceType GetPageBreakSourceType() const = 0;
361  virtual void SetPageBreakSourceType(HTMLExport::EPageBreakSourceType type) = 0;
362 
363 };
364 
365 #endif
366 
367