#include <IObjectExportOptions.h>

Inheritance diagram for IObjectExportOptions:

Public Types
enum	{ kDefaultIID = IID_IOBJECTEXPORTOPTIONS }

enum	TextSourceType { kCustom = 0, kXMPTitle, kXMPDescription, kXMPHeadline, kXMPOther, kXMLStructure, kXMPAltText, kXMPExtendedDescription, kDecorativeImage }

enum	TagType { kFromStructure = 0, kArtifact, kBasedOnObject }

enum	ImageSize { kFixed = 0, kRelative }

enum	ImageAlignment { kAlignLeft = 0, kAlignCenter, kAlignRight }

enum	ImagePageBreak { kBefore = 0, kAfter, kBeforeAndAfter }

enum	CustomLayoutType { kFloatLeft = 0, kFloatRight, kAlignmentAndSpacing }

enum	CustomWidthType { kNoneWidth = 0, kDefaultWidth, kRelativeWidth, kFixedWidth, kCustomValueWidth }

enum	CustomHeightType { kNoneHeight = 0, kDefaultHeight, kFixedHeight, kCustomValueHeight }

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

Public Member Functions
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

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

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

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.

Member Enumeration Documentation

enum IObjectExportOptions::CustomHeightType

Enumerator
kNoneHeight	Height none.
kDefaultHeight	Height default.
kFixedHeight	Height fixed.
kCustomValueHeight	Height set to custom value.

enum IObjectExportOptions::CustomLayoutType

Enumerator
kFloatLeft	Float left.
kFloatRight	Float right.
kAlignmentAndSpacing	Custom alignment and spacing.

enum IObjectExportOptions::CustomSizeType

Enumerator
kNoneSize	Size none.
kDefaultSize	Size default.
kFixedSize	Size fixed.
kRelativeToTextFlow	Size relative to text flow.
kRelativeToTextSize	Size relative to text Size.
kCustomValWidth	Width set to custom value.
kCustomValHeight	Height set to custom value.

enum IObjectExportOptions::CustomWidthType

Enumerator
kNoneWidth	Width none.
kDefaultWidth	Width default.
kRelativeWidth	Size relative to text flow.
kFixedWidth	Width fixed.
kCustomValueWidth	Width set to custom value.

enum IObjectExportOptions::ImageAlignment

Enumerator
kAlignLeft	Image will be aligned left.
kAlignCenter	Image will be aligned center.
kAlignRight	Image will be aligned right.

enum IObjectExportOptions::ImagePageBreak

Enumerator
kBefore	Page Break before image.
kAfter	Page Break after image.
kBeforeAndAfter	Page Break before and after image.

enum IObjectExportOptions::ImageSize

Enumerator
kFixed	Fixed size.
kRelative	Size relative to page width.

enum IObjectExportOptions::TagType

Enumerator
kFromStructure	Determine the tag from XML structure, or fallback to standard tag.
kArtifact	Tag as artifact.
kBasedOnObject	Apply standard tag (based on object type).

enum IObjectExportOptions::TextSourceType

Enumerator
kCustom	User entered alt/actual text.
kXMPTitle	Alt/actual text obtained from object's dc:title metadata.
kXMPDescription	Alt/actual text obtained from object's dc:description metadata.
kXMPHeadline	Alt/actual text obtained from object's photoshop:Headline metadata.
kXMPOther	Alt/actual text obtained from object's user specified metadata property.
kXMLStructure	Alt/actual text associated through XML structure.
kXMPAltText	Alt/actual text obtained from object's Iptc4xmpCore:AltTextAccessibility metadata.
kXMPExtendedDescription	Alt/actual text obtained from object's Iptc4xmpCore:ExtDescrAccessibility metadata.
kDecorativeImage	Decorative Image :No Alt Text for Accessibility metadata.

Member Function Documentation

virtual void IObjectExportOptions::CopyData ( IObjectExportOptions * pCopyFrom )

