#include <IObjectExportOptionsSuite.h>

Inheritance diagram for IObjectExportOptionsSuite:

Public Types
enum	{ kDefaultIID = IID_IOBJECTEXPORTOPTIONSSUITE }

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

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

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

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

IID_IOBJECTEXPORTOPTIONSUITE interface; this interface involves selections; There will be an implementation on the ASB which is referred to as the integrator, and different selection format such as Layout implement their own CSB; when client code ask for a method, it check current selection and let each selection CSB do their own work.

Member Function Documentation

virtual void IObjectExportOptionsSuite::ApplyActualTextMetadataProperty	(	const PMString &	nsPrefix,
		const PMString &	propertyPath
	)

pure virtual

Applies the actual text metadata property export option to the selection.

Parameters

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

virtual void IObjectExportOptionsSuite::ApplyActualTextSourceType ( IObjectExportOptions::TextSourceType sourceType )

pure virtual

Applies the actual text source type export option to the selection.

Parameters

sourceType IN the actual text source type

virtual void IObjectExportOptionsSuite::ApplyAltTextMetadataProperty	(	const PMString &	nsPrefix,
		const PMString &	propertyPath
	)

pure virtual

Applies the alternate text metadata property export option to the selection.

Parameters

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

virtual void IObjectExportOptionsSuite::ApplyAltTextSourceType ( IObjectExportOptions::TextSourceType sourceType )

pure virtual

Applies the alternate text source type export option to the selection.

Parameters

sourceType IN the alternate text source type

virtual void IObjectExportOptionsSuite::ApplyCustomActualText ( const PMString & customText )

pure virtual

Applies custom actual text export option to the selection.

Parameters

customText IN the custom actual text

virtual void IObjectExportOptionsSuite::ApplyCustomAltText ( const PMString & customText )

pure virtual

Applies custom alternate text export option to the selection.

Parameters

customText IN the custom alternate text

virtual void IObjectExportOptionsSuite::ApplyCustomContentConversion ( bool16 custom )

pure virtual

Applies the custom content rasterization option to the selection.

Parameters

custom IN whether to rasterize content or not

virtual void IObjectExportOptionsSuite::ApplyCustomHeight ( const PMString & height )

pure virtual

Applies custom height value to the selection.

Parameters

height IN the custom height.

virtual void IObjectExportOptionsSuite::ApplyCustomHeightType ( IObjectExportOptions::CustomHeightType customHeightType )

pure virtual

Applies custom height type export option to the selection.

Parameters

customHeightType IN the custom height type.

virtual void IObjectExportOptionsSuite::ApplyCustomImageConversion ( bool16 custom )

pure virtual

Applies the custom image conversion export option to the selection.

Parameters

custom IN whether to do custom conversion or not

virtual void IObjectExportOptionsSuite::ApplyCustomLayout ( bool16 layout )

pure virtual

Applies the custom layout export option to the selection.

Parameters

layout IN whether to use custom layout or not

virtual void IObjectExportOptionsSuite::ApplyCustomLayoutType ( IObjectExportOptions::CustomLayoutType customLayoutType )

pure virtual

Applies the custom layout type export option to the selection.

Parameters

customLayoutType IN type of custom layout to be used

virtual void IObjectExportOptionsSuite::ApplyCustomSize ( const PMString & sizeString )

pure virtual

Applies custom size string to the selection.

Parameters

sizeString IN the custom string.

virtual void IObjectExportOptionsSuite::ApplyCustomSizeType ( IObjectExportOptions::CustomSizeType customSizeType )

pure virtual

Applies custom Size type export option to the selection.

Parameters

customSizeType IN the custom Size type.

virtual void IObjectExportOptionsSuite::ApplyCustomWidth ( const PMString & width )

pure virtual

Applies custom width value to the selection.

Parameters

width IN the custom width.

virtual void IObjectExportOptionsSuite::ApplyCustomWidthType ( IObjectExportOptions::CustomWidthType customWidthType )

pure virtual

Applies custom width type export option to the selection.

Parameters

customWidthType IN the custom width type.

virtual void IObjectExportOptionsSuite::ApplyEpubType ( const PMString & eType )

pure virtual

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

Parameters

eType IN the epub type to set

virtual void IObjectExportOptionsSuite::ApplyGIFInterlaced ( bool16 interlaced )

pure virtual

Applies the gif interlaced export option to the selection.

Parameters

interlaced IN whether to create interlaced GIF

virtual void IObjectExportOptionsSuite::ApplyGIFPaletteType ( IXMLExportOptions::PaletteType palette )

pure virtual

Applies the gif palette type export option to the selection.

Parameters

palette IN kind of GIF palette to create

virtual void IObjectExportOptionsSuite::ApplyImageAlignment ( IObjectExportOptions::ImageAlignment align )

pure virtual

