IObjectExportOptionsData Class Reference

#include <IObjectExportOptionsData.h>

Inheritance diagram for IObjectExportOptionsData:

Public Types
enum	{ kDefaultIID = IID_IOBJECTEXPORTOPTIONSDATA }
enum	OptionState { kValueNotSet = 0, kValueSet, kValueMixed }

Public Member Functions
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
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
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface for export options associated with an object. Also maintains a state value for with each export option.

Member Function Documentation

virtual void IObjectExportOptionsData::CopyData ( const IObjectExportOptionsData *  pCopyFrom )

pure virtual

Copy data from an instance of the same interface to this instance.

Parameters

pCopyFrom

IN instance to copy from

virtual void IObjectExportOptionsData::CopyOptions ( const IObjectExportOptions *  pCopyFrom )

pure virtual

Copy data from an instance of IObjectExportOptions to this instance.

Parameters

pCopyFrom

IN instance to copy from

virtual void IObjectExportOptionsData::GetActualTextMetadataProperty ( PMString &  nsPrefix, PMString &  propertyPath  ) const

pure virtual

Get actual text metadata property.

Parameters

nsPrefix	OUT the xmp schema namespace prefix
propertyPath	OUT the xmp property path

virtual OptionState IObjectExportOptionsData::GetActualTextMetadataPropertyState ( ) const

pure virtual

Get actual text metadata property state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::TextSourceType IObjectExportOptionsData::GetActualTextSourceType ( ) const

pure virtual

Get actual text source type.

Returns

IObjectExportOptions::TextSourceType the actual text source type

virtual OptionState IObjectExportOptionsData::GetActualTextSourceTypeState ( ) const

pure virtual

Get actual text source type state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::GetAltTextMetadataProperty ( PMString &  nsPrefix, PMString &  propertyPath  ) const

pure virtual

Get alt text metadata property.

Parameters

nsPrefix	OUT the xmp schema namespace prefix
propertyPath	OUT the xmp property path

virtual OptionState IObjectExportOptionsData::GetAltTextMetadataPropertyState ( ) const

pure virtual

Get alt text metadata property state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::TextSourceType IObjectExportOptionsData::GetAltTextSourceType ( ) const

pure virtual

Get alternate text source type.

Returns

IObjectExportOptions::TextSourceType the alternate text source type

virtual OptionState IObjectExportOptionsData::GetAltTextSourceTypeState ( ) const

pure virtual

Get alternate text source type state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::GetCustomActualText ( PMString &  customText ) const

pure virtual

Get custom actual text.

Parameters

customText

OUT the custom actual text

virtual OptionState IObjectExportOptionsData::GetCustomActualTextState ( ) const

pure virtual

Get custom actual text state.

Returns

OptionState: the current state

virtual void IObjectExportOptionsData::GetCustomAltText ( PMString &  customText ) const

pure virtual

Get custom alternate text.

Parameters

customText

OUT the custom alternate text

virtual OptionState IObjectExportOptionsData::GetCustomAltTextState ( ) const

pure virtual

Get custom alternate text state.

Returns

OptionState: the current state of the option

virtual bool16 IObjectExportOptionsData::GetCustomContentConversion ( ) const

pure virtual

Get custom content conversion preference.

Returns

bool16: whether to do custom conversion or not

virtual OptionState IObjectExportOptionsData::GetCustomContentConversionState ( ) const

pure virtual

Get custom content conversion preference state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::CustomHeightType IObjectExportOptionsData::GetCustomHeightType ( ) const

pure virtual

Get height type.

Returns

CustomHeightType: height type.

virtual OptionState IObjectExportOptionsData::GetCustomHeightTypeState ( ) const

pure virtual

Get state of height type.

Returns

OptionState: current state of height type.

virtual void IObjectExportOptionsData::GetCustomHeightValue ( PMString &  height ) const

pure virtual

Get the value of custom height.

Returns

height: custom height value.

virtual OptionState IObjectExportOptionsData::GetCustomHeightValueState ( ) const

pure virtual

Get state of custom height value.

Returns

OptionState: current state of custom height value.

virtual bool16 IObjectExportOptionsData::GetCustomImageConversion ( ) const

pure virtual

Get custom image conversion preference.

Returns

bool16: whether to do custom conversion or not

