#include <ILibraryCmdUtils.h>

Inheritance diagram for ILibraryCmdUtils:

Public Types
enum	{ kDefaultIID = IID_ILIBRARYCMDUTILS }

Public Member Functions
virtual ICommand *	CreateLibraryAddItemCmd (UIDList selection, ILibrary library, bool16 fromCompletePage=false)=0

virtual ICommand *	CreateLibraryUpdateItemCmd (UIDList selection, ILibrary library, const AssetIDList &assetList)=0

virtual ICommand *	CreateLibraryCopyItemsCmd (const AssetIDList &sourceAssetList, ILibrary sourceLibrary, ILibrary destLibrary)=0

virtual ICommand *	CreateLibraryDeleteItemsCmd (const AssetIDList &assetList, ILibrary *library)=0

virtual ICommand *	CreateLibraryNewLibCmd (const IDFile &libraryFile)=0

virtual ICommand *	CreateLibraryOpenLibCmd (const IDFile &libraryFile)=0

virtual ICommand *	CreateLibraryCloseLibCmd (ILibrary *library)=0

virtual ErrorCode	ProcessLibraryAddItemCmd (UIDList selection, ILibrary library, bool16 fromCompletePage=false, AssetIDList newAssetList=nil, IDataExchangeHandler handler=nil, ExternalPMFlavor gotFlavor=kNoFlavor)=0

virtual ErrorCode	ProcessLibraryAddStructureCmd (XMLReference &addThis, ILibrary library, AssetIDList newAssetList=nil, IDataExchangeHandler *handler=nil, ExternalPMFlavor gotFlavor=kNoFlavor)=0

virtual ErrorCode	ProcessLibraryUpdateItemCmd (UIDList selection, ILibrary library, AssetIDList newAssetList=nil, IDataExchangeHandler handler=nil, ExternalPMFlavor gotFlavor=kNoFlavor)=0

virtual ErrorCode	ProcessLibraryUpdateStructureCmd (XMLReference &addThis, ILibrary library, AssetIDList assetList=nil, IDataExchangeHandler *handler=nil, ExternalPMFlavor gotFlavor=kNoFlavor)=0

virtual ErrorCode	ProcessLibraryCopyItemsCmd (const AssetIDList &sourceAssetList, ILibrary sourceLibrary, ILibrary destLibrary)=0

virtual ErrorCode	ProcessLibraryDeleteItemsCmd (const AssetIDList &assetList, ILibrary *library)=0

virtual ErrorCode	ProcessLibraryNewLibCmd (const IDFile &libraryFile)=0

virtual ErrorCode	ProcessLibraryOpenLibCmd (const IDFile &libraryFile, UIDRef *openedLib=nil)=0

virtual ErrorCode	ScheduleLibraryCloseLibCmd (ILibrary *library)=0

virtual ErrorCode	OpenLibraryWithUI (const IDFile &sysFile, UIDRef *openedLib=nil)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Static Public Member Functions
static ILibraryCmdUtils *	QueryLibraryCmdUtils ()

Detailed Description

Used to create and process the various commands of the Library.

Member Function Documentation

virtual ICommand* ILibraryCmdUtils::CreateLibraryAddItemCmd	(	UIDList *	selection,
		ILibrary *	library,
		bool16	fromCompletePage = `false`
	)

pure virtual

Create a command to add a library asset from pageitems.

Parameters

selection	IN the items to add
library	IN the library to contain the items
fromCompletePage	IN if kTrue, we are adding all items from the page

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryCloseLibCmd ( ILibrary * library )

pure virtual

Create a command to close a library.

Parameters

library IN file specification for the library file

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryCopyItemsCmd	(	const AssetIDList &	sourceAssetList,
		ILibrary *	sourceLibrary,
		ILibrary *	destLibrary
	)

pure virtual

Create a command to copy assets from one library to another.

Parameters

sourceAssetList	IN assetID's of assets being copied
sourceLibrary	IN ILibrary pointer to source library
destLibrary	IN ILibrary pointer to destination library

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryDeleteItemsCmd	(	const AssetIDList &	assetList,
		ILibrary *	library
	)

pure virtual

Create a command to delete library assets.

Parameters

assetList	IN assetIDs of assets to delete
library	IN ILibrary pointer to library

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryNewLibCmd ( const IDFile & libraryFile )

pure virtual

Create a command to create a new library.

Parameters

libraryFile IN file specification for the library file

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryOpenLibCmd ( const IDFile & libraryFile )

pure virtual

Create a command to open a library.

Parameters

libraryFile IN file specification for the library file

Returns: interface pointer to ICommand

virtual ICommand* ILibraryCmdUtils::CreateLibraryUpdateItemCmd	(	UIDList *	selection,
		ILibrary *	library,
		const AssetIDList &	assetList
	)

pure virtual

Create a command to update a library asset from pageitems.

Parameters

