Inheritance diagram for CusDtLnkFacade:

Public Member Functions
	CusDtLnkFacade (IPMUnknown *boss)

virtual	~CusDtLnkFacade ()

virtual ErrorCode	SetKeyValuePair (const IWorkspace *ws, const PMString &key, const PMString &val, const PMIID &iid=IID_ICUSDTLNKOPTIONS)

virtual PMString	GetValueFromKey (const IWorkspace *ws, const PMString &key, const PMIID &iid=IID_ICUSDTLNKOPTIONS) const

virtual bool16	IsOurCustomDataLink (const ClassID &classID) const

virtual bool16	IsOurCustomDataLink (const UIDRef &linkUIDRef) const

virtual ErrorCode	AddAdornment (const UIDList &itemList)

virtual ErrorCode	RemoveAdornment (const UIDList &itemList)

virtual ErrorCode	AddAssetDataBase (const IWorkspace *ws, const PMString &dbName, const PMString &fullPath)

virtual PMString	GetNthAssetDataBase (const IWorkspace *ws, int32 index) const

virtual int32	GetAssetDataBaseCount (const IWorkspace *ws) const

virtual PMString	GetAssetDataBasePath (const IWorkspace *ws, const PMString &dbName) const

virtual PMString	TruncatePath (const PMString &fullPath, bool16 useAnySeparator, const PlatformChar &separator) const

virtual UIDRef	ImportImageAndLoadPlaceGun (const UIDRef &docUIDRef, const URI &uri)

virtual UIDRef	ImportImageAndLoadPlaceGun (const UIDRef &docUIDRef, const PMString &path, const PMString &uniqueKey)

virtual PMString	GetCurrentlyChosenUniqueAssetKey (const IWorkspace *ws) const

virtual ErrorCode	SetCurrentlyChosenUniqueAssetKey (const IWorkspace *ws, const PMString &k)

virtual ErrorCode	InitializeDataLink (const IWorkspace ws, IDataLink dl, const IDFile &file, const PMString &formatName, const PMString &uniqueAssetKey)

virtual bool	UniqueKeyToURI (const PMString &uk, URI &uri) const

virtual bool	URIToIDFile (const URI &uri, IDFile &file) const

virtual PMString	GetFirstPartOfPath (const PMString &p) const

virtual IDFile	GetLocalFileFromAssetIdentifier (const IWorkspace *ws, const PMString &uniqueAssetKey) const

virtual PMString	GetAssetDataBaseRecordFieldValue (const IDFile &databaseFile, const PMString &recordID, const PMString &fieldName) const

virtual uint64	GetAssetSizeFromAssetIdentifier (const IWorkspace *ws, const PMString &uniqueAssetKey) const

virtual uint64	GetAssetTimestampFromAssetIdentifier (const IWorkspace *ws, const PMString &uniqueAssetKey) const

virtual uint64	GetAssetTimestampFromURI (const URI &uri) const

virtual PMString	GetAssetDescriptionFromAssetIdentifier (const IWorkspace *ws, const PMString &uniqueAssetKey) const

virtual PMString	GetAssetDescriptionFromURI (const URI &uri) const

virtual PMString	GetFieldValueFromAssetIdentifier (const IWorkspace *ws, const PMString &uniqueAssetKey, const PMString &fieldName) const

virtual void	StoreUniqueKey (IDataLink *dataLink, const PMString &uniqueAssetKey)

virtual PMString	RetrieveUniqueKey (IDataLink *dataLink) const

PMString	GetRecordFieldValueFromURI (const URI &uri, PMString &whichField) const

virtual bool16	NeedsOurAdornment (const UIDRef &pageItemUIDRef) const

virtual bool16	HasOurAdornment (const UIDRef &pageItemUIDRef) const

Public Member Functions inherited from CPMUnknown< ICusDtLnkFacade >
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

Public Member Functions inherited from ICusDtLnkFacade
PMString	GetRecordFieldValueFromURI (const URI &uri, PMString &whichField) const

Additional Inherited Members
Public Types inherited from ICusDtLnkFacade
enum	{ kDefaultIID = IID_ICUSDTLNKFACADE }

Protected Member Functions inherited from CPMUnknown< ICusDtLnkFacade >
	CPMUnknown (IPMUnknown *boss)

