ITextWalker.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __ITextWalker__
#define __ITextWalker__

#include "IPMUnknown.h"
#include "TextWalkerServiceProviderID.h"
class IDocument;
class ITextModel;
class ITextWalkerClient;
class IProgressBarControlData;
class ITextWalkerScope;
class ITextFocus;
class IFindChangeOptions;

//----------------------------------------------------------------------------------------
// Interface ITextWalker
//----------------------------------------------------------------------------------------

class ITextWalker : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTWALKER};

 virtual void Initialize (ITextWalkerClient *pClient, 
 ITextWalkerScope* pScope, 
 IFindChangeOptions* pOptions, 
 void* token = nil) = 0;
 virtual bool16 Walk() = 0;
 
 virtual int32 MoveBy( int32 nDelta ) = 0; 

 virtual void MoveTo( TextIndex nPosition ) = 0; 

 virtual void Suspend() = 0; 

 virtual void Halt() = 0; 
 
 virtual bool16 IsSuspended() const = 0; 

 virtual bool16 IsWalking() const = 0; 

 virtual TextIndex GetWalkerPosition() const = 0; 

 virtual ITextWalkerScope* QueryScope() = 0;

 virtual ITextWalkerClient* QueryClient () = 0;

 virtual void * GetCursorToken() = 0;
 
 virtual void SetClientSelection( TextIndex nStart, int32 nLength ) = 0;

 virtual ITextFocus* GetClientSelection(TextIndex *pStart, int32* pLength) const = 0;

 virtual bool16 AdjustRangeToStoryStart(int32 delta) = 0;

 virtual bool16 AdjustRangeToStoryEnd(int32 delta) = 0;

 virtual void ExtendCurrentRangeToEndOfStory() = 0;

 virtual void ExtendCurrentRangeToStory() = 0;
 
 virtual IFindChangeOptions* QueryFindChangeOptions() = 0;

 virtual void SetStateForRangeLock(bool16 state) = 0;

 virtual bool16 IsCompleted() const = 0;
};

class ITextWalkerClient : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTWALKERCLIENT};

 virtual bool16 OnStart( ITextWalker *pWalker ) = 0;

 virtual bool16 OnEnd( ITextWalker *pWalker ) = 0;
 
 virtual bool16 OnResume( ITextWalker *pWalker ) = 0;

 virtual bool16 OnSuspend( ITextWalker *pWalker ) = 0;

 virtual bool16 OnNextPosition(ITextWalker *pWalker, ITextModel *pModel,
 TextIndex nPosition,
 TextIndex nStartRange, TextIndex nEndRange,
 int32 startRangePrcnt, int32 endRangePrcnt,
 bool16 rangeAdjustable) = 0;

 virtual bool16 OnStoryStart( ITextWalker *pWalker, UID storyUID ) = 0;

 virtual void OnStoryEnd( ITextWalker *pWalker ) = 0;

 virtual bool16 OnDocumentStart( ITextWalker *pWalker, const UIDRef &newDoc ) = 0;

 virtual void OnDocumentEnd( ITextWalker *pWalker) = 0;

 virtual void SetReplacementCount(int32 count) = 0;

 virtual int32 GetReplacementCount() = 0;

 virtual bool16 UpdateTextRange() = 0;
};

#endif