IObjectExportOptions.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 __IObjectExportOptions__
#define __IObjectExportOptions__

#include "GenericID.h"
#include "IXMLExportOptions.h"

class IObjectExportOptions : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IOBJECTEXPORTOPTIONS};

 typedef enum
 {
 kCustom = 0,

 kXMPTitle,

 kXMPDescription,

 kXMPHeadline,

 kXMPOther,

 kXMLStructure,

 kXMPAltText,

 kXMPExtendedDescription,

 kDecorativeImage

 } TextSourceType;

 typedef enum
 {
 kFromStructure = 0,
 kArtifact,
 kBasedOnObject
 } TagType;

 typedef enum
 {
 kFixed = 0,
 kRelative
 } ImageSize;

 typedef enum
 {
 kAlignLeft = 0, 
 kAlignCenter, 
 kAlignRight,
 } ImageAlignment;

 typedef enum
 {
 kBefore = 0, 
 kAfter,
 kBeforeAndAfter
 } ImagePageBreak;

 typedef enum
 {
 kFloatLeft = 0,
 kFloatRight,
 kAlignmentAndSpacing
 } CustomLayoutType;

 /* OBSOLETE: Do not use. Use CustomSizeType instead. */
 typedef enum
 {
 kNoneWidth = 0,
 kDefaultWidth,
 kRelativeWidth,
 kFixedWidth,
 kCustomValueWidth
 } CustomWidthType;

 /* OBSOLETE: Do not use. Use CustomSizeType instead. */
 typedef enum
 {
 kNoneHeight = 0,
 kDefaultHeight,
 kFixedHeight,
 kCustomValueHeight
 } CustomHeightType;

 typedef enum
 {
 kNoneSize = 0,
 kDefaultSize,
 kFixedSize,
 kRelativeToTextFlow,
 kRelativeToTextSize,
 kCustomValWidth,
 kCustomValHeight
 } CustomSizeType;

 virtual void SetAltTextSourceType(TextSourceType sourceType) = 0;

 virtual TextSourceType GetAltTextSourceType() const = 0;

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

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

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

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

 virtual void SetActualTextSourceType(TextSourceType sourceType) = 0;

 virtual TextSourceType GetActualTextSourceType() const = 0;

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

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

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

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

 virtual void SetTagType(TagType tagType) = 0;

 virtual TagType GetTagType() const = 0;

 virtual void SetCustomImageConversion(bool16 custom) = 0;

 virtual bool16 GetCustomImageConversion() const = 0;

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

 virtual IXMLExportOptions::ImageType GetImageType() const = 0;


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

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

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

 virtual IXMLExportOptions::JPEGEncoding GetJPEGEncoding() const = 0;

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

 virtual IXMLExportOptions::JPEGQuality GetJPEGQuality() const = 0;

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

 virtual IXMLExportOptions::PaletteType GetGIFPaletteType() const = 0;

 virtual void SetGIFInterlaced(bool16 interlaced) = 0;

 virtual bool16 GetGIFInterlaced() const = 0;

 virtual void SetCustomLayout(bool16 layout) = 0;

 virtual bool16 GetCustomLayout() const = 0;

 virtual void SetCustomLayoutType(CustomLayoutType customLayoutType) = 0;

 virtual CustomLayoutType GetCustomLayoutType() const = 0;

 virtual void SetImageAlignment(ImageAlignment align) = 0; 

 virtual ImageAlignment GetImageAlignment() const = 0; 

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

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

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

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

 virtual void SetUseImagePageBreak(bool16 use) = 0; 

 virtual bool16 GetUseImagePageBreak() const = 0; 

 virtual void SetImagePageBreak(ImagePageBreak pageBreak) = 0; 

 virtual ImagePageBreak GetImagePageBreak() const = 0; 

 virtual void CopyData(IObjectExportOptions *pCopyFrom) = 0;


 virtual bool16 GetUseOriginalImage() const = 0; 
 
 virtual void SetUseOriginalImage(bool16 useOriginalImage) = 0; 

 virtual void SetEpubType(const PMString & epubType) = 0; 

 virtual void GetEpubType(PMString & epubType) const = 0;

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

 virtual void SetCustomHeightValue(const PMString &height) = 0;

 virtual void GetCustomHeightValue(PMString &height) const = 0; 

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

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

 virtual CustomWidthType GetCustomWidthType() const = 0;

 virtual CustomHeightType GetCustomHeightType() const = 0;

 virtual void SetCustomWidthType(CustomWidthType customWidthType) = 0;

 virtual void SetCustomHeightType(CustomHeightType customHeightType) = 0;

 /* Obsolete block ends */

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

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

 virtual CustomSizeType GetCustomSizeType() const = 0;

 virtual void SetCustomSizeType(CustomSizeType customSizeType) = 0;

 virtual bool16 GetCustomContentConversion() const = 0; 

 virtual void SetCustomContentConversion(bool16 custom) = 0;
};

#endif