Protected Attributes inherited from CPMUnknown< ICusDtLnkFacade >
HelperInterface	fHelperInterface

Detailed Description

CusDtLnkFacade is an implementation of the command facade interface ICusDtLnkFacade.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * CusDtLnkFacade::CusDtLnkFacade ( IPMUnknown * boss )

Constructor.

Parameters

boss	IN interface ptr from boss object on which this interface is aggregated.

virtual CusDtLnkFacade::~CusDtLnkFacade ( )

inlinevirtual

Destructor

Member Function Documentation

ErrorCode CusDtLnkFacade::AddAdornment ( const UIDList & itemList )

virtual

See ICusDtLnkFacade::AddAdornment

Implements ICusDtLnkFacade.

ErrorCode CusDtLnkFacade::AddAssetDataBase	(	const IWorkspace *	ws,
		const PMString &	dbName,
		const PMString &	fullPath
	)

virtual

See ICusDtLnkFacade::AddAssetDataBase

Implements ICusDtLnkFacade.

int32 CusDtLnkFacade::GetAssetDataBaseCount ( const IWorkspace * ws ) const

virtual

See ICusDtLnkFacade::GetAssetDataBaseCount

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetAssetDataBasePath	(	const IWorkspace *	ws,
		const PMString &	dbName
	)		const

virtual

See ICusDtLnkFacade::GetAssetDataBasePath

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetAssetDataBaseRecordFieldValue	(	const IDFile &	databaseFile,
		const PMString &	recordID,
		const PMString &	fieldName
	)		const

virtual

See ICusDtLnkFacade::GetAssetDataBaseRecordFieldValue

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetAssetDescriptionFromAssetIdentifier	(	const IWorkspace *	ws,
		const PMString &	uniqueAssetKey
	)		const

virtual

See ICusDtLnkFacade::GetAssetDescriptionFromAssetIdentifier

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetAssetDescriptionFromURI ( const URI & uri ) const

virtual

See ICusDtLnkFacade::GetAssetDescriptionFromURI

Implements ICusDtLnkFacade.

uint64 CusDtLnkFacade::GetAssetSizeFromAssetIdentifier	(	const IWorkspace *	ws,
		const PMString &	uniqueAssetKey
	)		const

virtual

See ICusDtLnkFacade::GetAssetSizeFromAssetIdentifier

Implements ICusDtLnkFacade.

uint64 CusDtLnkFacade::GetAssetTimestampFromAssetIdentifier	(	const IWorkspace *	ws,
		const PMString &	uniqueAssetKey
	)		const

virtual

See ICusDtLnkFacade::GetAssetTimestampFromAssetIdentifier

Implements ICusDtLnkFacade.

uint64 CusDtLnkFacade::GetAssetTimestampFromURI ( const URI & uri ) const

virtual

See ICusDtLnkFacade::GetAssetTimestampFromURI

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetCurrentlyChosenUniqueAssetKey ( const IWorkspace * ws ) const

virtual

See ICusDtLnkFacade::GetCurrentlyChosenUniqueAssetKey

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetFieldValueFromAssetIdentifier	(	const IWorkspace *	ws,
		const PMString &	uniqueAssetKey,
		const PMString &	fieldName
	)		const

virtual

See ICusDtLnkFacade::GetFieldValueFromAssetIdentifier

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetFirstPartOfPath ( const PMString & p ) const

virtual

See ICusDtLnkFacade::GetFirstPartOfPath

Implements ICusDtLnkFacade.

IDFile CusDtLnkFacade::GetLocalFileFromAssetIdentifier	(	const IWorkspace *	ws,
		const PMString &	uniqueAssetKey
	)		const

virtual

See ICusDtLnkFacade::GetLocalFileFromAssetIdentifier

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetNthAssetDataBase	(	const IWorkspace *	ws,
		int32	index
	)		const

virtual

See ICusDtLnkFacade::GetNthAssetDataBase

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::GetRecordFieldValueFromURI	(	const URI &	uri,
		PMString &	whichField
	)		const

See ICusDtLnkFacade::GetRecordFieldValueFromURI

PMString CusDtLnkFacade::GetValueFromKey	(	const IWorkspace *	ws,
		const PMString &	key,
		const PMIID &	iid = `IID_ICUSDTLNKOPTIONS`
	)		const

virtual

See ICusDtLnkFacade::GetValueFromKey