virtual OptionState IObjectExportOptionsData::GetCustomImageConversionState ( ) const

pure virtual

Get custom image conversion state.

Returns

OptionState: the current state of the option

virtual bool16 IObjectExportOptionsData::GetCustomLayout ( ) const

pure virtual

Get custom layout.

Returns

bool16: whether to do custom layout or not

virtual OptionState IObjectExportOptionsData::GetCustomLayoutState ( ) const

pure virtual

Get custom layout state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::CustomLayoutType IObjectExportOptionsData::GetCustomLayoutType ( ) const

pure virtual

Get custom layout type.

Returns

CustomLayoutType: the type of custom layout

virtual OptionState IObjectExportOptionsData::GetCustomLayoutTypeState ( ) const

pure virtual

Get custom layout type state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::CustomSizeType IObjectExportOptionsData::GetCustomSizeType ( ) const

pure virtual

Get size type.

Returns

CustomSizeType: size type.

virtual OptionState IObjectExportOptionsData::GetCustomSizeTypeState ( ) const

pure virtual

Get state of size type.

Returns

OptionState: current state of size type.

virtual void IObjectExportOptionsData::GetCustomSizeValue ( PMString &  size ) const

pure virtual

Get value of custom size.

Returns

size: custom size value.

virtual OptionState IObjectExportOptionsData::GetCustomSizeValueState ( ) const

pure virtual

Get state of custom size value.

Returns

OptionState: current state of custom size value.

virtual IObjectExportOptions::CustomWidthType IObjectExportOptionsData::GetCustomWidthType ( ) const

pure virtual

Get width type.

Returns

CustomWidthType: width type.

virtual OptionState IObjectExportOptionsData::GetCustomWidthTypeState ( ) const

pure virtual

Get state of width type.

Returns

OptionState: current state of width type.

virtual void IObjectExportOptionsData::GetCustomWidthValue ( PMString &  width ) const

pure virtual

Get value of custom width.

Returns

width: custom width value.

virtual OptionState IObjectExportOptionsData::GetCustomWidthValueState ( ) const

pure virtual

Get state of custom width value.

Returns

OptionState: current state of custom width value.

virtual void IObjectExportOptionsData::GetEpubType ( PMString &  epubType ) const

pure virtual

Get epub type.

Returns

PMString: epub type

virtual OptionState IObjectExportOptionsData::GetEpubTypeState ( ) const

pure virtual

Get epub type state.

Returns

OptionState: the current state of the option

virtual bool16 IObjectExportOptionsData::GetGIFInterlaced ( ) const

pure virtual

Get gif interlaced option.

Returns

bool16: whether to create interlaced GIF

virtual OptionState IObjectExportOptionsData::GetGIFInterlacedState ( ) const

pure virtual

Get gif interlaced option state.

Returns

OptionState: the current state of the option

virtual IXMLExportOptions::PaletteType IObjectExportOptionsData::GetGIFPaletteType ( ) const

pure virtual

Get gif palette type.

Returns

IXMLExportOptions::PaletteType: kind of GIF palette to create

virtual OptionState IObjectExportOptionsData::GetGIFPaletteTypeState ( ) const

pure virtual

Get gif palette type state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::ImageAlignment IObjectExportOptionsData::GetImageAlignment ( ) const

pure virtual

Get image alignment option.

Returns

ImageAlignment: kind of image alignment.

virtual OptionState IObjectExportOptionsData::GetImageAlignmentState ( ) const

pure virtual

Get image alignment option state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::ImagePageBreak IObjectExportOptionsData::GetImagePageBreak ( ) const

pure virtual

Get image page break.

Returns

ImagePageBreak: image page break.

virtual OptionState IObjectExportOptionsData::GetImagePageBreakState ( ) const

pure virtual

Get image page break state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::GetImageResolution ( PMReal &  resolution ) const

pure virtual

Get image resolution.

Parameters

resolution

OUT the resolution value

virtual OptionState IObjectExportOptionsData::GetImageResolutionState ( ) const

pure virtual

Get image resolution state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::GetImageSpaceAfter ( PMReal &  after ) const

pure virtual

Get image space after.

Returns

PMReal: the space after

virtual OptionState IObjectExportOptionsData::GetImageSpaceAfterState ( ) const

pure virtual

