ISpreadList.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.
// 
//========================================================================================

#ifndef __ISPREADLIST__
#define __ISPREADLIST__

#include "IPMUnknown.h"
#include "SpreadID.h"

class IGeometry;
class UIDList;
class IIterator;

class ISpreadList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISPREADLIST };

 enum { kAtTheEnd = -1 };

 virtual void InsertSpreads(const UIDList& spreadToInsert, int32 posForInsert) = 0;

 virtual void InsertOneSpread(const UID spreadToInsert, int32 posForInsert) = 0;


 virtual void RemoveSpreads(int32 firstIndex, int32 count) = 0;

 virtual void RemoveOneSpread(int32 posForRemove) = 0;


 virtual void MoveSpread(int32 from, int32 to) = 0;

 virtual IGeometry * QueryNthSpread(int32 spreadIndex) = 0;

 virtual UID GetNthSpreadUID(int32 spreadIndex) = 0;

 virtual int32 GetSpreadCount() const = 0;

 virtual int32 GetSpreadIndex(IGeometry * spread) = 0;

 virtual int32 GetSpreadIndex(UID spreadUID) = 0;

 
 virtual IIterator *NewPageIterator() = 0;
};


#endif // __ISPREADLIST__