IMasterSpreadList.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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.
// 
// 
// An interface off the document, contains the list of master spreads
// defined in this document.
// 
//========================================================================================

#ifndef __IMASTERSPREADLIST__
#define __IMASTERSPREADLIST__

#include "IPMUnknown.h"
#include "MasterPageID.h"

class IGeometry;
class UIDList;
class IIterator;

class IMasterSpreadList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMASTERSPREADLIST };
 enum { kAtTheEnd = -1 };

 virtual void InsertMasterSpreads(const UIDList& spreadToInsert, int32 posForInsert) = 0;
 
 virtual void RemoveMasterSpread(int32 index) = 0;

 virtual IGeometry * QueryNthMasterSpread(int32 spreadIndex) = 0;
 
 virtual UID GetNthMasterSpreadUID(int32 spreadIndex) = 0;
 
 virtual int32 GetMasterSpreadCount() = 0;

 virtual int32 GetMasterSpreadIndex(IGeometry * spread) = 0;

 virtual int32 GetMasterSpreadIndex(UID spreadUID) = 0;

 virtual IIterator *NewPageIterator() = 0;

 virtual void GenerateNewMasterName(PMString* pPrefix, PMString* pName, bool16 duplicate = kFalse) = 0;
 
 virtual UID FindMasterByName(PMString prefix, PMString basename) = 0;
};


#endif // __IMASTERSPREADLIST__