IBookManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IBOOKMANAGER__
#define __IBOOKMANAGER__

#include "IPMUnknown.h"

#include "K2Vector.h"

#include "BookID.h"

class IBook;
class IDocument;

class IBookManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IBOOKMANAGER };

 typedef enum
 { kAskMissing, 
 kIgnoreMissing, 
 kCancelMissing
 } UIFlags;

 virtual IBook* CreateBook(
 const IDFile& whatBook, 
 IDataBase::ProtectionLevel protection, 
 void* platformFileInfo = nil) = 0;

 virtual IBook* OpenBook(
 const IDFile& whatFile, 
 IDataBase::ProtectionLevel protection,
 bool16* bAlreadyOpen,
 bool16 bOpenExclusive = kFalse, 
 UIFlags alertMissingPlugIns = kAskMissing) = 0;

 virtual IBook* RecoverBook(
 const IDFile* pubFile, 
 const IDFile* miniSaveFile, 
 IDataBase::ProtectionLevel protection, 
 void* fileInfo = nil) = 0;

 virtual void CloseBook(IBook* iBook) = 0;

 virtual void CloseAll() = 0;

 virtual IBook* GetNthBook(int32 n) = 0;

 virtual int32 GetBookIndex(IBook* iBook) = 0;

 virtual int32 GetBookCount() = 0;

 virtual IBook* GetCurrentActiveBook() = 0;

 virtual void SetCurrentActiveBook(IBook* iBook) = 0;

 virtual IBook* FindOpenBookByName(const IDFile& whatBook) = 0;

 virtual bool16 IsDocumentWithinOpenBooks(IDocument* doc, PMString& bookName) = 0;
};

#endif //__IBOOKMANAGER__