ITableModelList.h

//========================================================================================
// 
// $File$
// 
// Owner: Joe Shankar
// 
// $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 __ITableModelList__
#define __ITableModelList__

#include "TablesID.h"
#include "PMTextUtils.h"


//-----------------------------------
// Forward References
//
class ITableModel;

class ITableModelList : public IPMUnknown {

public:
 // ----- Constants -----
 enum {kDefaultIID = IID_ITABLEMODELLIST };

 // ----- Iteration -----
 virtual int32 GetModelCount() const = 0;
 
 virtual ITableModel* QueryNthModel(int32 index) const = 0;

 virtual UID GetNthModelUID(int32 index) const = 0;

 
 virtual void CollectAnchorSpansInThread(TextIndex indexWithinThread,
 Text::StoryRangeList* resultList) const = 0;

 
 virtual int32 GetAnchorDeltaInThread(TextIndex at) const = 0;

 // ----- Addition and Removal ----- 
 virtual void AddModel(UID modelUID,
 UID insertionThreadDictUID,
 uint32 insertionThreadDictKey) = 0; 
 virtual void RemoveModel(UID modelUID) = 0;

 virtual void StoryThreadChanged(UID tableModelUID, UID dictUID, uint32 dictKey) = 0;
protected:

 virtual void Invariant() const = 0;

};


#endif // __ITableModelList__