IPhase2Conversion Class Reference

#include <IPhase2Conversion.h>

Inheritance diagram for IPhase2Conversion:

Public Types
enum	{ kDefaultIID = IID_IPHASE2CONVERSION }
enum	RootObjectType {   kUnknownType = 0, kDocumentType, kWorkspaceType, kBookType,   kAssetType, kPrinterPresetType, kPDFExportType, kFlattenerStyleType,   kDocumentPresetType }

Public Member Functions
virtual UIDRef	GetRootObject () const =0
virtual RootObjectType	GetRootObjectType () const =0
virtual PluginID	GetSourcePluginIDForClass (ClassID clsID)=0
virtual PluginID	GetSourcePluginIDForImplementation (ImplementationID implID)=0
virtual bool16	GetSourcePluginFormatNumber (PluginID plugin, FormatID &format)=0
virtual bool16	ReadSourceData (UID uid, ImplementationID implID, const FormatID &format, IPMStream *outStream)=0
virtual PluginID	GetTargetPluginIDForClass (ClassID clsID)=0
virtual PluginID	GetTargetPluginIDForImplementation (ImplementationID implID)=0
virtual bool16	GetTargetPluginFormatNumber (PluginID plugin, FormatID &format)=0
virtual void	RemoveClass (ClassID clsID)=0
virtual void	RemoveImplementation (ImplementationID implID)=0
virtual void	SetRootObject (const UIDRef &root)=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

This interface is passed to each Phase 2 conversion responder via the Respond method. The responder will probably need to use information provided by IPhase2Conversion in order to perform its function.

Member Enumeration Documentation

enum IPhase2Conversion::RootObjectType

Identifies the type of object being converted.

Enumerator
kUnknownType	Sorry, we can't figure it out
kDocumentType	Root is a document
kWorkspaceType	Root is the workspace
kBookType	Root is a book
kAssetType	Root is an asset from a library
kPrinterPresetType	Root is a printer preset (printer style)
kPDFExportType	Root is a PDFExport style
kFlattenerStyleType	Root is a flattener style import/export
kDocumentPresetType	Root is a document preset

Member Function Documentation

virtual UIDRef IPhase2Conversion::GetRootObject ( ) const

pure virtual

Get the root object that is being converted. This will typically be the document or workspace root, but may be something else if a Library asset is being converted.

Returns

The root object UIDRef

virtual RootObjectType IPhase2Conversion::GetRootObjectType ( ) const

pure virtual

Get the type of object being converted.

Returns

The root object type.

virtual bool16 IPhase2Conversion::GetSourcePluginFormatNumber ( PluginID  plugin, FormatID &  format  )

pure virtual

Get the source format number for a particular plugin.

Parameters

plugin	IN The plugin in question.
format	OUT The plugin's source format number.

Returns

kTrue if the information was found, kFalse if not.

virtual PluginID IPhase2Conversion::GetSourcePluginIDForClass ( ClassID  clsID )

pure virtual

Determine which plugin supplied a particular class in the source document.

Parameters

clsID

IN The class in question.

Returns

The plugin that provided it, or kInvalidPlugin if not found.

virtual PluginID IPhase2Conversion::GetSourcePluginIDForImplementation ( ImplementationID  implID )

pure virtual

Determine which plugin supplied a particular implementation in the source document.

Parameters

implID

IN The implementation in question.

Returns

The plugin that provided it, or kInvalidPlugin if not found.

virtual bool16 IPhase2Conversion::GetTargetPluginFormatNumber ( PluginID  plugin, FormatID &  format  )

pure virtual

Get the target format number for a particular plugin.

Parameters

plugin	IN The plugin in question.
format	OUT The plugin's target format number.

Returns

kTrue if the information was found, kFalse if not.

virtual PluginID IPhase2Conversion::GetTargetPluginIDForClass ( ClassID  clsID )

pure virtual

Determine which plugin will supply a particular class in the target document.

Parameters

clsID

IN The class in question.

Returns

The plugin that will provide it, or kInvalidPlugin if not found.

virtual PluginID IPhase2Conversion::GetTargetPluginIDForImplementation ( ImplementationID  implID )

pure virtual

Determine which plugin will supply a particular implementation in the target document.

Parameters

implID

IN The implementation in question.

Returns

The plugin that will provide it, or kInvalidPlugin if not found.

virtual bool16 IPhase2Conversion::ReadSourceData ( UID  uid, ImplementationID  implID, const FormatID &  format, IPMStream *  outStream  )

pure virtual

This method is not yet implemented

virtual void IPhase2Conversion::RemoveClass ( ClassID  clsID )

pure virtual

Notify the Conversion Manager that a class has been completely removed from the database during Phase Two conversion. NOTE: Removal is normally done during Phase One conversion. This method is for unusual circumstances.

Parameters

clsID

IN The class in question

virtual void IPhase2Conversion::RemoveImplementation ( ImplementationID  implID )

pure virtual

Notify the Conversion Manager that a implementation has been completely removed from the database during Phase Two conversion. NOTE: Removal is normally done during Phase One conversion. This method is for unusual circumstances.

Parameters

implID

IN The implementation in question

virtual void IPhase2Conversion::SetRootObject ( const UIDRef &  root )

pure virtual

Set the root object that is being converted. Not for use by clients. Used to set up the interface prior to client use.

Parameters

root	IN The root object UIDRef.