Get image space after state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::GetImageSpaceBefore ( PMReal &  before ) const

pure virtual

Get image space before.

Returns

PMReal: the space before

virtual OptionState IObjectExportOptionsData::GetImageSpaceBeforeState ( ) const

pure virtual

Get image space before state.

Returns

OptionState: the current state of the option

virtual IXMLExportOptions::ImageType IObjectExportOptionsData::GetImageType ( ) const

pure virtual

Get image conversion type.

Returns

IXMLExportOptions::ImageType: image conversion format

virtual OptionState IObjectExportOptionsData::GetImageTypeState ( ) const

pure virtual

Get image conversion type state.

Returns

OptionState: the current state of the option

virtual IXMLExportOptions::JPEGEncoding IObjectExportOptionsData::GetJPEGEncoding ( ) const

pure virtual

Get jpeg encoding option.

Returns

IXMLExportOptions::JPEGEncoding: JPEG encoding scheme

virtual OptionState IObjectExportOptionsData::GetJPEGEncodingState ( ) const

pure virtual

Get jpeg encoding option state.

Returns

OptionState: the current state of the option

virtual IXMLExportOptions::JPEGQuality IObjectExportOptionsData::GetJPEGQuality ( ) const

pure virtual

Get jpeg quality.

Returns

IXMLExportOptions::JPEGQuality: quality level to use for exported JPEG

virtual OptionState IObjectExportOptionsData::GetJPEGQualityState ( ) const

pure virtual

Get jpeg quality state.

Returns

OptionState: the current state of the option

virtual IObjectExportOptions::TagType IObjectExportOptionsData::GetTagType ( ) const

pure virtual

Get tag type.

Returns

IObjectExportOptions::TagType: the tag type

virtual OptionState IObjectExportOptionsData::GetTagTypeState ( ) const

pure virtual

Get tag type state.

Returns

OptionState: the current state of the option

virtual bool16 IObjectExportOptionsData::GetUseImagePageBreak ( ) const

pure virtual

Get use image page break.

Returns

bool16: use image page break.

virtual OptionState IObjectExportOptionsData::GetUseImagePageBreakState ( ) const

pure virtual

Get use image page break state.

Returns

OptionState: the current state of the option

virtual bool16 IObjectExportOptionsData::GetUseOriginalImage ( ) const

pure virtual

Get use original image preference.

Returns

bool16: whether to use original image or not

virtual OptionState IObjectExportOptionsData::GetUseOriginalImageState ( ) const

pure virtual

Get use original image state.

Returns

OptionState: the current state of the option

virtual void IObjectExportOptionsData::ResetState ( )

pure virtual

Resets the state of all options to kValueNotSet.

virtual void IObjectExportOptionsData::SetActualTextMetadataProperty ( const PMString &  nsPrefix, const PMString &  propertyPath  )

pure virtual

Set actual text metadata property.

Parameters

nsPrefix	IN the xmp schema namespace prefix
propertyPath	IN the xmp property path

virtual void IObjectExportOptionsData::SetActualTextSourceType ( IObjectExportOptions::TextSourceType  sourceType )

pure virtual

Set actual text source type.

Parameters

sourceType

IN the actual text source type

virtual void IObjectExportOptionsData::SetAltTextMetadataProperty ( const PMString &  nsPrefix, const PMString &  propertyPath  )

pure virtual

Set alt text metadata property.

Parameters

nsPrefix	IN the xmp schema namespace prefix
propertyPath	IN the xmp property path

virtual void IObjectExportOptionsData::SetAltTextSourceType ( IObjectExportOptions::TextSourceType  sourceType )

pure virtual

Set alternate text source type.

Parameters

sourceType

IN the alternate text source type

virtual void IObjectExportOptionsData::SetCustomActualText ( const PMString &  customText )

pure virtual

Set custom actual text.

Parameters

customText

IN the custom actual text

virtual void IObjectExportOptionsData::SetCustomAltText ( const PMString &  customText )

pure virtual

Set custom alternate text.

Parameters

customText

IN the custom alternate text

virtual void IObjectExportOptionsData::SetCustomContentConversion ( bool16  custom )

pure virtual

Set custom content conversion preference.

Parameters

custom

IN whether to do custom conversion or not