selection	IN the items to add
library	IN the library containing the asset being updated
assetList	IN AssetIDList containing one and only one assetID for asset to update

Returns: interface pointer to ICommand

virtual ErrorCode ILibraryCmdUtils::OpenLibraryWithUI	(	const IDFile &	sysFile,
		UIDRef *	openedLib = `nil`
	)

pure virtual

Open a library with the Library Panel UI brought up.

Parameters

sysFile	IN the file specification of the library to open
openedLib	OUT a UIDRef for the library opened

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryAddItemCmd	(	UIDList *	selection,
		ILibrary *	library,
		bool16	fromCompletePage = `false`,
		AssetIDList *	newAssetList = `nil`,
		IDataExchangeHandler *	handler = `nil`,
		ExternalPMFlavor	gotFlavor = `kNoFlavor`
	)

pure virtual

Create and immediately process a command to add a library asset from pageitems.

Parameters

selection	IN a pointer to the items to add, if IDataExchangeHandler is nil; this interface takes ownership of the pointer
library	IN the library to contain the items
fromCompletePage	IN if kTrue, we are adding all items from the page
newAssetList	OUT if supplied, contains the created assetIDs
handler	IN data exchange handler containing data, if selection UIDList pointer is nil
gotFlavor	IN flavor used by data exchange handler, if used

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryAddStructureCmd	(	XMLReference &	addThis,
		ILibrary *	library,
		AssetIDList *	newAssetList = `nil`,
		IDataExchangeHandler *	handler = `nil`,
		ExternalPMFlavor	gotFlavor = `kNoFlavor`
	)

pure virtual

Create and immediately process a command to add a library asset from structure.

Parameters

addThis	IN a pointer to the XMLReference to add, if IDataExchangeHandler is nil
library	IN the library to contain the items
newAssetList	OUT if supplied, contains the created assetIDs
handler	IN data exchange handler containing data, if XMLReference is nil
gotFlavor	IN flavor used by data exchange handler, if used

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryCopyItemsCmd	(	const AssetIDList &	sourceAssetList,
		ILibrary *	sourceLibrary,
		ILibrary *	destLibrary
	)

pure virtual

Create and immediately process a command to copy an asset from one library to another.

Parameters

sourceAssetList	IN assetID's of assets being copied
sourceLibrary	IN ILibrary pointer to source library
destLibrary	IN ILibrary pointer to destination library

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryDeleteItemsCmd	(	const AssetIDList &	assetList,
		ILibrary *	library
	)

pure virtual

Create and immediately process a command to delete library assets.

Parameters

assetList	IN assetIDs of assets to delete
library	IN ILibrary pointer to library

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryNewLibCmd ( const IDFile & libraryFile )

pure virtual

Create and immediately process a command to create a new library.

Parameters

libraryFile IN file specification for the library file

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryOpenLibCmd	(	const IDFile &	libraryFile,
		UIDRef *	openedLib = `nil`
	)

pure virtual

Create and immediately process a command to open a library.

Parameters

libraryFile	IN file specification for the library file
openedLib	OUT a UIDRef for the library opened

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryUpdateItemCmd	(	UIDList *	selection,
		ILibrary *	library,
		AssetIDList *	newAssetList = `nil`,
		IDataExchangeHandler *	handler = `nil`,
		ExternalPMFlavor	gotFlavor = `kNoFlavor`
	)

pure virtual

Create and immediately process a command to update a library asset from pageitems.

Parameters

selection	IN a pointer to the one and only one to add, if IDataExchangeHandler is nil
library	IN the library to contain the items
newAssetList	OUT if supplied, contains the created assetIDs
handler	IN data exchange handler containing data, if selection UIDList pointer is nil
gotFlavor	IN flavor used by data exchange handler, if used

Returns: error code

virtual ErrorCode ILibraryCmdUtils::ProcessLibraryUpdateStructureCmd	(	XMLReference &	addThis,
		ILibrary *	library,
		AssetIDList *	assetList = `nil`,
		IDataExchangeHandler *	handler = `nil`,
		ExternalPMFlavor	gotFlavor = `kNoFlavor`
	)

pure virtual

Create and immediately process a command to update a library asset from structure.

Parameters

addThis	IN a pointer to the XMLReference to add, if IDataExchangeHandler is nil
library	IN the library to contain the items
assetList	OUT if supplied, contains the created assetIDs
handler	IN data exchange handler containing data, if XMLReference is nil
gotFlavor	IN flavor used by data exchange handler, if used

Returns: error code

static ILibraryCmdUtils* ILibraryCmdUtils::QueryLibraryCmdUtils ( )

inlinestatic

Get an instance of the Library Cmd Utility Boss

Returns: an Interface pointer for ILibraryCmdUtils

virtual ErrorCode ILibraryCmdUtils::ScheduleLibraryCloseLibCmd ( ILibrary * library )

pure virtual

Create and schedule a command close a library.

Parameters

library IN file specification for the library file

Returns: error code

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation