ISVGExportCommandData Class Reference

#include <ISVGExportCommandData.h>

Inheritance diagram for ISVGExportCommandData:

Public Types
enum	{ kDefaultIID = IID_ISVGEXPORTCOMMANDDATA }

Public Member Functions
virtual void	SetUIFlags (UIFlags uiFlags)=0
virtual UIFlags	GetUIFlags () const =0
virtual void	SetCompressSVGOutput (bool16 compress)=0
virtual bool16	GetCompressSVGOutput () const =0
virtual void	SetProgress (RangeProgressBar *pProgress)=0
virtual RangeProgressBar *	GetProgress ()=0
virtual void	SetOutputStream (InterfacePtr< IPMStream > inOutputStream)=0
virtual InterfacePtr< IPMStream >	GetOutputStream () const =0
virtual void	SetIncludeOpticalMarginAlignment (bool16 use)=0
virtual bool16	GetIncludeOpticalMarginAlignment () const =0
virtual void	SetCoordinateSpace (const Transform::CoordinateSpace &coordinateSpace)=0
virtual Transform::CoordinateSpace	GetCoordinateSpace () const =0
virtual void	SetIncludeInlineObjects (bool16 includeInline)=0
virtual bool16	GetIncludeInlineObjects () 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

Data interface used to store settings for the SVG export command

Member Function Documentation

virtual bool16 ISVGExportCommandData::GetCompressSVGOutput ( ) const

pure virtual

Gets boolean flag that indicates whether we should compress output

Returns

kTrue if output should be compressed, else kFalse

virtual Transform::CoordinateSpace ISVGExportCommandData::GetCoordinateSpace ( ) const

pure virtual

Gets the coordinate space to be used for exporting page item as SVG

Returns

coordinate space

virtual bool16 ISVGExportCommandData::GetIncludeInlineObjects ( ) const

pure virtual

Gets whether to include inline objects in svg output.

Returns

kTrue if inline objects need to be included

virtual bool16 ISVGExportCommandData::GetIncludeOpticalMarginAlignment ( ) const

pure virtual

Gets whether to include optical alignment margin while exporting page items as SVG

Returns

kTrue if optical alignment needs to be considered.

virtual RangeProgressBar* ISVGExportCommandData::GetProgress ( )

pure virtual

Gets the progress bar to use during the export

Returns

The progress bar to use during export

virtual UIFlags ISVGExportCommandData::GetUIFlags ( ) const

pure virtual

Gets the UI flags to use during the export

Returns

the UIFlags to use

virtual void ISVGExportCommandData::SetCompressSVGOutput ( bool16  compress )

pure virtual

Sets boolean flag that indicates whether we should compress output

Parameters

compress

kTrue if output should be compressed, else kFalse

virtual void ISVGExportCommandData::SetCoordinateSpace ( const Transform::CoordinateSpace &  coordinateSpace )

pure virtual

sets coordinate space to be used when exporting svg page items. Note that this option works only we are exporting a single page items . For multiple page items coordinate space is by default by spread.

Parameters

coordinateSpace

coordinate space to be used.

virtual void ISVGExportCommandData::SetIncludeInlineObjects ( bool16  includeInline )

pure virtual

Sets whether to include inline objects in svg output.

Parameters

includeInline

kTrue if inline objects need to be included

virtual void ISVGExportCommandData::SetIncludeOpticalMarginAlignment ( bool16  use )

pure virtual

sets whether to include optical alignment margin while exporting page items as svg

Parameters

use	kTrue if optical alignment needs to be considered.

virtual void ISVGExportCommandData::SetProgress ( RangeProgressBar *  pProgress )

pure virtual

Sets the progress bar to use during the export.

Note: progress bar is not owned by this object. It must remain valid for the duration of the export and must be cleaned up the caller.

Parameters

pProgress

The progress bar to use during export

virtual void ISVGExportCommandData::SetUIFlags ( UIFlags  uiFlags )

pure virtual

Sets the UI flags to use during the export (used to determines whether to display progressbar, etc)

Parameters

uiFlags

The UI flags to use during the export