CusDtLnkLinkResourceHandler Class Reference

#include <CusDtLnkLinkResourceHandler.h>

Inheritance diagram for CusDtLnkLinkResourceHandler:

Public Types
typedef CPMUnknown < ILinkResourceHandler >	inherited
typedef object_type	data_type

Public Member Functions
	CusDtLnkLinkResourceHandler (IPMUnknown *boss)
virtual bool	Init (const UIDRef &ref, const URI &uri)
virtual bool	IsResourceURIValid (const UIDRef &ref, const URI &uri) const
virtual bool	AreResourceIdsEquivalent (const ILinkResource::ResourceId &id1, const ILinkResource::ResourceId &id2) const
virtual FileTypeInfo	GetResourceDataType (const UIDRef &ref, const URI &uri) const
virtual WideString	GetShortResourceName (const UIDRef &ref, const URI &uri, bool bUIName) const
virtual WideString	GetLongResourceName (const UIDRef &ref, const URI &uri, bool bUIName) const
virtual PMString	GetResourceStateInfo (const UIDRef &ref, const URI &uri, ILinkResource::ResourceState state, ILinkResource::ResourceStoreState storeState) const
virtual bool	AreStampsEquivalent (const WideString &stamp1, const WideString &stamp2) const
virtual bool	CanReadResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanWriteResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanReadWriteResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanCreateResourceStream (const UIDRef &ref, const URI &uri, ILinkResource::AccessMode mode) const
virtual IPMStream *	CreateResourceReadStream (const UIDRef &ref, const URI &uri) const
virtual IPMStream *	CreateResourceWriteStream (const UIDRef &ref, const URI &uri) const
virtual IPMStream *	CreateResourceReadWriteStream (const UIDRef &ref, const URI &uri) const
virtual bool	CanCacheResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanEmbedResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanUnembedResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanCopyToFile (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	CopyToFile (const UIDRef &ref, const URI &uri, IDFile &file) const
virtual bool	CanEditResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	EditResource (const UIDRef &ref, const URI &uri, const AppInfo &appInfo, PMString *errorString) const
virtual bool	CanRevealResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanRevealResourceInBridge (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResourceInBridge (const UIDRef &ref, const URI &uri) const
virtual bool	CanRevealResourceInCloudLibraries (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResourceInCloudLibraries (const UIDRef &ref, const URI &uri) const
virtual bool	GetXMPPacketInfo (const UIDRef &resourceRef, const URI &uri, std::string &packet) const
virtual bool	CanGetXMPPacketInfo (const UIDRef &ref, const URI &uri) const
virtual bool	CanDownloadOriginalResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	DownloadOriginalResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	AsyncDownloadOriginalResource (const UIDRef &ref, const URI &uri, ILinkResource::DownloadCompletionFunction completionFunction) const
virtual bool	CanReplaceFPOWithOriginalResource (const UIDRef &ref, const URI &uri) const
virtual ILinkResource::ResourceDownloadState	GetResourceDownloadProgress (const UIDRef &ref, const URI &uri, PMReal &progress) const
virtual bool	CanProvideFile (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	GetFile (const UIDRef &ref, const URI &uri, IDFile &idFile) const
virtual bool	canGetInstanceName () const
virtual ErrorCode	GetInstanceName (PMString &uri) const
Public Member Functions inherited from CPMUnknown< ILinkResourceHandler >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Protected Member Functions inherited from CPMUnknown< ILinkResourceHandler >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< ILinkResourceHandler >
HelperInterface	fHelperInterface

Detailed Description

The resource handler for link resource with an URI whose scheme is 'CSVLink'. A resource handler is required when you create link with youe own URI scheme. By default InDesign's file link has its URI begins with file://... the file in the URI is the scheme. Therefore, in the InDesign code base, there is a resource handler that knows how to handle link resource of URI scheme 'file'.

CusDtLnk creats a new type of link with URI scheme 'CSVLink', its URI beings with CSVLink://... This resource handler CusDtLnkLinkResourceHandler provides important data for the link resource, such as the import stream. When a CSVLink link needs to import data, this resource handler will be the one called upon by links architecture to actually parse the CSV, and open the corresponding image file for read.

Member Function Documentation

bool CusDtLnkLinkResourceHandler::AreResourceIdsEquivalent ( const ILinkResource::ResourceId &  id1, const ILinkResource::ResourceId &  id2  ) const

virtual

See Also

ILinkResourceHandler::AreResourceIdsEquivalent

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::AreStampsEquivalent ( const WideString &  stamp1, const WideString &  stamp2  ) const

virtual

See Also

ILinkResourceHandler::AreStampsEquivalent

Implements ILinkResourceHandler.

virtual ErrorCode CusDtLnkLinkResourceHandler::AsyncDownloadOriginalResource ( const UIDRef &  ref, const URI &  uri, ILinkResource::DownloadCompletionFunction  completionFunction  ) const

inlinevirtual

See Also

ILinkResourceHandler::AsyncDownloadOriginalResource

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanCacheResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanCacheResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanCopyToFile ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanCopyToFile

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanCreateResourceStream ( const UIDRef &  ref, const URI &  uri, ILinkResource::AccessMode  mode  ) const

virtual

See Also

ILinkResourceHandler::CanCreateResourceStream

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanDownloadOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanDownloadOriginalResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanEditResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanEditResource

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanEmbedResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanEmbedResource

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanGetXMPPacketInfo ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanGetXMPPacketInfo

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanProvideFile ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanProvideFile

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanReadResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanReadResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanReadWriteResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanReadWriteResource

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanReplaceFPOWithOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanReplaceFPOWithOriginalResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanRevealResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanRevealResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanRevealResourceInBridge ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanRevealResourceInBridge

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanRevealResourceInCloudLibraries ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanRevealResourceInCloudLibraries

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::CanUnembedResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::CanUnembedResource

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::CanWriteResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CanWriteResource

Implements ILinkResourceHandler.

ErrorCode CusDtLnkLinkResourceHandler::CopyToFile ( const UIDRef &  ref, const URI &  uri, IDFile &  file  ) const

virtual

See Also

ILinkResourceHandler::CopyToFile

Implements ILinkResourceHandler.

IPMStream * CusDtLnkLinkResourceHandler::CreateResourceReadStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CreateResourceReadStream

Implements ILinkResourceHandler.

IPMStream * CusDtLnkLinkResourceHandler::CreateResourceReadWriteStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CreateResourceReadWriteStream

Implements ILinkResourceHandler.

IPMStream * CusDtLnkLinkResourceHandler::CreateResourceWriteStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::CreateResourceWriteStream

Implements ILinkResourceHandler.

virtual ErrorCode CusDtLnkLinkResourceHandler::DownloadOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::DownloadOriginalResource

Implements ILinkResourceHandler.

ErrorCode CusDtLnkLinkResourceHandler::EditResource ( const UIDRef &  ref, const URI &  uri, const AppInfo &  appInfo, PMString *  errorString  ) const

virtual

See Also

ILinkResourceHandler::EditResource

Implements ILinkResourceHandler.

virtual ErrorCode CusDtLnkLinkResourceHandler::GetFile ( const UIDRef &  ref, const URI &  uri, IDFile &  idFile  ) const

inlinevirtual

See Also

ILinkResourceHandler::GetFile

Implements ILinkResourceHandler.

WideString CusDtLnkLinkResourceHandler::GetLongResourceName ( const UIDRef &  ref, const URI &  uri, bool  bUIName  ) const

virtual

See Also

ILinkResourceHandler::GetLongResourceName

Implements ILinkResourceHandler.

FileTypeInfo CusDtLnkLinkResourceHandler::GetResourceDataType ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::GetResourceDataType

Implements ILinkResourceHandler.

virtual ILinkResource::ResourceDownloadState CusDtLnkLinkResourceHandler::GetResourceDownloadProgress ( const UIDRef &  ref, const URI &  uri, PMReal &  progress  ) const

inlinevirtual

See Also

ILinkResourceHandler::GetResourceDownloadProgress

Implements ILinkResourceHandler.

virtual PMString CusDtLnkLinkResourceHandler::GetResourceStateInfo ( const UIDRef &  ref, const URI &  uri, ILinkResource::ResourceState  state, ILinkResource::ResourceStoreState  storeState  ) const

inlinevirtual

See Also

ILinkResourceHandler::GetResourceStateInfo

Implements ILinkResourceHandler.

WideString CusDtLnkLinkResourceHandler::GetShortResourceName ( const UIDRef &  ref, const URI &  uri, bool  bUIName  ) const

virtual

See Also

ILinkResourceHandler::GetShortResourceName

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::GetXMPPacketInfo ( const UIDRef &  resourceRef, const URI &  uri, std::string &  packet  ) const

inlinevirtual

See Also

ILinkResourceHandler::GetXMPPacketInfo

Implements ILinkResourceHandler.

virtual bool CusDtLnkLinkResourceHandler::Init ( const UIDRef &  ref, const URI &  uri  )

inlinevirtual

See Also

ILinkResourceHandler::Init

Implements ILinkResourceHandler.

bool CusDtLnkLinkResourceHandler::IsResourceURIValid ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::IsResourceURIValid

Implements ILinkResourceHandler.

ErrorCode CusDtLnkLinkResourceHandler::RevealResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::RevealResource

Implements ILinkResourceHandler.

ErrorCode CusDtLnkLinkResourceHandler::RevealResourceInBridge ( const UIDRef &  ref, const URI &  uri  ) const

virtual

See Also

ILinkResourceHandler::RevealResourceInBridge

Implements ILinkResourceHandler.

virtual ErrorCode CusDtLnkLinkResourceHandler::RevealResourceInCloudLibraries ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

See Also

ILinkResourceHandler::RevealResourceInCloudLibraries

Implements ILinkResourceHandler.