ILibraryScrapUtils Class Reference

#include <ILibraryScrapUtils.h>

Inheritance diagram for ILibraryScrapUtils:

Public Types
enum	{ kDefaultIID = IID_ILIBRARYSCRAPUTILS }

Public Member Functions
virtual LibraryAssetID	ConvertToLibraryAsset (const UIDList *originalPageItems, const UIDList *libraryScrapPageItems, ILibrary *library, bool16 fromCompletePage=false)=0
virtual LibraryAssetID	ConvertToAssetUsingSnippets (ILibrary *library, UIDList *itemList, IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor)=0
virtual ErrorCode	UpdateItemAsset (ILibrary *library, ILibraryAsset *asset, UIDList *itemList, IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor)=0
virtual ErrorCode	UpdateStructureAsset (ILibrary *library, ILibraryAsset *asset, XMLReference &fromThis, IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor)=0
virtual LibraryAssetID	ConvertStructureToAssetUsingSnippets (ILibrary *library, XMLReference &addThis, IDataExchangeHandler *handler, ExternalPMFlavor gotFlavor)=0
virtual bool16	IsScrapDB (IDataBase *db)=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 responsible for assisting the Library Panel's Scrap Controller. It also contains methods for CS2-based asset handling (which doesn't directly use the scrap).

Member Function Documentation

virtual LibraryAssetID ILibraryScrapUtils::ConvertStructureToAssetUsingSnippets ( ILibrary *  library, XMLReference &  addThis, IDataExchangeHandler *  handler, ExternalPMFlavor  gotFlavor  )

pure virtual

Convert structure into a Library Asset using Snippets

Parameters

library	IN interface pointer to the library
addThis	IN the structure item, or nil if using handler
handler	IN data exchange handler for data, if not using fromThis
gotFlavor	IN flavor if using handler

Returns

the LibraryAssetID of created asset

virtual LibraryAssetID ILibraryScrapUtils::ConvertToAssetUsingSnippets ( ILibrary *  library, UIDList *  itemList, IDataExchangeHandler *  handler, ExternalPMFlavor  gotFlavor  )

pure virtual

Convert pageitems into a Library Asset using Snippets

Parameters

library	IN interface pointer to the library
itemList	IN pointer to list of pageitems to convert, or nil if using handler
handler	IN data exchange handler for data, if itemList is nil
gotFlavor	IN flavor if using handler

Returns

the LibraryAssetID of created asset

virtual LibraryAssetID ILibraryScrapUtils::ConvertToLibraryAsset ( const UIDList *  originalPageItems, const UIDList *  libraryScrapPageItems, ILibrary *  library, bool16  fromCompletePage = false  )

pure virtual

DEPRECATED – Convert the Library Scrap into a Library Asset.

Parameters

originalPageItems	IN the original pageitems to convert
libraryScrapPageItems	IN items as stored in the library scrap
library	IN interface pointer to the library
fromCompletePage	IN if kTrue, we are adding all items from the page

Returns

the LibraryAssetID of created asset

virtual bool16 ILibraryScrapUtils::IsScrapDB ( IDataBase *  db )

pure virtual

Check to see if a given database is the library scrap database.

Parameters

db	IN IDatabase to test.

Returns

kTrue if db is the library scrap database

virtual ErrorCode ILibraryScrapUtils::UpdateItemAsset ( ILibrary *  library, ILibraryAsset *  asset, UIDList *  itemList, IDataExchangeHandler *  handler, ExternalPMFlavor  gotFlavor  )

pure virtual

Update an asset using pageitems

Parameters

library	IN interface pointer to the library
asset	IN the asset to update
itemList	IN pointer to list of pageitems to use, or nil if using handler
handler	IN data exchange handler for data, if itemList is nil
gotFlavor	IN flavor if using handler

Returns

error code

virtual ErrorCode ILibraryScrapUtils::UpdateStructureAsset ( ILibrary *  library, ILibraryAsset *  asset, XMLReference &  fromThis, IDataExchangeHandler *  handler, ExternalPMFlavor  gotFlavor  )

pure virtual

Update a structure asset using XMLReference

Parameters

library	IN interface pointer to the library
asset	IN the asset to update
fromThis	IN the structure item, or nil if using handler
handler	IN data exchange handler for data, if not using fromThis
gotFlavor	IN flavor if using handler

Returns

error code