ITextWalkerScope.h

//========================================================================================
// 
// $File$
// 
// Owner: Habib Khalfallah 
// 
// $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 __ITextWalkerScope__
#define __ITextWalkerScope__
#include "TextWalkerServiceProviderID.h"
#include "ITextModel.h"
#include "ITextFocus.h"
#include "PMTextUtils.h"

class ITextWalkerScope : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTWALKERSCOPE};

 enum LockType {kLockForRead , kLockForWrite };

 virtual bool16 LockScope(LockType lockType) const = 0;

 virtual bool16 UnlockScope() const = 0;

 virtual bool16 IsLocked() const = 0;

 virtual bool16 IsEmpty() const = 0;

 virtual void SetNextDoc(const UIDRef& doc) = 0;

 virtual void SetNextStory(UID story) = 0;

 virtual void SetNextRange(const Text::StoryRangeList* list) = 0;

 virtual bool16 RemoveDoc(const UIDRef& doc) = 0;

 virtual bool16 RemoveStory(const UIDRef& doc, UID story) = 0;

 virtual int32 GetCharTotal() const = 0;

 virtual const UIDRef& GetCursorDoc(void *token) const = 0;
 
 virtual UID GetCursorStory(void *token) const = 0;

 virtual ITextFocus* GetCursorRange(void *token, bool16 *pAdjustable = nil,
 int32* pCharOffset = nil, bool16 searchBackwards=kFalse) const = 0;

 virtual bool16 AdjustRangeToStoryStart(void *token, int32 delta) = 0;

 virtual bool16 AdjustRangeToStoryEnd(void *token, int32 delta) = 0;

 virtual bool16 ExtendRangeToEndOfStory(void *token) = 0;

 virtual bool16 ExtendRangeToStory(void *token) = 0;

 virtual bool16 MoveToNextDoc(void *token) const = 0;

 virtual bool16 MoveToNextStory(void *token) const = 0;

 virtual bool16 MoveToNextRange(void *token) const = 0; 
 
 virtual void* GetNewCursor(void * basedOn = nil) const = 0;

 virtual bool16 ReleaseCursor(void * token) const = 0;

 virtual void SetPosition(void *token, TextIndex nPosition) = 0;

 virtual TextIndex GetPosition(void *token) const = 0;

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

 virtual ITextFocus* GetClientSelection(void *token, TextIndex& start, int32& length) const = 0;

 virtual void AllowClientSelectionSetRange(void *token, bool16 bAllow) = 0;

 virtual void ClearClientSelection(void *token) = 0;
};

#endif