IDocumentList.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $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.
// 
// 
// Purpose of Interface:
// Create, open, manage, and close documents
// 
//========================================================================================

#ifndef __IDOCUMENTLIST__
#define __IDOCUMENTLIST__

#include "IPMUnknown.h"
#include "DocumentID.h"
#include "IDocument.h"

class IDocumentList : public IPMUnknown
{
public:
 enum UIFlags { 
 kAskMissing, 
 kIgnoreMissing, 
 kCancelMissing, 
 kForceIgnoreMissing, 
 kDontCheck
 };
 virtual int32 GetDocCount(bool16 bClosePlacedINDDFiles = kFalse) const = 0;

 virtual IDocument * GetNthDoc(int32 n) = 0;

 virtual IDocument *FindDoc(const IDFile& whatFile) const = 0;

 virtual IDocument *FindDocByDataBase(IDataBase* db) const = 0;

 virtual IDocument *FindDocFromPreviousVersion(const IDFile& whatFile) = 0;
 

 virtual IDocument * NewDoc(const ClassID& docClassID, IDataBase::ProtectionLevel protection, void* fileInfo = nil, IDocument::UndoSupport undoSupport = IDocument::kFullUndoSupport) = 0;

 virtual IDocument * OpenDoc(const IDFile& whatFile, IDataBase::ProtectionLevel protection, bool16 bOpenOriginal = true, UIFlags alertMissingPlugIns = kAskMissing, bool16 bUseLockFile = kTrue, IDocument::UndoSupport undoSupport = IDocument::kFullUndoSupport) = 0;

 // For Private Use Only
 virtual IDocument * OpenDocClone(IDataBase*db, const PMString& docName) = 0;

 virtual IDocument * RecoverDoc(const IDFile* pubFile, const IDFile* miniSaveFile, IDataBase::ProtectionLevel protection, void* fileInfo = nil, bool16 bIsFauxUserFile = kFalse, IDocument::UndoSupport undoSupport = IDocument::kFullUndoSupport) = 0;

 virtual void CloseDoc(IDocument * doc) = 0;

 // For Private Use Only
 virtual void CloseDocClone(IDocument * doc) = 0;

 virtual void CloseAll() = 0;
 

 virtual void PurgeMemory(int32 level) = 0;
 
 virtual IDocument * FindDoc(const std::string& assetRef) const =0;

};

#endif