IFrameList.h

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

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

class ITextFrameColumn;
class ITextModel;
class RangeData;

class IFrameList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFRAMELIST };

 enum { kAtTheEnd = -1 };

 virtual void SetTextModelUID(UID modelUID) = 0;

 virtual UID GetTextModelUID() const = 0;

 virtual ITextModel * QueryTextModel() const = 0;

 virtual int32 GetFrameIndex(UID frameUID) const = 0;

 virtual int32 GetFrameIndex(const ITextFrameColumn* frame) const = 0;

 virtual int32 GetFrameCount() const = 0;

 virtual UID GetNthFrameUID(int32 n) const = 0;

 virtual ITextFrameColumn * QueryNthFrame(int32 n) const = 0;

 virtual TextIndex GetFrameStart(UID frameUID) const = 0;

 virtual int32 GetFrameSpan(UID frameUID) const = 0;

 virtual ITextFrameColumn * QueryFrameContaining(TextIndex textIndex, int32 * frameIndex /* = nil*/) const = 0;

 virtual int32 GetFrameIndexContaining(TextIndex at) const = 0;

 virtual void GetFramesContaining(const RangeData& range, int32* firstIndex, int32* lastIndex) const = 0;

 virtual bool16 GetWasOversetValid() const = 0;

 virtual bool16 GetWasOverset() const = 0;

 virtual void SetWasOverset(bool16 ov) = 0;

 virtual void AddFrame(UID frameUID) = 0;

 virtual void AddFrameAt(UID frameUID, int32 at) = 0;

 virtual void ProcessAddFrameAt(UID frameUID, int32 at) = 0;

 virtual void RemoveFrame(UID frameUID) = 0;

 virtual void ClearFrameList() = 0;

 virtual int32 GetFirstDamagedFrameIndex() const = 0;

 virtual void ClearInViewCache() = 0;

 virtual bool16 IsInView(UID frameUID) const = 0;

 virtual void AddToInViewCache(UID frameUID) = 0;

 /*
 Normally recomposition and damage recording clear the "in view"
 cache every time they are called, since they have no way of
 knowing if what is in view has changed. However, recalculating
 the cache is not free and some operations like Change All
 make a lot of separate calls to mark damage (which calls IsInView)
 without the possibility of what is in view changing. For these cases
 you can (carefully) "freeze" and "unfreeze" the in view cache.
 Freezing the cache clears it and prevents subsequent calls to
 ClearInViewCache from having any effect. IsInView will populate
 the cache as usual.
 Note: The "frozen" flag is not persistent, so you must maintain
 a reference on the IFrameList for the entire time the cache is frozen.
 @param freezeIt If set to kTrue, the cache is frozen.
 */
 virtual void FreezeInViewCache(bool16 freezeIt) = 0;

 class InViewCacheFreezer
 {
 public:
 InViewCacheFreezer(IFrameList * frameList)
 : fFrameList(frameList)
 {
 if (frameList != nil)
 {
 fFrameList->AddRef();
 fFrameList->FreezeInViewCache(kTrue);
 }
 }

 ~InViewCacheFreezer()
 {
 if (fFrameList != nil)
 fFrameList->FreezeInViewCache(kFalse);
 }

 private:
 InterfacePtr<IFrameList> fFrameList;
 };

 virtual uint32 GetChangeCounter() const = 0;

#ifdef DEBUG

 virtual void LockDamaging( bool16 bLock ) = 0;

 virtual bool16 IsDamagingLocked() const = 0;
#endif

 virtual void SetNotInViewList(const UIDList& frameList) = 0;

 virtual void RemoveNotInViewList(const UIDList& frameList) = 0;

};

#endif