Applies the image alignment export option to the selection.

Parameters

align IN the alignment type

virtual void IObjectExportOptionsSuite::ApplyImagePageBreak ( IObjectExportOptions::ImagePageBreak pageBreak )

pure virtual

Applies the image page break export option to the selection.

Parameters

pageBreak IN the page break to apply

virtual void IObjectExportOptionsSuite::ApplyImageResolution ( const PMReal & resolution )

pure virtual

Applies the image resolution export option to the selection.

Parameters

resolution IN the resolution value

virtual void IObjectExportOptionsSuite::ApplyImageSpaceAfter ( const PMReal & after )

pure virtual

Applies the image space after export option to the selection.

Parameters

after IN the image space after value

virtual void IObjectExportOptionsSuite::ApplyImageSpaceBefore ( const PMReal & before )

pure virtual

Applies image space before export option to the selection.

Parameters

before IN the image space before value

virtual void IObjectExportOptionsSuite::ApplyImageType ( IXMLExportOptions::ImageType type )

pure virtual

Applies the image type export option to the selection.

Parameters

type	IN image conversion format

virtual void IObjectExportOptionsSuite::ApplyJPEGEncoding ( IXMLExportOptions::JPEGEncoding encoding )

pure virtual

Applies the jpeg encoding export option to the selection.

Parameters

encoding IN JPEG encoding scheme to choose

virtual void IObjectExportOptionsSuite::ApplyJPEGQuality ( IXMLExportOptions::JPEGQuality quality )

pure virtual

Applies the jpeg quality export option to the selection.

Parameters

quality IN quality level to use for exported JPEG

virtual void IObjectExportOptionsSuite::ApplyOnAllSVGs	(	bool16	value,
		ISVGAttributes::EPubExportSVGStrategy	type
	)

pure virtual

Sets the document preferences, type of SVG export, and whether the type needs to be applied to all current and incoming SVGs. Also, applies the export preference to all existing SVGs.

Parameters

value	IN whether to apply the input SVG export type to all SVGs in document.
type	IN the SVG Export type.

virtual void IObjectExportOptionsSuite::ApplySVGExportType ( ISVGAttributes::EPubExportSVGStrategy type )

pure virtual

Applies the SVG Export type i.e. embed code or object tags to the selection.

Parameters

type	IN the SVG Export type.

virtual void IObjectExportOptionsSuite::ApplyTagType ( IObjectExportOptions::TagType tagType )

pure virtual

Applies the tag type export option to the selection.

Parameters

tagType IN the tag type

virtual void IObjectExportOptionsSuite::ApplyUseImagePageBreak ( bool16 usePageBreak )

pure virtual

Applies the use image page break export option to the selection.

Parameters

usePageBreak IN whether to page break on encountering image

virtual void IObjectExportOptionsSuite::ApplyUseOriginalImage ( bool16 useOriginal )

pure virtual

Applies the use original image option to the selection.

Parameters

useOriginal IN whether to use original image or not

virtual bool16 IObjectExportOptionsSuite::CanApplyObjectExportOptions ( void ) const

pure virtual

Checks whether we can apply export options to the selection.

Returns: bool16: return kTrue if the selection is valid.

virtual bool16 IObjectExportOptionsSuite::CanApplySVGExportOptions ( void ) const

pure virtual

Checks whether we can apply svg export options to the selection.

Returns: bool16: return kTrue if the selection is valid.

virtual void IObjectExportOptionsSuite::GetObjectExportOptions ( IObjectExportOptionsData * objExpOptsData ) const

pure virtual

Gets the export options for the selection.

Parameters

objExpOptsData OUT export options with the state information

virtual void IObjectExportOptionsSuite::GetSVGExportOptions ( ISVGExportOptionsData * svgExpOptsData ) const

pure virtual

Gets the svg export options for the selection.

Parameters

svgExpOptsData OUT export options with the state information

virtual ErrorCode IObjectExportOptionsSuite::GetTextFromMetadata	(	const PMString &	nsPrefix,
		const PMString &	propertyPath,
		PMString &	metadataText
	)		const

pure virtual

Gets the unique xmp metadata property value for the selection.

Parameters

nsPrefix	IN the xmp schema namespace prefix
propertyPath	IN the xmp property path
metadataText	OUT the value of the xmp property

Returns: ErrorCode: error code

virtual ErrorCode IObjectExportOptionsSuite::GetTextFromStructure	(	bool16	alt,
		PMString &	structureText
	)		const

pure virtual

Gets the unique xml structure value of alt/actual text for the selection.

Parameters

alt	IN boolean passed to indicate whether we want alt or actual text, kTrue: alt, kFalse: actual.
structureText	OUT the alt/actual text from the xml structure

Returns: ErrorCode: error code

Public Types

Public Member Functions

Detailed Description

Member Function Documentation