IVOSCache.h

//========================================================================================
// 
// $File$
// 
// Owner: EricM
// 
// $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 __IVOSCACHE__
#define __IVOSCACHE__

#include "IPMUnknown.h"
#include "VOSCursor.h"
#include "TextID.h"
#include "K2Vector.h"

class IVOSDiskPage;
class UIDList;
class ITextModel;


class IVOSCache : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IVOSCACHE };

 virtual VOS_Cursor Locate(int32 virtualKey) = 0;

 virtual int32 LocatePageStart(IVOSDiskPage * page) = 0;

 virtual void PageSplit(IVOSDiskPage *formerFirst, IVOSDiskPage *newSecond) = 0;

 virtual void LengthAdjusted(IVOSDiskPage *which) = 0;

 virtual void PageRemoved(IVOSDiskPage *which) = 0;

 virtual void PageInserted(IVOSDiskPage *newOne, IVOSDiskPage *beforeThis) = 0;

 virtual void Reset() = 0;

 virtual void GetAllPageUIDs(ITextModel *story, UIDList *list) = 0;

 virtual UID GetPageUIDs( UID startPage,
 int32 *length,
 int32 *pageCount,
 K2Vector<UID> *pageIDList,
 K2Vector<int32> *pageLenList) = 0;


 virtual void PagesRemoved(UID startPage,int32 pageCount) = 0;

#ifdef DEBUG

 virtual void Validate() const = 0;
#endif
};

#endif // __IVOSCACHE__