IObjectExportOptionsSuite.h

//========================================================================================
// 
// $File$ 
// 
// Owner: Mainak Ghosh 
// 
// $Author$ 
// 
// $DateTime$ 
// 
// $Revision$ 
// 
// $Change$ 
// 
// ADOBE CONFIDENTIAL 
// 
// Copyright 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 __IObjectExportOptionSuite__
#define __IObjectExportOptionSuite__

#include "GenericID.h"
#include "IObjectExportOptionsData.h"
#include "ISVGExportOptionsData.h"

class IObjectExportOptionsSuite : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IOBJECTEXPORTOPTIONSSUITE};

 virtual bool16 CanApplyObjectExportOptions(void) const = 0;

 virtual void GetObjectExportOptions(IObjectExportOptionsData *objExpOptsData) const = 0;
 
 virtual bool16 CanApplySVGExportOptions(void) const = 0;
 
 virtual void GetSVGExportOptions(ISVGExportOptionsData *svgExpOptsData) const = 0;


 virtual void ApplyAltTextSourceType(IObjectExportOptions::TextSourceType sourceType) = 0;

 virtual void ApplyCustomAltText(const PMString& customText) = 0;

 virtual void ApplyAltTextMetadataProperty(const PMString& nsPrefix, const PMString& propertyPath) = 0;

 virtual void ApplyActualTextSourceType(IObjectExportOptions::TextSourceType sourceType) = 0;

 virtual void ApplyCustomActualText(const PMString& customText) = 0;

 virtual void ApplyActualTextMetadataProperty(const PMString& nsPrefix, const PMString& propertyPath) = 0;

 virtual void ApplyTagType(IObjectExportOptions::TagType tagType) = 0;

 virtual void ApplyCustomImageConversion(bool16 custom) = 0;

 virtual void ApplyImageType(IXMLExportOptions::ImageType type) = 0;


 virtual void ApplyImageResolution(const PMReal &resolution) = 0;

 virtual void ApplyJPEGEncoding(IXMLExportOptions::JPEGEncoding encoding) = 0;

 virtual void ApplyJPEGQuality(IXMLExportOptions::JPEGQuality quality) = 0;

 virtual void ApplyGIFPaletteType(IXMLExportOptions::PaletteType palette) = 0;

 virtual void ApplyGIFInterlaced(bool16 interlaced) = 0;

 virtual void ApplyCustomLayout(bool16 layout) = 0;

 virtual void ApplyCustomLayoutType(IObjectExportOptions::CustomLayoutType customLayoutType) = 0;

 virtual void ApplyImageAlignment(IObjectExportOptions::ImageAlignment align) = 0;

 virtual void ApplyImageSpaceBefore(const PMReal &before) = 0;

 virtual void ApplyImageSpaceAfter(const PMReal &after) = 0;

 virtual void ApplyUseImagePageBreak(bool16 usePageBreak) = 0;

 virtual void ApplyImagePageBreak(IObjectExportOptions::ImagePageBreak pageBreak) = 0;

 virtual ErrorCode GetTextFromStructure(bool16 alt, PMString &structureText) const = 0;

 virtual ErrorCode GetTextFromMetadata(const PMString &nsPrefix, const PMString &propertyPath, PMString &metadataText) const = 0;

 virtual void ApplyUseOriginalImage(bool16 useOriginal) = 0;

 virtual void ApplyEpubType(const PMString &eType) = 0;

 /* OBSOLETE: Do not use. Use CustomSizeType based APIs instead. */
 /* Obsolete block starts */

 virtual void ApplyCustomWidthType(IObjectExportOptions::CustomWidthType customWidthType) = 0;

 virtual void ApplyCustomHeightType(IObjectExportOptions::CustomHeightType customHeightType) = 0;

 virtual void ApplyCustomWidth(const PMString &width) = 0; 

 virtual void ApplyCustomHeight(const PMString &height) = 0; 
 /* Obsolete block ends */


 virtual void ApplyCustomSizeType(IObjectExportOptions::CustomSizeType customSizeType) = 0;

 virtual void ApplyCustomSize(const PMString &sizeString) = 0; 

 virtual void ApplyCustomContentConversion(bool16 custom) = 0;
 
 virtual void ApplySVGExportType(ISVGAttributes::EPubExportSVGStrategy type) = 0;
 
 virtual void ApplyOnAllSVGs(bool16 value, ISVGAttributes::EPubExportSVGStrategy type) = 0;
};

#endif