pure virtual

Copy data from pCopyFrom to the current instance.

Parameters

pCopyFrom IN instance to copy from

virtual void IObjectExportOptions::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 TextSourceType IObjectExportOptions::GetActualTextSourceType ( ) const

pure virtual

Get actual text source type.

Returns: TextSourceType: the actual text source type

virtual void IObjectExportOptions::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 TextSourceType IObjectExportOptions::GetAltTextSourceType ( ) const

pure virtual

Get alternate text source type.

Returns: TextSourceType: the alternate text source type

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

pure virtual

Get custom actual text.

Parameters

customText OUT the custom actual text

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

pure virtual

Get custom alternate text.

Parameters

customText OUT the cutom alternate text

virtual bool16 IObjectExportOptions::GetCustomContentConversion ( ) const

pure virtual

Get custom content conversion preference.

Returns: bool16: whether to do custom conversion or not

virtual CustomHeightType IObjectExportOptions::GetCustomHeightType ( ) const

pure virtual

Get height type.

Returns: CustomHeightType: height type.

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

pure virtual

Get the value of custom height.

Returns: height: custom height value.

virtual bool16 IObjectExportOptions::GetCustomImageConversion ( ) const

pure virtual

Get custom image conversion preference.

Returns: bool16: whether to do custom conversion or not

virtual bool16 IObjectExportOptions::GetCustomLayout ( ) const

pure virtual

Get custom layout.

Returns: bool16: whether to do custom layout or not

virtual CustomLayoutType IObjectExportOptions::GetCustomLayoutType ( ) const

pure virtual

Get custom layout type.

Returns: CustomLayoutType: type of custom layout

virtual CustomSizeType IObjectExportOptions::GetCustomSizeType ( ) const

pure virtual

Get size type.

Returns: CustomSizeType: size type.

virtual void IObjectExportOptions::GetCustomSizeValue ( PMString & sizeString ) const

pure virtual

Get the value of custom sizeString.

Returns: sizeString: custom width value.

virtual CustomWidthType IObjectExportOptions::GetCustomWidthType ( ) const

pure virtual

Get width type.

Returns: CustomWidthType: width type.

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

pure virtual

Get the value of custom width.

Returns: width: custom width value.

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

pure virtual

Get epub type.

Returns: PMString: the epub type

virtual bool16 IObjectExportOptions::GetGIFInterlaced ( ) const

pure virtual

Get gif interlaced option.

Returns: bool16: whether to create interlaced GIF

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

pure virtual

Get gif palette type.

Returns: IXMLExportOptions::PaletteType: kind of GIF palette to create

virtual ImageAlignment IObjectExportOptions::GetImageAlignment ( ) const

pure virtual

Get image alignment option.

Returns: ImageAlignment: kind of image alignment.

virtual ImagePageBreak IObjectExportOptions::GetImagePageBreak ( ) const

pure virtual

Get image page break.

Returns: ImagePageBreak: image page break.

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

pure virtual

Get image resolution.

Parameters

resolution OUT the resolution value

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

pure virtual

Get image space after.

Returns: PMReal: the space after

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

pure virtual

Get image space before.

Returns: PMReal: the space before

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

pure virtual

Get image conversion type.

Returns: IXMLExportOptions::ImageType: image conversion format

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

pure virtual

Get jpeg encoding option.

Returns: IXMLExportOptions::JPEGEncoding: JPEG encoding scheme

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

pure virtual

Get jpeg quality.

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

virtual TagType IObjectExportOptions::GetTagType ( ) const

pure virtual

Get tag type.

Returns: TagType: the tag type

virtual bool16 IObjectExportOptions::GetUseImagePageBreak ( ) const

pure virtual

Get use image page break.

Returns: bool16: use image page break.

virtual bool16 IObjectExportOptions::GetUseOriginalImage ( ) const

pure virtual

Get use original image preference.

Returns: bool16: whether to use original image or not

