IExportProviderSignalData Class Reference

#include <IExportProviderSignalData.h>

Inheritance diagram for IExportProviderSignalData:

Public Types
enum	{ kDefaultIID = IID_IEXPORTPROVIDERSIGNALDATA }

Public Member Functions
virtual void	SetDocument (IDocument *document)=0
virtual IDocument *	GetDocument () const =0
virtual void	SetFile (const IDFile &file)=0
virtual IDFile	GetFile () const =0
virtual void	SetFormat (const PMString &format)=0
virtual PMString	GetFormat () const =0
virtual void	SetUIFlags (UIFlags uiFlags)=0
virtual UIFlags	GetUIFlags () const =0
virtual void	SetURI (const URI &uri)=0
virtual const URI &	GetURI () const =0
virtual void	SetStandAlone (bool8 bIsStandAlone)=0
virtual bool8	IsStandAlone () const =0
virtual void	SetSessionToken (ExportSessionToken sessionToken)=0
virtual ExportSessionToken	GetSessionToken () 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 for Export Providers to use when signaling responders.

See Also

IExportProvider.h

CExportProvider.h

Member Function Documentation

virtual IDocument* IExportProviderSignalData::GetDocument ( ) const

pure virtual

Get the document

virtual IDFile IExportProviderSignalData::GetFile ( ) const

pure virtual

DEPRECATED: Use GetURI instead. Get the file

virtual PMString IExportProviderSignalData::GetFormat ( ) const

pure virtual

Get the format

virtual UIFlags IExportProviderSignalData::GetUIFlags ( ) const

pure virtual

Get the UI flags

virtual const URI& IExportProviderSignalData::GetURI ( ) const

pure virtual

Get the unique resource identifier representing the export result.

virtual bool8 IExportProviderSignalData::IsStandAlone ( ) const

pure virtual

Get the AssetType

virtual void IExportProviderSignalData::SetDocument ( IDocument *  document )

pure virtual

Set the document

virtual void IExportProviderSignalData::SetFile ( const IDFile &  file )

pure virtual

DEPRECATED: Use SetURI instead. Set the file

virtual void IExportProviderSignalData::SetFormat ( const PMString &  format )

pure virtual

Set the format

virtual void IExportProviderSignalData::SetSessionToken ( ExportSessionToken  sessionToken )

pure virtual

A session token identifies an export of one or more documents. For the standalone exports this is unused. For exports like JPEG we start return the sessionToken from the standalone export signal and pass it as an argument to the sub-exports.

Defaults to nil

virtual void IExportProviderSignalData::SetStandAlone ( bool8  bIsStandAlone )

pure virtual

A single export may produce a number of assets, and we need to 

distinguish between the main export and the extra assets that need to be treated differently.

Defaults to True.

virtual void IExportProviderSignalData::SetUIFlags ( UIFlags  uiFlags )

pure virtual

Set the UI flags

virtual void IExportProviderSignalData::SetURI ( const URI &  uri )

pure virtual

Set the unique resource identifier representing the export result.