virtual void IObjectExportOptionsData::SetCustomHeightType ( IObjectExportOptions::CustomHeightType  customHeightType )

pure virtual

Set height type

Parameters

customHeightType

IN to set height type.

virtual void IObjectExportOptionsData::SetCustomHeightValue ( const PMString &  height )

pure virtual

Set value of custom height.

Parameters

height

IN to set custom height value.

virtual void IObjectExportOptionsData::SetCustomImageConversion ( bool16  custom )

pure virtual

Set custom image conversion preference.

Parameters

custom

IN whether to do custom conversion or not

virtual void IObjectExportOptionsData::SetCustomLayout ( bool16  layout )

pure virtual

Set custom layout.

Parameters

layout

IN whether to do custom layout or not

virtual void IObjectExportOptionsData::SetCustomLayoutType ( IObjectExportOptions::CustomLayoutType  customLayoutType )

pure virtual

Set custom layout type.

Parameters

customLayoutType

IN kind of custom layout

virtual void IObjectExportOptionsData::SetCustomSizeType ( IObjectExportOptions::CustomSizeType  CustomSizeType )

pure virtual

Set size type

Parameters

CustomSizeType

IN to set size type.

virtual void IObjectExportOptionsData::SetCustomWidthType ( IObjectExportOptions::CustomWidthType  customWidthType )

pure virtual

Set width type

Parameters

customWidthType

IN to set width type.

virtual void IObjectExportOptionsData::SetCustomWidthValue ( const PMString &  width )

pure virtual

Set value of custom width.

Parameters

width

IN to set custom width value.

virtual void IObjectExportOptionsData::SetEpubType ( const PMString &  epubType )

pure virtual

Set the epub type. The list of valid epub types are in http://www.idpf.org/epub/vocab/structure/# .

Parameters

epubType

IN to set epub type

virtual void IObjectExportOptionsData::SetGIFInterlaced ( bool16  interlaced )

pure virtual

Set gif interlaced option.

Parameters

interlaced

IN whether to create interlaced GIF

virtual void IObjectExportOptionsData::SetGIFPaletteType ( IXMLExportOptions::PaletteType  palette )

pure virtual

Set gif palette type.

Parameters

palette

IN kind of GIF palette to create

virtual void IObjectExportOptionsData::SetImageAlignment ( IObjectExportOptions::ImageAlignment  align )

pure virtual

Set image alignment option.

Parameters

align

IN kind of image alignment.

virtual void IObjectExportOptionsData::SetImagePageBreak ( IObjectExportOptions::ImagePageBreak  pageBreak )

pure virtual

Set image page break.

Parameters

pageBreak

IN image page break.

virtual void IObjectExportOptionsData::SetImageResolution ( const PMReal &  resolution )

pure virtual

Set image resolution.

Parameters

resolution

IN the resolution value

virtual void IObjectExportOptionsData::SetImageSpaceAfter ( const PMReal &  after )

pure virtual

Set image space after.

Parameters

before

IN the space after

virtual void IObjectExportOptionsData::SetImageSpaceBefore ( const PMReal &  before )

pure virtual

Set image space before.

Parameters

before

IN the space before

virtual void IObjectExportOptionsData::SetImageType ( IXMLExportOptions::ImageType  type )

pure virtual

Set image conversion type.

Parameters

type	IN image conversion format

virtual void IObjectExportOptionsData::SetJPEGEncoding ( IXMLExportOptions::JPEGEncoding  encoding )

pure virtual

Set jpeg encoding option.

Parameters

encoding

IN JPEG encoding scheme to choose

virtual void IObjectExportOptionsData::SetJPEGQuality ( IXMLExportOptions::JPEGQuality  quality )

pure virtual

Set jpeg quality.

Parameters

quality

IN quality level to use for exported JPEG

virtual void IObjectExportOptionsData::SetTagType ( IObjectExportOptions::TagType  tagType )

pure virtual

Set tag type.

Parameters

tagType

IN the tag type

virtual void IObjectExportOptionsData::SetUseImagePageBreak ( bool16  use )

pure virtual

Set use image page break.

Parameters

use	IN use image page break.

virtual void IObjectExportOptionsData::SetUseOriginalImage ( bool16  useOriginalImage )

pure virtual

Set the use original image preference.

Parameters

useOriginalImage

IN whether to use original image or not