ILibrary Class Reference

#include <ILibrary.h>

Inheritance diagram for ILibrary:

Public Types
enum	{ kDefaultIID = IID_ILIBRARY }

Public Member Functions
virtual ErrorCode	Initialize ()=0
virtual bool16	Open (const IDFile &libraryFile, const PMString &actualFileName)=0
virtual bool16	Create (const IDFile &libraryFile, const PMString &actualFileName)=0
virtual void	Close ()=0
virtual bool16	IsOpen () const =0
virtual bool16	IsLocked () const =0
virtual int32	Length () const =0
virtual IDFile	GetLibraryFileSpec () const =0
virtual PMString	GetFileName () const =0
virtual bool16	NeedsSnippetConversion (const IDFile &libraryFile)=0
virtual bool16	ConvertToSnippets (const IDFile &oldLibraryFile, IDFile &newLibraryFile, bool16 bUseOldName=kFalse)=0
virtual bool16	LibraryIsPreSnippets ()=0
virtual ILibraryScrapController *	GetScrapController () const =0
virtual void	DisableLibraryLevelNotification ()=0
virtual void	EnableLibraryLevelNotification ()=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

The main interface to the library boss. This interface controls opening and closing of a library file and has various utility methods to determine its status.

Member Function Documentation

virtual void ILibrary::Close ( )

pure virtual

Closes the library.

virtual bool16 ILibrary::ConvertToSnippets ( const IDFile &  oldLibraryFile, IDFile &  newLibraryFile, bool16  bUseOldName = kFalse  )

pure virtual

• For Internal Use Only *

virtual bool16 ILibrary::Create ( const IDFile &  libraryFile, const PMString &  actualFileName  )

pure virtual

Creates a library with the given pathname.

Parameters

libraryFile	IN the library file specification
actualFileName	IN the filename for the library

Returns

kTrue if successful, kFalse otherwise

virtual void ILibrary::DisableLibraryLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual void ILibrary::EnableLibraryLevelNotification ( )

pure virtual

• For Internal Use Only *

virtual PMString ILibrary::GetFileName ( ) const

pure virtual

Gets the file name of the library

Returns

the library filename

virtual IDFile ILibrary::GetLibraryFileSpec ( ) const

pure virtual

Gets the name and path of the library file

Returns

the file specification for the library

virtual ILibraryScrapController* ILibrary::GetScrapController ( ) const

pure virtual

• For Internal Use Only *

virtual ErrorCode ILibrary::Initialize ( )

pure virtual

Initializes the Library Data.

Returns

an error code

virtual bool16 ILibrary::IsLocked ( ) const

pure virtual

Tell if the library is locked (no changes can be made).

Returns

kTrue for locked, kFalse for unlocked

virtual bool16 ILibrary::IsOpen ( ) const

pure virtual

Tell if the library is open.

Returns

kTrue if open, kFalse if closed

virtual int32 ILibrary::Length ( ) const

pure virtual

Get the total number of assets in library

Returns

the number of assets

virtual bool16 ILibrary::LibraryIsPreSnippets ( )

pure virtual

• For Internal Use Only *

virtual bool16 ILibrary::NeedsSnippetConversion ( const IDFile &  libraryFile )

pure virtual

• For Internal Use Only *

virtual bool16 ILibrary::Open ( const IDFile &  libraryFile, const PMString &  actualFileName  )

pure virtual

Opens the library with the given pathname.

Parameters

libraryFile	IN the library file specification
actualFileName	IN the filename for the library

Returns

kTrue if successful, kFalse otherwise