IObjectExportOptionsData.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 __IObjectExportOptionsData__
#define __IObjectExportOptionsData__

#include "GenericID.h"
#include "IObjectExportOptions.h"

class IObjectExportOptionsData : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IOBJECTEXPORTOPTIONSDATA};

 /* Enumerates the state of an option.
 The option's value should not be accessed if the state is "kValueNotSet" or "kValueMixed".
 */
 typedef enum
 {
 /* No value set - invalid (clients should treat as opaque). This is the default state. */
 kValueNotSet = 0,
 /* Valid value set. */
 kValueSet,
 /* The value is different across the selection. */
 kValueMixed
 } OptionState;

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

 virtual IObjectExportOptions::TextSourceType GetAltTextSourceType() const = 0;

 virtual OptionState GetAltTextSourceTypeState() const = 0;

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

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

 virtual OptionState GetCustomAltTextState() const = 0;

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

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

 virtual OptionState GetAltTextMetadataPropertyState() const = 0;

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

 virtual IObjectExportOptions::TextSourceType GetActualTextSourceType() const = 0;

 virtual OptionState GetActualTextSourceTypeState() const = 0;

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

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

 virtual OptionState GetCustomActualTextState() const = 0;

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

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

 virtual OptionState GetActualTextMetadataPropertyState() const = 0;

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

 virtual IObjectExportOptions::TagType GetTagType() const = 0;

 virtual OptionState GetTagTypeState() const = 0;

 virtual void SetCustomImageConversion(bool16 custom) = 0;

 virtual bool16 GetCustomImageConversion() const = 0;

 virtual OptionState GetCustomImageConversionState() const = 0;

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

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

 virtual OptionState GetImageTypeState() const = 0;


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

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

 virtual OptionState GetImageResolutionState() const = 0;

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

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

 virtual OptionState GetJPEGEncodingState() const = 0;

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

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

 virtual OptionState GetJPEGQualityState() const = 0;

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

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

 virtual OptionState GetGIFPaletteTypeState() const = 0;

 virtual void SetGIFInterlaced(bool16 interlaced) = 0;

 virtual bool16 GetGIFInterlaced() const = 0;

 virtual OptionState GetGIFInterlacedState() const = 0;

 virtual void SetCustomLayout(bool16 layout) = 0;

 virtual bool16 GetCustomLayout() const = 0;

 virtual OptionState GetCustomLayoutState() const = 0;

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

 virtual IObjectExportOptions::CustomLayoutType GetCustomLayoutType() const = 0;

 virtual OptionState GetCustomLayoutTypeState() const = 0;

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

 virtual IObjectExportOptions::ImageAlignment GetImageAlignment() const = 0; 

 virtual OptionState GetImageAlignmentState() const = 0;

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

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

 virtual OptionState GetImageSpaceBeforeState() const = 0; 

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

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

 virtual OptionState GetImageSpaceAfterState() const = 0; 
 
 virtual void SetUseImagePageBreak(bool16 use) = 0; 

 virtual bool16 GetUseImagePageBreak() const = 0; 

 virtual OptionState GetUseImagePageBreakState() const = 0; 

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

 virtual IObjectExportOptions::ImagePageBreak GetImagePageBreak() const = 0; 

 virtual OptionState GetImagePageBreakState() const = 0; 

 virtual void CopyData(const IObjectExportOptionsData *pCopyFrom) = 0;

 virtual void CopyOptions(const IObjectExportOptions *pCopyFrom) = 0;

 virtual void ResetState() = 0;

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

 virtual OptionState GetUseOriginalImageState() const = 0;

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

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

 virtual OptionState GetEpubTypeState() 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 OptionState GetCustomHeightValueState() const = 0;

 virtual OptionState GetCustomWidthValueState() const = 0;

 virtual OptionState GetCustomHeightTypeState() const = 0;

 virtual OptionState GetCustomWidthTypeState() const = 0;

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

 virtual IObjectExportOptions::CustomWidthType GetCustomWidthType() const = 0;

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

 virtual IObjectExportOptions::CustomHeightType GetCustomHeightType() const = 0;
 /* Obsolete block ends */

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

 virtual OptionState GetCustomSizeValueState() const = 0;

 virtual OptionState GetCustomSizeTypeState() const = 0;

 virtual void SetCustomSizeType(IObjectExportOptions::CustomSizeType CustomSizeType) = 0;

 virtual IObjectExportOptions::CustomSizeType GetCustomSizeType() const = 0;

 virtual bool16 GetCustomContentConversion() const = 0; 

 virtual void SetCustomContentConversion(bool16 custom) = 0;

 virtual OptionState GetCustomContentConversionState() const = 0;
};

#endif