virtual void IObjectExportOptions::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 IObjectExportOptions::SetActualTextSourceType ( TextSourceType sourceType )

pure virtual

Set actual text source type.

Parameters

sourceType IN the actual text source type

virtual void IObjectExportOptions::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 IObjectExportOptions::SetAltTextSourceType ( TextSourceType sourceType )

pure virtual

Set alternate text source type.

Parameters

sourceType IN the alternate text source type

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

pure virtual

Set custom actual text.

Parameters

customText IN the custom actual text

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

pure virtual

Set custom alternate text.

Parameters

customText IN the custom alternate text

virtual void IObjectExportOptions::SetCustomContentConversion ( bool16 custom )

pure virtual

Set custom content conversion preference.

Parameters

custom IN whether to do custom conversion or not

virtual void IObjectExportOptions::SetCustomHeightType ( CustomHeightType customHeightType )

pure virtual

Set height type

Parameters

customHeightType IN to set height type.

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

pure virtual

Set the value of custom height.

Parameters

height IN to set the value of custom height.

virtual void IObjectExportOptions::SetCustomImageConversion ( bool16 custom )

pure virtual

Set custom image conversion preference.

Parameters

custom IN whether to do custom conversion or not

virtual void IObjectExportOptions::SetCustomLayout ( bool16 layout )

pure virtual

Set custom layout.

Parameters

layout IN whether to do custom layout or not

virtual void IObjectExportOptions::SetCustomLayoutType ( CustomLayoutType customLayoutType )

pure virtual

Set custom layout type.

Parameters

customLayoutType IN kind of custom layout type

virtual void IObjectExportOptions::SetCustomSizeType ( CustomSizeType customSizeType )

pure virtual

Set size type.

Parameters

customSizeType IN to set size type.

virtual void IObjectExportOptions::SetCustomSizeValue ( const PMString & sizeString )

pure virtual

Set the value of custom size.

Parameters

Size	IN to set the value of size.

virtual void IObjectExportOptions::SetCustomWidthType ( CustomWidthType customWidthType )

pure virtual

Set width type

Parameters

customWidthType IN to set width type.

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

pure virtual

Set the value of custom width.

Parameters

width IN to set the value of width.

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

pure virtual

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

Parameters

epubType IN epub type

virtual void IObjectExportOptions::SetGIFInterlaced ( bool16 interlaced )

pure virtual

Set gif interlaced option.

Parameters

interlaced IN whether to create interlaced GIF

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

pure virtual

Set gif palette type.

Parameters

palette IN kind of GIF palette to create

virtual void IObjectExportOptions::SetImageAlignment ( ImageAlignment align )

pure virtual

Set image alignment option.

Parameters

align IN kind of image alignment.

virtual void IObjectExportOptions::SetImagePageBreak ( ImagePageBreak pageBreak )

pure virtual

Set image page break.

Parameters

pageBreak IN image page break.

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

pure virtual

Set image resolution.

Parameters

resolution IN the resolution value

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

pure virtual

Set image space after.

Parameters

before IN the space after

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

pure virtual

Set image space before.

Parameters

before IN the space before

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

pure virtual

Set image conversion type.

Parameters

type	IN image conversion format

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

pure virtual

Set jpeg encoding option.

Parameters

encoding IN JPEG encoding scheme to choose

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

pure virtual

Set jpeg quality.

Parameters

quality IN quality level to use for exported JPEG

virtual void IObjectExportOptions::SetTagType ( TagType tagType )

pure virtual

Set tag type.

Parameters

tagType IN the tag type

virtual void IObjectExportOptions::SetUseImagePageBreak ( bool16 use )

pure virtual

Set use image page break.

Parameters

use	IN use image page break.

virtual void IObjectExportOptions::SetUseOriginalImage ( bool16 useOriginalImage )

pure virtual

Set the use original image preference.

Parameters

useOriginalImage IN whether to use original image or not

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation