IFileSpecAsFileReference Class Reference

#include <edl/ifilespec.h>

Inheritance diagram for IFileSpecAsFileReference:

Classes
class	Data

Public Member Functions
virtual bool	getFileSpec (EDLSysString &strFileSpec) const =0
	Sets file specification string.
virtual bool	setFileSpec (const EDLSysString &strFileSpec)=0
	Gets file specification string.
Public Member Functions inherited from IFileSpec
virtual eFileSpecType	getFileSpecType () const =0
	Retrieves the file spec type.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IFileSpecAsFileReference.
static EDL_API bool	resolveToURI (EDLSysString &strUri, const EDLSysString &strFileSpec, bool &resolved, const EDLString &strDocumentDir, bool allowNetworkLookup=false)
	Static utility function that attempts to resolve a file specification string to a URI.
static EDL_API bool	convertURIToFileSpecString (EDLSysString &strFileSpec, const EDLSysString &strUri)
	Static utility function to convert a file URI to a filespec string.

Additional Inherited Members
Public Types inherited from IFileSpec
enum	eFileSpecType { eFileSpecExternal , eFileSpecEmbedded , eFileSpecUrl }
	Types of file specification for file references in PDF. More...
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Member Function Documentation

classID()

const CClassID & IFileSpecAsFileReference::classID ( )

inlinestatic

Retrieves class id of IFileSpecAsFileReference.

Returns

CClassID Class id of the element

convertURIToFileSpecString()

EDL_API bool IFileSpecAsFileReference::convertURIToFileSpecString ( EDLSysString & strFileSpec, const EDLSysString & strUri )

static

Static utility function to convert a file URI to a filespec string.

Parameters

strFileSpec	A reference to receive the file specification
strUri	the URI to convert.

Returns

bool returns true on success

getFileSpec()

virtual bool IFileSpecAsFileReference::getFileSpec ( EDLSysString & strFileSpec ) const

pure virtual

Sets file specification string.

Parameters

strFileSpec

specification string

Returns

bool Returns true on success

resolveToURI()

EDL_API bool IFileSpecAsFileReference::resolveToURI ( EDLSysString & strUri, const EDLSysString & strFileSpec, bool & resolved, const EDLString & strDocumentDir, bool allowNetworkLookup = false )

static

Static utility function that attempts to resolve a file specification string to a URI.

This may involve searching local and potentially remote filesystems for the existance of the file. Should the file not be unambiguously or directly found, resolved will be set to false and a best-effort result URI will be returned.

Note: Some filespecs may be already present in URI form (such file://path/to/file). For such cases, the URI will be returned unmodified (albeit escaped with percent encoding if required), and it will be assumed that the URI can be resolved (resolved will be set to true).

Parameters

strUri	Reference to receive the resolved URI
strFileSpec	The file spec to be resolved
resolved	Reference to receive the status of the resolution attempt.
strDocumentDir	The full path to the directory containing the current file, for resolving relative paths. Pass an empty string to use the process' current working directory. This string must be in the standard form used by the host operating system.
allowNetworkLookup	Allow the resolver to check for the existance of a shared volume that matches the filespec.

Returns

bool returns false on failure.

setFileSpec()

virtual bool IFileSpecAsFileReference::setFileSpec ( const EDLSysString & strFileSpec )

pure virtual

Gets file specification string.

Parameters

strFileSpec

specification string

Returns

bool Returns true on success

---

The documentation for this class was generated from the following file:

• edl/ifilespec.h