#include <IWalkerScopeFactoryUtils.h>

Inheritance diagram for IWalkerScopeFactoryUtils:

Public Types
enum	{ kDefaultIID = IID_IWALKERSCOPEFACTORYUTILS }

enum	WalkScopeType { kEmptyScope, kAllDocumentScope, kDocumentScope, kStoryScope, kStoryListScope, kSelectionScope, kToEndOfStoryScope }

Public Member Functions
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

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

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

IWalkerScopeFactoryUtils provides an interface for creating the appropriate ITextWalkerScope.

See Also: also WalkerScopeOptions.h

Member Enumeration Documentation

enum IWalkerScopeFactoryUtils::WalkScopeType

Enumerator
kEmptyScope	This enumeration specifies nothing for walking.
kAllDocumentScope	This enumeration specifies all documents for walking
kDocumentScope	This enumeration specifies the active document for walking
kStoryScope	This enumeration specifies the selected story for walking
kStoryListScope	This enumeration specifies the list of specified stories for walking
kSelectionScope	This enumertaion specifies the active selection for walking
kToEndOfStoryScope	This enumeration specifies the walking in the active story from current position to end of the story

Member Function Documentation

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

pure virtual

Does the necessary exclusions in the input range list as per the supplied options

Parameters

story	[IN] UIDRef of story that needs to be walked
inRangeList	[IN] the input range list in which we need to carry out exclusions
outRangeList	[OUT] the output range list
options	[IN] the scope options based on which the exclusions will be carried out

virtual WalkScopeType IWalkerScopeFactoryUtils::GetActiveSelectionScope ( ) const

pure virtual

Looks at selections and decides what the scope is.

Returns: the Walker scope type of the active selection scope

virtual WalkScopeType IWalkerScopeFactoryUtils::GetWalkScope ( ITextWalkerScope * pScope ) const

pure virtual

Lets one query the walker scope type for the supplied ITextWalkerScope

Parameters

pScope [IN] the pointer to ITextWalkerScope for which the scope type is being queried.

Returns: Walker scope type of the scope supplied

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryActiveSelectionWalkerScope	(	ISelectionManager *	pActiveSelection,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for the current selection

Parameters

pActiveSelection	[IN] selection manager interface for determining the current selection
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the current selection

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryAllOpenDocsWalkerScope ( WalkerScopeOptions options = WalkerScopeOptions() ) const

pure virtual

Create the ITextWalkerScope for all the documents that are open

Parameters

options [IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for all the documents that are open

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

pure virtual

Create the ITextWalkerScope for all the active documents

Parameters

storyRef	[IN] the UIDRef of story that needs to be walked first
rangeList	[IN] 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
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for all the active documents

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryDocumentWalkerScope	(	const UIDRef &	doc,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for the document specified

Parameters

doc	[IN] UIDRef of the document in which the walker needs to walk
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the document specified

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

pure virtual

Create the ITextWalkerScope for the supplied document

Parameters

doc	[IN] UIDRef of document that needs to be walked
storyRef	[IN] UIDRef of the story that needs to be walked first
rangeList	[IN] 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
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the supplied document

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryFocusListWalkerScope	(	const ITextFocusList *	focusList,
		WalkerScopeOptions	options = `WalkerScopeOptions()`,
		bool16	collectStoryRanges = `kFalse`
	)		const

pure virtual

Create the ITextWalkerScope for the supplied focus list

Parameters

focusList	[IN] a pointer to interface ITextFocusList containing the focus list which need to be walked
options	[IN] lets one specify options like "include master pages" etc for the resultant walker
collectStoryRanges[IN]	(default value kFalse), pass kTrue only if we want to get sequential story ranges of table or other type of owned items like footnote within span of focus text.

Returns: ITextWalkerScope created for the supplied focus list

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryRangeWalkerScope	(	ITextModel *	pModel,
		TextIndex	start,
		int32	length,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for range that is supplied

Parameters

pModel	[IN] ITextModel interface pointer to the story in which the range is supplied
start	[IN] the starting text index of the range
length	[IN] the range span starting from the starting index supplied
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the range that is supplied

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryRangeWalkerScope	(	ITextModel *	pModel,
		const RangeData &	r,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for range that is supplied

Parameters

pModel	[IN] ITextModel interface pointer to the story in which the range is supplied
r	[IN] Range information contained in RangeData class
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for range that is supplied

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryStoryListWalkerScope	(	const UIDList &	storyList,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for the supplied storylist

Parameters

storyList	[IN] the list of UIDs of the stories in which the walker needs to walk
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the supplied storylist

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryStoryWalkerScope	(	const UIDRef &	story,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for the specified story

Parameters

story	[IN] UIDRef of the story that needs to be walked.
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the specified story

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

pure virtual

Create the ITextWalkerScope for all the active documents

Parameters

story	[IN] UIDRef of story that needs to be walked
rangeList	[IN] 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
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for all the active documents

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryToEndOfStoryWalkerScope	(	const UIDRef &	story,
		const Text::StoryRangeList &	rangeList,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope from the current position to end of the story

Parameters

story	[IN] the UIDRef of story that needs to be walked
rangeList	[IN] 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
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created from the current position to end of the story

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryWalkerScope_UsingSelections	(	WalkScopeType	scopeType,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the appropriate ITextWalkerScope for the given scope type and the current selection

Parameters

scopeType	[IN] lets one specify various scope types
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the given scope type and the current selection

virtual ITextWalkerScope* IWalkerScopeFactoryUtils::QueryXMLElementWalkerScope	(	const XMLReference &	xmlElement,
		WalkerScopeOptions	options = `WalkerScopeOptions()`
	)		const

pure virtual

Create the ITextWalkerScope for an XML element including linked story elements

Parameters

xmlElement	[IN] the XMLReference of xml element that needs to be walked
options	[IN] lets one specify options like "include master pages" etc for the resultant walker

Returns: ITextWalkerScope created for the XML element including linked story elements

virtual WalkScopeType IWalkerScopeFactoryUtils::SetWalkScope	(	ITextWalker *	pWalker,
		WalkScopeType	type
	)

pure virtual

Lets one switch the scope type for the walker that is supplied. We only allow switches between kStoryScope and kToEndOfStoryScope. pScope(pScope is the pointer to ITextWalkerScope corresponding to pWalker) must not be locked.

Parameters

pWalker	[IN] the pointer to walker for which the scope type needs to be changed.
type	[IN] the scope type which needs to be set.

Returns: Walker scope type of the walker of this set operation

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation