IXMLExportOptions Class Reference

#include <IXMLExportOptions.h>

Inheritance diagram for IXMLExportOptions:

Public Types
enum	{ kDefaultIID = IID_IXMLEXPORTOPTIONS }
enum	ImageType { kImageBest = 0, kImageJPEG, kImageGIF, kImagePNG }
enum	JPEGEncoding { kJPEGBaseline = 0, kJPEGProgressive }
enum	JPEGQuality { kJPEGLowQuality = 0, kJPEGMediumQuality, kJPEGGoodQuality, kJPEGMaxQuality }
enum	PaletteType { kAdaptivePalette = 0, kMacPalette, kWebPalette, kWinPalette }
enum	UntaggedTablesFormat { kNone = 0, kCALS }
enum	FrameOfReference { kSpread, kItem, kGraphicFrame, kGraphicFrameWithoutStyle }
typedef enum IXMLExportOptions::ImageType	ImageType

Public Member Functions
virtual bool16	GetExportFromSelected () const =0
virtual void	SetExportFromSelected (bool16 exportFromSelected)=0
virtual IXMLOutStream::eEncodingType	GetEncodingType () const =0
virtual void	SetEncodingType (IXMLOutStream::eEncodingType encodingType)=0
virtual void	EnableOptimizedImages (bool8 enable)=0
virtual void	EnableFormattedImages (bool8 enable)=0
virtual void	EnableCopyOriginals (bool8 enable)=0
virtual void	SetImageType (ImageType type)=0
virtual void	SetJPEGOptions (JPEGEncoding encode, JPEGQuality quality)=0
virtual void	SetGIFOptions (PaletteType palette, bool8 interlaced)=0
virtual void	SetPNGOptions (uint32 compressionLevel)=0
virtual bool8	IsEnabledOptimizedImages (void) const =0
virtual bool8	IsEnabledFormattedImages (void) const =0
virtual bool8	IsEnabledCopyOriginals () const =0
virtual ImageType	GetImageType (void) const =0
virtual void	GetJPEGOptions (JPEGEncoding *encode, JPEGQuality *quality) const =0
virtual void	GetGIFOptions (PaletteType *palette, bool8 *interlaced) const =0
virtual void	GetPNGOptions (uint32 *compressionLevel) const =0
virtual void	SetImagePPI (const PMReal &resolution)=0
virtual PMReal	GetImagePPI () const =0
virtual FrameOfReference	GetFrameOfReference () const =0
virtual void	SetFrameOfReference (FrameOfReference x)=0
virtual bool16	GetExportRuby () const =0
virtual void	SetExportRuby (bool16 exportRuby)=0
virtual bool16	GetExcludeDTD () const =0
virtual void	SetExcludeDTD (bool16 excludeDTD)=0
virtual UntaggedTablesFormat	GetExportUntaggedTablesFormat () const =0
virtual void	SetExportUntaggedTablesFormat (UntaggedTablesFormat exportUntaggedTables)=0
virtual bool16	GetRunScriptOnExport () const =0
virtual void	SetRunScriptOnExport (bool16 runScript)=0
virtual IDFile	GetXSLTScriptFileName () const =0
virtual void	SetXSLTScriptFileName (IDFile fileName)=0
virtual bool16	GetExportCharacterReferences () const =0
virtual void	SetExportCharacterReferences (bool16 exportReferences)=0
virtual void	Copy (IXMLExportOptions *otherOptions)=0
virtual void	SetImageScale (PMReal xScale=1.0, PMReal yScale=1.0)=0
virtual void	GetImageScale (PMReal &xScale, PMReal &yScale) 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 preferences. To change preferences from client code, use kChangeXMLExportOptionsCmdBoss rather than calling mutators on this interface.

Member Typedef Documentation

typedef enum IXMLExportOptions::ImageType IXMLExportOptions::ImageType

Supported image types.

Member Enumeration Documentation

enum IXMLExportOptions::FrameOfReference

When rasterizing, the frame of reference for that rasterization.

Enumerator
kSpread	Spread coords (the default)
kItem	In item coordinates.
kGraphicFrame	In frame coordinates if the item is a graphic; otherwise the item's coordinates.
kGraphicFrameWithoutStyle	In frame coordinates if the item is a graphic; otherwise the item's coordinates. Use frame pathBounds for clipping (instead of Printed bounding box)

enum IXMLExportOptions::ImageType

Supported image types.

enum IXMLExportOptions::JPEGEncoding

JPEGEncoding

enum IXMLExportOptions::JPEGQuality

JPEGQuality

enum IXMLExportOptions::PaletteType

PaletteType (GIF)

Enumerator
kAdaptivePalette	Tries to create an exact palette first. If it cannot, an adaptive palette will be created.
kMacPalette	Use the Macintosh 256 entry system palette from Photoshop
kWebPalette	Use a 216 entry web safe color palette
kWinPalette	Use the Windows 256 entry system palette from Photoshop

enum IXMLExportOptions::UntaggedTablesFormat

UntaggedTablesFormat

Enumerator
kNone	Don't export untagged tables.
kCALS	Export untagged tables as CALS XML.

Member Function Documentation

virtual void IXMLExportOptions::Copy ( IXMLExportOptions *  otherOptions )

pure virtual

Set the state stored on this interface based off another similar interface

Parameters

otherOptions

interface whose state we'll copy over to this

virtual void IXMLExportOptions::EnableCopyOriginals ( bool8  enable )

pure virtual

Mutator for image setting; see IXMLExportUtils for information

Parameters

enable

virtual void IXMLExportOptions::EnableFormattedImages ( bool8  enable )

pure virtual

Mutator for image setting; see IXMLExportUtils for information

Parameters

enable

Returns

virtual void IXMLExportOptions::EnableOptimizedImages ( bool8  enable )

pure virtual

Mutator for image setting; see IXMLExportUtils for information

Parameters

enable

Returns

virtual IXMLOutStream::eEncodingType IXMLExportOptions::GetEncodingType ( ) const

pure virtual

Accessor for encoding type

Returns

IXMLOutStream::eEncodingType stored

virtual bool16 IXMLExportOptions::GetExcludeDTD ( ) const

pure virtual

Acccessor for property whether to exclude a DTD reference on export

Returns

bool16 kTrue if should DTD reference should be exluded on export, false otherwise

virtual bool16 IXMLExportOptions::GetExportCharacterReferences ( ) const

pure virtual

Accessor for property specifying whether to export special characters as entities.

Returns

bool16 kTrue if special characters are to be exported as entities.

virtual bool16 IXMLExportOptions::GetExportFromSelected ( ) const

pure virtual

Acccessor for property specifying whether to export from selection

Returns

bool16 kTrue if should export from selection, kFalse otherwise

virtual bool16 IXMLExportOptions::GetExportRuby ( ) const

pure virtual

Acccessor for property whether to export ruby with the W3C markup

Returns

bool16 kTrue if should export ruby, false otherwise

virtual UntaggedTablesFormat IXMLExportOptions::GetExportUntaggedTablesFormat ( ) const

pure virtual

Acccessor for property specifying the format to use when exporting untagged tables.

Returns

UntaggedTablesFormat The format to use when exporting untagged tables.

virtual FrameOfReference IXMLExportOptions::GetFrameOfReference ( ) const

pure virtual

Accessor for rasterization frame of reference.

virtual void IXMLExportOptions::GetGIFOptions ( PaletteType *  palette, bool8 *  interlaced  ) const

pure virtual

Accessor for GIF parameters stored on this interface

Parameters

palette	[OUT]
interlaced	[OUT]

virtual PMReal IXMLExportOptions::GetImagePPI ( ) const

pure virtual

Accessor for retrieving desired resolution set in SetImagePPI().

Returns

resolution current resolution setting

virtual void IXMLExportOptions::GetImageScale ( PMReal &  xScale, PMReal &  yScale  ) const

pure virtual

Get xScale of the image

Parameters

xScale	exported image's xScale
yScale	exported image's yScale

virtual ImageType IXMLExportOptions::GetImageType ( void  ) const

pure virtual

Accessor for ImageType stored on this interface

Returns

ImageType

virtual void IXMLExportOptions::GetJPEGOptions ( JPEGEncoding *  encode, JPEGQuality *  quality  ) const

pure virtual

Accessor for JPEG parameters stored on this interface

Parameters

encode	[OUT]
quality	[OUT]

virtual void IXMLExportOptions::GetPNGOptions ( uint32 *  compressionLevel ) const

pure virtual

Accessor for PNG parameters stored on this interface

Parameters

compressionLevel

[OUT]

virtual bool16 IXMLExportOptions::GetRunScriptOnExport ( ) const

pure virtual

Acccessor for property specifying whether to run an XSLT script during export. This goes along with GetXSLTScriptFileName.

Returns

kTrue if should be Running a Script, kFalse otherwise

virtual IDFile IXMLExportOptions::GetXSLTScriptFileName ( ) const

pure virtual

Acccessor for property specifying where the XSLT script is located. This goes along with GetRunScriptOnExport.

Returns

The filename of the script to run

virtual bool8 IXMLExportOptions::IsEnabledCopyOriginals ( ) const

pure virtual

Accessor for property stored on this interface

Returns

bool8

virtual bool8 IXMLExportOptions::IsEnabledFormattedImages ( void  ) const

pure virtual

Accessor for property stored on this interface

Returns

bool8

virtual bool8 IXMLExportOptions::IsEnabledOptimizedImages ( void  ) const

pure virtual

Accessor for property stored on this interface

Returns

bool8

virtual void IXMLExportOptions::SetEncodingType ( IXMLOutStream::eEncodingType  encodingType )

pure virtual

Mutator for encoding type stored on this interface

Parameters

encodingType

specify a new encoding type to store on this interface

virtual void IXMLExportOptions::SetExcludeDTD ( bool16  excludeDTD )

pure virtual

Mutator for property whether to exclude a DTD reference on export

Parameters

exclude

DTD kTrue if excluding DTD on export

virtual void IXMLExportOptions::SetExportCharacterReferences ( bool16  exportReferences )

pure virtual

Mutator for property specifying whether to export special characters as references.

Parameters

exportReference

kTrue to export references.

virtual void IXMLExportOptions::SetExportFromSelected ( bool16  exportFromSelected )

pure virtual

Mutator for property specifying whether to export from selection

Parameters

exportFromSelected

kTrue if should be exporting from selection

virtual void IXMLExportOptions::SetExportRuby ( bool16  exportRuby )

pure virtual

Mutator for property whether to export ruby with the W3C markup

Parameters

exportRuby

kTrue if exporting ruby

virtual void IXMLExportOptions::SetExportUntaggedTablesFormat ( UntaggedTablesFormat  exportUntaggedTables )

pure virtual

Mutator for property specifying the format to use when exporting untagged tables.

Parameters

exportUntaggedTables

The format to use when exporting untagged tables.

virtual void IXMLExportOptions::SetFrameOfReference ( FrameOfReference  x )

pure virtual

Mutator for rasterization frame of reference.

virtual void IXMLExportOptions::SetGIFOptions ( PaletteType  palette, bool8  interlaced  )

pure virtual

Mutator for image setting; GIF parameters

Parameters

palette	kind of palette (from PaletteType) to create on export
interlaced	whether interlaced GIFs created on export

virtual void IXMLExportOptions::SetImagePPI ( const PMReal &  resolution )

pure virtual

Mutator for specifying the desired export resolution for graphic types like jpeg and png. Actual output resolution may differ dependent on source image.

Parameters

resolution

desired resolution (dpi)

virtual void IXMLExportOptions::SetImageScale ( PMReal  xScale = 1.0, PMReal  yScale = 1.0  )

pure virtual

Set xScale, ysScale for the image which are exported.

Parameters

xScale	exported image's xScale
yScale	exported image's yscale

virtual void IXMLExportOptions::SetImageType ( ImageType  type )

pure virtual

Mutator for image setting

Parameters

type	specify how exported images should be represented

virtual void IXMLExportOptions::SetJPEGOptions ( JPEGEncoding  encode, JPEGQuality  quality  )

pure virtual

Mutator for image setting; JPEG parameters

Parameters

encode	what variant of JPEG encoding schemes to choose
quality	specifies quality level to use for exported JPEGs

virtual void IXMLExportOptions::SetPNGOptions ( uint32  compressionLevel )

pure virtual

Mutator for image setting; PNG parameters

Parameters

compressionLevel

0..9 are allowed levels of compression with 9 being the highest compression.

virtual void IXMLExportOptions::SetRunScriptOnExport ( bool16  runScript )

pure virtual

Mutator for property specifying whether to run an XSLT script during export. This goes along with SetXSLTScriptFileName.

Parameters

runScript

kTrue if should be Running a Script

virtual void IXMLExportOptions::SetXSLTScriptFileName ( IDFile  fileName )

pure virtual

Mutator for property specifying where the XSLT script is located. This goes along with SetRunScriptOnExport.

Parameters

fileName

The filename of the script to run