Implements ICusDtLnkFacade.

bool16 CusDtLnkFacade::HasOurAdornment ( const UIDRef & pageItemUIDRef ) const

virtual

See ICusDtLnkFacade::HasOurAdornment

Implements ICusDtLnkFacade.

UIDRef CusDtLnkFacade::ImportImageAndLoadPlaceGun	(	const UIDRef &	docUIDRef,
		const URI &	uri
	)

virtual

See ICusDtLnkFacade::ImportImageAndLoadPlaceGun

Implements ICusDtLnkFacade.

UIDRef CusDtLnkFacade::ImportImageAndLoadPlaceGun	(	const UIDRef &	docUIDRef,
		const PMString &	path,
		const PMString &	uniqueKey
	)

virtual

Given a document and a path in local file system to image, load the placegun, initializing a custom datalink with the uniqueKey supplied

Parameters

docUIDRef	which document to target
path	refers to asset in local filesystem
uniqueKey	unique identifier for custom datalink to create pointing at asset

Returns: UIDRef representing contents of the place gun

Implements ICusDtLnkFacade.

ErrorCode CusDtLnkFacade::InitializeDataLink	(	const IWorkspace *	ws,
		IDataLink *	dl,
		const IDFile &	file,
		const PMString &	formatName,
		const PMString &	uniqueAssetKey
	)

virtual

See ICusDtLnkFacade::InitializeDataLink

Implements ICusDtLnkFacade.

bool16 CusDtLnkFacade::IsOurCustomDataLink ( const ClassID & classID ) const

virtual

See ICusDtLnkFacade::IsOurCustomDataLink

Implements ICusDtLnkFacade.

bool16 CusDtLnkFacade::IsOurCustomDataLink ( const UIDRef & linkUIDRef ) const

virtual

Determine if given UIDRef of an ILink is an our own type. In practice, we are looking to see if the link resource associated with the ILink has an URL whose schema is of ours.

Parameters

linkUIDRef the link of interest

Returns: bool16 kTrue if this is one of our link resource type, kFalse otherwise

Implements ICusDtLnkFacade.

bool16 CusDtLnkFacade::NeedsOurAdornment ( const UIDRef & pageItemUIDRef ) const

virtual

See ICusDtLnkFacade::NeedsOurAdornment

Implements ICusDtLnkFacade.

ErrorCode CusDtLnkFacade::RemoveAdornment ( const UIDList & itemList )

virtual

See ICusDtLnkFacade::RemoveAdornment

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::RetrieveUniqueKey ( IDataLink * dataLink ) const

virtual

See ICusDtLnkFacade::RetrieveUniqueKey

Implements ICusDtLnkFacade.

ErrorCode CusDtLnkFacade::SetCurrentlyChosenUniqueAssetKey	(	const IWorkspace *	ws,
		const PMString &	k
	)

virtual

See ICusDtLnkFacade::SetCurrentlyChosenUniqueAssetKey

Implements ICusDtLnkFacade.

ErrorCode CusDtLnkFacade::SetKeyValuePair	(	const IWorkspace *	ws,
		const PMString &	key,
		const PMString &	val,
		const PMIID &	iid = `IID_ICUSDTLNKOPTIONS`
	)

virtual

See ICusDtLnkFacade::SetKeyValuePair

Implements ICusDtLnkFacade.

void CusDtLnkFacade::StoreUniqueKey	(	IDataLink *	dataLink,
		const PMString &	uniqueAssetKey
	)

virtual

See ICusDtLnkFacade::StoreUniqueKey

Implements ICusDtLnkFacade.

PMString CusDtLnkFacade::TruncatePath	(	const PMString &	fullPath,
		bool16	useAnySeparator,
		const PlatformChar &	separator
	)		const

virtual

See ICusDtLnkFacade::TruncatePath

Implements ICusDtLnkFacade.

bool CusDtLnkFacade::UniqueKeyToURI	(	const PMString &	uk,
		URI &	uri
	)		const

virtual

See ICusDtLnkFacade::UniqueKeyToURI

Implements ICusDtLnkFacade.

bool CusDtLnkFacade::URIToIDFile	(	const URI &	uri,
		IDFile &	file
	)		const

virtual

See ICusDtLnkFacade::URIToIDFile

Implements ICusDtLnkFacade.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation