ISVGExportPreferences.h

//========================================================================================
// 
// $File$
// 
// Owner: Greg St. Pierre
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2007 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ISVGExportPreferences__
#define __ISVGExportPreferences__

#include "SVGExportID.h"

class ISVGExportPreferences : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISVGEXPORTPREFERENCES };

 /*
 Gets embed images flag. If true, images should be embedded in the
 generated SVG file; otherwise, images are externalized

 @return kTrue if images should be embedded, else kFalse
 */
 virtual bool16 GetEmbedImages() const = 0;

 virtual void SetEmbedImages(bool16 embed) = 0;

 enum ImageFormat
 {
 kDefaultImageFormat,
 kJPEGImageFormat,
 kGIFImageFormat,
 kPNGImageFormat
 };

 virtual ImageFormat GetImageFormat() const = 0;

 virtual void SetImageFormat(ImageFormat format) = 0;

 enum JPEGQuality
 {
 kJPEGQualityHigh,
 kJPEGQualityMedHigh,
 kJPEGQualityMed,
 kJPEGQualityMedLow,
 kJPEGQualityLow
 };

 virtual JPEGQuality GetJPEGQuality() const = 0;

 virtual void SetJPEGQuality(JPEGQuality quality) = 0;

 enum GIFPaletteType
 {
 kWebPalette,
 kMacPalette,
 kWinPalette,
 kExactPalette, // Note: if generation of exact fails, adaptive is used
 kAdaptivePalette
 };

 virtual GIFPaletteType GetGIFPaletteType() const = 0;

 virtual void SetGIFPaletteType(GIFPaletteType palette) = 0;

 virtual bool16 GetInterlacedGIF() const = 0;

 virtual void SetInterlacedGIF(bool16 interlace) = 0;

 enum ExportBitmapSampling
 {
 kHiResSampling,
 kLowResSampling
 };

 virtual ExportBitmapSampling GetExportBitmapSampling() const = 0;

 virtual void SetExportBitmapSampling(ExportBitmapSampling sampling) = 0;

 virtual bool16 GetEmbedFonts() const = 0;

 virtual void SetEmbedFonts(bool16 embed) = 0;

 enum FontSubsetting
 {
 // List borrowed from Illustrator
 kSubsetNone,
 kSubsetGlyphsOnly,
 kSubsetCommonEnglishOnly,
 kSubsetGlyphsPlusEnglish,
 kSubsetCommonRomanOnly,
 kSubsetGlyphsPlusRoman,
 kSubsetEntire
 };

 virtual FontSubsetting GetFontSubsetting() const = 0;

 virtual void SetFontSubsetting(FontSubsetting subset) = 0;
 
 virtual bool16 GetOutputReadersSpreads() const = 0;

 virtual void SetOutputReadersSpreads(bool16 output) = 0;

 enum ImageSampling
 {
 kNoSampling,
 kSubSampling,
 kDownSampling
 };

 virtual ImageSampling GetImageSampling() const = 0;

 virtual void SetImageSampling(ImageSampling sampling) = 0;

 virtual uint32 GetRealPrecision() const = 0;

 virtual void SetRealPrecision(uint32 precision) = 0;

 enum RenderingStyle
 {
 kProgressiveRendering,
 kBatchRendering
 };

 virtual RenderingStyle GetRenderingStyle() const = 0;

 virtual void SetRenderingStyle(RenderingStyle style) = 0;

 enum FileEncoding
 {
 kASCIIEncoding,
 kUTF8Encoding,
 kUTF16Encoding
 };

 virtual FileEncoding GetFileEncoding() const = 0;

 virtual void SetFileEncoding(FileEncoding encoding) = 0;

 enum StyleFormat
 {
 kInlineStyleFormat,
 kEntityStyleFormat,
 kCSSStyleFormat,
 kInlineFormat
 };

 virtual StyleFormat GetStyleFormat() const = 0;

 virtual void SetStyleFormat(StyleFormat format) = 0;

 enum PageRangeFormat
 {
 kAllPages,
 kRange
 };

 virtual PageRangeFormat GetPageRangeFormat() const = 0;

 virtual void SetPageRangeFormat(PageRangeFormat format) = 0;

 virtual PMString const &GetPageRange() const = 0;

 virtual void SetPageRange(PMString const &range) = 0;

 virtual UID GetFlattenerStyle() const = 0;

 virtual void SetFlattenerStyle(UID const &style) = 0;

 virtual bool16 GetIgnoreFlattenerSpreadOverrides() const = 0;

 virtual void SetIgnoreFlattenerSpreadOverrides(bool16 ignore) = 0;

 virtual bool16 GetFlattenOutput() const = 0;

 virtual void SetFlattenOutput(bool16 flatten) = 0;

 virtual bool16 GetUseNativeXP() const = 0;

 virtual void SetUseNativeXP(bool16 useNativeXP) = 0;

 virtual void Copy(ISVGExportPreferences const *other) = 0;

 virtual bool16 GetPageItemExport() const = 0;

 virtual void SetPageItemExport(bool16 pageitemExport) = 0;

 //[TODO]temporary for prototype APIs

 virtual void EnableDisableContent(bool16 inEnableStroke) = 0;
 virtual void EnableDisableFill(bool16 inEnableFill) = 0;
 virtual void EnableDisableStroke(bool16 inEnableFill) = 0;

 virtual bool16 IsContentEnabled() const = 0;
 virtual bool16 IsStrokeEnabled() const = 0;
 virtual bool16 IsFillEnabled() const = 0;

 virtual void EnableWriteXMLHeader(bool16 enable) = 0;
 virtual bool16 IsWriteXMLHeaderEnabled() const = 0;

};

#endif