IWalkerScopeFactoryUtils.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 __IWalkerScopeFactoryUtils__
#define __IWalkerScopeFactoryUtils__
#include "TextWalkerServiceProviderID.h"
#include "PMTextUtils.h"
#include "WalkerScopeOptions.h"
class ITextWalkerScope;
class ITextWalker;
class IDocument;
class UIDList;
class ITextModel;
class ITextFocusList;
class ISelectionManager;
class RangeData;
class XMLReference;

class IWalkerScopeFactoryUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWALKERSCOPEFACTORYUTILS};
 
 enum WalkScopeType
 { 
 kEmptyScope, 
 kAllDocumentScope, 
 kDocumentScope, 
 kStoryScope, 
 kStoryListScope, 
 kSelectionScope, 
 kToEndOfStoryScope
 };

 virtual ITextWalkerScope *QueryWalkerScope_UsingSelections(WalkScopeType scopeType,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryActiveSelectionWalkerScope (ISelectionManager* pActiveSelection,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryDocumentWalkerScope(const UIDRef& doc,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryStoryListWalkerScope(const UIDList& storyList,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryFocusListWalkerScope(const ITextFocusList* focusList,WalkerScopeOptions options = WalkerScopeOptions(),bool16 collectStoryRanges=kFalse) const = 0;

 virtual ITextWalkerScope *QueryStoryWalkerScope(const UIDRef& story,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryRangeWalkerScope(ITextModel *pModel, TextIndex start, int32 length,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryRangeWalkerScope(ITextModel *pModel, const RangeData& r,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryAllOpenDocsWalkerScope(WalkerScopeOptions options = WalkerScopeOptions()) const = 0;


 // The range list argument in the following set of functions is used to get a scope that contains ordered
 // foci that start after the range list (inclusive) till the end, and loop back to the beginning up to start 
 // of range list. 
 virtual ITextWalkerScope *QueryToEndOfStoryWalkerScope(const UIDRef& story, const Text::StoryRangeList& rangeList,WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryAllOpenDocsWalkerScope(const UIDRef& storyRef,
 const Text::StoryRangeList& rangeList,
 WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryDocumentWalkerScope(const UIDRef& doc, 
 const UIDRef& storyRef,
 const Text::StoryRangeList& rangeList,
 WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryStoryWalkerScope(const UIDRef& story, 
 const Text::StoryRangeList& rangeList,
 WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual ITextWalkerScope *QueryXMLElementWalkerScope(const XMLReference& xmlElement,
 WalkerScopeOptions options = WalkerScopeOptions()) const = 0;

 virtual void CarryoutAnyExclusions(const UIDRef& textStory,
 const Text::StoryRangeList& inRangeList,
 Text::StoryRangeList& outRangeList,
 const WalkerScopeOptions& options) const = 0;

 virtual WalkScopeType GetActiveSelectionScope() const = 0;
 
 virtual WalkScopeType SetWalkScope(ITextWalker* pWalker, WalkScopeType type) = 0; 

 virtual WalkScopeType GetWalkScope(ITextWalkerScope* pScope) const = 0;
};

#endif