ITextObjectParent.h

//========================================================================================
// 
// $File$
// 
// Owner: Jonathan W. Brown
// 
// $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 __ITextObjectParent__
#define __ITextObjectParent__

#include "ITextStoryThread.h"

#include "ScriptData.h"
#include "TextID.h"

class ITextObjectParent : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTOBJECTPARENT } ;

 class RangeIter
 {
 public:
 virtual ~RangeIter();

 virtual bool16 GetFirstRange(UIDRef& textModelRef,
 InterfacePtr<const ITextStoryThread>& thread,
 TextIndex& threadStart,
 int32& threadSpan,
 TextIndex& adjThreadStart,
 int32& adjThreadSpan,
 TextIndex& rangeStart,
 int32& rangeSpan) = 0;

 virtual bool16 GetNextRange(InterfacePtr<const ITextStoryThread>& thread,
 TextIndex& threadStart,
 int32& threadSpan,
 TextIndex& adjThreadStart,
 int32& adjThreadSpan,
 TextIndex& rangeStart,
 int32& rangeSpan) = 0;

 protected:
 RangeIter();
 RangeIter(const RangeIter& other);

 };

 class SingleRangeIter : public RangeIter
 {
 public:
 SingleRangeIter(const UIDRef& textModelRef,
 const ITextStoryThread* thread,
 TextIndex threadStart, int32 threadSpan,
 // adjThreadStart, adjThreadSpan set to thread values
 TextIndex rangeStart, int32 rangeSpan);

 SingleRangeIter(const UIDRef& textModelRef,
 const ITextStoryThread* thread,
 TextIndex threadStart, int32 threadSpan,
 TextIndex adjThreadStart, int32 adjThreadSpan,
 TextIndex rangeStart, int32 rangeSpan);

 bool16 GetFirstRange(UIDRef& textModelRef,
 InterfacePtr<const ITextStoryThread>& thread,
 TextIndex& threadStart,
 int32& threadSpan,
 TextIndex& adjThreadStart,
 int32& adjThreadSpan,
 TextIndex& rangeStart,
 int32& rangeSpan)
 {
 textModelRef = fTextModelRef;
 thread = fThread;
 threadStart = fThreadStart;
 threadSpan = fThreadSpan;
 adjThreadStart = fAdjThreadStart;
 adjThreadSpan = fAdjThreadSpan;
 rangeStart = fRangeStart;
 rangeSpan = fRangeSpan;
 return kTrue;
 }

 bool16 GetNextRange(InterfacePtr<const ITextStoryThread>& thread,
 TextIndex& threadStart,
 int32& threadSpan,
 TextIndex& adjThreadStart,
 int32& adjThreadSpan,
 TextIndex& rangeStart,
 int32& rangeSpan)
 { return kFalse; }

 private:
 UIDRef fTextModelRef;
 InterfacePtr<const ITextStoryThread> fThread;
 TextIndex fThreadStart;
 int32 fThreadSpan;
 TextIndex fAdjThreadStart;
 int32 fAdjThreadSpan;
 TextIndex fRangeStart;
 int32 fRangeSpan;

 };
 
 virtual RangeIter* CreateRangeIterFor(const ScriptInfo::RequestContext& context, ScriptID childType) const = 0;

};

#endif