IXMLExportOptions.h

//========================================================================================
// 
// $File$
// 
// Owner: Ryan Gano
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 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 __IXMLExportOptions__
#define __IXMLExportOptions__

#include "XMLID.h"
#include "IPMUnknown.h"
#include "IXMLOutStream.h"

//========================================================================================
// CLASS IXMLExportOptions
//========================================================================================
class IXMLExportOptions : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IXMLEXPORTOPTIONS };

 typedef enum ImageType {
 kImageBest = 0,
 kImageJPEG,
 kImageGIF,
 kImagePNG
 } ImageType;

 typedef enum
 {
 kJPEGBaseline = 0,
 kJPEGProgressive
 } JPEGEncoding; 

 typedef enum
 {
 kJPEGLowQuality = 0,
 kJPEGMediumQuality,
 kJPEGGoodQuality,
 kJPEGMaxQuality
 } JPEGQuality;
 
 typedef enum
 {
 kAdaptivePalette = 0, 
 kMacPalette, 
 kWebPalette,
 kWinPalette
 } PaletteType;
 
 typedef enum
 {
 kNone = 0,
 kCALS
 } UntaggedTablesFormat;

 typedef enum
 {
 kSpread,

 kItem,

 kGraphicFrame,

 kGraphicFrameWithoutStyle,
 } FrameOfReference;

 virtual bool16 GetExportFromSelected() const = 0;

 virtual void SetExportFromSelected(bool16 exportFromSelected) = 0;


 virtual IXMLOutStream::eEncodingType GetEncodingType() const = 0;

 virtual void SetEncodingType(IXMLOutStream::eEncodingType encodingType) = 0;


 virtual void EnableOptimizedImages(bool8 enable) = 0;

 virtual void EnableFormattedImages(bool8 enable) = 0;

 virtual void EnableCopyOriginals(bool8 enable) = 0;

 virtual void SetImageType(ImageType type) = 0;

 virtual void SetJPEGOptions(JPEGEncoding encode, JPEGQuality quality) = 0;

 virtual void SetGIFOptions(PaletteType palette, bool8 interlaced) = 0;
 
 
 virtual void SetPNGOptions(uint32 compressionLevel) = 0;

 virtual bool8 IsEnabledOptimizedImages(void) const = 0;

 virtual bool8 IsEnabledFormattedImages(void) const = 0;

 virtual bool8 IsEnabledCopyOriginals() const = 0;

 virtual ImageType GetImageType(void) const = 0;

 virtual void GetJPEGOptions(JPEGEncoding *encode, JPEGQuality *quality) const = 0;

 virtual void GetGIFOptions(PaletteType *palette, bool8 *interlaced) const = 0;
 
 virtual void GetPNGOptions(uint32 *compressionLevel) const = 0;
 
 virtual void SetImagePPI(const PMReal &resolution) = 0;
 
 virtual PMReal GetImagePPI() const = 0;

 virtual FrameOfReference GetFrameOfReference() const = 0;

 virtual void SetFrameOfReference(FrameOfReference x) = 0;

 virtual bool16 GetExportRuby() const = 0;

 virtual void SetExportRuby(bool16 exportRuby) = 0;

 virtual bool16 GetExcludeDTD() const = 0;

 virtual void SetExcludeDTD(bool16 excludeDTD) = 0;
 
 virtual UntaggedTablesFormat GetExportUntaggedTablesFormat() const = 0;

 virtual void SetExportUntaggedTablesFormat(UntaggedTablesFormat exportUntaggedTables) = 0;

 virtual bool16 GetRunScriptOnExport() const = 0;

 virtual void SetRunScriptOnExport(bool16 runScript) = 0;

 virtual IDFile GetXSLTScriptFileName() const = 0;

 virtual void SetXSLTScriptFileName(IDFile fileName) = 0;
 virtual bool16 GetExportCharacterReferences() const = 0;

 virtual void SetExportCharacterReferences(bool16 exportReferences) = 0;
 
 virtual void Copy(IXMLExportOptions* otherOptions) = 0;

 virtual void SetImageScale(PMReal xScale = 1.0, PMReal yScale = 1.0) = 0;

 virtual void GetImageScale(PMReal &xScale, PMReal &yScale) const = 0;

};

#endif